From 399cbac2de1bc0acbed4c9a0a864a9c84da3692e Mon Sep 17 00:00:00 2001 From: tianxinliu <121260442+tianxin-ms@users.noreply.github.com> Date: Tue, 24 Sep 2024 09:06:50 +0800 Subject: [PATCH 01/48] Cognitive Services 2024-10-01 (#30491) * Copy files from preview/2024-06-01-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to stable/2024-10-01 Updated the API version from preview/2024-06-01-preview to stable/2024-10-01. * Added tag for 2024-10-01 in readme file * Cognitive Services 2024-10-01 --- .../examples/CalculateModelCapacity.json | 4 +- .../stable/2024-10-01/cognitiveservices.json | 6992 +++++++++++++++++ .../examples/AddRaiBlocklistItems.json | 36 + .../examples/CalculateModelCapacity.json | 46 + .../examples/CheckDomainAvailability.json | 21 + .../examples/CheckSkuAvailability.json | 30 + .../2024-10-01/examples/CreateAccount.json | 140 + .../2024-10-01/examples/CreateAccountMin.json | 87 + .../examples/CreateSharedCommitmentPlan.json | 67 + ...CreateSharedCommitmentPlanAssociation.json | 36 + .../2024-10-01/examples/DeleteAccount.json | 17 + .../examples/DeleteCommitmentPlan.json | 18 + .../2024-10-01/examples/DeleteDeployment.json | 18 + .../examples/DeleteEncryptionScope.json | 17 + .../DeletePrivateEndpointConnection.json | 19 + .../examples/DeleteRaiBlocklist.json | 17 + .../examples/DeleteRaiBlocklistItem.json | 18 + .../examples/DeleteRaiBlocklistItems.json | 16 + .../2024-10-01/examples/DeleteRaiPolicy.json | 17 + .../examples/DeleteSharedCommitmentPlan.json | 17 + ...DeleteSharedCommitmentPlanAssociation.json | 18 + .../2024-10-01/examples/GetAccount.json | 31 + .../examples/GetCommitmentPlan.json | 26 + .../examples/GetDefenderForAISetting.json | 30 + .../examples/GetDeletedAccount.json | 32 + .../2024-10-01/examples/GetDeployment.json | 30 + .../examples/GetEncryptionScope.json | 38 + ...etworkSecurityPerimeterConfigurations.json | 46 + .../2024-10-01/examples/GetOperations.json | 43 + .../GetPrivateEndpointConnection.json | 29 + .../2024-10-01/examples/GetRaiBlocklist.json | 20 + .../examples/GetRaiBlocklistItem.json | 22 + .../examples/GetRaiContentFilter.json | 22 + .../2024-10-01/examples/GetRaiPolicy.json | 105 + .../examples/GetSharedCommitmentPlan.json | 31 + .../GetSharedCommitmentPlanAssociation.json | 21 + .../stable/2024-10-01/examples/GetSkus.json | 2164 +++++ .../stable/2024-10-01/examples/GetUsages.json | 28 + .../examples/ListAccountModels.json | 48 + .../examples/ListAccountsByResourceGroup.json | 50 + .../examples/ListAccountsBySubscription.json | 77 + .../examples/ListBlocklistItems.json | 33 + .../2024-10-01/examples/ListBlocklists.json | 23 + .../examples/ListCommitmentPlans.json | 29 + .../examples/ListCommitmentTiers.json | 28 + .../examples/ListDefenderForAISetting.json | 33 + .../ListDeletedAccountsBySubscription.json | 77 + .../examples/ListDeploymentSkus.json | 34 + .../2024-10-01/examples/ListDeployments.json | 33 + .../examples/ListEncryptionScopes.json | 41 + .../stable/2024-10-01/examples/ListKeys.json | 16 + .../ListLocationBasedModelCapacities.json | 34 + .../examples/ListLocationModels.json | 64 + .../examples/ListModelCapacities.json | 33 + ...etworkSecurityPerimeterConfigurations.json | 49 + .../ListPrivateEndpointConnections.json | 31 + .../examples/ListPrivateLinkResources.json | 30 + .../examples/ListRaiContentFilters.json | 100 + .../2024-10-01/examples/ListRaiPolicies.json | 106 + .../ListSharedCommitmentPlanAssociations.json | 24 + ...tSharedCommitmentPlansByResourceGroup.json | 34 + ...stSharedCommitmentPlansBySubscription.json | 33 + .../stable/2024-10-01/examples/ListSkus.json | 30 + .../2024-10-01/examples/ListUsages.json | 24 + .../examples/PurgeDeletedAccount.json | 18 + .../examples/PutCommitmentPlan.json | 51 + .../examples/PutDefenderForAISetting.json | 54 + .../2024-10-01/examples/PutDeployment.json | 62 + .../examples/PutEncryptionScope.json | 77 + .../PutPrivateEndpointConnection.json | 54 + .../2024-10-01/examples/PutRaiBlocklist.json | 34 + .../examples/PutRaiBlocklistItem.json | 38 + .../2024-10-01/examples/PutRaiPolicy.json | 283 + ...etworkSecurityPerimeterConfigurations.json | 51 + .../2024-10-01/examples/RegenerateKey.json | 19 + .../2024-10-01/examples/UpdateAccount.json | 58 + .../examples/UpdateDefenderForAISetting.json | 35 + .../2024-10-01/examples/UpdateDeployment.json | 41 + .../examples/UpdateSharedCommitmentPlan.json | 44 + .../resource-manager/readme.md | 9 +- 80 files changed, 12408 insertions(+), 3 deletions(-) create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/cognitiveservices.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/AddRaiBlocklistItems.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CalculateModelCapacity.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CheckDomainAvailability.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CheckSkuAvailability.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CreateAccount.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CreateAccountMin.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CreateSharedCommitmentPlan.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CreateSharedCommitmentPlanAssociation.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteAccount.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteCommitmentPlan.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteDeployment.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteEncryptionScope.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeletePrivateEndpointConnection.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteRaiBlocklist.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteRaiBlocklistItem.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteRaiBlocklistItems.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteRaiPolicy.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteSharedCommitmentPlan.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteSharedCommitmentPlanAssociation.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetAccount.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetCommitmentPlan.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetDefenderForAISetting.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetDeletedAccount.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetDeployment.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetEncryptionScope.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetNetworkSecurityPerimeterConfigurations.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetOperations.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetPrivateEndpointConnection.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetRaiBlocklist.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetRaiBlocklistItem.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetRaiContentFilter.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetRaiPolicy.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetSharedCommitmentPlan.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetSharedCommitmentPlanAssociation.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetSkus.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetUsages.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListAccountModels.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListAccountsByResourceGroup.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListAccountsBySubscription.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListBlocklistItems.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListBlocklists.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListCommitmentPlans.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListCommitmentTiers.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListDefenderForAISetting.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListDeletedAccountsBySubscription.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListDeploymentSkus.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListDeployments.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListEncryptionScopes.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListKeys.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListLocationBasedModelCapacities.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListLocationModels.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListModelCapacities.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListNetworkSecurityPerimeterConfigurations.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListPrivateEndpointConnections.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListPrivateLinkResources.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListRaiContentFilters.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListRaiPolicies.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListSharedCommitmentPlanAssociations.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListSharedCommitmentPlansByResourceGroup.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListSharedCommitmentPlansBySubscription.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListSkus.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListUsages.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PurgeDeletedAccount.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutCommitmentPlan.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutDefenderForAISetting.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutDeployment.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutEncryptionScope.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutPrivateEndpointConnection.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutRaiBlocklist.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutRaiBlocklistItem.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutRaiPolicy.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ReconcileNetworkSecurityPerimeterConfigurations.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/RegenerateKey.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/UpdateAccount.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/UpdateDefenderForAISetting.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/UpdateDeployment.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/UpdateSharedCommitmentPlan.json diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CalculateModelCapacity.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CalculateModelCapacity.json index da4842487689..faf4d5744a5b 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CalculateModelCapacity.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CalculateModelCapacity.json @@ -8,7 +8,7 @@ "name": "gpt-4", "version": "0613" }, - "skuName": "ProvisinedManaged", + "skuName": "ProvisionedManaged", "workloads": [ { "requestPerMinute": 10, @@ -35,7 +35,7 @@ "name": "gpt-4", "version": "0613" }, - "skuName": "ProvisinedManaged", + "skuName": "ProvisionedManaged", "estimatedCapacity": { "value": 346, "deployableValue": 400 diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/cognitiveservices.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/cognitiveservices.json new file mode 100644 index 000000000000..09efa425b617 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/cognitiveservices.json @@ -0,0 +1,6992 @@ +{ + "swagger": "2.0", + "info": { + "title": "CognitiveServicesManagementClient", + "description": "Cognitive Services Management Client", + "version": "2024-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}": { + "put": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Create Cognitive Services Account. Accounts is a resource group wide resource type. It holds the keys for developer to access intelligent APIs. It's also the resource type for billing.", + "operationId": "Accounts_Create", + "x-ms-examples": { + "Create Account": { + "$ref": "./examples/CreateAccount.json" + }, + "Create Account Min": { + "$ref": "./examples/CreateAccountMin.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "name": "account", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Account" + }, + "description": "The parameters to provide for the created account." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is created successfully or already existed, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "201": { + "description": "If resource is created successfully, the service should return 201 (OK).", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Updates a Cognitive Services account", + "operationId": "Accounts_Update", + "x-ms-examples": { + "Update Account": { + "$ref": "./examples/UpdateAccount.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "name": "account", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Account" + }, + "description": "The parameters to provide for the created account." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "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": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Deletes a Cognitive Services account from the resource group. ", + "operationId": "Accounts_Delete", + "x-ms-examples": { + "Delete Account": { + "$ref": "./examples/DeleteAccount.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;" + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, + "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": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Returns a Cognitive Services account specified by the parameters.", + "operationId": "Accounts_Get", + "x-ms-examples": { + "Get Account": { + "$ref": "./examples/GetAccount.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. The only GET specific properties are \"name,\" \"type\" and \"id.\"\nField\tDescription\nKind\trequired. String.\n\tThe API set for this API account. It can be \n\t· a single API, for example: Face API, Vision API, Speech API. \n\ta bundle of APIs: Face + Speech, Vision + Emotion, etc.\nsku.name\tRequired.\n\tThe pricing tier/plan of this API. Could be: \n\tF0 - Free\n\tB0 - Basic\n\tS0 - Standard\n\tP0 - Premium\n", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/resourceGroups/{resourceGroupName}/deletedAccounts/{accountName}": { + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Returns a Cognitive Services account specified by the parameters.", + "operationId": "DeletedAccounts_Get", + "x-ms-examples": { + "Get Account": { + "$ref": "./examples/GetDeletedAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. The only GET specific properties are \"name,\" \"type\" and \"id.\"\nField\tDescription\nKind\trequired. String.\n\tThe API set for this API account. It can be \n\t· a single API, for example: Face API, Vision API, Speech API. \n\ta bundle of APIs: Face + Speech, Vision + Emotion, etc.\nsku.name\tRequired.\n\tThe pricing tier/plan of this API. Could be: \n\tF0 - Free\n\tB0 - Basic\n\tS0 - Standard\n\tP0 - Premium\n", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Deletes a Cognitive Services account from the resource group. ", + "operationId": "DeletedAccounts_Purge", + "x-ms-examples": { + "Delete Account": { + "$ref": "./examples/PurgeDeletedAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;" + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, + "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": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts": { + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Returns all the resources of a particular type belonging to a resource group", + "operationId": "Accounts_ListByResourceGroup", + "x-ms-examples": { + "List Accounts by Resource Group": { + "$ref": "./examples/ListAccountsByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/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/AccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/accounts": { + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Returns all the resources of a particular type belonging to a subscription.", + "operationId": "Accounts_List", + "x-ms-examples": { + "List Accounts by Subscription": { + "$ref": "./examples/ListAccountsBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/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/AccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/deletedAccounts": { + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Returns all the resources of a particular type belonging to a subscription.", + "operationId": "DeletedAccounts_List", + "x-ms-examples": { + "List Deleted Accounts by Subscription": { + "$ref": "./examples/ListDeletedAccountsBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/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/AccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/listKeys": { + "post": { + "tags": [ + "CognitiveServicesAccounts" + ], + "operationId": "Accounts_ListKeys", + "description": "Lists the account keys for the specified Cognitive Services account.", + "x-ms-examples": { + "List Keys": { + "$ref": "./examples/ListKeys.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns with a response body containing the subscription keys for the resource: key1\nThe first API key for authentication when client calls the API endpoint.\n\nkey2\nThe second API key for authentication when client calls the API endpoint.", + "schema": { + "$ref": "#/definitions/ApiKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/regenerateKey": { + "post": { + "tags": [ + "CognitiveServicesAccounts" + ], + "operationId": "Accounts_RegenerateKey", + "description": "Regenerates the specified account key for the specified Cognitive Services account.", + "x-ms-examples": { + "Regenerate Keys": { + "$ref": "./examples/RegenerateKey.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + }, + "description": "regenerate key parameters." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ApiKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/skus": { + "get": { + "tags": [ + "Skus", + "CognitiveServicesAccounts" + ], + "operationId": "ResourceSkus_List", + "description": "Gets the list of Microsoft.CognitiveServices SKUs available for your Subscription.", + "x-ms-examples": { + "Regenerate Keys": { + "$ref": "./examples/GetSkus.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceSkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/skus": { + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "List available SKUs for the requested Cognitive Services account", + "x-ms-examples": { + "List SKUs": { + "$ref": "./examples/ListSkus.json" + } + }, + "operationId": "Accounts_ListSkus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. The only GET specific properties are \"name,\" \"type\" and \"id.\"\nField\tDescription\nsku\tRequired, object\n\tThe exact set of keys that define this sku. This matches the fields on the respective resource.\nsku.name\tRequired, string\n\tThe name of the SKU. This is typically a letter + number code, such as A0 or P3\nsku.tier\tRequired, string\n\tThe tier of this particular SKU. Typically one of:\n\t· Free\n\t· Basic\n\t· Standard\n\t· Premium\n", + "schema": { + "$ref": "#/definitions/AccountSkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/usages": { + "get": { + "tags": [ + "Usages" + ], + "description": "Get usages for the requested subscription", + "x-ms-examples": { + "Get Usages": { + "$ref": "./examples/ListUsages.json" + } + }, + "operationId": "Usages_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/usageFilterParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/usages": { + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Get usages for the requested Cognitive Services account", + "x-ms-examples": { + "Get Usages": { + "$ref": "./examples/GetUsages.json" + } + }, + "operationId": "Accounts_ListUsages", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/usageFilterParameter" + } + ], + "responses": { + "200": { + "description": "The usages for Cognitive Services account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/models": { + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "List available Models for the requested Cognitive Services account", + "x-ms-examples": { + "List AccountModels": { + "$ref": "./examples/ListAccountModels.json" + } + }, + "operationId": "Accounts_ListModels", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. The only GET specific properties are \"name,\" \"type\" and \"id.\"\nField\tDescription\nsku\tRequired, object\n\tThe exact set of keys that define this sku. This matches the fields on the respective resource.\nsku.name\tRequired, string\n\tThe name of the SKU. This is typically a letter + number code, such as A0 or P3\nsku.tier\tRequired, string\n\tThe tier of this particular SKU. Typically one of:\n\t· Free\n\t· Basic\n\t· Standard\n\t· Premium\n", + "schema": { + "$ref": "#/definitions/AccountModelListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.CognitiveServices/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all the available Cognitive Services account operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "Get Operations": { + "$ref": "./examples/GetOperations.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/checkSkuAvailability": { + "post": { + "tags": [ + "CognitiveServicesAccounts" + ], + "operationId": "CheckSkuAvailability", + "description": "Check available SKUs.", + "x-ms-examples": { + "Check SKU Availability": { + "$ref": "./examples/CheckSkuAvailability.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CheckSkuAvailabilityParameter" + }, + "description": "Check SKU Availability POST body." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SkuAvailabilityListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/commitmentTiers": { + "get": { + "tags": [ + "CommitmentTiers" + ], + "operationId": "CommitmentTiers_List", + "description": "List Commitment Tiers.", + "x-ms-examples": { + "ListCommitmentTiers": { + "$ref": "./examples/ListCommitmentTiers.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/locationParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/CommitmentTierListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/models": { + "get": { + "tags": [ + "Models" + ], + "operationId": "Models_List", + "description": "List Models.", + "x-ms-examples": { + "ListLocationModels": { + "$ref": "./examples/ListLocationModels.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/locationParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/ModelListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/modelCapacities": { + "get": { + "tags": [ + "ModelCapacities" + ], + "operationId": "LocationBasedModelCapacities_List", + "description": "List Location Based ModelCapacities.", + "x-ms-examples": { + "ListLocationBasedModelCapacities": { + "$ref": "./examples/ListLocationBasedModelCapacities.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/modelFormatFilterParameter" + }, + { + "$ref": "#/parameters/modelNameFilterParameter" + }, + { + "$ref": "#/parameters/modelVersionFilterParameter" + } + ], + "responses": { + "200": { + "description": "OK. Successfully retrieved modelCapacities by location.", + "schema": { + "$ref": "#/definitions/ModelCapacityListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/modelCapacities": { + "get": { + "tags": [ + "ModelCapacities" + ], + "operationId": "ModelCapacities_List", + "description": "List ModelCapacities.", + "x-ms-examples": { + "ListModelCapacities": { + "$ref": "./examples/ListModelCapacities.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/modelFormatFilterParameter" + }, + { + "$ref": "#/parameters/modelNameFilterParameter" + }, + { + "$ref": "#/parameters/modelVersionFilterParameter" + } + ], + "responses": { + "200": { + "description": "OK. Successfully retrieved modelCapacities.", + "schema": { + "$ref": "#/definitions/ModelCapacityListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/checkDomainAvailability": { + "post": { + "tags": [ + "CognitiveServicesAccounts" + ], + "operationId": "CheckDomainAvailability", + "description": "Check whether a domain is available.", + "x-ms-examples": { + "Check SKU Availability": { + "$ref": "./examples/CheckDomainAvailability.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CheckDomainAvailabilityParameter" + }, + "description": "Check Domain Availability parameter." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DomainAvailability" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/calculateModelCapacity": { + "post": { + "tags": [ + "CognitiveServicesAccounts" + ], + "operationId": "calculateModelCapacity", + "description": "Model capacity calculator.", + "x-ms-examples": { + "Calculate Model Capacity": { + "$ref": "./examples/CalculateModelCapacity.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CalculateModelCapacityParameter" + }, + "description": "Check Domain Availability parameter." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/CalculateModelCapacityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "description": "Gets the private endpoint connections associated with the Cognitive Services account.", + "x-ms-examples": { + "GetPrivateEndpointConnection": { + "$ref": "./examples/ListPrivateEndpointConnections.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private endpoint connections.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection associated with the Cognitive Services account.", + "x-ms-examples": { + "GetPrivateEndpointConnection": { + "$ref": "./examples/GetPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/privateEndpointConnectionNameParameter" + } + ], + "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": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "description": "Update the state of specified private endpoint connection associated with the Cognitive Services account.", + "x-ms-examples": { + "PutPrivateEndpointConnection": { + "$ref": "./examples/PutPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/privateEndpointConnectionNameParameter" + }, + { + "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" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "description": "Deletes the specified private endpoint connection associated with the Cognitive Services account.", + "x-ms-examples": { + "DeletePrivateEndpointConnection": { + "$ref": "./examples/DeletePrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/privateEndpointConnectionNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the private endpoint connection successfully." + }, + "202": { + "description": "Accepted -- the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_List", + "description": "Gets the private link resources that need to be created for a Cognitive Services account.", + "x-ms-examples": { + "ListPrivateLinkResources": { + "$ref": "./examples/ListPrivateLinkResources.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments": { + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_List", + "description": "Gets the deployments associated with the Cognitive Services account.", + "x-ms-examples": { + "ListDeployments": { + "$ref": "./examples/ListDeployments.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved deployments.", + "schema": { + "$ref": "#/definitions/DeploymentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}": { + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Get", + "description": "Gets the specified deployments associated with the Cognitive Services account.", + "x-ms-examples": { + "GetDeployment": { + "$ref": "./examples/GetDeployment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/deploymentNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the deployments properties successfully.", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CreateOrUpdate", + "description": "Update the state of specified deployments associated with the Cognitive Services account.", + "x-ms-examples": { + "PutDeployment": { + "$ref": "./examples/PutDeployment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/deploymentNameParameter" + }, + { + "name": "deployment", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + }, + "description": "The deployment properties." + } + ], + "responses": { + "200": { + "description": "Create/Update the deployment successfully.", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "201": { + "description": "Create the deployment successfully.", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Update", + "description": "Update specified deployments associated with the Cognitive Services account.", + "x-ms-examples": { + "UpdateDeployment": { + "$ref": "./examples/UpdateDeployment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/deploymentNameParameter" + }, + { + "name": "deployment", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PatchResourceTagsAndSku" + }, + "description": "The deployment properties." + } + ], + "responses": { + "200": { + "description": "Updated the deployment successfully.", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "202": { + "headers": { + "location": { + "type": "string" + } + }, + "description": "If resource is updated successfully, the service should return 201 (OK)." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "delete": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Delete", + "description": "Deletes the specified deployment associated with the Cognitive Services account.", + "x-ms-examples": { + "DeleteDeployment": { + "$ref": "./examples/DeleteDeployment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/deploymentNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the deployment successfully." + }, + "202": { + "description": "Accepted -- the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "No Content -- The deployment does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}/skus": { + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_ListSkus", + "description": "Lists the specified deployments skus associated with the Cognitive Services account.", + "x-ms-examples": { + "ListDeploymentSkus": { + "$ref": "./examples/ListDeploymentSkus.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/deploymentNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- List the deployments skus successfully.", + "schema": { + "$ref": "#/definitions/DeploymentSkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/commitmentPlans": { + "get": { + "tags": [ + "CommitmentPlans" + ], + "operationId": "CommitmentPlans_List", + "description": "Gets the commitmentPlans associated with the Cognitive Services account.", + "x-ms-examples": { + "ListCommitmentPlans": { + "$ref": "./examples/ListCommitmentPlans.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved commitmentPlans.", + "schema": { + "$ref": "#/definitions/CommitmentPlanListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/commitmentPlans/{commitmentPlanName}": { + "get": { + "tags": [ + "CommitmentPlans" + ], + "operationId": "CommitmentPlans_Get", + "description": "Gets the specified commitmentPlans associated with the Cognitive Services account.", + "x-ms-examples": { + "GetCommitmentPlan": { + "$ref": "./examples/GetCommitmentPlan.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/commitmentPlanNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the commitmentPlans properties successfully.", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "CommitmentPlans" + ], + "operationId": "CommitmentPlans_CreateOrUpdate", + "description": "Update the state of specified commitmentPlans associated with the Cognitive Services account.", + "x-ms-examples": { + "PutCommitmentPlan": { + "$ref": "./examples/PutCommitmentPlan.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/commitmentPlanNameParameter" + }, + { + "name": "commitmentPlan", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CommitmentPlan" + }, + "description": "The commitmentPlan properties." + } + ], + "responses": { + "200": { + "description": "Create/Update the CommitmentPlan successfully.", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "201": { + "description": "Create the CommitmentPlan successfully.", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "CommitmentPlans" + ], + "operationId": "CommitmentPlans_Delete", + "description": "Deletes the specified commitmentPlan associated with the Cognitive Services account.", + "x-ms-examples": { + "DeleteCommitmentPlan": { + "$ref": "./examples/DeleteCommitmentPlan.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/commitmentPlanNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the commitmentPlan successfully." + }, + "202": { + "description": "Accepted -- the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "No Content -- The commitmentPlan does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/encryptionScopes": { + "get": { + "tags": [ + "EncryptionScopes" + ], + "operationId": "EncryptionScopes_List", + "description": "Gets the content filters associated with the Azure OpenAI account.", + "x-ms-examples": { + "ListEncryptionScopes": { + "$ref": "./examples/ListEncryptionScopes.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved Content Filters.", + "schema": { + "$ref": "#/definitions/EncryptionScopeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/encryptionScopes/{encryptionScopeName}": { + "get": { + "tags": [ + "EncryptionScopes" + ], + "operationId": "EncryptionScopes_Get", + "description": "Gets the specified EncryptionScope associated with the Cognitive Services account.", + "x-ms-examples": { + "GetEncryptionScope": { + "$ref": "./examples/GetEncryptionScope.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/encryptionScopeNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the EncryptionScopes properties successfully.", + "schema": { + "$ref": "#/definitions/EncryptionScope" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "EncryptionScopes" + ], + "operationId": "EncryptionScopes_CreateOrUpdate", + "description": "Update the state of specified encryptionScope associated with the Cognitive Services account.", + "x-ms-examples": { + "PutEncryptionScope": { + "$ref": "./examples/PutEncryptionScope.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/encryptionScopeNameParameter" + }, + { + "name": "encryptionScope", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EncryptionScope" + }, + "description": "The encryptionScope properties." + } + ], + "responses": { + "200": { + "description": "Create/Update the EncryptionScope successfully.", + "schema": { + "$ref": "#/definitions/EncryptionScope" + } + }, + "201": { + "description": "Create the EncryptionScope successfully.", + "schema": { + "$ref": "#/definitions/EncryptionScope" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "EncryptionScopes" + ], + "operationId": "EncryptionScopes_Delete", + "description": "Deletes the specified encryptionScope associated with the Cognitive Services account.", + "x-ms-examples": { + "DeleteEncryptionScope": { + "$ref": "./examples/DeleteEncryptionScope.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/encryptionScopeNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- the operation was successfully started and will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content -- The Content Filters does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiPolicies": { + "get": { + "tags": [ + "RaiPolicies" + ], + "operationId": "RaiPolicies_List", + "description": "Gets the content filters associated with the Azure OpenAI account.", + "x-ms-examples": { + "ListRaiPolicies": { + "$ref": "./examples/ListRaiPolicies.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved Content Filters.", + "schema": { + "$ref": "#/definitions/RaiPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists": { + "get": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklists_List", + "description": "Gets the custom blocklists associated with the Azure OpenAI account.", + "x-ms-examples": { + "ListBlocklists": { + "$ref": "./examples/ListBlocklists.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved blocklists.", + "schema": { + "$ref": "#/definitions/RaiBlockListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}/raiBlocklistItems": { + "get": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklistItems_List", + "description": "Gets the blocklist items associated with the custom blocklist.", + "x-ms-examples": { + "ListBlocklistItems": { + "$ref": "./examples/ListBlocklistItems.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved blocklist items.", + "schema": { + "$ref": "#/definitions/RaiBlockListItemsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiPolicies/{raiPolicyName}": { + "get": { + "tags": [ + "RaiPolicies" + ], + "operationId": "RaiPolicies_Get", + "description": "Gets the specified Content Filters associated with the Azure OpenAI account.", + "x-ms-examples": { + "GetRaiPolicy": { + "$ref": "./examples/GetRaiPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiPolicyNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the Content Filters successfully.", + "schema": { + "$ref": "#/definitions/RaiPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "RaiPolicies" + ], + "operationId": "RaiPolicies_CreateOrUpdate", + "description": "Update the state of specified Content Filters associated with the Azure OpenAI account.", + "x-ms-examples": { + "PutRaiPolicy": { + "$ref": "./examples/PutRaiPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiPolicyNameParameter" + }, + { + "name": "raiPolicy", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RaiPolicy" + }, + "description": "Properties describing the Content Filters." + } + ], + "responses": { + "200": { + "description": "Create/Update the Content Filters successfully.", + "schema": { + "$ref": "#/definitions/RaiPolicy" + } + }, + "201": { + "description": "Create the Content Filters successfully.", + "schema": { + "$ref": "#/definitions/RaiPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "RaiPolicies" + ], + "operationId": "RaiPolicies_Delete", + "description": "Deletes the specified Content Filters associated with the Azure OpenAI account.", + "x-ms-examples": { + "DeleteRaiPolicy": { + "$ref": "./examples/DeleteRaiPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiPolicyNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- the operation was successfully started and will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content -- The Content Filters does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}": { + "get": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklists_Get", + "description": "Gets the specified custom blocklist associated with the Azure OpenAI account.", + "x-ms-examples": { + "GetRaiBlocklist": { + "$ref": "./examples/GetRaiBlocklist.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the custom blocklist successfully.", + "schema": { + "$ref": "#/definitions/RaiBlocklist" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklists_CreateOrUpdate", + "description": "Update the state of specified blocklist associated with the Azure OpenAI account.", + "x-ms-examples": { + "PutRaiBlocklist": { + "$ref": "./examples/PutRaiBlocklist.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + }, + { + "name": "raiBlocklist", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RaiBlocklist" + }, + "description": "Properties describing the custom blocklist." + } + ], + "responses": { + "200": { + "description": "Created/updated the custom blocklist successfully.", + "schema": { + "$ref": "#/definitions/RaiBlocklist" + } + }, + "201": { + "description": "Created/updated the custom blocklist successfully.", + "schema": { + "$ref": "#/definitions/RaiBlocklist" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklists_Delete", + "description": "Deletes the specified custom blocklist associated with the Azure OpenAI account.", + "x-ms-examples": { + "DeleteRaiBlocklist": { + "$ref": "./examples/DeleteRaiBlocklist.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- the operation was successfully started and will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content -- The Content Filters does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}/raiBlocklistItems/{raiBlocklistItemName}": { + "get": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklistItems_Get", + "description": "Gets the specified custom blocklist Item associated with the custom blocklist.", + "x-ms-examples": { + "GetRaiBlocklistItem": { + "$ref": "./examples/GetRaiBlocklistItem.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + }, + { + "$ref": "#/parameters/raiBlocklistItemNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the custom blocklist Item successfully.", + "schema": { + "$ref": "#/definitions/RaiBlocklistItem" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklistItems_CreateOrUpdate", + "description": "Update the state of specified blocklist item associated with the Azure OpenAI account.", + "x-ms-examples": { + "PutRaiBlocklistItem": { + "$ref": "./examples/PutRaiBlocklistItem.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + }, + { + "$ref": "#/parameters/raiBlocklistItemNameParameter" + }, + { + "name": "raiBlocklistItem", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RaiBlocklistItem" + }, + "description": "Properties describing the custom blocklist." + } + ], + "responses": { + "200": { + "description": "Created/updated the blocklist Item successfully.", + "schema": { + "$ref": "#/definitions/RaiBlocklistItem" + } + }, + "201": { + "description": "Created/updated the blocklist Item successfully.", + "schema": { + "$ref": "#/definitions/RaiBlocklistItem" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklistItems_Delete", + "description": "Deletes the specified blocklist Item associated with the custom blocklist.", + "x-ms-examples": { + "DeleteRaiBlocklistItem": { + "$ref": "./examples/DeleteRaiBlocklistItem.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + }, + { + "$ref": "#/parameters/raiBlocklistItemNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- the operation was successfully started and will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content -- The blocklist item does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}/addRaiBlocklistItems": { + "post": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklistItems_BatchAdd", + "description": "Batch operation to add blocklist items.", + "x-ms-examples": { + "AddRaiBlocklistItems": { + "$ref": "./examples/AddRaiBlocklistItems.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + }, + { + "name": "raiBlocklistItems", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RaiBlocklistItemsBulkAddRequest" + }, + "description": "Properties describing the custom blocklist items." + } + ], + "responses": { + "200": { + "description": "Added the blocklist Items successfully.", + "schema": { + "$ref": "#/definitions/RaiBlocklist" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}/deleteRaiBlocklistItems": { + "post": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklistItems_BatchDelete", + "description": "Batch operation to delete blocklist items.", + "x-ms-examples": { + "DeleteRaiBlocklistItems": { + "$ref": "./examples/DeleteRaiBlocklistItems.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + }, + { + "name": "raiBlocklistItemsNames", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RaiBlocklistItemsBulkDeleteRequest" + }, + "description": "List of RAI Blocklist Items Names." + } + ], + "responses": { + "204": { + "description": "Added the blocklist Items successfully." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/raiContentFilters": { + "get": { + "tags": [ + "RaiContentFilters" + ], + "operationId": "RaiContentFilters_List", + "description": "List Content Filters types.", + "x-ms-examples": { + "ListRaiContentFilters": { + "$ref": "./examples/ListRaiContentFilters.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/locationParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/RaiContentFilterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/raiContentFilters/{filterName}": { + "get": { + "tags": [ + "RaiContentFilters" + ], + "operationId": "RaiContentFilters_Get", + "description": "Get Content Filters by Name.", + "x-ms-examples": { + "GetRaiContentFilters": { + "$ref": "./examples/GetRaiContentFilter.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/raiContentFilterNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. Get the RAI content filter successfully.", + "schema": { + "$ref": "#/definitions/RaiContentFilter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans/{commitmentPlanName}": { + "put": { + "tags": [ + "CognitiveServicesCommitmentPlans" + ], + "description": "Create Cognitive Services commitment plan.", + "operationId": "CommitmentPlans_CreateOrUpdatePlan", + "x-ms-examples": { + "Create Commitment Plan": { + "$ref": "./examples/CreateSharedCommitmentPlan.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/commitmentPlanResourceNameParameter" + }, + { + "name": "commitmentPlan", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CommitmentPlan" + }, + "description": "The parameters to provide for the created commitment plan." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is created successfully or already existed, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "201": { + "description": "If resource is created successfully, the service should return 201 (OK).", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "CognitiveServicesCommitmentPlans" + ], + "description": "Create Cognitive Services commitment plan.", + "operationId": "CommitmentPlans_UpdatePlan", + "x-ms-examples": { + "Create Commitment Plan": { + "$ref": "./examples/UpdateSharedCommitmentPlan.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/commitmentPlanResourceNameParameter" + }, + { + "name": "commitmentPlan", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PatchResourceTagsAndSku" + }, + "description": "The parameters to provide for the created commitment plan." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is updated successfully or already existed, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "202": { + "headers": { + "location": { + "type": "string" + } + }, + "description": "If resource is updated successfully, the service should return 201 (OK)." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "delete": { + "tags": [ + "CognitiveServicesCommitmentPlans" + ], + "description": "Deletes a Cognitive Services commitment plan from the resource group. ", + "operationId": "CommitmentPlans_DeletePlan", + "x-ms-examples": { + "Delete Commitment Plan": { + "$ref": "./examples/DeleteSharedCommitmentPlan.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/commitmentPlanResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;" + }, + "202": { + "headers": { + "location": { + "type": "string" + } + }, + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, + "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": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "CognitiveServicesCommitmentPlans" + ], + "description": "Returns a Cognitive Services commitment plan specified by the parameters.", + "operationId": "CommitmentPlans_GetPlan", + "x-ms-examples": { + "Get Commitment Plan": { + "$ref": "./examples/GetSharedCommitmentPlan.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/commitmentPlanResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved commitment plan resources.", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans": { + "get": { + "tags": [ + "CognitiveServicesCommitmentPlans" + ], + "description": "Returns all the resources of a particular type belonging to a resource group", + "operationId": "CommitmentPlans_ListPlansByResourceGroup", + "x-ms-examples": { + "List Commitment Plans by Resource Group": { + "$ref": "./examples/ListSharedCommitmentPlansByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved commitment plan resources.", + "schema": { + "$ref": "#/definitions/CommitmentPlanListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/commitmentPlans": { + "get": { + "tags": [ + "CognitiveServicesCommitmentPlans" + ], + "description": "Returns all the resources of a particular type belonging to a subscription.", + "operationId": "CommitmentPlans_ListPlansBySubscription", + "x-ms-examples": { + "List Accounts by Subscription": { + "$ref": "./examples/ListSharedCommitmentPlansBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved commitment plan resources.", + "schema": { + "$ref": "#/definitions/CommitmentPlanListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans/{commitmentPlanName}/accountAssociations": { + "get": { + "tags": [ + "CommitmentPlans" + ], + "operationId": "CommitmentPlans_ListAssociations", + "description": "Gets the associations of the Cognitive Services commitment plan.", + "x-ms-examples": { + "ListCommitmentPlans": { + "$ref": "./examples/ListSharedCommitmentPlanAssociations.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/commitmentPlanResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved Commitment Plan Associations.", + "schema": { + "$ref": "#/definitions/CommitmentPlanAccountAssociationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans/{commitmentPlanName}/accountAssociations/{commitmentPlanAssociationName}": { + "get": { + "tags": [ + "CommitmentPlans" + ], + "operationId": "CommitmentPlans_GetAssociation", + "description": "Gets the association of the Cognitive Services commitment plan.", + "x-ms-examples": { + "GetCommitmentPlan": { + "$ref": "./examples/GetSharedCommitmentPlanAssociation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/commitmentPlanResourceNameParameter" + }, + { + "$ref": "#/parameters/commitmentPlanAssociationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the Commitment Plan Association successfully.", + "schema": { + "$ref": "#/definitions/CommitmentPlanAccountAssociation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "CommitmentPlans" + ], + "operationId": "CommitmentPlans_CreateOrUpdateAssociation", + "description": "Create or update the association of the Cognitive Services commitment plan.", + "x-ms-examples": { + "PutCommitmentPlan": { + "$ref": "./examples/CreateSharedCommitmentPlanAssociation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/commitmentPlanResourceNameParameter" + }, + { + "$ref": "#/parameters/commitmentPlanAssociationNameParameter" + }, + { + "name": "association", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CommitmentPlanAccountAssociation" + }, + "description": "The commitmentPlan properties." + } + ], + "responses": { + "200": { + "description": "Create/Update the Commitment Plan Association successfully.", + "schema": { + "$ref": "#/definitions/CommitmentPlanAccountAssociation" + } + }, + "201": { + "description": "Create the Commitment Plan Association successfully.", + "schema": { + "$ref": "#/definitions/CommitmentPlanAccountAssociation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "CommitmentPlans" + ], + "operationId": "CommitmentPlans_DeleteAssociation", + "description": "Deletes the association of the Cognitive Services commitment plan.", + "x-ms-examples": { + "DeleteCommitmentPlan": { + "$ref": "./examples/DeleteSharedCommitmentPlanAssociation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/commitmentPlanResourceNameParameter" + }, + { + "$ref": "#/parameters/commitmentPlanAssociationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the CommitmentPlanAssociation successfully." + }, + "202": { + "headers": { + "location": { + "type": "string" + } + }, + "description": "Accepted -- the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "No Content -- The Commitment Plan Association does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/networkSecurityPerimeterConfigurations": { + "get": { + "tags": [ + "NetworkSecurityPerimeterConfigurations" + ], + "operationId": "NetworkSecurityPerimeterConfigurations_List", + "description": "Gets a list of NSP configurations for an account.", + "x-ms-examples": { + "ListNetworkSecurityPerimeterConfigurations": { + "$ref": "./examples/ListNetworkSecurityPerimeterConfigurations.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of configs.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/networkSecurityPerimeterConfigurations/{nspConfigurationName}": { + "get": { + "tags": [ + "NetworkSecurityPerimeterConfigurations" + ], + "operationId": "NetworkSecurityPerimeterConfigurations_Get", + "description": "Gets the specified NSP configurations for an account.", + "x-ms-examples": { + "GetNetworkSecurityPerimeterConfigurations": { + "$ref": "./examples/GetNetworkSecurityPerimeterConfigurations.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/nspConfigurationNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the config.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/networkSecurityPerimeterConfigurations/{nspConfigurationName}/reconcile": { + "post": { + "tags": [ + "NetworkSecurityPerimeterConfigurations" + ], + "operationId": "NetworkSecurityPerimeterConfigurations_Reconcile", + "description": "Reconcile the NSP configuration for an account.", + "x-ms-examples": { + "ReconcileNetworkSecurityPerimeterConfigurations": { + "$ref": "./examples/ReconcileNetworkSecurityPerimeterConfigurations.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/nspConfigurationNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully Reconciled the NSP configuration.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfiguration" + } + }, + "202": { + "headers": { + "location": { + "type": "string" + } + }, + "description": "Request to reconcile the NSP configuration accepted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/defenderForAISettings": { + "get": { + "tags": [ + "DefenderForAISettings" + ], + "operationId": "DefenderForAISettings_List", + "description": "Lists the Defender for AI settings.", + "x-ms-examples": { + "ListDefenderForAISetting": { + "$ref": "./examples/ListDefenderForAISetting.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- List the defender setting name successfully.", + "schema": { + "$ref": "#/definitions/DefenderForAISettingResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/defenderForAISettings/{defenderForAISettingName}": { + "get": { + "tags": [ + "DefenderForAISettings" + ], + "operationId": "DefenderForAISettings_Get", + "description": "Gets the specified Defender for AI setting by name.", + "x-ms-examples": { + "GetDefenderForAISetting": { + "$ref": "./examples/GetDefenderForAISetting.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/defenderForAISettingNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the defender setting name successfully.", + "schema": { + "$ref": "#/definitions/DefenderForAISetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "DefenderForAISettings" + ], + "operationId": "DefenderForAISettings_CreateOrUpdate", + "description": "Creates or Updates the specified Defender for AI setting.", + "x-ms-examples": { + "PutDefenderForAISetting": { + "$ref": "./examples/PutDefenderForAISetting.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/defenderForAISettingNameParameter" + }, + { + "name": "defenderForAISettings", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DefenderForAISetting" + }, + "description": "Properties describing the Defender for AI setting." + } + ], + "responses": { + "200": { + "description": "Created/updated the Defender for AI setting successfully.", + "schema": { + "$ref": "#/definitions/DefenderForAISetting" + } + }, + "201": { + "description": "Created the Defender for AI setting successfully.", + "schema": { + "$ref": "#/definitions/DefenderForAISetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "DefenderForAISettings" + ], + "operationId": "DefenderForAISettings_Update", + "description": "Updates the specified Defender for AI setting.", + "x-ms-examples": { + "UpdateDefenderForAISetting": { + "$ref": "./examples/UpdateDefenderForAISetting.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/defenderForAISettingNameParameter" + }, + { + "name": "defenderForAISettings", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DefenderForAISetting" + }, + "description": "Properties describing the Defender for AI setting." + } + ], + "responses": { + "200": { + "description": "Updated the Defender for AI setting successfully.", + "schema": { + "$ref": "#/definitions/DefenderForAISetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Kind": { + "type": "string", + "description": "The kind (type) of cognitive service account." + }, + "Sku": { + "description": "The resource model definition representing SKU", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU. Ex - P3. It is typically a letter+number code" + }, + "tier": { + "type": "string", + "enum": [ + "Free", + "Basic", + "Standard", + "Premium", + "Enterprise" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + }, + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT." + }, + "size": { + "type": "string", + "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. " + }, + "family": { + "type": "string", + "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here." + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted." + } + }, + "required": [ + "name" + ] + }, + "SkuName": { + "type": "string", + "description": "The name of SKU." + }, + "Account": { + "description": "Cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU.", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/Kind", + "description": "The Kind of the resource." + }, + "sku": { + "$ref": "#/definitions/Sku" + }, + "identity": { + "$ref": "#/definitions/Identity" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "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 geo-location where the resource lives" + }, + "properties": { + "$ref": "#/definitions/AccountProperties", + "description": "Properties of Cognitive Services account." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/AzureEntityResource" + } + ] + }, + "AccountListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of accounts.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Account" + }, + "description": "Gets the list of Cognitive Services accounts and their properties." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "AccountProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the cognitive services account at the time the operation was called.", + "enum": [ + "Accepted", + "Creating", + "Deleting", + "Moving", + "Failed", + "Succeeded", + "ResolvingDNS" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "endpoint": { + "type": "string", + "description": "Endpoint of the created account.", + "readOnly": true + }, + "internalId": { + "type": "string", + "description": "The internal identifier (deprecated, do not use this property).", + "readOnly": true + }, + "capabilities": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SkuCapability" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Gets the capabilities of the cognitive services account. Each item indicates the capability of a specific feature. The values are read-only and for reference only." + }, + "isMigrated": { + "type": "boolean", + "description": "If the resource is migrated from an existing key.", + "readOnly": true + }, + "migrationToken": { + "type": "string", + "description": "Resource migration token." + }, + "skuChangeInfo": { + "$ref": "#/definitions/SkuChangeInfo", + "description": "Sku change info of account.", + "readOnly": true + }, + "customSubDomainName": { + "type": "string", + "description": "Optional subdomain name used for token-based authentication." + }, + "networkAcls": { + "$ref": "#/definitions/NetworkRuleSet", + "description": "A collection of rules governing the accessibility from specific network locations." + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "The encryption properties for this resource." + }, + "userOwnedStorage": { + "type": "array", + "items": { + "$ref": "#/definitions/UserOwnedStorage" + }, + "x-ms-identifiers": [ + "resourceId" + ], + "description": "The storage accounts for this resource." + }, + "amlWorkspace": { + "$ref": "#/definitions/UserOwnedAmlWorkspace", + "description": "The user owned AML workspace properties." + }, + "privateEndpointConnections": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The private endpoint connection associated with the Cognitive Services account." + }, + "publicNetworkAccess": { + "type": "string", + "description": "Whether or not public endpoint access is allowed for this account.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "apiProperties": { + "$ref": "#/definitions/ApiProperties", + "description": "The api properties for special APIs." + }, + "dateCreated": { + "readOnly": true, + "type": "string", + "description": "Gets the date of cognitive services account creation." + }, + "callRateLimit": { + "readOnly": true, + "$ref": "#/definitions/CallRateLimit" + }, + "dynamicThrottlingEnabled": { + "type": "boolean", + "description": "The flag to enable dynamic throttling." + }, + "quotaLimit": { + "readOnly": true, + "$ref": "#/definitions/QuotaLimit" + }, + "restrictOutboundNetworkAccess": { + "type": "boolean" + }, + "allowedFqdnList": { + "type": "array", + "items": { + "type": "string" + } + }, + "disableLocalAuth": { + "type": "boolean" + }, + "endpoints": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "restore": { + "type": "boolean", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "deletionDate": { + "type": "string", + "description": "The deletion date, only available for deleted account.", + "readOnly": true + }, + "scheduledPurgeDate": { + "type": "string", + "description": "The scheduled purge date, only available for deleted account.", + "readOnly": true + }, + "locations": { + "$ref": "#/definitions/MultiRegionSettings", + "description": "The multiregion settings of Cognitive Services account." + }, + "commitmentPlanAssociations": { + "type": "array", + "items": { + "$ref": "#/definitions/CommitmentPlanAssociation" + }, + "x-ms-identifiers": [ + "commitmentPlanId" + ], + "description": "The commitment plan associations of Cognitive Services account.", + "readOnly": true + }, + "abusePenalty": { + "readOnly": true, + "$ref": "#/definitions/AbusePenalty" + }, + "raiMonitorConfig": { + "$ref": "#/definitions/RaiMonitorConfig" + } + }, + "description": "Properties of Cognitive Services account." + }, + "ApiProperties": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "properties": { + "qnaRuntimeEndpoint": { + "type": "string", + "description": "(QnAMaker Only) The runtime endpoint of QnAMaker." + }, + "qnaAzureSearchEndpointKey": { + "type": "string", + "description": "(QnAMaker Only) The Azure Search endpoint key of QnAMaker." + }, + "qnaAzureSearchEndpointId": { + "type": "string", + "description": "(QnAMaker Only) The Azure Search endpoint id of QnAMaker." + }, + "statisticsEnabled": { + "type": "boolean", + "description": "(Bing Search Only) The flag to enable statistics of Bing Search." + }, + "eventHubConnectionString": { + "type": "string", + "description": "(Personalization Only) The flag to enable statistics of Bing Search.", + "pattern": "^( *)Endpoint=sb://(.*);( *)SharedAccessKeyName=(.*);( *)SharedAccessKey=(.*)$", + "maxLength": 1000 + }, + "storageAccountConnectionString": { + "type": "string", + "description": "(Personalization Only) The storage account connection string.", + "pattern": "^(( *)DefaultEndpointsProtocol=(http|https)( *);( *))?AccountName=(.*)AccountKey=(.*)EndpointSuffix=(.*)$", + "maxLength": 1000 + }, + "aadClientId": { + "type": "string", + "description": "(Metrics Advisor Only) The Azure AD Client Id (Application Id).", + "maxLength": 500 + }, + "aadTenantId": { + "type": "string", + "description": "(Metrics Advisor Only) The Azure AD Tenant Id.", + "maxLength": 500 + }, + "superUser": { + "type": "string", + "description": "(Metrics Advisor Only) The super user of Metrics Advisor.", + "maxLength": 500 + }, + "websiteName": { + "type": "string", + "description": "(Metrics Advisor Only) The website name of Metrics Advisor.", + "maxLength": 500 + } + }, + "description": "The api properties for special APIs." + }, + "CommitmentPlanAccountAssociationListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Commitment Plan Account Association.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/CommitmentPlanAccountAssociation" + }, + "x-ms-identifiers": [ + "id" + ], + "description": "Gets the list of Cognitive Services Commitment Plan Account Association and their properties." + } + }, + "description": "The list of cognitive services Commitment Plan Account Association operation response." + }, + "CommitmentPlanAccountAssociation": { + "description": "The commitment plan association.", + "type": "object", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CommitmentPlanAccountAssociationProperties", + "description": "Properties of Cognitive Services account commitment plan association." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "AbusePenalty": { + "description": "The abuse penalty.", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "Throttle", + "Block" + ], + "x-ms-enum": { + "name": "AbusePenaltyAction", + "modelAsString": true + }, + "description": "The action of AbusePenalty." + }, + "rateLimitPercentage": { + "type": "number", + "description": "The percentage of rate limit." + }, + "expiration": { + "type": "string", + "format": "date-time", + "description": "The datetime of expiration of the AbusePenalty." + } + } + }, + "CommitmentPlanAccountAssociationProperties": { + "type": "object", + "properties": { + "accountId": { + "type": "string", + "description": "The Azure resource id of the account." + } + }, + "description": "The commitment plan account association properties." + }, + "CommitmentPlanAssociation": { + "type": "object", + "properties": { + "commitmentPlanId": { + "type": "string", + "description": "The Azure resource id of the commitment plan." + }, + "commitmentPlanLocation": { + "type": "string", + "description": "The location of of the commitment plan." + } + }, + "description": "The commitment plan association." + }, + "MultiRegionSettings": { + "type": "object", + "properties": { + "routingMethod": { + "type": "string", + "enum": [ + "Priority", + "Weighted", + "Performance" + ], + "x-ms-enum": { + "name": "RoutingMethods", + "modelAsString": true + }, + "description": "Multiregion routing methods." + }, + "regions": { + "type": "array", + "items": { + "$ref": "#/definitions/RegionSetting" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "description": "The multiregion settings Cognitive Services account." + }, + "RegionSetting": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the region." + }, + "value": { + "type": "number", + "description": "A value for priority or weighted routing methods." + }, + "customsubdomain": { + "type": "string", + "description": "Maps the region to the regional custom subdomain." + } + }, + "description": "The call rate limit Cognitive Services account." + }, + "CapacityConfig": { + "type": "object", + "properties": { + "minimum": { + "type": "integer", + "format": "int32", + "description": "The minimum capacity." + }, + "maximum": { + "type": "integer", + "format": "int32", + "description": "The maximum capacity." + }, + "step": { + "type": "integer", + "format": "int32", + "description": "The minimal incremental between allowed values for capacity." + }, + "default": { + "type": "integer", + "format": "int32", + "description": "The default capacity." + }, + "allowedValues": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "The array of allowed values for capacity." + } + }, + "description": "The capacity configuration." + }, + "CallRateLimit": { + "type": "object", + "properties": { + "count": { + "type": "number", + "description": "The count value of Call Rate Limit." + }, + "renewalPeriod": { + "type": "number", + "description": "The renewal period in seconds of Call Rate Limit." + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/ThrottlingRule" + }, + "x-ms-identifiers": [ + "key" + ] + } + }, + "description": "The call rate limit Cognitive Services account." + }, + "BillingMeterInfo": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "meterId": { + "type": "string" + }, + "unit": { + "type": "string" + } + } + }, + "DeploymentCapacitySettings": { + "type": "object", + "description": "Internal use only.", + "properties": { + "designatedCapacity": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The designated capacity." + }, + "priority": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The priority of this capacity setting." + } + } + }, + "QuotaLimit": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "renewalPeriod": { + "type": "number" + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/ThrottlingRule" + }, + "x-ms-identifiers": [ + "key" + ] + } + } + }, + "ThrottlingRule": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "renewalPeriod": { + "type": "number" + }, + "count": { + "type": "number" + }, + "minCount": { + "type": "number" + }, + "dynamicThrottlingEnabled": { + "type": "boolean" + }, + "matchPatterns": { + "type": "array", + "items": { + "$ref": "#/definitions/RequestMatchPattern" + }, + "x-ms-identifiers": [ + "path", + "method" + ] + } + } + }, + "RequestMatchPattern": { + "type": "object", + "properties": { + "path": { + "type": "string" + }, + "method": { + "type": "string" + } + } + }, + "ApiKeys": { + "type": "object", + "properties": { + "key1": { + "type": "string", + "description": "Gets the value of key 1." + }, + "key2": { + "type": "string", + "description": "Gets the value of key 2." + } + }, + "description": "The access keys for the cognitive services account." + }, + "SkuChangeInfo": { + "type": "object", + "properties": { + "countOfDowngrades": { + "type": "number", + "description": "Gets the count of downgrades." + }, + "countOfUpgradesAfterDowngrades": { + "type": "number", + "description": "Gets the count of upgrades after downgrades." + }, + "lastChangeDate": { + "type": "string", + "description": "Gets the last change date." + } + }, + "description": "Sku change info of account." + }, + "RegenerateKeyParameters": { + "type": "object", + "properties": { + "keyName": { + "type": "string", + "description": "key name to generate (Key1|Key2)", + "enum": [ + "Key1", + "Key2" + ], + "x-ms-enum": { + "name": "KeyName", + "modelAsString": false + } + } + }, + "required": [ + "keyName" + ], + "description": "Regenerate key parameters." + }, + "AccountSkuListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AccountSku" + }, + "x-ms-identifiers": [ + "sku/name", + "resourceType" + ], + "description": "Gets the list of Cognitive Services accounts and their properties." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "AccountSku": { + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "description": "Resource Namespace and Type" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU of Cognitive Services account." + } + }, + "description": "Cognitive Services resource type and SKU." + }, + "UsageListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Usages.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of usages for Cognitive Service account." + } + }, + "description": "The response to a list usage request." + }, + "Usage": { + "type": "object", + "properties": { + "unit": { + "description": "The unit of the metric.", + "$ref": "#/definitions/UnitType" + }, + "name": { + "$ref": "#/definitions/MetricName", + "description": "The name information for the metric." + }, + "quotaPeriod": { + "type": "string", + "description": "The quota period used to summarize the usage values." + }, + "limit": { + "type": "number", + "format": "double", + "description": "Maximum value for this metric." + }, + "currentValue": { + "type": "number", + "format": "double", + "description": "Current value for this metric." + }, + "nextResetTime": { + "type": "string", + "description": "Next reset time for current quota." + }, + "status": { + "type": "string", + "description": "Cognitive Services account quota usage status.", + "enum": [ + "Included", + "Blocked", + "InOverage", + "Unknown" + ], + "x-ms-enum": { + "name": "QuotaUsageStatus", + "modelAsString": true + } + } + }, + "description": "The usage data for a usage request." + }, + "MetricName": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The name of the metric." + }, + "localizedValue": { + "type": "string", + "description": "The friendly name of the metric." + } + }, + "description": "A metric name." + }, + "UnitType": { + "type": "string", + "description": "The unit of the metric.", + "enum": [ + "Count", + "Bytes", + "Seconds", + "Percent", + "CountPerSecond", + "BytesPerSecond", + "Milliseconds" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "UnitType" + } + }, + "CheckSkuAvailabilityParameter": { + "type": "object", + "description": "Check SKU availability parameter.", + "properties": { + "skus": { + "type": "array", + "items": { + "$ref": "#/definitions/SkuName" + }, + "description": "The SKU of the resource." + }, + "kind": { + "$ref": "#/definitions/Kind" + }, + "type": { + "type": "string", + "description": "The Type of the resource." + } + }, + "required": [ + "skus", + "kind", + "type" + ] + }, + "CalculateModelCapacityParameter": { + "type": "object", + "description": "Calculate Model Capacity parameter.", + "properties": { + "model": { + "$ref": "#/definitions/DeploymentModel" + }, + "skuName": { + "$ref": "#/definitions/SkuName" + }, + "workloads": { + "type": "array", + "items": { + "$ref": "#/definitions/ModelCapacityCalculatorWorkload" + }, + "x-ms-identifiers": [], + "description": "List of Model Capacity Calculator Workload." + } + } + }, + "ModelCapacityCalculatorWorkload": { + "type": "object", + "description": "Model Capacity Calculator Workload.", + "properties": { + "requestPerMinute": { + "type": "integer", + "format": "int64", + "description": "Request per minute." + }, + "requestParameters": { + "$ref": "#/definitions/ModelCapacityCalculatorWorkloadRequestParam" + } + } + }, + "ModelCapacityCalculatorWorkloadRequestParam": { + "type": "object", + "description": "Dictionary, Model Capacity Calculator Workload Parameters.", + "properties": { + "avgPromptTokens": { + "type": "integer", + "format": "int64", + "description": "Average prompt tokens." + }, + "avgGeneratedTokens": { + "type": "integer", + "format": "int64", + "description": "Average generated tokens." + } + } + }, + "CalculateModelCapacityResult": { + "type": "object", + "description": "Calculate Model Capacity result.", + "properties": { + "model": { + "$ref": "#/definitions/DeploymentModel" + }, + "skuName": { + "type": "string" + }, + "estimatedCapacity": { + "type": "object", + "description": "Model Estimated Capacity.", + "properties": { + "value": { + "type": "integer", + "format": "int32" + }, + "deployableValue": { + "type": "integer", + "format": "int32" + } + } + } + } + }, + "SkuAvailabilityListResult": { + "type": "object", + "description": "Check SKU availability result list.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SkuAvailability" + }, + "x-ms-identifiers": [ + "skuName", + "type", + "kind" + ], + "description": "Check SKU availability result list." + } + } + }, + "SkuAvailability": { + "type": "object", + "description": "SKU availability.", + "properties": { + "kind": { + "$ref": "#/definitions/Kind", + "description": "The Kind of the resource." + }, + "type": { + "type": "string", + "description": "The Type of the resource." + }, + "skuName": { + "$ref": "#/definitions/SkuName", + "description": "The SKU of Cognitive Services account." + }, + "skuAvailable": { + "type": "boolean", + "description": "Indicates the given SKU is available or not." + }, + "reason": { + "type": "string", + "description": "Reason why the SKU is not available." + }, + "message": { + "type": "string", + "description": "Additional error message." + } + } + }, + "SkuCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the SkuCapability." + }, + "value": { + "type": "string", + "description": "The value of the SkuCapability." + } + }, + "description": "SkuCapability indicates the capability of a certain feature." + }, + "CheckDomainAvailabilityParameter": { + "type": "object", + "description": "Check Domain availability parameter.", + "properties": { + "subdomainName": { + "type": "string", + "description": "The subdomain name to use." + }, + "type": { + "type": "string", + "description": "The Type of the resource." + }, + "kind": { + "$ref": "#/definitions/Kind", + "description": "The Kind of the resource." + } + }, + "required": [ + "subdomainName", + "type" + ] + }, + "DomainAvailability": { + "type": "object", + "description": "Domain availability.", + "properties": { + "isSubdomainAvailable": { + "type": "boolean", + "description": "Indicates the given SKU is available or not." + }, + "reason": { + "type": "string", + "description": "Reason why the SKU is not available." + }, + "subdomainName": { + "type": "string", + "description": "The subdomain name to use." + }, + "type": { + "type": "string", + "description": "The Type of the resource." + }, + "kind": { + "$ref": "#/definitions/Kind", + "description": "The Kind of the resource." + } + } + }, + "ResourceSkuRestrictions": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of restrictions.", + "enum": [ + "Location", + "Zone" + ], + "x-ms-enum": { + "name": "ResourceSkuRestrictionsType", + "modelAsString": false + } + }, + "values": { + "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." + }, + "restrictionInfo": { + "$ref": "#/definitions/ResourceSkuRestrictionInfo", + "description": "The information about the restriction where the SKU cannot be used." + }, + "reasonCode": { + "type": "string", + "description": "The reason for restriction.", + "enum": [ + "QuotaId", + "NotAvailableForSubscription" + ], + "x-ms-enum": { + "name": "ResourceSkuRestrictionsReasonCode", + "modelAsString": true + } + } + }, + "description": "Describes restrictions of a SKU." + }, + "ResourceSku": { + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "description": "The type of resource the SKU applies to." + }, + "name": { + "type": "string", + "description": "The name of SKU." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of Cognitive Services account." + }, + "kind": { + "type": "string", + "description": "The Kind of resources that are supported in this SKU." + }, + "locations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of locations that the SKU is available." + }, + "restrictions": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSkuRestrictions" + }, + "x-ms-identifiers": [], + "description": "The restrictions because of which SKU cannot be used. This is empty if there are no restrictions." + } + }, + "description": "Describes an available Cognitive Services SKU." + }, + "ResourceSkuRestrictionInfo": { + "type": "object", + "properties": { + "locations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Locations where the SKU is restricted" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of availability zones where the SKU is restricted." + } + } + }, + "ResourceSkuListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSku" + }, + "x-ms-identifiers": [ + "resourceType", + "name", + "kind" + ], + "description": "The list of skus available for the subscription." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Skus." + } + }, + "required": [ + "value" + ], + "description": "The Get Skus operation response." + }, + "NetworkRuleSet": { + "type": "object", + "properties": { + "defaultAction": { + "type": "string", + "description": "The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "NetworkRuleAction", + "modelAsString": true + } + }, + "bypass": { + "type": "string", + "description": "Setting for trusted services.", + "enum": [ + "None", + "AzureServices" + ], + "x-ms-enum": { + "name": "ByPassSelection", + "modelAsString": true + } + }, + "ipRules": { + "type": "array", + "items": { + "$ref": "#/definitions/IpRule" + }, + "x-ms-identifiers": [], + "description": "The list of IP address rules." + }, + "virtualNetworkRules": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + }, + "description": "The list of virtual network rules." + } + }, + "description": "A set of rules governing the network accessibility." + }, + "IpRule": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78)." + } + }, + "required": [ + "value" + ], + "description": "A rule governing the accessibility from a specific ip address or ip range." + }, + "VirtualNetworkRule": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'." + }, + "state": { + "type": "string", + "description": "Gets the state of virtual network rule." + }, + "ignoreMissingVnetServiceEndpoint": { + "type": "boolean", + "description": "Ignore missing vnet service endpoint or not." + } + }, + "required": [ + "id" + ], + "description": "A rule governing the accessibility from a specific virtual network." + }, + "Identity": { + "type": "object", + "description": "Identity for the resource.", + "properties": { + "type": { + "type": "string", + "description": "The identity type.", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of resource." + }, + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of resource identity." + }, + "userAssignedIdentities": { + "description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}", + "type": "object", + "additionalProperties": { + "description": "User-assigned managed identity.", + "$ref": "#/definitions/UserAssignedIdentity" + } + } + } + }, + "UserAssignedIdentity": { + "type": "object", + "description": "User-assigned managed identity.", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "Azure Active Directory principal ID associated with this Identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "Client App Id associated with this identity." + } + } + }, + "Encryption": { + "type": "object", + "properties": { + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Properties of KeyVault" + }, + "keySource": { + "type": "string", + "description": "Enumerates the possible value of keySource for Encryption", + "default": "Microsoft.KeyVault", + "enum": [ + "Microsoft.CognitiveServices", + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "keySource", + "modelAsString": true + } + } + }, + "description": "Properties to configure Encryption" + }, + "KeyVaultProperties": { + "type": "object", + "properties": { + "keyName": { + "type": "string", + "description": "Name of the Key from KeyVault" + }, + "keyVersion": { + "type": "string", + "description": "Version of the Key from KeyVault" + }, + "keyVaultUri": { + "type": "string", + "description": "Uri of KeyVault" + }, + "identityClientId": { + "type": "string" + } + }, + "description": "Properties to configure keyVault Properties" + }, + "EncryptionScopeListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of EncryptionScope.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EncryptionScope" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of EncryptionScope." + } + }, + "description": "The list of cognitive services EncryptionScopes." + }, + "EncryptionScope": { + "type": "object", + "description": "Cognitive Services EncryptionScope", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/EncryptionScopeProperties", + "description": "Properties of Cognitive Services EncryptionScope." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "EncryptionScopeProperties": { + "type": "object", + "description": "Properties to EncryptionScope", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the resource at the time the operation was called.", + "enum": [ + "Accepted", + "Creating", + "Deleting", + "Moving", + "Failed", + "Succeeded", + "Canceled" + ], + "x-ms-enum": { + "name": "EncryptionScopeProvisioningState", + "modelAsString": true + } + }, + "state": { + "type": "string", + "description": "The encryptionScope state.", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "EncryptionScopeState", + "modelAsString": true + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/Encryption" + } + ] + }, + "UserOwnedStorage": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "Full resource id of a Microsoft.Storage resource." + }, + "identityClientId": { + "type": "string" + } + }, + "description": "The user owned storage for Cognitive Services account." + }, + "UserOwnedAmlWorkspace": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "Full resource id of a AML workspace resource." + }, + "identityClientId": { + "type": "string", + "description": "Identity Client id of a AML workspace resource." + } + }, + "description": "The user owned AML workspace for Cognitive Services account." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + }, + "description": "A list of private endpoint connections" + }, + "PrivateEndpointConnection": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Resource properties." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "location": { + "type": "string", + "description": "The location of the private endpoint connection" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/AzureEntityResource" + } + ], + "description": "The Private Endpoint Connection resource." + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpoint", + "description": "The resource of private end point." + }, + "privateLinkServiceConnectionState": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "The provisioning state of the private endpoint connection resource." + }, + "groupIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource group ids." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ], + "description": "Properties of the PrivateEndpointConnectProperties." + }, + "PrivateLinkResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + }, + "description": "A list of private link resources" + }, + "PrivateLinkResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "description": "A private link resource" + }, + "PrivateLinkResourceProperties": { + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource Private link DNS zone name." + }, + "displayName": { + "description": "The private link resource display name.", + "type": "string", + "readOnly": true + } + }, + "description": "Properties of a private link resource." + }, + "DeploymentListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Deployment.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Deployment" + }, + "description": "Gets the list of Cognitive Services accounts Deployment and their properties." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "Deployment": { + "description": "Cognitive Services account deployment.", + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/DeploymentProperties", + "description": "Properties of Cognitive Services account deployment." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "DeploymentProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the resource at the time the operation was called.", + "enum": [ + "Accepted", + "Creating", + "Deleting", + "Moving", + "Failed", + "Succeeded", + "Disabled", + "Canceled" + ], + "x-ms-enum": { + "name": "DeploymentProvisioningState", + "modelAsString": true + } + }, + "model": { + "$ref": "#/definitions/DeploymentModel" + }, + "scaleSettings": { + "$ref": "#/definitions/DeploymentScaleSettings" + }, + "capabilities": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The capabilities." + }, + "raiPolicyName": { + "type": "string", + "description": "The name of RAI policy." + }, + "callRateLimit": { + "readOnly": true, + "$ref": "#/definitions/CallRateLimit" + }, + "rateLimits": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ThrottlingRule" + }, + "x-ms-identifiers": [ + "key" + ] + }, + "versionUpgradeOption": { + "type": "string", + "description": "Deployment model version upgrade option.", + "enum": [ + "OnceNewDefaultVersionAvailable", + "OnceCurrentVersionExpired", + "NoAutoUpgrade" + ], + "x-ms-enum": { + "name": "DeploymentModelVersionUpgradeOption", + "modelAsString": true + } + }, + "dynamicThrottlingEnabled": { + "type": "boolean", + "description": "If the dynamic throttling is enabled.", + "readOnly": true + }, + "currentCapacity": { + "type": "integer", + "format": "int32", + "description": "The current capacity." + }, + "capacitySettings": { + "$ref": "#/definitions/DeploymentCapacitySettings" + }, + "parentDeploymentName": { + "type": "string", + "description": "The name of parent deployment." + } + }, + "description": "Properties of Cognitive Services account deployment." + }, + "DeploymentModel": { + "type": "object", + "properties": { + "publisher": { + "type": "string", + "description": "Deployment model publisher." + }, + "format": { + "type": "string", + "description": "Deployment model format." + }, + "name": { + "type": "string", + "description": "Deployment model name." + }, + "version": { + "type": "string", + "description": "Optional. Deployment model version. If version is not specified, a default version will be assigned. The default version is different for different models and might change when there is new version available for a model. Default version for a model could be found from list models API." + }, + "source": { + "type": "string", + "description": "Optional. Deployment model source ARM resource ID." + }, + "sourceAccount": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.CognitiveServices/accounts" + } + ] + }, + "description": "Optional. Source of the model, another Microsoft.CognitiveServices accounts ARM resource ID." + }, + "callRateLimit": { + "readOnly": true, + "$ref": "#/definitions/CallRateLimit" + } + }, + "description": "Properties of Cognitive Services account deployment model." + }, + "DeploymentScaleSettings": { + "type": "object", + "properties": { + "scaleType": { + "type": "string", + "description": "Deployment scale type.", + "enum": [ + "Standard", + "Manual" + ], + "x-ms-enum": { + "name": "DeploymentScaleType", + "modelAsString": true + } + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "Deployment capacity." + }, + "activeCapacity": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Deployment active capacity. This value might be different from `capacity` if customer recently updated `capacity`." + } + }, + "description": "Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.)" + }, + "DeploymentSkuListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of deployment skus.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SkuResource" + }, + "x-ms-identifiers": [ + "resourceType" + ], + "description": "Gets the list of Cognitive Services accounts deployment skus." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "SkuResource": { + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "description": "The resource type name." + }, + "sku": { + "$ref": "#/definitions/Sku" + }, + "capacity": { + "$ref": "#/definitions/CapacityConfig" + } + }, + "description": "Properties of Cognitive Services account resource sku resource properties." + }, + "CommitmentTierListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of CommitmentTier.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/CommitmentTier" + }, + "x-ms-identifiers": [ + "kind", + "tier", + "skuName", + "hostingModel", + "planType" + ], + "description": "Gets the list of Cognitive Services accounts CommitmentTier and their properties." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "CommitmentTier": { + "description": "Cognitive Services account commitment tier.", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/Kind", + "description": "The Kind of the resource." + }, + "skuName": { + "type": "string", + "description": "The name of the SKU. Ex - P3. It is typically a letter+number code" + }, + "hostingModel": { + "$ref": "#/definitions/HostingModel", + "description": "Account hosting model." + }, + "planType": { + "type": "string", + "description": "Commitment plan type." + }, + "tier": { + "type": "string", + "description": "Commitment period commitment tier." + }, + "maxCount": { + "type": "integer", + "format": "int32", + "description": "Commitment period commitment max count." + }, + "quota": { + "$ref": "#/definitions/CommitmentQuota" + }, + "cost": { + "$ref": "#/definitions/CommitmentCost" + } + } + }, + "CommitmentQuota": { + "type": "object", + "properties": { + "quantity": { + "type": "integer", + "format": "int64", + "description": "Commitment quota quantity." + }, + "unit": { + "type": "string", + "description": "Commitment quota unit." + } + }, + "description": "Cognitive Services account commitment quota." + }, + "CommitmentCost": { + "type": "object", + "properties": { + "commitmentMeterId": { + "type": "string", + "description": "Commitment meter Id." + }, + "overageMeterId": { + "type": "string", + "description": "Overage meter Id." + } + }, + "description": "Cognitive Services account commitment cost." + }, + "CommitmentPlanListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of CommitmentPlan.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/CommitmentPlan" + }, + "description": "Gets the list of Cognitive Services accounts CommitmentPlan and their properties." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "CommitmentPlan": { + "description": "Cognitive Services account commitment plan.", + "type": "object", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "kind": { + "$ref": "#/definitions/Kind", + "description": "The Kind of the resource." + }, + "sku": { + "$ref": "#/definitions/Sku" + }, + "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 geo-location where the resource lives" + }, + "properties": { + "$ref": "#/definitions/CommitmentPlanProperties", + "description": "Properties of Cognitive Services account commitment plan." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "CommitmentPlanProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the resource at the time the operation was called.", + "enum": [ + "Accepted", + "Creating", + "Deleting", + "Moving", + "Failed", + "Succeeded", + "Canceled" + ], + "x-ms-enum": { + "name": "CommitmentPlanProvisioningState", + "modelAsString": true + } + }, + "commitmentPlanGuid": { + "type": "string", + "description": "Commitment plan guid." + }, + "hostingModel": { + "$ref": "#/definitions/HostingModel", + "description": "Account hosting model." + }, + "planType": { + "type": "string", + "description": "Commitment plan type." + }, + "current": { + "$ref": "#/definitions/CommitmentPeriod" + }, + "autoRenew": { + "type": "boolean", + "description": "AutoRenew commitment plan." + }, + "next": { + "$ref": "#/definitions/CommitmentPeriod" + }, + "last": { + "$ref": "#/definitions/CommitmentPeriod", + "readOnly": true + }, + "provisioningIssues": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of ProvisioningIssue." + } + }, + "description": "Properties of Cognitive Services account commitment plan." + }, + "HostingModel": { + "type": "string", + "description": "Account hosting model.", + "enum": [ + "Web", + "ConnectedContainer", + "DisconnectedContainer", + "ProvisionedWeb" + ], + "x-ms-enum": { + "name": "HostingModel", + "modelAsString": true + } + }, + "CommitmentPeriod": { + "type": "object", + "properties": { + "tier": { + "type": "string", + "description": "Commitment period commitment tier." + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Commitment period commitment count." + }, + "quota": { + "$ref": "#/definitions/CommitmentQuota", + "readOnly": true + }, + "startDate": { + "type": "string", + "description": "Commitment period start date.", + "readOnly": true + }, + "endDate": { + "type": "string", + "description": "Commitment period end date.", + "readOnly": true + } + }, + "description": "Cognitive Services account commitment period." + }, + "ModelListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Model.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Model" + }, + "x-ms-identifiers": [ + "kind", + "skuName", + "/model/name", + "/model/format", + "/model/version" + ], + "description": "Gets the list of Cognitive Services accounts Model and their properties." + } + }, + "description": "The list of cognitive services models." + }, + "Model": { + "description": "Cognitive Services Model.", + "type": "object", + "properties": { + "model": { + "$ref": "#/definitions/AccountModel" + }, + "kind": { + "$ref": "#/definitions/Kind" + }, + "skuName": { + "$ref": "#/definitions/SkuName" + }, + "description": { + "type": "string", + "description": "The description of the model." + } + } + }, + "ModelSku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the model SKU." + }, + "usageName": { + "type": "string", + "description": "The usage name of the model SKU." + }, + "deprecationDate": { + "type": "string", + "format": "date-time", + "description": "The datetime of deprecation of the model SKU." + }, + "capacity": { + "$ref": "#/definitions/CapacityConfig" + }, + "rateLimits": { + "type": "array", + "items": { + "$ref": "#/definitions/CallRateLimit" + }, + "x-ms-identifiers": [], + "description": "The list of rateLimit." + }, + "cost": { + "type": "array", + "items": { + "$ref": "#/definitions/BillingMeterInfo" + }, + "x-ms-identifiers": [], + "description": "The list of billing meter info." + } + }, + "description": "Describes an available Cognitive Services Model SKU." + }, + "AccountModelListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Model.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AccountModel" + }, + "x-ms-identifiers": [ + "name", + "format", + "version" + ], + "description": "Gets the list of Cognitive Services accounts Model and their properties." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "AccountModel": { + "description": "Cognitive Services account Model.", + "type": "object", + "properties": { + "baseModel": { + "$ref": "#/definitions/DeploymentModel" + }, + "isDefaultVersion": { + "type": "boolean", + "description": "If the model is default version." + }, + "skus": { + "type": "array", + "items": { + "$ref": "#/definitions/ModelSku" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of Model Sku." + }, + "maxCapacity": { + "type": "integer", + "format": "int32", + "description": "The max capacity." + }, + "capabilities": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The capabilities." + }, + "finetuneCapabilities": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The capabilities for finetune models." + }, + "deprecation": { + "$ref": "#/definitions/ModelDeprecationInfo" + }, + "lifecycleStatus": { + "type": "string", + "enum": [ + "Stable", + "Preview", + "GenerallyAvailable", + "Deprecating", + "Deprecated" + ], + "x-ms-enum": { + "name": "ModelLifecycleStatus", + "modelAsString": true + }, + "description": "Model lifecycle status." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "#/definitions/DeploymentModel" + } + ] + }, + "ModelDeprecationInfo": { + "description": "Cognitive Services account ModelDeprecationInfo.", + "type": "object", + "properties": { + "fineTune": { + "type": "string", + "description": "The datetime of deprecation of the fineTune Model." + }, + "inference": { + "type": "string", + "description": "The datetime of deprecation of the inference Model." + } + } + }, + "ModelCapacityListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of ModelSkuCapacity.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "type": "object", + "readOnly": true, + "properties": { + "location": { + "type": "string", + "description": "The location of the Model Sku Capacity." + }, + "properties": { + "$ref": "#/definitions/ModelSkuCapacityProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "x-ms-identifiers": [ + "model" + ], + "description": "Gets the list of Cognitive Services accounts ModelSkuCapacity." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "ModelSkuCapacityProperties": { + "description": "Cognitive Services account ModelSkuCapacity.", + "type": "object", + "properties": { + "model": { + "$ref": "#/definitions/DeploymentModel" + }, + "skuName": { + "type": "string" + }, + "availableCapacity": { + "type": "number", + "description": "The available capacity for deployment with this model and sku." + }, + "availableFinetuneCapacity": { + "type": "number", + "description": "The available capacity for deployment with a fine-tune version of this model and sku." + } + } + }, + "PatchResourceTags": { + "description": "The object being used to update tags of a resource, in general used for PATCH operations.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + } + }, + "PatchResourceTagsAndSku": { + "description": "The object being used to update tags and sku of a resource, in general used for PATCH operations.", + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PatchResourceTags" + } + ] + }, + "RaiMonitorConfig": { + "description": "Cognitive Services Rai Monitor Config.", + "type": "object", + "properties": { + "adxStorageResourceId": { + "type": "string", + "description": "The storage resource Id." + }, + "identityClientId": { + "type": "string", + "description": "The identity client Id to access the storage." + } + } + }, + "RaiPolicyListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of RaiPolicy.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RaiPolicy" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of RaiPolicy." + } + }, + "description": "The list of cognitive services RaiPolicies." + }, + "RaiPolicy": { + "description": "Cognitive Services RaiPolicy.", + "type": "object", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/RaiPolicyProperties", + "description": "Properties of Cognitive Services RaiPolicy." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "RaiBlockListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of RaiBlocklists.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RaiBlocklist" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of RaiBlocklist." + } + }, + "description": "The list of cognitive services RAI Blocklists." + }, + "RaiBlocklist": { + "description": "Cognitive Services RaiBlocklist.", + "type": "object", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/RaiBlocklistProperties", + "description": "Properties of Cognitive Services RaiBlocklist." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "RaiBlocklistProperties": { + "description": "RAI Custom Blocklist properties.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the block list." + } + } + }, + "RaiBlocklistItemProperties": { + "description": "RAI Custom Blocklist Item properties.", + "type": "object", + "properties": { + "pattern": { + "type": "string", + "description": "Pattern to match against." + }, + "isRegex": { + "type": "boolean", + "description": "If the pattern is a regex pattern." + } + } + }, + "RaiBlockListItemsResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of RaiBlocklistItems.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RaiBlocklistItem" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of RaiBlocklistItems." + } + }, + "description": "The list of cognitive services RAI Blocklist Items." + }, + "RaiBlocklistItemsBulkAddRequest": { + "description": "The list of Cognitive Services RaiBlocklist Items for batch add.", + "type": "array", + "items": { + "$ref": "#/definitions/RaiBlocklistItemBulkRequest" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "RaiBlocklistItemBulkRequest": { + "description": "The Cognitive Services RaiBlocklist Item request body.", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "properties": { + "$ref": "#/definitions/RaiBlocklistItemProperties", + "description": "Properties of Cognitive Services RaiBlocklist Item." + } + } + }, + "RaiBlocklistItemsBulkDeleteRequest": { + "description": "The list of Cognitive Services RaiBlocklist Items Names.", + "type": "object", + "items": { + "type": "string" + } + }, + "RaiBlocklistItem": { + "description": "Cognitive Services RaiBlocklist Item.", + "type": "object", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/RaiBlocklistItemProperties", + "description": "Properties of Cognitive Services RaiBlocklist Item." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "RaiPolicyProperties": { + "description": "Azure OpenAI Content Filters properties.", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "UserManaged", + "SystemManaged" + ], + "x-ms-enum": { + "name": "RaiPolicyType", + "modelAsString": true + }, + "description": "Content Filters policy type.", + "readOnly": true + }, + "mode": { + "type": "string", + "enum": [ + "Default", + "Deferred", + "Blocking", + "Asynchronous_filter" + ], + "x-ms-enum": { + "name": "RaiPolicyMode", + "modelAsString": true + }, + "description": "Rai policy mode. The enum value mapping is as below: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Please use 'Asynchronous_filter' after 2024-10-01. It is the same as 'Deferred' in previous version." + }, + "basePolicyName": { + "type": "string", + "description": "Name of Rai policy." + }, + "contentFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/RaiPolicyContentFilter" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of Content Filters." + }, + "customBlocklists": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomBlocklistConfig" + }, + "x-ms-identifiers": [], + "description": "The list of custom Blocklist." + } + } + }, + "CustomBlocklistConfig": { + "description": "Gets or sets the source to which filter applies.", + "type": "object", + "properties": { + "source": { + "$ref": "#/definitions/RaiPolicyContentSource" + } + }, + "allOf": [ + { + "$ref": "#/definitions/RaiBlocklistConfig" + } + ] + }, + "RaiPolicyContentSource": { + "description": "Content source to apply the Content Filters.", + "type": "string", + "enum": [ + "Prompt", + "Completion" + ], + "x-ms-enum": { + "name": "RaiPolicyContentSource", + "modelAsString": true + } + }, + "RaiPolicyContentFilter": { + "description": "Azure OpenAI Content Filter.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of ContentFilter." + }, + "enabled": { + "type": "boolean", + "description": "If the ContentFilter is enabled." + }, + "severityThreshold": { + "description": "Level at which content is filtered.", + "type": "string", + "enum": [ + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "ContentLevel", + "modelAsString": true + } + }, + "blocking": { + "type": "boolean", + "description": "If blocking would occur." + }, + "source": { + "$ref": "#/definitions/RaiPolicyContentSource" + } + } + }, + "RaiBlocklistConfig": { + "description": "Azure OpenAI blocklist config.", + "type": "object", + "properties": { + "blocklistName": { + "type": "string", + "description": "Name of ContentFilter." + }, + "blocking": { + "type": "boolean", + "description": "If blocking would occur." + } + } + }, + "RaiContentFilterListResult": { + "description": "The list of Content Filters.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Content Filters.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RaiContentFilter" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of RaiContentFilter." + } + } + }, + "RaiContentFilter": { + "description": "Azure OpenAI Content Filter.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Azure OpenAI Content Filter Properties.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Content Filter." + }, + "isMultiLevelFilter": { + "type": "boolean", + "description": "If the Content Filter has multi severity levels(Low, Medium, or High)." + }, + "source": { + "$ref": "#/definitions/RaiPolicyContentSource" + } + } + } + } + }, + "NetworkSecurityPerimeterConfigurationList": { + "description": "A list of NSP configurations for an Cognitive Services account.", + "type": "object", + "properties": { + "value": { + "description": "Array of NSP configurations List Result for an Cognitive Services account.", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfiguration" + }, + "x-ms-identifiers": [ + "id" + ] + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string" + } + } + }, + "NetworkSecurityPerimeterConfiguration": { + "description": "NSP Configuration for an Cognitive Services account.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationProperties", + "description": "NSP Configuration properties." + } + } + }, + "NetworkSecurityPerimeterConfigurationProperties": { + "description": "The properties of an NSP Configuration.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "description": "Provisioning state of NetworkSecurityPerimeter configuration", + "type": "string" + }, + "provisioningIssues": { + "description": "List of Provisioning Issues", + "type": "array", + "items": { + "$ref": "#/definitions/ProvisioningIssue" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "networkSecurityPerimeter": { + "$ref": "#/definitions/NetworkSecurityPerimeter" + }, + "resourceAssociation": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationAssociationInfo" + }, + "profile": { + "$ref": "#/definitions/NetworkSecurityPerimeterProfileInfo" + } + } + }, + "ProvisioningIssue": { + "type": "object", + "properties": { + "name": { + "description": "Name of the NSP provisioning issue", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ProvisioningIssueProperties" + } + } + }, + "ProvisioningIssueProperties": { + "description": "Properties of Provisioning Issue", + "type": "object", + "properties": { + "issueType": { + "description": "Type of Issue", + "type": "string" + }, + "severity": { + "description": "Severity of the issue", + "type": "string" + }, + "description": { + "description": "Description of the issue", + "type": "string" + }, + "suggestedResourceIds": { + "description": "IDs of resources that can be associated to the same perimeter to remediate the issue.", + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "description": "Fully qualified resource ID for the resource." + } + }, + "suggestedAccessRules": { + "description": "Optional array, suggested access rules", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityPerimeterAccessRule" + } + } + } + }, + "NetworkSecurityPerimeter": { + "description": "Information about a linked Network Security Perimeter", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified identifier of the resource", + "type": "string", + "format": "arm-id" + }, + "perimeterGuid": { + "description": "Guid of the resource", + "type": "string" + }, + "location": { + "description": "Location of the resource", + "type": "string" + } + } + }, + "NetworkSecurityPerimeterConfigurationAssociationInfo": { + "description": "Network Security Perimeter Configuration Association Information", + "type": "object", + "properties": { + "name": { + "description": "Name of the resource association", + "type": "string" + }, + "accessMode": { + "description": "Access Mode of the resource association", + "type": "string" + } + } + }, + "NetworkSecurityPerimeterProfileInfo": { + "description": "Network Security Perimeter Profile Information", + "type": "object", + "properties": { + "name": { + "description": "Name of the resource profile", + "type": "string" + }, + "accessRulesVersion": { + "description": "Access rules version of the resource profile", + "type": "integer", + "format": "int64" + }, + "accessRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityPerimeterAccessRule" + }, + "x-ms-identifiers": [] + }, + "diagnosticSettingsVersion": { + "description": "Current diagnostic settings version", + "type": "integer", + "format": "int64" + }, + "enabledLogCategories": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of enabled log categories" + } + } + }, + "NetworkSecurityPerimeterAccessRule": { + "description": "Network Security Perimeter Access Rule", + "type": "object", + "properties": { + "name": { + "description": "Network Security Perimeter Access Rule Name", + "type": "string" + }, + "properties": { + "description": "Properties of Network Security Perimeter Access Rule", + "$ref": "#/definitions/NetworkSecurityPerimeterAccessRuleProperties" + } + } + }, + "NetworkSecurityPerimeterAccessRuleProperties": { + "description": "The Properties of Network Security Perimeter Rule", + "type": "object", + "properties": { + "direction": { + "enum": [ + "Inbound", + "Outbound" + ], + "type": "string", + "description": "Direction of Access Rule", + "x-ms-enum": { + "name": "NspAccessRuleDirection", + "modelAsString": true + } + }, + "addressPrefixes": { + "description": "Address prefixes for inbound rules", + "type": "array", + "items": { + "description": "IP Address", + "type": "string" + } + }, + "subscriptions": { + "description": "Subscriptions for inbound rules", + "type": "array", + "items": { + "description": "Subscription for inbound rule", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified identifier of subscription", + "type": "string" + } + } + } + }, + "networkSecurityPerimeters": { + "description": "NetworkSecurityPerimeters for inbound rules", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityPerimeter" + } + }, + "fullyQualifiedDomainNames": { + "description": "Fully qualified domain name for outbound rules", + "type": "array", + "items": { + "description": "Fully qualified domain name", + "type": "string" + } + } + } + }, + "DefenderForAISettingResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Defender for AI Settings.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DefenderForAISetting" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of Defender for AI Settings." + } + }, + "description": "The list of cognitive services Defender for AI Settings." + }, + "DefenderForAISetting": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DefenderForAISettingProperties" + } + }, + "description": "The Defender for AI resource." + }, + "DefenderForAISettingProperties": { + "type": "object", + "properties": { + "state": { + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "DefenderForAISettingState", + "modelAsString": true + }, + "description": "Defender for AI state on the AI resource." + } + }, + "description": "The Defender for AI resource properties." + } + }, + "parameters": { + "accountNameParameter": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 64, + "minLength": 2, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of Cognitive Services account.", + "x-ms-parameter-location": "method" + }, + "locationParameter": { + "name": "location", + "in": "path", + "description": "Resource location.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "usageFilterParameter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "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).", + "x-ms-parameter-location": "method" + }, + "privateEndpointConnectionNameParameter": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection associated with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "deploymentNameParameter": { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment associated with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "raiPolicyNameParameter": { + "name": "raiPolicyName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the RaiPolicy associated with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "raiBlocklistNameParameter": { + "name": "raiBlocklistName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the RaiBlocklist associated with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "raiBlocklistItemNameParameter": { + "name": "raiBlocklistItemName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the RaiBlocklist Item associated with the custom blocklist", + "x-ms-parameter-location": "method" + }, + "commitmentPlanNameParameter": { + "name": "commitmentPlanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the commitmentPlan associated with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "commitmentPlanResourceNameParameter": { + "name": "commitmentPlanName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the commitmentPlan associated with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "commitmentPlanAssociationNameParameter": { + "name": "commitmentPlanAssociationName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the commitment plan association with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "encryptionScopeNameParameter": { + "name": "encryptionScopeName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the encryptionScope associated with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "modelFormatFilterParameter": { + "name": "modelFormat", + "in": "query", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The format of the Model", + "x-ms-parameter-location": "method" + }, + "modelNameFilterParameter": { + "name": "modelName", + "in": "query", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the Model", + "x-ms-parameter-location": "method" + }, + "modelVersionFilterParameter": { + "name": "modelVersion", + "in": "query", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The version of the Model", + "x-ms-parameter-location": "method" + }, + "defenderForAISettingNameParameter": { + "name": "defenderForAISettingName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the defender for AI setting.", + "x-ms-parameter-location": "method" + }, + "nspConfigurationNameParameter": { + "name": "nspConfigurationName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^.*$", + "description": "The name of the NSP Configuration.", + "x-ms-parameter-location": "method" + }, + "raiContentFilterNameParameter": { + "name": "filterName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the RAI Content Filter.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/AddRaiBlocklistItems.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/AddRaiBlocklistItems.json new file mode 100644 index 000000000000..642d4dd1f36f --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/AddRaiBlocklistItems.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "myblocklist", + "raiBlocklistItems": [ + { + "name": "myblocklistitem1", + "properties": { + "pattern": "^[a-z0-9_-]{2,16}$", + "isRegex": true + } + }, + { + "name": "myblocklistitem2", + "properties": { + "pattern": "blockwords", + "isRegex": false + } + } + ] + }, + "responses": { + "200": { + "body": { + "name": "myblocklist", + "properties": { + "description": "Brief description of the blocklist" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CalculateModelCapacity.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CalculateModelCapacity.json new file mode 100644 index 000000000000..d80e55602ca9 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CalculateModelCapacity.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "parameters": { + "model": { + "format": "OpenAI", + "name": "gpt-4", + "version": "0613" + }, + "skuName": "ProvisionedManaged", + "workloads": [ + { + "requestPerMinute": 10, + "requestParameters": { + "avgPromptTokens": 30, + "avgGeneratedTokens": 50 + } + }, + { + "requestPerMinute": 20, + "requestParameters": { + "avgPromptTokens": 60, + "avgGeneratedTokens": 20 + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "model": { + "format": "OpenAI", + "name": "gpt-4", + "version": "0613" + }, + "skuName": "ProvisionedManaged", + "estimatedCapacity": { + "value": 346, + "deployableValue": 400 + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CheckDomainAvailability.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CheckDomainAvailability.json new file mode 100644 index 000000000000..f36ec0e126db --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CheckDomainAvailability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "location": "westus", + "parameters": { + "subdomainName": "contosodemoapp1", + "type": "Microsoft.CognitiveServices/accounts" + } + }, + "responses": { + "200": { + "body": { + "isSubdomainAvailable": false, + "reason": "Sub domain name 'contosodemoapp1' is not valid", + "subdomainName": "contosodemoapp1", + "type": "Microsoft.CognitiveServices/accounts" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CheckSkuAvailability.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CheckSkuAvailability.json new file mode 100644 index 000000000000..0677182e1d29 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CheckSkuAvailability.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "location": "westus", + "parameters": { + "skus": [ + "S0" + ], + "kind": "Face", + "type": "Microsoft.CognitiveServices/accounts" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kind": "Face", + "type": "Microsoft.CognitiveServices/accounts", + "skuName": "S0", + "skuAvailable": true, + "reason": null, + "message": null + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CreateAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CreateAccount.json new file mode 100644 index 000000000000..35c02e4afdcf --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CreateAccount.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "accountName": "testCreate1", + "account": { + "location": "West US", + "kind": "Emotion", + "sku": { + "name": "S0" + }, + "properties": { + "encryption": { + "keyVaultProperties": { + "keyName": "KeyName", + "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA", + "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/" + }, + "keySource": "Microsoft.KeyVault" + }, + "userOwnedStorage": [ + { + "resourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount" + } + ] + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-10T08%3A00%3A05.445595Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded", + "encryption": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "FakeKeyName", + "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA", + "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/" + } + }, + "userOwnedStorage": [ + { + "resourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount" + } + ] + }, + "identity": { + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded", + "encryption": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "FakeKeyName", + "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA", + "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/" + } + }, + "userOwnedStorage": [ + { + "resourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount" + } + ] + }, + "identity": { + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded", + "encryption": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "FakeKeyName", + "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA", + "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/" + } + }, + "userOwnedStorage": [ + { + "resourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount" + } + ] + }, + "identity": { + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CreateAccountMin.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CreateAccountMin.json new file mode 100644 index 000000000000..45e09d898f13 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CreateAccountMin.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "accountName": "testCreate1", + "account": { + "location": "West US", + "kind": "CognitiveServices", + "sku": { + "name": "S0" + }, + "properties": {}, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-10T08%3A00%3A05.445595Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CreateSharedCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CreateSharedCommitmentPlan.json new file mode 100644 index 000000000000..eedd9f6ea235 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CreateSharedCommitmentPlan.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "resourceGroupName", + "commitmentPlanName": "commitmentPlanName", + "commitmentPlan": { + "location": "West US", + "kind": "SpeechServices", + "sku": { + "name": "S0" + }, + "properties": { + "hostingModel": "Web", + "planType": "STT", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "SpeechServices", + "properties": { + "provisioningState": "Succeeded", + "hostingModel": "Web", + "planType": "STT", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "SpeechServices", + "properties": { + "provisioningState": "Succeeded", + "hostingModel": "Web", + "planType": "STT", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CreateSharedCommitmentPlanAssociation.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CreateSharedCommitmentPlanAssociation.json new file mode 100644 index 000000000000..05e0effcbcc8 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/CreateSharedCommitmentPlanAssociation.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "resourceGroupName", + "commitmentPlanName": "commitmentPlanName", + "commitmentPlanAssociationName": "commitmentPlanAssociationName", + "association": { + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName/accountAssociations/commitmentPlanAssociationName", + "name": "commitmentPlanAssociationName", + "type": "Microsoft.CognitiveServices/commitmentPlans/accountAssociations", + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName/accountAssociations/commitmentPlanAssociationName", + "name": "commitmentPlanAssociationName", + "type": "Microsoft.CognitiveServices/commitmentPlans/accountAssociations", + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteAccount.json new file mode 100644 index 000000000000..e51d84891ba0 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteAccount.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "accountName": "PropTest01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteCommitmentPlan.json new file mode 100644 index 000000000000..32585d642653 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteCommitmentPlan.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "commitmentPlanName": "commitmentPlanName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteDeployment.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteDeployment.json new file mode 100644 index 000000000000..1aaf07998aad --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteDeployment.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "deploymentName": "deploymentName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteEncryptionScope.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteEncryptionScope.json new file mode 100644 index 000000000000..9b0bc5de8a53 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteEncryptionScope.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "encryptionScopeName": "encryptionScopeName" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeletePrivateEndpointConnection.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..e4873a17c417 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeletePrivateEndpointConnection.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6977", + "accountName": "sto2527", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2024-10-01", + "monitor": "true" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteRaiBlocklist.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteRaiBlocklist.json new file mode 100644 index 000000000000..3e97463a0e26 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteRaiBlocklist.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "raiBlocklistName" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteRaiBlocklistItem.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteRaiBlocklistItem.json new file mode 100644 index 000000000000..35d5ccea52eb --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteRaiBlocklistItem.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "raiBlocklistName", + "raiBlocklistItemName": "raiBlocklistItemName" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteRaiBlocklistItems.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteRaiBlocklistItems.json new file mode 100644 index 000000000000..f4a8ead06d80 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteRaiBlocklistItems.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "raiBlocklistName", + "raiBlocklistItemsNames": [ + "myblocklistitem1", + "myblocklistitem2" + ] + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteRaiPolicy.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteRaiPolicy.json new file mode 100644 index 000000000000..3d0f0421b26e --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteRaiPolicy.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiPolicyName": "raiPolicyName" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteSharedCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteSharedCommitmentPlan.json new file mode 100644 index 000000000000..86aa4abcdde4 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteSharedCommitmentPlan.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "resourceGroupName", + "commitmentPlanName": "commitmentPlanName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteSharedCommitmentPlanAssociation.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteSharedCommitmentPlanAssociation.json new file mode 100644 index 000000000000..1b2dca9771f4 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/DeleteSharedCommitmentPlanAssociation.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "resourceGroupName", + "commitmentPlanName": "commitmentPlanName", + "commitmentPlanAssociationName": "commitmentPlanAssociationName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetAccount.json new file mode 100644 index 000000000000..33a4b6402f42 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetAccount.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "accountName": "myAccount" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount", + "name": "myAccount", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "F0" + }, + "kind": "Emotion", + "tags": { + "Owner": "felixwa", + "ExpiredDate": "2017/09/01" + }, + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetCommitmentPlan.json new file mode 100644 index 000000000000..b5b1e9963ccc --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetCommitmentPlan.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "commitmentPlanName": "commitmentPlanName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/accounts/commitmentPlans", + "properties": { + "hostingModel": "Web", + "planType": "Speech2Text", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetDefenderForAISetting.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetDefenderForAISetting.json new file mode 100644 index 000000000000..ab01625908f6 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetDefenderForAISetting.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "defenderForAISettingName": "Default" + }, + "responses": { + "200": { + "body": { + "name": "Default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetDeletedAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetDeletedAccount.json new file mode 100644 index 000000000000..77dac505e8b4 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetDeletedAccount.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "accountName": "myAccount", + "location": "westus" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.CognitiveServices/locations/westus/resourceGroups/myResourceGroup/deletedAccounts/myAccount", + "name": "myAccount", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "F0" + }, + "kind": "Emotion", + "tags": { + "Owner": "felixwa", + "ExpiredDate": "2017/09/01" + }, + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetDeployment.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetDeployment.json new file mode 100644 index 000000000000..cb9c76656cd1 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetDeployment.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "deploymentName": "deploymentName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "properties": { + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetEncryptionScope.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetEncryptionScope.json new file mode 100644 index 000000000000..879c81c0e056 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetEncryptionScope.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "encryptionScopeName": "encryptionScopeName" + }, + "responses": { + "200": { + "body": { + "name": "encryptionScopeName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName", + "type": "Microsoft.CognitiveServices/accounts/encryptionScopes", + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2023-06-08T06:35:08.0662558Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-08T06:35:08.0662558Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "state": "Enabled", + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "DevKeyWestUS2", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "identityClientId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetNetworkSecurityPerimeterConfigurations.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetNetworkSecurityPerimeterConfigurations.json new file mode 100644 index 000000000000..5c45589ba6cf --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetNetworkSecurityPerimeterConfigurations.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "nspConfigurationName": "NSPConfigurationName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/networkSecurityPerimeterConfigurations", + "name": "networkSecurityPerimeterConfigurationName", + "type": "Microsoft.CognitiveServices/accounts/networkSecurityPerimeterConfigurations", + "properties": { + "provisioningState": "Succeeded", + "networkSecurityPerimeter": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.Network/networkSecurityPerimeters/perimeter", + "perimeterGuid": "00000000-0000-0000-0000-000000000000", + "location": "East US" + }, + "resourceAssociation": { + "name": "associationName", + "accessMode": "Enforced" + }, + "profile": { + "name": "profileName", + "accessRulesVersion": 1, + "accessRules": [ + { + "name": "ruleName", + "properties": { + "direction": "Inbound", + "addressPrefixes": [ + "148.0.0.0/8", + "152.4.6.0/24" + ] + } + } + ] + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetOperations.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetOperations.json new file mode 100644 index 000000000000..765ec4e77589 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetOperations.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.CognitiveServices/accounts/read", + "display": { + "provider": "Microsoft Cognitive Services", + "resource": "Cognitive Services API Account", + "operation": "Read API Account", + "description": "Reads API accounts." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CognitiveServices/accounts/write", + "display": { + "provider": "Microsoft Cognitive Services", + "resource": "Cognitive Services API Account", + "operation": "Write API Account", + "description": "Writes API Accounts." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CognitiveServices/accounts/delete", + "display": { + "provider": "Microsoft Cognitive Services", + "resource": "Cognitive Services API Account", + "operation": "Delete API Account", + "description": "Deletes API accounts" + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetPrivateEndpointConnection.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetPrivateEndpointConnection.json new file mode 100644 index 000000000000..5abaccfac121 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetPrivateEndpointConnection.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6977", + "accountName": "sto2527", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2024-10-01", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.CognitiveServices/accounts/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetRaiBlocklist.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetRaiBlocklist.json new file mode 100644 index 000000000000..417bd188568b --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetRaiBlocklist.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "raiBlocklistName" + }, + "responses": { + "200": { + "body": { + "name": "raiBlocklistName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName", + "properties": { + "description": "This is a sample blocklist" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetRaiBlocklistItem.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetRaiBlocklistItem.json new file mode 100644 index 000000000000..7ecd06240b91 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetRaiBlocklistItem.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "raiBlocklistName", + "raiBlocklistItemName": "raiBlocklistItemName" + }, + "responses": { + "200": { + "body": { + "name": "raiBlocklistItemName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName", + "properties": { + "pattern": "Pattern To Block", + "isRegex": false + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetRaiContentFilter.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetRaiContentFilter.json new file mode 100644 index 000000000000..b72632feeb47 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetRaiContentFilter.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "WestUS", + "filterName": "IndirectAttack" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/IndirectAttack", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "IndirectAttack", + "properties": { + "name": "Indirect Attack", + "isMultiLevelFilter": false, + "source": "Prompt" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetRaiPolicy.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetRaiPolicy.json new file mode 100644 index 000000000000..dfd886a0e063 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetRaiPolicy.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "deploymentName": "deploymentName", + "raiPolicyName": "raiPolicyName", + "effective": true + }, + "responses": { + "200": { + "body": { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "mode": "Asynchronous_filter", + "contentFilters": [ + { + "name": "hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "jailbreak", + "blocking": true, + "source": "Prompt", + "enabled": true + }, + { + "name": "protected_material_text", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "protected_material_code", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "profanity", + "blocking": true, + "source": "Prompt", + "enabled": true + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetSharedCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetSharedCommitmentPlan.json new file mode 100644 index 000000000000..4d4533ba979a --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetSharedCommitmentPlan.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "resourceGroupName", + "commitmentPlanName": "commitmentPlanName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "SpeechServices", + "properties": { + "provisioningState": "Succeeded", + "hostingModel": "Web", + "planType": "STT", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetSharedCommitmentPlanAssociation.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetSharedCommitmentPlanAssociation.json new file mode 100644 index 000000000000..773140d9f39b --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetSharedCommitmentPlanAssociation.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "resourceGroupName", + "commitmentPlanName": "commitmentPlanName", + "commitmentPlanAssociationName": "commitmentPlanAssociationName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName/accountAssociations/commitmentPlanAssociationName", + "name": "commitmentPlanAssociationName", + "type": "Microsoft.CognitiveServices/commitmentPlans/accountAssociations", + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetSkus.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetSkus.json new file mode 100644 index 000000000000..57c0132a67d4 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetSkus.json @@ -0,0 +1,2164 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "f1c637e4-72ec-4f89-8d2b-0f933c036002" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Bing.Speech", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Bing.Speech", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S5", + "tier": "Standard", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S6", + "tier": "Standard", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S7", + "tier": "Standard", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S8", + "tier": "Standard", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "Bing.Autosuggest.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "Bing.CustomSearch", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "Bing.SpellCheck.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Bing.EntitySearch", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "Bing.EntitySearch", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "SpeakerRecognition", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "SpeakerRecognition", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "CustomSpeech", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "CustomSpeech", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "CustomVision.Training", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "CustomVision.Training", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "CustomVision.Prediction", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "CustomVision.Prediction", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetUsages.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetUsages.json new file mode 100644 index 000000000000..821352e2a81b --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetUsages.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "5a4f5c2e-6983-4ccb-bd34-2196d5b5bbd3", + "resourceGroupName": "myResourceGroup", + "accountName": "TestUsage02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": { + "value": "Face.Transactions", + "localizedValue": "Face.Transactions" + }, + "status": "Included", + "currentValue": 3, + "limit": 30000, + "nextResetTime": "2018-03-28T09:33:51Z", + "quotaPeriod": "30.00:00:00", + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListAccountModels.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListAccountModels.json new file mode 100644 index 000000000000..b6cbe77563f3 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListAccountModels.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroupName", + "location": "location", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "baseModel": { + "format": "OpenAI", + "name": "ada", + "version": "1" + }, + "format": "OpenAI", + "name": "ada.1", + "version": "1", + "maxCapacity": 10, + "capabilities": { + "fineTune": "true" + }, + "deprecation": { + "fineTune": "2024-01-01T00:00:00Z", + "inference": "2024-01-01T00:00:00Z" + } + }, + { + "format": "OpenAI", + "name": "davinci", + "version": "1", + "maxCapacity": 10, + "capabilities": { + "fineTune": "true" + }, + "deprecation": { + "fineTune": "2024-01-01T00:00:00Z", + "inference": "2024-01-01T00:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListAccountsByResourceGroup.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListAccountsByResourceGroup.json new file mode 100644 index 000000000000..fecff0f9542d --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListAccountsByResourceGroup.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount", + "name": "myAccount", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "F0" + }, + "kind": "Emotion", + "tags": { + "Owner": "felixwa", + "ExpiredDate": "2017/09/01" + }, + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/TestPropertyWU2", + "name": "TestPropertyWU2", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "S0" + }, + "kind": "Face", + "tags": {}, + "etag": "W/\"datetime'2017-04-07T04%3A32%3A38.9187216Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/face/v1.0", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListAccountsBySubscription.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListAccountsBySubscription.json new file mode 100644 index 000000000000..c49c14a46ef8 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListAccountsBySubscription.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch", + "name": "bingSearch", + "type": "Microsoft.CognitiveServices/accounts", + "location": "global", + "sku": { + "name": "S1" + }, + "kind": "Bing.Search", + "etag": "W/\"datetime'2017-03-27T11%3A19%3A08.762494Z'\"", + "properties": { + "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/CrisProd", + "name": "CrisProd", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "S0" + }, + "kind": "CRIS", + "tags": { + "can't delete it successfully": "v-yunjin" + }, + "etag": "W/\"datetime'2017-03-31T08%3A57%3A07.4499566Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/sts/v1.0", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/rayrptest0308", + "name": "rayrptest0308", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "S0" + }, + "kind": "Face", + "etag": "W/\"datetime'2017-03-27T11%3A15%3A23.5232645Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/face/v1.0", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/raytest02", + "name": "raytest02", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-04T02%3A07%3A07.3957572Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListBlocklistItems.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListBlocklistItems.json new file mode 100644 index 000000000000..579e4fa38cd0 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListBlocklistItems.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "raiBlocklistName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "raiBlocklistItemName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName", + "properties": { + "pattern": "Pattern To Block", + "isRegex": false + } + }, + { + "name": "raiBlocklistItemName2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName2", + "properties": { + "pattern": "Another Pattern To Block", + "isRegex": false + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListBlocklists.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListBlocklists.json new file mode 100644 index 000000000000..547101baecea --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListBlocklists.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "raiBlocklistName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName", + "properties": { + "description": "This is a sample blocklist" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListCommitmentPlans.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListCommitmentPlans.json new file mode 100644 index 000000000000..3e0f47934b84 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListCommitmentPlans.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/accounts/commitmentPlans", + "properties": { + "hostingModel": "Web", + "planType": "Speech2Text", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListCommitmentTiers.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListCommitmentTiers.json new file mode 100644 index 000000000000..66243a53e6bf --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListCommitmentTiers.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroupName", + "location": "location" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kind": "TextAnalytics", + "skuName": "S", + "hostingModel": "Web", + "planType": "TA", + "tier": "T1", + "quota": { + "quantity": 1000000, + "unit": "Transaction" + }, + "cost": {} + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListDefenderForAISetting.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListDefenderForAISetting.json new file mode 100644 index 000000000000..cc86b421e05b --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListDefenderForAISetting.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListDeletedAccountsBySubscription.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListDeletedAccountsBySubscription.json new file mode 100644 index 000000000000..c49c14a46ef8 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListDeletedAccountsBySubscription.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch", + "name": "bingSearch", + "type": "Microsoft.CognitiveServices/accounts", + "location": "global", + "sku": { + "name": "S1" + }, + "kind": "Bing.Search", + "etag": "W/\"datetime'2017-03-27T11%3A19%3A08.762494Z'\"", + "properties": { + "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/CrisProd", + "name": "CrisProd", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "S0" + }, + "kind": "CRIS", + "tags": { + "can't delete it successfully": "v-yunjin" + }, + "etag": "W/\"datetime'2017-03-31T08%3A57%3A07.4499566Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/sts/v1.0", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/rayrptest0308", + "name": "rayrptest0308", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "S0" + }, + "kind": "Face", + "etag": "W/\"datetime'2017-03-27T11%3A15%3A23.5232645Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/face/v1.0", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/raytest02", + "name": "raytest02", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-04T02%3A07%3A07.3957572Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListDeploymentSkus.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListDeploymentSkus.json new file mode 100644 index 000000000000..f54564a7e4a0 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListDeploymentSkus.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "deploymentName": "deploymentName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.CognitiveServices/accounts/deployments", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "capacity": { + "minimum": 100, + "maximum": 1000, + "step": 100, + "default": 100, + "allowedValues": [ + 100, + 200 + ] + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListDeployments.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListDeployments.json new file mode 100644 index 000000000000..5f5fcd41fa7a --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListDeployments.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "properties": { + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListEncryptionScopes.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListEncryptionScopes.json new file mode 100644 index 000000000000..9cf46931f922 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListEncryptionScopes.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "encryptionScopeName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName", + "type": "Microsoft.CognitiveServices/accounts/encryptionScopes", + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2023-06-08T06:35:08.0662558Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-08T06:35:08.0662558Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "state": "Enabled", + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "DevKeyWestUS2", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "identityClientId": "00000000-0000-0000-0000-000000000000" + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListKeys.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListKeys.json new file mode 100644 index 000000000000..3fb6a82ef38a --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "accountName": "myAccount" + }, + "responses": { + "200": { + "body": { + "key1": "KEY1", + "key2": "KEY2" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListLocationBasedModelCapacities.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListLocationBasedModelCapacities.json new file mode 100644 index 000000000000..7c941328c29e --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListLocationBasedModelCapacities.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "WestUS", + "modelFormat": "OpenAI", + "modelName": "ada", + "modelVersion": "1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionContext.SubscriptionId}/providers/Microsoft.CognitiveServices/locations/WestUS/models/OpenAI.ada.1/skuCapacities/Standard", + "type": "Microsoft.CognitiveServices/locations/models/skuCapacities", + "name": "Standard", + "location": "WestUS", + "properties": { + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1" + }, + "skuName": "Standard", + "availableCapacity": 300, + "availableFinetuneCapacity": 20 + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListLocationModels.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListLocationModels.json new file mode 100644 index 000000000000..618539ca5428 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListLocationModels.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "WestUS" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kind": "OpenAI", + "skuName": "S0", + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1", + "maxCapacity": 3, + "capabilities": { + "fineTune": "true", + "inference": "false", + "scaleType": "Manual", + "completion": "true", + "search": "true", + "FineTuneTokensMaxValue": "37500000" + }, + "finetuneCapabilities": { + "fineTune": "true", + "inference": "false", + "scaleType": "Manual,Standard", + "completion": "true", + "search": "true", + "FineTuneTokensMaxValue": "37500000" + }, + "deprecation": { + "fineTune": "2024-01-01T00:00:00Z", + "inference": "2024-01-01T00:00:00Z" + }, + "lifecycleStatus": "Preview", + "systemData": { + "createdBy": "Microsoft", + "createdAt": "2021-10-07T00:00:00Z", + "lastModifiedBy": "Microsoft", + "lastModifiedAt": "2021-10-07T00:00:00Z" + }, + "skus": [ + { + "name": "provisioned", + "usageName": "OpenAI.Provisioned.Class1", + "capacity": { + "minimum": 100, + "maximum": 1000, + "step": 100, + "default": 100 + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListModelCapacities.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListModelCapacities.json new file mode 100644 index 000000000000..93a20dc519ba --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListModelCapacities.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "modelFormat": "OpenAI", + "modelName": "ada", + "modelVersion": "1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionContext.SubscriptionId}/providers/Microsoft.CognitiveServices/locations/WestUS/models/OpenAI.ada.1/skuCapacities/Standard", + "type": "Microsoft.CognitiveServices/locations/models/skuCapacities", + "name": "Standard", + "location": "WestUS", + "properties": { + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1" + }, + "skuName": "Standard", + "availableCapacity": 300, + "availableFinetuneCapacity": 20 + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListNetworkSecurityPerimeterConfigurations.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListNetworkSecurityPerimeterConfigurations.json new file mode 100644 index 000000000000..6e5b4575b7ca --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListNetworkSecurityPerimeterConfigurations.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/networkSecurityPerimeterConfigurations", + "name": "networkSecurityPerimeterConfigurationName", + "type": "Microsoft.CognitiveServices/accounts/networkSecurityPerimeterConfigurations", + "properties": { + "provisioningState": "Succeeded", + "networkSecurityPerimeter": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.Network/networkSecurityPerimeters/perimeter", + "perimeterGuid": "00000000-0000-0000-0000-000000000000", + "location": "East US" + }, + "resourceAssociation": { + "name": "associationName", + "accessMode": "Enforced" + }, + "profile": { + "name": "profileName", + "accessRulesVersion": 1, + "accessRules": [ + { + "name": "ruleName", + "properties": { + "direction": "Inbound", + "addressPrefixes": [ + "148.0.0.0/8", + "152.4.6.0/24" + ] + } + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListPrivateEndpointConnections.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListPrivateEndpointConnections.json new file mode 100644 index 000000000000..e4dcf0e0172d --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListPrivateEndpointConnections.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6977", + "accountName": "sto2527", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.CognitiveServices/accounts/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListPrivateLinkResources.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListPrivateLinkResources.json new file mode 100644 index 000000000000..7431c6d6f321 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListPrivateLinkResources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6977", + "accountName": "sto2527", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.CognitiveServices/accounts/sto2527/privateLinkResources/account", + "name": "blob", + "type": "Microsoft.CognitiveServices/accounts/privateLinkResources", + "properties": { + "groupId": "account", + "requiredMembers": [ + "default" + ], + "requiredZoneNames": [ + "privatelink.cognitiveservices.azure.com" + ] + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListRaiContentFilters.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListRaiContentFilters.json new file mode 100644 index 000000000000..637f7c6f6b0f --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListRaiContentFilters.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "WestUS" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Hate", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "Hate", + "properties": { + "name": "Hate", + "isMultiLevelFilter": true + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Sexual", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "Sexual", + "properties": { + "name": "Sexual", + "isMultiLevelFilter": true + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Violence", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "Violence", + "properties": { + "name": "Violence", + "isMultiLevelFilter": true + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Selfharm", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "Selfharm", + "properties": { + "name": "Selfharm", + "isMultiLevelFilter": true + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Jailbreak", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "Jailbreak", + "properties": { + "name": "Jailbreak", + "isMultiLevelFilter": false, + "source": "Prompt" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/ProtectedMaterialText", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "ProtectedMaterialText", + "properties": { + "name": "Protected Material Text", + "isMultiLevelFilter": false, + "source": "Completion" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/ProtectedMaterialCode", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "ProtectedMaterialCode", + "properties": { + "name": "Protected Material Code", + "isMultiLevelFilter": false, + "source": "Completion" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Profanity", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "Profanity", + "properties": { + "name": "Profanity", + "isMultiLevelFilter": false + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/IndirectAttack", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "IndirectAttack", + "properties": { + "name": "Indirect Attack", + "isMultiLevelFilter": false, + "source": "Prompt" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListRaiPolicies.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListRaiPolicies.json new file mode 100644 index 000000000000..dd8c19c3d76a --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListRaiPolicies.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "mode": "Asynchronous_filter", + "contentFilters": [ + { + "name": "hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "jailbreak", + "blocking": true, + "source": "Prompt", + "enabled": true + }, + { + "name": "protected_material_text", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "protected_material_code", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "profanity", + "blocking": true, + "source": "Prompt", + "enabled": true + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListSharedCommitmentPlanAssociations.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListSharedCommitmentPlanAssociations.json new file mode 100644 index 000000000000..f82064becb7c --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListSharedCommitmentPlanAssociations.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "resourceGroupName", + "commitmentPlanName": "commitmentPlanName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName/accountAssociations/accountAssociationName", + "name": "accountAssociationName", + "type": "Microsoft.CognitiveServices/commitmentPlans/accountAssociations", + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListSharedCommitmentPlansByResourceGroup.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListSharedCommitmentPlansByResourceGroup.json new file mode 100644 index 000000000000..3dd7eb611ef0 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListSharedCommitmentPlansByResourceGroup.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "SpeechServices", + "properties": { + "provisioningState": "Succeeded", + "hostingModel": "Web", + "planType": "STT", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListSharedCommitmentPlansBySubscription.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListSharedCommitmentPlansBySubscription.json new file mode 100644 index 000000000000..c7768694f612 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListSharedCommitmentPlansBySubscription.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "SpeechServices", + "properties": { + "provisioningState": "Succeeded", + "hostingModel": "Web", + "planType": "STT", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListSkus.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListSkus.json new file mode 100644 index 000000000000..60c406954c2e --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListSkus.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "accountName": "myAccount" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.CognitiveServices/accounts", + "sku": { + "name": "F0", + "tier": "Free" + } + }, + { + "resourceType": "Microsoft.CognitiveServices/accounts", + "sku": { + "name": "S0", + "tier": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListUsages.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListUsages.json new file mode 100644 index 000000000000..28049e0013e8 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListUsages.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "WestUS" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": { + "value": "AccountCount", + "localizedValue": "Cognitive Services total account limit" + }, + "currentValue": 3, + "limit": 200, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PurgeDeletedAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PurgeDeletedAccount.json new file mode 100644 index 000000000000..f39a0adf0611 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PurgeDeletedAccount.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "accountName": "PropTest01", + "location": "westus" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutCommitmentPlan.json new file mode 100644 index 000000000000..a92d4da7f0e9 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutCommitmentPlan.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "commitmentPlanName": "commitmentPlanName", + "commitmentPlan": { + "properties": { + "hostingModel": "Web", + "planType": "Speech2Text", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/accounts/commitmentPlans", + "properties": { + "hostingModel": "Web", + "planType": "Speech2Text", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/accounts/commitmentPlans", + "properties": { + "hostingModel": "Web", + "planType": "Speech2Text", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutDefenderForAISetting.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutDefenderForAISetting.json new file mode 100644 index 000000000000..46f63e3f4b2c --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutDefenderForAISetting.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "defenderForAISettingName": "Default", + "defenderForAISettings": { + "properties": { + "state": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "Default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"" + } + }, + "201": { + "body": { + "name": "Default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutDeployment.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutDeployment.json new file mode 100644 index 000000000000..d873fe80bab8 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutDeployment.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "deploymentName": "deploymentName", + "deployment": { + "sku": { + "name": "Standard", + "capacity": 1 + }, + "properties": { + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "properties": { + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1" + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "properties": { + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1" + }, + "provisioningState": "Accepted" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutEncryptionScope.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutEncryptionScope.json new file mode 100644 index 000000000000..29119d3d542d --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutEncryptionScope.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "encryptionScopeName": "encryptionScopeName", + "encryptionScope": { + "properties": { + "state": "Enabled", + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "DevKeyWestUS2", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "identityClientId": "00000000-0000-0000-0000-000000000000" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "encryptionScopeName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName", + "type": "Microsoft.CognitiveServices/accounts/encryptionScopes", + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2023-06-08T06:35:08.0662558Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-08T06:35:08.0662558Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "state": "Enabled", + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "DevKeyWestUS2", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "identityClientId": "00000000-0000-0000-0000-000000000000" + } + } + } + }, + "201": { + "body": { + "name": "encryptionScopeName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName", + "type": "Microsoft.CognitiveServices/accounts/encryptionScopes", + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2023-06-08T06:35:08.0662558Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-08T06:35:08.0662558Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "state": "Enabled", + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "DevKeyWestUS2", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "identityClientId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutPrivateEndpointConnection.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutPrivateEndpointConnection.json new file mode 100644 index 000000000000..fe98bc4475c8 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutPrivateEndpointConnection.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res7687", + "accountName": "sto9699", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2024-10-01", + "monitor": "true", + "properties": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.CognitiveServices/accounts/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + }, + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.CognitiveServices/accounts/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutRaiBlocklist.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutRaiBlocklist.json new file mode 100644 index 000000000000..c8fa7e0a3175 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutRaiBlocklist.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "raiBlocklistName", + "raiBlocklist": { + "properties": { + "description": "Basic blocklist description" + } + } + }, + "responses": { + "200": { + "body": { + "name": "raiBlocklistName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName", + "properties": { + "description": "Basic blocklist description" + } + } + }, + "201": { + "body": { + "name": "raiBlocklistName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiBlocklistName", + "properties": { + "description": "Basic blocklist description" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutRaiBlocklistItem.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutRaiBlocklistItem.json new file mode 100644 index 000000000000..8e0c37cd68e2 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutRaiBlocklistItem.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "raiBlocklistName", + "raiBlocklistItemName": "raiBlocklistItemName", + "raiBlocklistItem": { + "properties": { + "pattern": "Pattern To Block", + "isRegex": false + } + } + }, + "responses": { + "200": { + "body": { + "name": "raiBlocklistItemName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName", + "properties": { + "pattern": "Pattern To Block", + "isRegex": false + } + } + }, + "201": { + "body": { + "name": "raiBlocklistItemName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName", + "properties": { + "pattern": "Pattern To Block", + "isRegex": false + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutRaiPolicy.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutRaiPolicy.json new file mode 100644 index 000000000000..22c21e57e715 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/PutRaiPolicy.json @@ -0,0 +1,283 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiPolicyName": "raiPolicyName", + "raiPolicy": { + "properties": { + "basePolicyName": "Microsoft.Default", + "mode": "Asynchronous_filter", + "contentFilters": [ + { + "name": "hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "jailbreak", + "blocking": true, + "source": "Prompt", + "enabled": true + }, + { + "name": "protected_material_text", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "protected_material_code", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "profanity", + "blocking": true, + "source": "Prompt", + "enabled": true + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "mode": "Asynchronous_filter", + "contentFilters": [ + { + "name": "hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "jailbreak", + "blocking": true, + "source": "Prompt", + "enabled": true + }, + { + "name": "protected_material_text", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "protected_material_code", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "profanity", + "blocking": true, + "source": "Prompt", + "enabled": true + } + ] + } + } + }, + "201": { + "body": { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "mode": "Asynchronous_filter", + "contentFilters": [ + { + "name": "hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "jailbreak", + "blocking": true, + "source": "Prompt", + "enabled": true + }, + { + "name": "protected_material_text", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "protected_material_code", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "profanity", + "blocking": true, + "source": "Prompt", + "enabled": true + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ReconcileNetworkSecurityPerimeterConfigurations.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ReconcileNetworkSecurityPerimeterConfigurations.json new file mode 100644 index 000000000000..31a97de21191 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ReconcileNetworkSecurityPerimeterConfigurations.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "nspConfigurationName": "NSPConfigurationName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/networkSecurityPerimeterConfigurations", + "name": "networkSecurityPerimeterConfigurationName", + "type": "Microsoft.CognitiveServices/accounts/networkSecurityPerimeterConfigurations", + "properties": { + "provisioningState": "Succeeded", + "networkSecurityPerimeter": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.Network/networkSecurityPerimeters/perimeter", + "perimeterGuid": "00000000-0000-0000-0000-000000000000", + "location": "East US" + }, + "resourceAssociation": { + "name": "associationName", + "accessMode": "Enforced" + }, + "profile": { + "name": "profileName", + "accessRulesVersion": 1, + "accessRules": [ + { + "name": "ruleName", + "properties": { + "direction": "Inbound", + "addressPrefixes": [ + "148.0.0.0/8", + "152.4.6.0/24" + ] + } + } + ] + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/RegenerateKey.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/RegenerateKey.json new file mode 100644 index 000000000000..93d382c8a0cd --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/RegenerateKey.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "accountName": "myAccount", + "parameters": { + "keyName": "Key2" + } + }, + "responses": { + "200": { + "body": { + "key1": "KEY1", + "key2": "KEY2" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/UpdateAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/UpdateAccount.json new file mode 100644 index 000000000000..6aa0ed5b80b9 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/UpdateAccount.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "bvttest", + "accountName": "bingSearch", + "account": { + "location": "global", + "sku": { + "name": "S2" + } + } + }, + "responses": { + "200": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-10-01", + "azure-AsyncOperation": "http://azure.async.operation/status" + }, + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch", + "name": "bingSearch", + "type": "Microsoft.CognitiveServices/accounts", + "location": "global", + "sku": { + "name": "S2" + }, + "kind": "Bing.Search", + "etag": "W/\"datetime'2017-04-10T07%3A46%3A21.5618831Z'\"", + "properties": { + "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-10-01", + "azure-AsyncOperation": "http://azure.async.operation/status" + }, + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch", + "name": "bingSearch", + "type": "Microsoft.CognitiveServices/accounts", + "location": "global", + "sku": { + "name": "S2" + }, + "kind": "Bing.Search", + "etag": "W/\"datetime'2017-04-10T07%3A46%3A21.5618831Z'\"", + "properties": { + "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/UpdateDefenderForAISetting.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/UpdateDefenderForAISetting.json new file mode 100644 index 000000000000..b11fe00ea5f0 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/UpdateDefenderForAISetting.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "defenderForAISettingName": "Default", + "defenderForAISettings": { + "properties": { + "state": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "Default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/UpdateDeployment.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/UpdateDeployment.json new file mode 100644 index 000000000000..89cdecd8dbb5 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/UpdateDeployment.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "deploymentName": "deploymentName", + "deployment": { + "sku": { + "name": "Standard", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "properties": { + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1" + }, + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/UpdateSharedCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/UpdateSharedCommitmentPlan.json new file mode 100644 index 000000000000..d07346ae75d9 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/UpdateSharedCommitmentPlan.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "resourceGroupName", + "commitmentPlanName": "commitmentPlanName", + "commitmentPlan": { + "tags": { + "name": "value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "SpeechServices", + "properties": { + "provisioningState": "Succeeded", + "hostingModel": "Web", + "planType": "STT", + "autoRenew": true, + "current": { + "tier": "T1" + } + }, + "tags": { + "name": "value" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/readme.md b/specification/cognitiveservices/resource-manager/readme.md index fe067d66ac4a..a48b90750b70 100644 --- a/specification/cognitiveservices/resource-manager/readme.md +++ b/specification/cognitiveservices/resource-manager/readme.md @@ -30,10 +30,17 @@ These are the global settings for the CognitiveServices API. ``` yaml openapi-type: arm -tag: package-preview-2024-06 +tag: package-2024-10 ``` +### Tag: package-2024-10 +These settings apply only when `--tag=package-2024-10` is specified on the command line. +```yaml $(tag) == 'package-2024-10' +input-file: + - Microsoft.CognitiveServices/stable/2024-10-01/cognitiveservices.json +``` + ### Tag: package-preview-2024-06 These settings apply only when `--tag=package-preview-2024-06` is specified on the command line. From b01fe8aa1c723b3db4525b70678441b7cf9ee2ac Mon Sep 17 00:00:00 2001 From: Arthur Ma Date: Tue, 24 Sep 2024 15:05:04 +0800 Subject: [PATCH 02/48] Update client.tsp for ComputeSchedule (#30671) --- .../ComputeSchedule.Management/client.tsp | 75 +++++++++++++++++++ .../ComputeSchedule.Management/models.tsp | 12 +-- .../ComputeSchedule.Management/tspconfig.yaml | 5 ++ .../2024-08-15-preview/computeschedule.json | 10 ++- 4 files changed, 93 insertions(+), 9 deletions(-) diff --git a/specification/computeschedule/ComputeSchedule.Management/client.tsp b/specification/computeschedule/ComputeSchedule.Management/client.tsp index f92367c17dba..d8a451726e84 100644 --- a/specification/computeschedule/ComputeSchedule.Management/client.tsp +++ b/specification/computeschedule/ComputeSchedule.Management/client.tsp @@ -2,5 +2,80 @@ import "./main.tsp"; import "@azure-tools/typespec-client-generator-core"; using Azure.ClientGenerator.Core; +using Microsoft.ComputeSchedule; @@clientName(Microsoft.ComputeSchedule, "ComputeScheduleMgmt", "python"); + +@@clientName(ScheduledActions.virtualMachinesSubmitDeallocate, + "SubmitVirtualMachineDeallocate", + "csharp" +); +@@clientName(ScheduledActions.virtualMachinesSubmitHibernate, + "SubmitVirtualMachineHibernate", + "csharp" +); + +@@clientName(ScheduledActions.virtualMachinesSubmitStart, + "SubmitVirtualMachineStart", + "csharp" +); +@@clientName(ScheduledActions.virtualMachinesExecuteDeallocate, + "ExecuteVirtualMachineDeallocate", + "csharp" +); +@@clientName(ScheduledActions.virtualMachinesExecuteHibernate, + "ExecuteVirtualMachineHibernate", + "csharp" +); +@@clientName(ScheduledActions.virtualMachinesExecuteStart, + "ExecuteVirtualMachineStart", + "csharp" +); +@@clientName(ScheduledActions.virtualMachinesGetOperationStatus, + "GetVirtualMachineOperationStatus", + "csharp" +); +@@clientName(ScheduledActions.virtualMachinesCancelOperations, + "CancelVirtualMachineOperations", + "csharp" +); +@@clientName(ScheduledActions.virtualMachinesGetOperationErrors, + "GetVirtualMachineOperationErrors", + "csharp" +); + +@@clientName(CancelOperationsResponse, "CancelOperationsResult", "csharp"); +@@clientName(DeadlineType, "ScheduledActionDeadlineType", "csharp"); +@@clientName(DeallocateResourceOperationResponse, + "DeallocateResourceOperationResult", + "csharp" +); +@@clientName(DeallocateResourceOperationResponse.type, + "ResourceType", + "csharp" +); +@@clientName(ExecutionParameters, + "ScheduledActionExecutionParameterDetail", + "csharp" +); +@@clientName(GetOperationErrorsResponse, "GetOperationErrorsResult", "csharp"); +@@clientName(GetOperationStatusResponse, "GetOperationStatusResult", "csharp"); +@@clientName(HibernateResourceOperationResponse, + "HibernateResourceOperationResult", + "csharp" +); +@@clientName(HibernateResourceOperationResponse.type, "ResourceType", "csharp"); +@@clientName(OperationState, "ScheduledActionOperationState", "csharp"); +@@clientName(OptimizationPreference, + "ScheduledActionOptimizationPreference", + "csharp" +); +@@clientName(ResourceOperation, "ResourceOperationResult", "csharp"); +@@clientName(Resources, "UserRequestResources", "csharp"); +@@clientName(RetryPolicy, "UserRequestRetryPolicy", "csharp"); +@@clientName(Schedule, "UserRequestSchedule", "csharp"); +@@clientName(StartResourceOperationResponse, + "StartResourceOperationResult", + "csharp" +); +@@clientName(StartResourceOperationResponse.type, "ResourceType", "csharp"); diff --git a/specification/computeschedule/ComputeSchedule.Management/models.tsp b/specification/computeschedule/ComputeSchedule.Management/models.tsp index 164dd9a03641..a2b0ab895408 100644 --- a/specification/computeschedule/ComputeSchedule.Management/models.tsp +++ b/specification/computeschedule/ComputeSchedule.Management/models.tsp @@ -120,7 +120,7 @@ model Schedule { @doc("The resources needed for the user request") model Resources { @doc("The resource ids used for the request") - ids: Array; + ids: Array; } @doc("The retry policy for the user request") @@ -156,7 +156,7 @@ model ResourceOperationDetails { operationId: string; @doc("Unique identifier for the resource involved in the operation, eg ArmId") - resourceId: Azure.Core.armResourceIdentifier; + resourceId: armResourceIdentifier; @doc("Type of operation performed on the resources") opType: ResourceOperationType = ResourceOperationType.Unknown; @@ -191,7 +191,7 @@ model ResourceOperationDetails { @doc("High level response from an operation on a resource") model ResourceOperation { @doc("Unique identifier for the resource involved in the operation, eg ArmId") - resourceId?: Azure.Core.armResourceIdentifier; + resourceId?: armResourceIdentifier; @doc("Resource level error code if it exists") errorCode?: string; @@ -271,7 +271,7 @@ model DeallocateResourceOperationResponse { @doc("The location of the deallocate request eg westus") @visibility("read", "create") - location: string; + location: azureLocation; @extension("x-ms-identifiers", ["resourceId"]) @doc("The results from the deallocate request if no errors exist") @@ -304,7 +304,7 @@ model StartResourceOperationResponse { @doc("The location of the start request eg westus") @visibility("read", "create") - location: string; + location: azureLocation; @extension("x-ms-identifiers", ["resourceId"]) @doc("The results from the start request if no errors exist") @@ -337,7 +337,7 @@ model HibernateResourceOperationResponse { @doc("The location of the Hibernate request eg westus") @visibility("read", "create") - location: string; + location: azureLocation; @extension("x-ms-identifiers", ["resourceId"]) @doc("The results from the Hibernate request if no errors exist") diff --git a/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml b/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml index 713a5826ab6e..74029a03414b 100644 --- a/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml +++ b/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml @@ -15,6 +15,11 @@ options: generate-test: true generate-sample: true examples-dir: "{project-root}/examples" + "@azure-tools/typespec-csharp": + package-dir: "Azure.ResourceManager.ComputeSchedule" + flavor: azure + clear-output-folder: true + namespace: "{package-dir}" linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-08-15-preview/computeschedule.json b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-08-15-preview/computeschedule.json index e23760f86190..b55ad7f312ce 100644 --- a/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-08-15-preview/computeschedule.json +++ b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-08-15-preview/computeschedule.json @@ -562,6 +562,10 @@ } }, "definitions": { + "Azure.Core.azureLocation": { + "type": "string", + "description": "Represents an Azure geography region where supported resource providers live." + }, "CancelOperationsRequest": { "type": "object", "description": "This is the request to cancel running operations in scheduled actions using the operation ids", @@ -645,7 +649,7 @@ "description": "The type of resources used in the deallocate request eg virtual machines" }, "location": { - "type": "string", + "$ref": "#/definitions/Azure.Core.azureLocation", "description": "The location of the deallocate request eg westus", "x-ms-mutability": [ "read", @@ -840,7 +844,7 @@ "description": "The type of resources used in the Hibernate request eg virtual machines" }, "location": { - "type": "string", + "$ref": "#/definitions/Azure.Core.azureLocation", "description": "The location of the Hibernate request eg westus", "x-ms-mutability": [ "read", @@ -1391,7 +1395,7 @@ "description": "The type of resources used in the start request eg virtual machines" }, "location": { - "type": "string", + "$ref": "#/definitions/Azure.Core.azureLocation", "description": "The location of the start request eg westus", "x-ms-mutability": [ "read", From 4883fa5dbf6f2c9093fac8ce334547e9dfac68fa Mon Sep 17 00:00:00 2001 From: HE Xinyu Date: Tue, 24 Sep 2024 15:39:22 +0800 Subject: [PATCH 03/48] set default tag to latest API (#30640) --- specification/kubernetesruntime/resource-manager/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/kubernetesruntime/resource-manager/readme.md b/specification/kubernetesruntime/resource-manager/readme.md index 17b4c30b42d2..822f278b2a47 100644 --- a/specification/kubernetesruntime/resource-manager/readme.md +++ b/specification/kubernetesruntime/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the kubernetesruntime. ``` yaml openapi-type: arm openapi-subtype: rpaas -tag: package-preview-2023-10-01 +tag: package-2024-03-01 suppressions: - code: ConsistentPatchProperties From 004561fdc79afa4a5d28a1e9173bf7c6983784fc Mon Sep 17 00:00:00 2001 From: Weidong Xu Date: Tue, 24 Sep 2024 17:32:21 +0800 Subject: [PATCH 04/48] mgmt, java, mongocluster, unpin api-version (#30702) --- .../DocumentDB.MongoCluster.Management/tspconfig.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml b/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml index ccdb09b8afaa..f9a171843585 100644 --- a/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml +++ b/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml @@ -22,7 +22,6 @@ options: flavor: "azure" namespace: "com.azure.resourcemanager.mongocluster" service-name: "Mongo Cluster" - api-version: "2024-06-01-preview" "@azure-tools/typespec-go": service-dir: "sdk/resourcemanager/mongocluster" package-dir: "armmongocluster" From 7ec14d22272e95ba23e2dbaa969531448c4d7af6 Mon Sep 17 00:00:00 2001 From: Jaxel Rojas Date: Tue, 24 Sep 2024 08:30:44 -0400 Subject: [PATCH 05/48] refactor: renaming specifications to Azure.Developer.TrustedSigning (#30664) --- ...ofileOperations_GetSignRootCertificate.json | 0 ...cateProfileOperations_GetSigningStatus.json | 0 ...rofileOperations_ListExtendedKeyUsages.json | 0 .../CertificateProfileOperations_Sign.json | 0 .../TrustedSigning}/main.tsp | 18 +++++++++--------- .../TrustedSigning}/tspconfig.yaml | 16 ++++++++-------- .../azure.developer.trustedsigning.json} | 12 ++++++------ ...ofileOperations_GetSignRootCertificate.json | 0 ...cateProfileOperations_GetSigningStatus.json | 0 ...rofileOperations_ListExtendedKeyUsages.json | 0 .../CertificateProfileOperations_Sign.json | 0 .../data-plane/readme.md | 8 ++++---- 12 files changed, 27 insertions(+), 27 deletions(-) rename specification/{developersigning/DeveloperSigning => trustedsigning/TrustedSigning}/examples/2023-06-15-preview/CertificateProfileOperations_GetSignRootCertificate.json (100%) rename specification/{developersigning/DeveloperSigning => trustedsigning/TrustedSigning}/examples/2023-06-15-preview/CertificateProfileOperations_GetSigningStatus.json (100%) rename specification/{developersigning/DeveloperSigning => trustedsigning/TrustedSigning}/examples/2023-06-15-preview/CertificateProfileOperations_ListExtendedKeyUsages.json (100%) rename specification/{developersigning/DeveloperSigning => trustedsigning/TrustedSigning}/examples/2023-06-15-preview/CertificateProfileOperations_Sign.json (100%) rename specification/{developersigning/DeveloperSigning => trustedsigning/TrustedSigning}/main.tsp (90%) rename specification/{developersigning/DeveloperSigning => trustedsigning/TrustedSigning}/tspconfig.yaml (67%) rename specification/{developersigning/data-plane/Azure.Developer.Signing/preview/2023-06-15-preview/azure.developer.signing.json => trustedsigning/data-plane/Azure.Developer.TrustedSigning/preview/2023-06-15-preview/azure.developer.trustedsigning.json} (97%) rename specification/{developersigning/data-plane/Azure.Developer.Signing => trustedsigning/data-plane/Azure.Developer.TrustedSigning}/preview/2023-06-15-preview/examples/CertificateProfileOperations_GetSignRootCertificate.json (100%) rename specification/{developersigning/data-plane/Azure.Developer.Signing => trustedsigning/data-plane/Azure.Developer.TrustedSigning}/preview/2023-06-15-preview/examples/CertificateProfileOperations_GetSigningStatus.json (100%) rename specification/{developersigning/data-plane/Azure.Developer.Signing => trustedsigning/data-plane/Azure.Developer.TrustedSigning}/preview/2023-06-15-preview/examples/CertificateProfileOperations_ListExtendedKeyUsages.json (100%) rename specification/{developersigning/data-plane/Azure.Developer.Signing => trustedsigning/data-plane/Azure.Developer.TrustedSigning}/preview/2023-06-15-preview/examples/CertificateProfileOperations_Sign.json (100%) rename specification/{developersigning => trustedsigning}/data-plane/readme.md (74%) diff --git a/specification/developersigning/DeveloperSigning/examples/2023-06-15-preview/CertificateProfileOperations_GetSignRootCertificate.json b/specification/trustedsigning/TrustedSigning/examples/2023-06-15-preview/CertificateProfileOperations_GetSignRootCertificate.json similarity index 100% rename from specification/developersigning/DeveloperSigning/examples/2023-06-15-preview/CertificateProfileOperations_GetSignRootCertificate.json rename to specification/trustedsigning/TrustedSigning/examples/2023-06-15-preview/CertificateProfileOperations_GetSignRootCertificate.json diff --git a/specification/developersigning/DeveloperSigning/examples/2023-06-15-preview/CertificateProfileOperations_GetSigningStatus.json b/specification/trustedsigning/TrustedSigning/examples/2023-06-15-preview/CertificateProfileOperations_GetSigningStatus.json similarity index 100% rename from specification/developersigning/DeveloperSigning/examples/2023-06-15-preview/CertificateProfileOperations_GetSigningStatus.json rename to specification/trustedsigning/TrustedSigning/examples/2023-06-15-preview/CertificateProfileOperations_GetSigningStatus.json diff --git a/specification/developersigning/DeveloperSigning/examples/2023-06-15-preview/CertificateProfileOperations_ListExtendedKeyUsages.json b/specification/trustedsigning/TrustedSigning/examples/2023-06-15-preview/CertificateProfileOperations_ListExtendedKeyUsages.json similarity index 100% rename from specification/developersigning/DeveloperSigning/examples/2023-06-15-preview/CertificateProfileOperations_ListExtendedKeyUsages.json rename to specification/trustedsigning/TrustedSigning/examples/2023-06-15-preview/CertificateProfileOperations_ListExtendedKeyUsages.json diff --git a/specification/developersigning/DeveloperSigning/examples/2023-06-15-preview/CertificateProfileOperations_Sign.json b/specification/trustedsigning/TrustedSigning/examples/2023-06-15-preview/CertificateProfileOperations_Sign.json similarity index 100% rename from specification/developersigning/DeveloperSigning/examples/2023-06-15-preview/CertificateProfileOperations_Sign.json rename to specification/trustedsigning/TrustedSigning/examples/2023-06-15-preview/CertificateProfileOperations_Sign.json diff --git a/specification/developersigning/DeveloperSigning/main.tsp b/specification/trustedsigning/TrustedSigning/main.tsp similarity index 90% rename from specification/developersigning/DeveloperSigning/main.tsp rename to specification/trustedsigning/TrustedSigning/main.tsp index a582b5cfcb50..ee0c97e294bc 100644 --- a/specification/developersigning/DeveloperSigning/main.tsp +++ b/specification/trustedsigning/TrustedSigning/main.tsp @@ -17,10 +17,10 @@ using Azure.Core; ]> ) @service({ - title: "Azure Developer Signing", - summary: "Azure Developer Signing is a service that provides managed artifact signing for all.", + title: "Azure Trusted Signing", + summary: "Azure Trusted Signing is a service that provides managed artifact signing for all.", }) -@versioned(Azure.Developer.Signing.Versions) +@versioned(Azure.Developer.TrustedSigning.Versions) @server( "https://{region}.codesigning.azure.net/", "Sign and retrieve relevant information pertaining signing process.", @@ -29,8 +29,8 @@ using Azure.Core; region: string, } ) -@doc("Azure Developer Signing is a service that provides managed artifact signing for all.") -namespace Azure.Developer.Signing; +@doc("Azure Trusted Signing is a service that provides managed artifact signing for all.") +namespace Azure.Developer.TrustedSigning; @doc("Versions info.") enum Versions { @@ -110,22 +110,22 @@ union SignatureAlgorithm { "ES256K", } -@doc("Azure Developer Signing customer account created upon registration on the service.") +@doc("Azure Trusted Signing customer account created upon registration on the service.") @resource("codesigningaccounts") model SigningAccount { @key("accountName") @visibility("read", "update") - @doc("Azure Developer Signing account name.") + @doc("Azure Trusted Signing account name.") accountName: string; } -@doc("Azure Developer Signing certificate profile configured on an account.") +@doc("Azure Trusted Signing certificate profile configured on an account.") @resource("certificateprofiles") @parentResource(SigningAccount) model CertificateProfileName { @key("certificateProfile") @visibility("read", "update") - @doc("Azure Developer Signing certificate profile name under an account.") + @doc("Azure Trusted Signing certificate profile name under an account.") certificateProfile: string; } diff --git a/specification/developersigning/DeveloperSigning/tspconfig.yaml b/specification/trustedsigning/TrustedSigning/tspconfig.yaml similarity index 67% rename from specification/developersigning/DeveloperSigning/tspconfig.yaml rename to specification/trustedsigning/TrustedSigning/tspconfig.yaml index 6784f1bf3426..25463f0e28f1 100644 --- a/specification/developersigning/DeveloperSigning/tspconfig.yaml +++ b/specification/trustedsigning/TrustedSigning/tspconfig.yaml @@ -12,9 +12,9 @@ options: emit-lro-options: "none" emitter-output-dir: "{project-root}/.." omit-unreachable-types: true - output-file: "{azure-resource-provider-folder}/Azure.Developer.Signing/{version-status}/{version}/azure.developer.signing.json" + output-file: "{azure-resource-provider-folder}/Azure.Developer.TrustedSigning/{version-status}/{version}/azure.developer.trustedsigning.json" "@azure-tools/typespec-python": - package-dir: "azure-developer-signing" + package-dir: "azure-developer-trustedsigning" package-name: "{package-dir}" flavor: azure generate-test: true @@ -22,19 +22,19 @@ options: examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": clear-output-folder: true - package-dir: "Azure.Developer.Signing" + package-dir: "Azure.Developer.TrustedSigning" model-namespace: false namespace: "{package-dir}" flavor: azure "@azure-tools/typespec-ts": - package-dir: "azure-developer-signing-rest" + package-dir: "azure-developer-trustedsigning-rest" generateMetadata: true generateTest: true packageDetails: - name: "@azure-rest/developer-signing" - description: "Azure developer signing service" + name: "@azure-rest/developer-trusted signing" + description: "Azure trusted signing service" flavor: azure "@azure-tools/typespec-java": - package-dir: "azure-developer-signing" - namespace: "com.azure.developer.signing" + package-dir: "azure-developer-trusedsigning" + namespace: "com.azure.developer.trustedsigning" flavor: azure diff --git a/specification/developersigning/data-plane/Azure.Developer.Signing/preview/2023-06-15-preview/azure.developer.signing.json b/specification/trustedsigning/data-plane/Azure.Developer.TrustedSigning/preview/2023-06-15-preview/azure.developer.trustedsigning.json similarity index 97% rename from specification/developersigning/data-plane/Azure.Developer.Signing/preview/2023-06-15-preview/azure.developer.signing.json rename to specification/trustedsigning/data-plane/Azure.Developer.TrustedSigning/preview/2023-06-15-preview/azure.developer.trustedsigning.json index 3ad206e9823f..5e3ecef5afc2 100644 --- a/specification/developersigning/data-plane/Azure.Developer.Signing/preview/2023-06-15-preview/azure.developer.signing.json +++ b/specification/trustedsigning/data-plane/Azure.Developer.TrustedSigning/preview/2023-06-15-preview/azure.developer.trustedsigning.json @@ -1,9 +1,9 @@ { "swagger": "2.0", "info": { - "title": "Azure Developer Signing", + "title": "Azure Trusted Signing", "version": "2023-06-15-preview", - "description": "Azure Developer Signing is a service that provides managed artifact signing for all.", + "description": "Azure Trusted Signing is a service that provides managed artifact signing for all.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" @@ -63,14 +63,14 @@ { "name": "accountName", "in": "path", - "description": "Azure Developer Signing account name.", + "description": "Azure Trusted Signing account name.", "required": true, "type": "string" }, { "name": "certificateProfile", "in": "path", - "description": "Azure Developer Signing certificate profile name under an account.", + "description": "Azure Trusted Signing certificate profile name under an account.", "required": true, "type": "string" }, @@ -247,14 +247,14 @@ { "name": "accountName", "in": "path", - "description": "Azure Developer Signing account name.", + "description": "Azure Trusted Signing account name.", "required": true, "type": "string" }, { "name": "certificateProfile", "in": "path", - "description": "Azure Developer Signing certificate profile name under an account.", + "description": "Azure Trusted Signing certificate profile name under an account.", "required": true, "type": "string" } diff --git a/specification/developersigning/data-plane/Azure.Developer.Signing/preview/2023-06-15-preview/examples/CertificateProfileOperations_GetSignRootCertificate.json b/specification/trustedsigning/data-plane/Azure.Developer.TrustedSigning/preview/2023-06-15-preview/examples/CertificateProfileOperations_GetSignRootCertificate.json similarity index 100% rename from specification/developersigning/data-plane/Azure.Developer.Signing/preview/2023-06-15-preview/examples/CertificateProfileOperations_GetSignRootCertificate.json rename to specification/trustedsigning/data-plane/Azure.Developer.TrustedSigning/preview/2023-06-15-preview/examples/CertificateProfileOperations_GetSignRootCertificate.json diff --git a/specification/developersigning/data-plane/Azure.Developer.Signing/preview/2023-06-15-preview/examples/CertificateProfileOperations_GetSigningStatus.json b/specification/trustedsigning/data-plane/Azure.Developer.TrustedSigning/preview/2023-06-15-preview/examples/CertificateProfileOperations_GetSigningStatus.json similarity index 100% rename from specification/developersigning/data-plane/Azure.Developer.Signing/preview/2023-06-15-preview/examples/CertificateProfileOperations_GetSigningStatus.json rename to specification/trustedsigning/data-plane/Azure.Developer.TrustedSigning/preview/2023-06-15-preview/examples/CertificateProfileOperations_GetSigningStatus.json diff --git a/specification/developersigning/data-plane/Azure.Developer.Signing/preview/2023-06-15-preview/examples/CertificateProfileOperations_ListExtendedKeyUsages.json b/specification/trustedsigning/data-plane/Azure.Developer.TrustedSigning/preview/2023-06-15-preview/examples/CertificateProfileOperations_ListExtendedKeyUsages.json similarity index 100% rename from specification/developersigning/data-plane/Azure.Developer.Signing/preview/2023-06-15-preview/examples/CertificateProfileOperations_ListExtendedKeyUsages.json rename to specification/trustedsigning/data-plane/Azure.Developer.TrustedSigning/preview/2023-06-15-preview/examples/CertificateProfileOperations_ListExtendedKeyUsages.json diff --git a/specification/developersigning/data-plane/Azure.Developer.Signing/preview/2023-06-15-preview/examples/CertificateProfileOperations_Sign.json b/specification/trustedsigning/data-plane/Azure.Developer.TrustedSigning/preview/2023-06-15-preview/examples/CertificateProfileOperations_Sign.json similarity index 100% rename from specification/developersigning/data-plane/Azure.Developer.Signing/preview/2023-06-15-preview/examples/CertificateProfileOperations_Sign.json rename to specification/trustedsigning/data-plane/Azure.Developer.TrustedSigning/preview/2023-06-15-preview/examples/CertificateProfileOperations_Sign.json diff --git a/specification/developersigning/data-plane/readme.md b/specification/trustedsigning/data-plane/readme.md similarity index 74% rename from specification/developersigning/data-plane/readme.md rename to specification/trustedsigning/data-plane/readme.md index 3b101d3d2514..3718e88ae479 100644 --- a/specification/developersigning/data-plane/readme.md +++ b/specification/trustedsigning/data-plane/readme.md @@ -1,8 +1,8 @@ -# Azure.Developer.Signing +# Azure.Developer.TrustedSigning > see https://aka.ms/autorest -This is the AutoRest configuration file for Azure.Developer.Signing. +This is the AutoRest configuration file for Azure.Developer.TrustedSigning. ## Getting Started @@ -22,7 +22,7 @@ For other options on installation see [Installing AutoRest](https://aka.ms/autor ### Basic Information -These are the global settings for the Azure.Developer.Signing. +These are the global settings for the Azure.Developer.TrustedSigning. ```yaml openapi-type: data-plane @@ -35,7 +35,7 @@ These settings apply only when `--tag=2023-06-15-preview` is specified on the co ```yaml $(tag) == '2023-06-15-preview' input-file: - - Azure.Developer.Signing/preview/2023-06-15-preview/azure.developer.signing.json + - Azure.Developer.TrustedSigning/preview/2023-06-15-preview/azure.developer.trustedsigning.json ``` ## Suppression From 532af243218e8db373a44e332bcc037b5bbfd849 Mon Sep 17 00:00:00 2001 From: steve munk <33468793+stevemunk@users.noreply.github.com> Date: Tue, 24 Sep 2024 08:32:27 -0700 Subject: [PATCH 06/48] Creator retirement banners. (#30697) --- .../Creator/preview/2.0/featurestate.json | 8 ++++---- .../data-plane/Creator/preview/2.0/tileset.json | 2 +- .../preview/2023-03-01-preview/featurestate.json | 16 ++++++++-------- .../preview/2023-03-01-preview/routeset.json | 10 +++++----- .../preview/2023-03-01-preview/style.json | 10 +++++----- .../preview/2023-03-01-preview/tileset.json | 14 +++++++------- .../preview/2023-03-01-preview/wayfind.json | 2 +- 7 files changed, 31 insertions(+), 31 deletions(-) diff --git a/specification/maps/data-plane/Creator/preview/2.0/featurestate.json b/specification/maps/data-plane/Creator/preview/2.0/featurestate.json index 4b31d74653e2..e586658567ba 100644 --- a/specification/maps/data-plane/Creator/preview/2.0/featurestate.json +++ b/specification/maps/data-plane/Creator/preview/2.0/featurestate.json @@ -173,7 +173,7 @@ }, "get": { "summary": "Use to get a list of statesets.", - "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nSubmit List Statesets Request \n\nThe `List Statesets` API is an HTTP `GET` request used to return a list of existing statesets.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit List Statesets Request \n\nThe `List Statesets` API is an HTTP `GET` request used to return a list of existing statesets.", "operationId": "FeatureState_ListStatesets", "x-ms-examples": { "List all the previously created statesets": { @@ -208,7 +208,7 @@ "/featureStateSets/{statesetId}": { "put": { "summary": "Use to update the stateset style rules.", - "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nSubmit Update Stateset Request \n\nThe `Update Stateset` API is an HTTP `PUT` request used to update the stateset style rules of the specified stateset.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Update Stateset Request \n\nThe `Update Stateset` API is an HTTP `PUT` request used to update the stateset style rules of the specified stateset.", "operationId": "FeatureState_UpdateStateset", "x-ms-examples": { "Update stateset style rules with a statesetId": { @@ -246,7 +246,7 @@ }, "delete": { "summary": "Use to delete a stateset and its associated data.", - "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nSubmit Delete Request \n\nThe `Delete Stateset` API is an HTTP `DELETE` request used to delete the specified stateset and its associated data.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Delete Stateset Request \n\nThe `Delete Stateset` API is an HTTP `DELETE` request used to delete the specified stateset and its associated data.", "operationId": "FeatureState_DeleteStateset", "x-ms-examples": { "Delete an existing stateset": { @@ -310,7 +310,7 @@ "put": { "operationId": "FeatureState_UpdateStates", "summary": "Use to update the state of a feature.", - "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n Submit Update States Request \n\n The `Update States` API is a `PUT` request that allows the user to update the state of the specified feature in a given stateset.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Update States Request \n\n The `Update States` API is a `PUT` request that allows the user to update the state of the specified feature in a given stateset.", "x-ms-examples": { "Update the states of a feature": { "$ref": "./examples/featurestate/Featurestate_UpdateStates.json" diff --git a/specification/maps/data-plane/Creator/preview/2.0/tileset.json b/specification/maps/data-plane/Creator/preview/2.0/tileset.json index 24207bf8838c..85790fd25cdd 100644 --- a/specification/maps/data-plane/Creator/preview/2.0/tileset.json +++ b/specification/maps/data-plane/Creator/preview/2.0/tileset.json @@ -209,7 +209,7 @@ }, "delete": { "summary": "Use to delete a tileset.", - "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nn### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `tilesetId` of the tileset to delete.
\n\n#### Delete request \"Successful\"\n\nThe Tileset Delete API returns a HTTP `204 No Content` response with an empty body, if the tileset was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the tileset with the passed-in `tilesetId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Tileset Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `tilesetId` of the tileset to delete.\n\n#### Delete request \"Successful\"\n\nThe Tileset Delete API returns a HTTP `204 No Content` response with an empty body, if the tileset was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the tileset with the passed-in `tilesetId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Tileset Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", "operationId": "Tileset_Delete", "x-ms-examples": { "Delete a created tileset": { diff --git a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/featurestate.json b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/featurestate.json index b98252308f14..2f83d4722344 100644 --- a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/featurestate.json +++ b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/featurestate.json @@ -128,7 +128,7 @@ "/featureStateSets": { "post": { "summary": "Use to create a new stateset.", - "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator Feature State service retirement**\n>\n> The Azure Maps Creator [Feature State](/rest/api/maps-creator/feature-state) service is now deprecated and will be retired on 3/31/25. To avoid service disruptions, discontinue use of the Feature State services by 3/31/25. For information on real-time feature styling in Creator, see [Enhance your indoor maps with real-time map feature styling](https://techcommunity.microsoft.com/t5/azure-maps-blog/enhance-your-indoor-maps-with-real-time-map-feature-styling/ba-p/4048929).\n\nThe Feature State service allows the user to update the states of a feature and query them to be used in other services. The dynamic properties of a feature that don't belong to the dataset are referred to as *states* here.\n\nThis Feature State service pivot on the Stateset. Like Tileset, Stateset encapsulates the storage mechanism for feature states for a dataset.\n\nOnce the stateset is created, users can use that `statesetId` to post feature state updates and retrieve the current feature states. A feature can have only one state at a given point in time. \n\nFeature state is defined by the key name, value and the timestamp. When a feature state update is posted to Azure Maps, the state value gets updated only if the provided state's timestamp is later than the stored timestamp. \n\nAzure Maps MapControl provides a way to use these feature states to style the features. For more information, see the Render services [Get Map State Tile](/rest/api/maps/render/get-map-state-tile).\n\n### Submit Create Request\n\nThe `Create Stateset` API is an HTTP `POST` request used to create a new Stateset, defining the values and corresponding styles for its properties in the body of the request. For more information, see [Create a feature stateset](/azure/azure-maps/how-to-creator-feature-stateset).", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe Feature State service allows the user to update the states of a feature and query them to be used in other services. The dynamic properties of a feature that don't belong to the dataset are referred to as *states* here.\n\nThis Feature State service pivot on the Stateset. Like Tileset, Stateset encapsulates the storage mechanism for feature states for a dataset.\n\nOnce the stateset is created, users can use that `statesetId` to post feature state updates and retrieve the current feature states. A feature can have only one state at a given point in time. \n\nFeature state is defined by the key name, value and the timestamp. When a feature state update is posted to Azure Maps, the state value gets updated only if the provided state's timestamp is later than the stored timestamp. \n\nAzure Maps MapControl provides a way to use these feature states to style the features. For more information, see the Render services [Get Map State Tile](/rest/api/maps/render/get-map-state-tile).\n\n### Submit Create Request\n\nThe `Create Stateset` API is an HTTP `POST` request used to create a new Stateset, defining the values and corresponding styles for its properties in the body of the request. For more information, see [Create a feature stateset](/azure/azure-maps/how-to-creator-feature-stateset).", "operationId": "FeatureState_CreateStateset", "x-ms-examples": { "Create a new stateset with a datasetId": { @@ -172,7 +172,7 @@ }, "get": { "summary": "Use to get a list of statesets.", - "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator Feature State service retirement**\n>\n> The Azure Maps Creator [Feature State](/rest/api/maps-creator/feature-state) service is now deprecated and will be retired on 3/31/25. To avoid service disruptions, discontinue use of the Feature State services by 3/31/25. For information on real-time feature styling in Creator, see [Enhance your indoor maps with real-time map feature styling](https://techcommunity.microsoft.com/t5/azure-maps-blog/enhance-your-indoor-maps-with-real-time-map-feature-styling/ba-p/4048929).\n\n ### Submit List Statesets Request \n\n The `List Statesets` API is an HTTP `GET` request that returns a list of all existing statesets.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n ### Submit List Statesets Request \n\n The `List Statesets` API is an HTTP `GET` request that returns a list of all existing statesets.", "operationId": "FeatureState_ListStatesets", "x-ms-examples": { "List all the previously created statesets": { @@ -207,7 +207,7 @@ "/featureStateSets/{statesetId}": { "put": { "summary": "Use to update the stateset style rules.", - "description": "\n\n > [!NOTE]\n>\n> **Azure Maps Creator Feature State service retirement**\n>\n> The Azure Maps Creator [Feature State](/rest/api/maps-creator/feature-state) service is now deprecated and will be retired on 3/31/25. To avoid service disruptions, discontinue use of the Feature State services by 3/31/25. For information on real-time feature styling in Creator, see [Enhance your indoor maps with real-time map feature styling](https://techcommunity.microsoft.com/t5/azure-maps-blog/enhance-your-indoor-maps-with-real-time-map-feature-styling/ba-p/4048929).\n\n### Submit Update Stateset Request \n\nThe `Update Stateset` API is an HTTP `PUT` request used to update the stateset style rules of the specified stateset.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Update Stateset Request \n\nThe `Update Stateset` API is an HTTP `PUT` request used to update the stateset style rules of the specified stateset.", "operationId": "FeatureState_UpdateStateset", "x-ms-examples": { "Update stateset style rules with a statesetId": { @@ -245,7 +245,7 @@ }, "delete": { "summary": "Use to delete a stateset and its associated data.", - "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator Feature State service retirement**\n>\n> The Azure Maps Creator [Feature State](/rest/api/maps-creator/feature-state) service is now deprecated and will be retired on 3/31/25. To avoid service disruptions, discontinue use of the Feature State services by 3/31/25. For information on real-time feature styling in Creator, see [Enhance your indoor maps with real-time map feature styling](https://techcommunity.microsoft.com/t5/azure-maps-blog/enhance-your-indoor-maps-with-real-time-map-feature-styling/ba-p/4048929).\n\n### Submit Delete Stateset Request\n\n The `Delete Stateset` API is an HTTP `DELETE` request used to delete the specified stateset and its associated data.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Delete Stateset Request\n\n The `Delete Stateset` API is an HTTP `DELETE` request used to delete the specified stateset and its associated data.", "operationId": "FeatureState_DeleteStateset", "x-ms-examples": { "Delete an existing stateset": { @@ -274,7 +274,7 @@ }, "get": { "summary": "Use to retrieve stateset information.", - "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator Feature State service retirement**\n>\n> The Azure Maps Creator [Feature State](/rest/api/maps-creator/feature-state) service is now deprecated and will be retired on 3/31/25. To avoid service disruptions, discontinue use of the Feature State services by 3/31/25. For information on real-time feature styling in Creator, see [Enhance your indoor maps with real-time map feature styling](https://techcommunity.microsoft.com/t5/azure-maps-blog/enhance-your-indoor-maps-with-real-time-map-feature-styling/ba-p/4048929).\n\n### Submit Get Stateset Request\n\n The `Get Stateset` API is an HTTP `GET` request used to retrieve the specified stateset information, including the `datasetId` associated to the stateset, and its styles.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Get Stateset Request\n\n The `Get Stateset` API is an HTTP `GET` request used to retrieve the specified stateset information, including the `datasetId` associated to the stateset, and its styles.", "operationId": "FeatureState_GetStateset", "x-ms-examples": { "Get stateset information with a statesetId": { @@ -308,7 +308,7 @@ "/featureStateSets/{statesetId}/featureStates/{featureId}": { "put": { "summary": "Use to update the state of a feature.", - "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator Feature State service retirement**\n>\n> The Azure Maps Creator [Feature State](/rest/api/maps-creator/feature-state) service is now deprecated and will be retired on 3/31/25. To avoid service disruptions, discontinue use of the Feature State services by 3/31/25. For information on real-time feature styling in Creator, see [Enhance your indoor maps with real-time map feature styling](https://techcommunity.microsoft.com/t5/azure-maps-blog/enhance-your-indoor-maps-with-real-time-map-feature-styling/ba-p/4048929).\n\n ### Submit Update States Request \n\n The `Update States` API is a `PUT` request that allows the user to update the state of the specified feature in a given stateset.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Update States Request \n\n The `Update States` API is a `PUT` request that allows the user to update the state of the specified feature in a given stateset.", "operationId": "FeatureState_UpdateStates", "x-ms-examples": { "Update the states of a feature": { @@ -350,7 +350,7 @@ "delete": { "operationId": "FeatureState_DeleteState", "summary": "Use to delete state information.", - "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator Feature State service retirement**\n>\n> The Azure Maps Creator [Feature State](/rest/api/maps-creator/feature-state) service is now deprecated and will be retired on 3/31/25. To avoid service disruptions, discontinue use of the Feature State services by 3/31/25. For information on real-time feature styling in Creator, see [Enhance your indoor maps with real-time map feature styling](https://techcommunity.microsoft.com/t5/azure-maps-blog/enhance-your-indoor-maps-with-real-time-map-feature-styling/ba-p/4048929).\n\n ### Submit Delete State Request \n\n The `Delete State` API is an HTTP `DELETE` request is used to delete state information defined by the `stateKeyName` parameter for the specified feature as specified by the `featureId`.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n ### Submit Delete State Request \n\n The `Delete State` API is an HTTP `DELETE` request is used to delete state information defined by the `stateKeyName` parameter for the specified feature as specified by the `featureId`.", "x-ms-examples": { "Delete the given feature state": { "$ref": "./examples/featurestate/Featurestate_DeleteFeatureState.json" @@ -385,7 +385,7 @@ "get": { "operationId": "FeatureState_ListStates", "summary": "Use to get current state information.", - "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator Feature State service retirement**\n>\n> The Azure Maps Creator [Feature State](/rest/api/maps-creator/feature-state) service is now deprecated and will be retired on 3/31/25. To avoid service disruptions, discontinue use of the Feature State services by 3/31/25. For information on real-time feature styling in Creator, see [Enhance your indoor maps with real-time map feature styling](https://techcommunity.microsoft.com/t5/azure-maps-blog/enhance-your-indoor-maps-with-real-time-map-feature-styling/ba-p/4048929).\n\n ### Submit List States Request \n\n The `List States` API is an HTTP `GET` request that returns the current state information associated with the given feature in the specified stateset.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n ### Submit List States Request \n\n The `List States` API is an HTTP `GET` request that returns the current state information associated with the given feature in the specified stateset.", "x-ms-examples": { "Get the current states of a feature": { "$ref": "./examples/featurestate/Featurestate_ListStates.json" diff --git a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/routeset.json b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/routeset.json index 86e54b5611ad..f4c76599efec 100644 --- a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/routeset.json +++ b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/routeset.json @@ -186,7 +186,7 @@ "/routesets": { "post": { "summary": "Use to create a routeset.", - "description": "\n\nThe `Create` API is an HTTP `POST` request that allows the caller to create a routeset from a dataset. The routeset is a data structure consumed by the Azure Maps [Wayfinding](/rest/api/maps-creator/wayfinding) service to discover the shortest paths within a facility.\n\nThe Create Routeset API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDKs. See the [Creator for indoor maps](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article for an introduction to the Azure Maps Creator concepts and tools.\n\n### Submit Create Request\n\nTo create a routeset, make a `POST` request with an empty body. The dataset is used as the source of the routeset data, so the `datasetId` query parameter must be included.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Create` API is an HTTP `POST` request that allows the caller to create a routeset from a dataset. The routeset is a data structure consumed by the Azure Maps [Wayfinding](/rest/api/maps-creator/wayfinding) service to discover the shortest paths within a facility.\n\nThe Create Routeset API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDKs. See the [Creator for indoor maps](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article for an introduction to the Azure Maps Creator concepts and tools.\n\n### Submit Create Request\n\nTo create a routeset, make a `POST` request with an empty body. The dataset is used as the source of the routeset data, so the `datasetId` query parameter must be included.", "operationId": "Routeset_Create", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -222,7 +222,7 @@ }, "get": { "summary": "Use to get a list of routesets.", - "description": "\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDKs. See the [Creator for indoor maps](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article for an introduction to the Azure Maps Creator concepts and tools.\n\n### Submit List Request\n\nThe `List` API is an HTTP `GET` request that allows the caller to fetch a list of all routesets in the current Azure Maps Creator account.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDKs. See the [Creator for indoor maps](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article for an introduction to the Azure Maps Creator concepts and tools.\n\n### Submit List Request\n\nThe `List` API is an HTTP `GET` request that allows the caller to fetch a list of all routesets in the current Azure Maps Creator account.", "operationId": "Routeset_List", "x-ms-examples": { "Enumerate all routesets for a given subscription": { @@ -257,7 +257,7 @@ "/routesets/{routesetId}": { "get": { "summary": "Use to get the details of a routeset.", - "description": "\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDKs. See the [Creator for indoor maps](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article for an introduction to the Azure Maps Creator concepts and tools.\n\n### Submit Get Request\n\nThe `Get` API is an HTTP `GET` request that allows the caller to fetch the details of an existing routeset, specified by the `routesetId`.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDKs. See the [Creator for indoor maps](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article for an introduction to the Azure Maps Creator concepts and tools.\n\n### Submit Get Request\n\nThe `Get` API is an HTTP `GET` request that allows the caller to fetch the details of an existing routeset, specified by the `routesetId`.", "operationId": "Routeset_Get", "x-ms-examples": { "Get details for a previously created dataset": { @@ -289,7 +289,7 @@ }, "delete": { "summary": "Use to delete a routeset.", - "description": "\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDKs. See the [Creator for indoor maps](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article for an introduction to the Azure Maps Creator concepts and tools.\n\n### Submit Delete Request\n\nThe `Delete` API is an HTTP `DELETE` request sent with the `routesetId` of the routeset to delete.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDKs. See the [Creator for indoor maps](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article for an introduction to the Azure Maps Creator concepts and tools.\n\n### Submit Delete Request\n\nThe `Delete` API is an HTTP `DELETE` request sent with the `routesetId` of the routeset to delete.", "operationId": "Routeset_Delete", "x-ms-examples": { "Delete an existing routeset": { @@ -320,7 +320,7 @@ "/routesets/operations/{operationId}": { "get": { "summary": "Use to check the status of the routeset creation process.", - "description": "\n\nThe `Get Operation` API is an HTTP `GET` request used to check the status of the routeset creation process and retrieve the `routesetId`.\n\n### Submit Operations Request\n\nTo view the current progress of a routeset operation, you will use a `GET` request where the `operationId` given the path is the ID that represents the operation.\n\n### Operation Response\n\nWhile in progress, a `200-OK` http status code is returned with no extra headers. If the operation succeeds, a `200-OK` http status code is returned with the `Resource-Location` in the header.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Get Operation` API is an HTTP `GET` request used to check the status of the routeset creation process and retrieve the `routesetId`.\n\n### Submit Operations Request\n\nTo view the current progress of a routeset operation, you will use a `GET` request where the `operationId` given the path is the ID that represents the operation.\n\n### Operation Response\n\nWhile in progress, a `200-OK` http status code is returned with no extra headers. If the operation succeeds, a `200-OK` http status code is returned with the `Resource-Location` in the header.", "operationId": "Routeset_GetOperation", "x-ms-examples": { "Get the status of an operation which is still running": { diff --git a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/style.json b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/style.json index f4008f605904..996d040c24fb 100644 --- a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/style.json +++ b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/style.json @@ -102,7 +102,7 @@ "/styles": { "post": { "summary": "Use to create an Azure Maps style.", - "description": "\n\n## Submit Create Request\n\n The `Style Create` API is an HTTP `POST` request used to create an Azure Maps style by passing in either a JSON or ZIP file containing the style information. \n\nThe Create Style API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Create Request\n\n The `Style Create` API is an HTTP `POST` request used to create an Azure Maps style by passing in either a JSON or ZIP file containing the style information. \n\nThe Create Style API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", "operationId": "Style_Create", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -151,7 +151,7 @@ }, "get": { "summary": "Use to get a list of styles.", - "description": "\n\nThe `List` API is an HTTP `GET` request that allows the caller to fetch a list of all styles in the current Azure Maps Creator account. The default indoor style `microsoft-maps:indoor_2022-01-01` and `microsoft-maps:indoor_dark_2022-01-01` will not show in the list response. But you can still use it as your own style by the predefined alias.\n\n### Submit List Request", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `List` API is an HTTP `GET` request that allows the caller to fetch a list of all styles in the current Azure Maps Creator account. The default indoor style `microsoft-maps:indoor_2022-01-01` and `microsoft-maps:indoor_dark_2022-01-01` will not show in the list response. But you can still use it as your own style by the predefined alias.\n\n### Submit List Request", "operationId": "Style_List", "x-ms-examples": { "Get a list of all styles": { @@ -186,7 +186,7 @@ "/styles/{styleId}": { "get": { "summary": "Use to get details of a style.", - "description": "\n\n### Submit Get Request\n\nThe `Get` API is an HTTP `GET` request that allows the caller to fetch the details of an existing style by passing in the `styleId` or its [alias](). Get the two predefined default styles using the alias `microsoft-maps:indoor_2022-01-01` for indoor light and `microsoft-maps:indoor_dark_2022-01-01` for indoor dark.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Get Request\n\nThe `Get` API is an HTTP `GET` request that allows the caller to fetch the details of an existing style by passing in the `styleId` or its [alias](). Get the two predefined default styles using the alias `microsoft-maps:indoor_2022-01-01` for indoor light and `microsoft-maps:indoor_dark_2022-01-01` for indoor dark.", "operationId": "Style_Get", "x-ms-examples": { "Get the details for a single style": { @@ -229,7 +229,7 @@ }, "delete": { "summary": "Use to delete a style.", - "description": "\n\n### Submit Delete Request\n\n\n\nThe `Delete` API is an HTTP `DELETE` request that is used to delete the specified style, where the path will contain the `styleId` of the style to delete. \n\n#### Delete request \"Successful\"\n\nThe Style Delete API returns a HTTP `204 No Content` response with an empty body, if the style was deleted successfully. \n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the style with the passed-in `styleId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Style Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Delete Request\n\n\n\nThe `Delete` API is an HTTP `DELETE` request that is used to delete the specified style, where the path will contain the `styleId` of the style to delete. \n\n#### Delete request \"Successful\"\n\nThe Style Delete API returns a HTTP `204 No Content` response with an empty body, if the style was deleted successfully. \n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the style with the passed-in `styleId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Style Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", "operationId": "Style_Delete", "x-ms-examples": { "Delete a created style": { @@ -260,7 +260,7 @@ "/styles/operations/{operationId}": { "get": { "summary": "Use to check the status of the style creation process.", - "description": "\n\nThe `Get Operation` API is an HTTP `GET` request used to check the status of the style creation process and retrieve the `styletId`.\n\n### Submit Operations Request\n\nTo view the current progress of a style operation, you will use a `GET` request where the `operationId` given the path is the ID that represents the operation.\n\n### Operation Response\n\nWhile in progress, a `200-OK` http status code is returned with no extra headers. If the operation succeeds, a `200-OK` http status code is returned with the `Resource-Location` in the header.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Get Operation` API is an HTTP `GET` request used to check the status of the style creation process and retrieve the `styletId`.\n\n### Submit Operations Request\n\nTo view the current progress of a style operation, you will use a `GET` request where the `operationId` given the path is the ID that represents the operation.\n\n### Operation Response\n\nWhile in progress, a `200-OK` http status code is returned with no extra headers. If the operation succeeds, a `200-OK` http status code is returned with the `Resource-Location` in the header.", "operationId": "Style_GetOperation", "x-ms-examples": { "Get the status of an operation which is still running": { diff --git a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/tileset.json b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/tileset.json index 54bcf525868b..5bcd832d3cfa 100644 --- a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/tileset.json +++ b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/tileset.json @@ -102,7 +102,7 @@ "/tilesets": { "post": { "summary": "Use to create a tileset.", - "description": "\n\n The `Create` API is an HTTP `POST` request used to create a tileset from the specified dataset. For more information, see [Create a tileset](/azure/azure-maps/tutorial-creator-indoor-maps#create-a-tileset). A tileset contains a set of tiles that can be consumed using [Get Map Tile](/rest/api/maps/render/get-map-tile) to retrieve custom tiles. To create a dataset, use [Dataset Create](/rest/api/maps-creator/dataset/create). For an introduction to concepts and tools that apply to Azure Maps Creator, see [Creator for indoor maps](/azure/azure-maps/creator-indoor-maps)..\n\n## Submit Create Request\n\nTo create your tileset you will make a `POST` request with an empty body. The `datasetId` query parameter will be used as the source of the tileset data.\n\nThe Create Tileset API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n The `Create` API is an HTTP `POST` request used to create a tileset from the specified dataset. For more information, see [Create a tileset](/azure/azure-maps/tutorial-creator-indoor-maps#create-a-tileset). A tileset contains a set of tiles that can be consumed using [Get Map Tile](/rest/api/maps/render/get-map-tile) to retrieve custom tiles. To create a dataset, use [Dataset Create](/rest/api/maps-creator/dataset/create). For an introduction to concepts and tools that apply to Azure Maps Creator, see [Creator for indoor maps](/azure/azure-maps/creator-indoor-maps)..\n\n## Submit Create Request\n\nTo create your tileset you will make a `POST` request with an empty body. The `datasetId` query parameter will be used as the source of the tileset data.\n\nThe Create Tileset API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", "operationId": "Tileset_Create", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -147,7 +147,7 @@ }, "get": { "summary": "Use to get a list of tilesets.", - "description": "\n\n### Submit List Request\n\nThe `List` API is an HTTP `GET` request used to fetch a list of all existing tilesets.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit List Request\n\nThe `List` API is an HTTP `GET` request used to fetch a list of all existing tilesets.", "operationId": "Tileset_List", "x-ms-examples": { "Get a list of all tilesets": { @@ -182,7 +182,7 @@ "/tilesets/{tilesetId}": { "get": { "summary": "Use to get the details of a tileset.", - "description": "\n\n### Submit Get Request\n\nThe `Get` API is an HTTP `GET` request used to fetch the details of a tileset.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Get Request\n\nThe `Get` API is an HTTP `GET` request used to fetch the details of a tileset.", "operationId": "Tileset_Get", "x-ms-examples": { "Gets the details for a single tileset": { @@ -214,7 +214,7 @@ }, "delete": { "summary": "Use to delete a tileset.", - "description": "\n\n### Submit Delete Request\n\nThe `Delete` API is an HTTP `DELETE` request that is used to delete the specified tileset, where the path will contain the `tilesetId` of the tileset to delete.\n\n#### Delete request \"Successful\"\n\nThe Tileset Delete API returns a HTTP `204 No Content` response with an empty body, if the tileset was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the tileset with the passed-in `tilesetId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Tileset Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Delete Request\n\nThe `Delete` API is an HTTP `DELETE` request that is used to delete the specified tileset, where the path will contain the `tilesetId` of the tileset to delete.\n\n#### Delete request \"Successful\"\n\nThe Tileset Delete API returns a HTTP `204 No Content` response with an empty body, if the tileset was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the tileset with the passed-in `tilesetId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Tileset Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", "operationId": "Tileset_Delete", "x-ms-examples": { "Delete a created tileset": { @@ -245,7 +245,7 @@ "/tilesets:fetchConfiguration": { "get": { "summary": "Use to get a tileset configuration.", - "description": "\n\nThe Tileset `Get Configuration` request allows the caller to get a [tileset configuration](/rest/api/maps-creator/tileset/get-configuration#tilesetconfiguration) based on the dataset provided. The tileset configuration can then be used to create a custom tileset using [Tileset Create](/rest/api/maps-creator/tileset/create).\n\n Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDKs. For more information on concepts and tools that apply to Azure Maps Creator, see [Creator for indoor maps](/azure/azure-maps/creator-indoor-maps).\n\n### Submit Get Configuration Request\n\n The `Get Configuration` API is an HTTP `GET` request is used to get a tileset configuration based on the `datasetId.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe Tileset `Get Configuration` request allows the caller to get a [tileset configuration](/rest/api/maps-creator/tileset/get-configuration#tilesetconfiguration) based on the dataset provided. The tileset configuration can then be used to create a custom tileset using [Tileset Create](/rest/api/maps-creator/tileset/create).\n\n Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDKs. For more information on concepts and tools that apply to Azure Maps Creator, see [Creator for indoor maps](/azure/azure-maps/creator-indoor-maps).\n\n### Submit Get Configuration Request\n\n The `Get Configuration` API is an HTTP `GET` request is used to get a tileset configuration based on the `datasetId.", "operationId": "Tileset_GetConfiguration", "x-ms-examples": { "Gets the tileset configuration for a given dataset": { @@ -279,7 +279,7 @@ "/tilesets:validateConfiguration": { "post": { "summary": "Use to validate a tileset configuration.", - "description": "\n\n### Submit Validate Configuration Request\n\nThe `Validate Configuration` API is an HTTP `POST` request used to validate the specified [tileset configuration](/rest/api/maps-creator/tileset/validate-configuration#tilesetconfiguration) based on the provided `datasetId`.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Validate Configuration Request\n\nThe `Validate Configuration` API is an HTTP `POST` request used to validate the specified [tileset configuration](/rest/api/maps-creator/tileset/validate-configuration#tilesetconfiguration) based on the provided `datasetId`.", "operationId": "Tileset_ValidateConfiguration", "x-ms-examples": { "Validates the correctness of a tileset configuration": { @@ -322,7 +322,7 @@ "/tilesets/operations/{operationId}": { "get": { "summary": "Use to get the status of a tileset creation.", - "description": "\n\nThe `Get Operation` API is an HTTP `GET` request is used to check the status of the tileset creation process and retrieve the `tilesetId` value. The path is obtained from a call to [Tileset - Create](/rest/api/maps-creator/tilesets/create). While in progress, an HTTP 200 is returned with no extra headers. Once successfully completed an HTTP 200 is returned with a `Resource-Location` header. For more information, see [Check the status of tileset creation](/azure/azure-maps/tutorial-creator-indoor-maps#check-the-status-of-tileset-creation).", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Get Operation` API is an HTTP `GET` request is used to check the status of the tileset creation process and retrieve the `tilesetId` value. The path is obtained from a call to [Tileset - Create](/rest/api/maps-creator/tilesets/create). While in progress, an HTTP 200 is returned with no extra headers. Once successfully completed an HTTP 200 is returned with a `Resource-Location` header. For more information, see [Check the status of tileset creation](/azure/azure-maps/tutorial-creator-indoor-maps#check-the-status-of-tileset-creation).", "operationId": "Tileset_GetOperation", "x-ms-examples": { "Get the status of an operation which is still running": { diff --git a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/wayfind.json b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/wayfind.json index 1a842dad5517..c8ffc0b7e7bf 100644 --- a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/wayfind.json +++ b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/wayfind.json @@ -260,7 +260,7 @@ "/wayfinding/path": { "get": { "summary": "Use to calculate the best path between two locations within a facility.", - "description": "\n\n The Wayfinding Service is part of Creator, and adheres to the [Open Geospatial Consortium](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) standard. Wayfinding uses indoor map data from the [routeset](/rest/api/maps-creator/routeset) to calculate the best path between two locations within the same facility. For more information, see [Wayfinding](/azure/azure-maps/creator-indoor-maps#wayfinding-preview) in the _Creator for indoor maps_ concepts article.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe Wayfinding Service is part of Creator, and adheres to the [Open Geospatial Consortium](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) standard. Wayfinding uses indoor map data from the [routeset](/rest/api/maps-creator/routeset) to calculate the best path between two locations within the same facility. For more information, see [Wayfinding](/azure/azure-maps/creator-indoor-maps#wayfinding-preview) in the _Creator for indoor maps_ concepts article.", "operationId": "Wayfinding_GetPath", "x-ms-examples": { "Get the shortest path between two points in the facility.": { From 6d11bffac41f2c3b64216c7e8b045ca4134ce303 Mon Sep 17 00:00:00 2001 From: Andres Zourelli Date: Tue, 24 Sep 2024 11:49:20 -0400 Subject: [PATCH 07/48] [BugFix] Remove flatten property from SKU in preview resource ciamDirectories in Microsoft.AzureActiveDirectory (#30461) * remove flatten property * lint fix --- .../preview/2023-05-17-preview/externalIdentities.json | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json b/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json index ae016e86deae..98c64d2329b8 100644 --- a/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json +++ b/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json @@ -1534,7 +1534,6 @@ "create", "read" ], - "x-ms-client-flatten": true, "x-ms-enum": { "name": "CIAMResourceSKUTier", "modelAsString": true, From f999652ecea2a4bddc2b08a113617e23e98f10d4 Mon Sep 17 00:00:00 2001 From: Bryan Strassner Date: Tue, 24 Sep 2024 11:21:07 -0500 Subject: [PATCH 08/48] Microsoft.NetworkCloud 2024-07-01 stable (#30628) * Base of 2024-06-01-preview for 2024-07-01 stable * Microsoft.NetworkCloud 2024-07-01 stable version --------- Co-authored-by: Marina Bashtovaya --- .../examples/AgentPools_Create.json | 255 + .../examples/AgentPools_Delete.json | 17 + .../2024-07-01/examples/AgentPools_Get.json | 97 + .../AgentPools_ListByKubernetesCluster.json | 101 + .../2024-07-01/examples/AgentPools_Patch.json | 208 + .../BareMetalMachineKeySets_Create.json | 174 + .../BareMetalMachineKeySets_Delete.json | 17 + .../examples/BareMetalMachineKeySets_Get.json | 79 + ...BareMetalMachineKeySets_ListByCluster.json | 83 + .../BareMetalMachineKeySets_Patch.json | 170 + .../examples/BareMetalMachines_Cordon.json | 18 + .../examples/BareMetalMachines_Create.json | 225 + .../examples/BareMetalMachines_Delete.json | 16 + .../examples/BareMetalMachines_Get.json | 103 + ...BareMetalMachines_ListByResourceGroup.json | 107 + .../BareMetalMachines_ListBySubscription.json | 106 + .../examples/BareMetalMachines_Patch.json | 209 + .../examples/BareMetalMachines_PowerOff.json | 18 + .../examples/BareMetalMachines_Reimage.json | 15 + .../examples/BareMetalMachines_Replace.json | 25 + .../examples/BareMetalMachines_Restart.json | 15 + .../BareMetalMachines_RunCommand.json | 23 + .../BareMetalMachines_RunDataExtracts.json | 27 + .../BareMetalMachines_RunReadCommands.json | 35 + .../examples/BareMetalMachines_Start.json | 15 + .../examples/BareMetalMachines_Uncordon.json | 15 + .../examples/BmcKeySets_Create.json | 159 + .../examples/BmcKeySets_Delete.json | 17 + .../2024-07-01/examples/BmcKeySets_Get.json | 74 + .../examples/BmcKeySets_ListByCluster.json | 78 + .../2024-07-01/examples/BmcKeySets_Patch.json | 156 + .../CloudServicesNetworks_Create.json | 152 + .../CloudServicesNetworks_Delete.json | 16 + .../examples/CloudServicesNetworks_Get.json | 67 + ...dServicesNetworks_ListByResourceGroup.json | 71 + ...udServicesNetworks_ListBySubscription.json | 70 + .../examples/CloudServicesNetworks_Patch.json | 148 + .../examples/ClusterManagers_Create.json | 131 + .../examples/ClusterManagers_Create_Uami.json | 142 + .../examples/ClusterManagers_Delete.json | 16 + .../examples/ClusterManagers_Get.json | 60 + .../ClusterManagers_ListByResourceGroup.json | 64 + .../ClusterManagers_ListBySubscription.json | 63 + .../examples/ClusterManagers_Patch.json | 77 + .../ClusterMetricsConfigurations_Create.json | 108 + .../ClusterMetricsConfigurations_Delete.json | 17 + .../ClusterMetricsConfigurations_Get.json | 49 + ...erMetricsConfigurations_ListByCluster.json | 53 + .../ClusterMetricsConfigurations_Patch.json | 104 + .../Clusters_ContinueUpdateVersion.json | 18 + .../2024-07-01/examples/Clusters_Create.json | 547 + .../2024-07-01/examples/Clusters_Delete.json | 16 + .../2024-07-01/examples/Clusters_Deploy.json | 16 + .../Clusters_Deploy_SkipValidation.json | 20 + .../2024-07-01/examples/Clusters_Get.json | 203 + .../Clusters_ListByResourceGroup.json | 207 + .../examples/Clusters_ListBySubscription.json | 206 + ...atch_AggregatorOrSingleRackDefinition.json | 456 + .../Clusters_Patch_CommandOutput.json | 428 + .../examples/Clusters_Patch_Location.json | 409 + ..._Patch_RuntimeProtectionConfiguration.json | 411 + .../Clusters_Patch_SecretArchive.json | 412 + .../Clusters_Patch_UpdateStrategy.json | 415 + .../examples/Clusters_ScanRuntime.json | 18 + .../examples/Clusters_UpdateVersion.json | 18 + .../2024-07-01/examples/Consoles_Create.json | 104 + .../2024-07-01/examples/Consoles_Delete.json | 17 + .../2024-07-01/examples/Consoles_Get.json | 47 + .../Consoles_ListByVirtualMachine.json | 51 + .../2024-07-01/examples/Consoles_Patch.json | 100 + .../KubernetesClusterFeatures_Create.json | 97 + .../KubernetesClusterFeatures_Delete.json | 17 + .../KubernetesClusterFeatures_Get.json | 45 + ...usterFeatures_ListByKubernetesCluster.json | 48 + .../KubernetesClusterFeatures_Patch.json | 97 + .../examples/KubernetesClusters_Create.json | 798 + .../examples/KubernetesClusters_Delete.json | 16 + .../examples/KubernetesClusters_Get.json | 312 + ...ernetesClusters_L2LoadBalancer_Create.json | 711 + ...ubernetesClusters_ListByResourceGroup.json | 316 + ...KubernetesClusters_ListBySubscription.json | 314 + .../examples/KubernetesClusters_Patch.json | 644 + .../KubernetesClusters_RestartNode.json | 18 + .../examples/L2Networks_Create.json | 99 + .../examples/L2Networks_Delete.json | 16 + .../2024-07-01/examples/L2Networks_Get.json | 45 + .../L2Networks_ListByResourceGroup.json | 49 + .../L2Networks_ListBySubscription.json | 48 + .../2024-07-01/examples/L2Networks_Patch.json | 51 + .../examples/L3Networks_Create.json | 110 + .../examples/L3Networks_Delete.json | 16 + .../2024-07-01/examples/L3Networks_Get.json | 49 + .../L3Networks_ListByResourceGroup.json | 53 + .../L3Networks_ListBySubscription.json | 52 + .../2024-07-01/examples/L3Networks_Patch.json | 55 + .../2024-07-01/examples/Operations_List.json | 38 + .../2024-07-01/examples/RackSkus_Get.json | 107 + .../examples/RackSkus_ListBySubscription.json | 110 + .../2024-07-01/examples/Racks_Create.json | 98 + .../2024-07-01/examples/Racks_Delete.json | 16 + .../stable/2024-07-01/examples/Racks_Get.json | 44 + .../examples/Racks_ListByResourceGroup.json | 48 + .../examples/Racks_ListBySubscription.json | 47 + .../2024-07-01/examples/Racks_Patch.json | 92 + .../examples/StorageAppliances_Create.json | 150 + .../examples/StorageAppliances_Delete.json | 16 + ...liances_DisableRemoteVendorManagement.json | 15 + ...pliances_EnableRemoteVendorManagement.json | 20 + .../examples/StorageAppliances_Get.json | 68 + ...StorageAppliances_ListByResourceGroup.json | 72 + .../StorageAppliances_ListBySubscription.json | 71 + .../examples/StorageAppliances_Patch.json | 139 + .../examples/TrunkedNetworks_Create.json | 119 + .../examples/TrunkedNetworks_Delete.json | 16 + .../examples/TrunkedNetworks_Get.json | 52 + .../TrunkedNetworks_ListByResourceGroup.json | 56 + .../TrunkedNetworks_ListBySubscription.json | 55 + .../examples/TrunkedNetworks_Patch.json | 58 + .../examples/VirtualMachines_Create.json | 248 + .../examples/VirtualMachines_Delete.json | 16 + .../examples/VirtualMachines_Get.json | 96 + .../VirtualMachines_ListByResourceGroup.json | 100 + .../VirtualMachines_ListBySubscription.json | 99 + .../examples/VirtualMachines_Patch.json | 199 + .../examples/VirtualMachines_PowerOff.json | 18 + .../examples/VirtualMachines_Reimage.json | 15 + .../examples/VirtualMachines_Restart.json | 15 + .../examples/VirtualMachines_Start.json | 15 + .../2024-07-01/examples/Volumes_Create.json | 95 + .../2024-07-01/examples/Volumes_Delete.json | 16 + .../2024-07-01/examples/Volumes_Get.json | 44 + .../examples/Volumes_ListByResourceGroup.json | 48 + .../examples/Volumes_ListBySubscription.json | 47 + .../2024-07-01/examples/Volumes_Patch.json | 50 + .../stable/2024-07-01/networkcloud.json | 13441 ++++++++++++++++ .../networkcloud/resource-manager/readme.md | 29 +- 136 files changed, 28356 insertions(+), 2 deletions(-) create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_ListByKubernetesCluster.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachineKeySets_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachineKeySets_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachineKeySets_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachineKeySets_ListByCluster.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachineKeySets_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Cordon.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_ListByResourceGroup.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_PowerOff.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Reimage.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Replace.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Restart.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_RunCommand.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_RunDataExtracts.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_RunReadCommands.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Start.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Uncordon.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BmcKeySets_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BmcKeySets_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BmcKeySets_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BmcKeySets_ListByCluster.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BmcKeySets_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/CloudServicesNetworks_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/CloudServicesNetworks_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/CloudServicesNetworks_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/CloudServicesNetworks_ListByResourceGroup.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/CloudServicesNetworks_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/CloudServicesNetworks_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Create_Uami.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_ListByResourceGroup.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterMetricsConfigurations_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterMetricsConfigurations_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterMetricsConfigurations_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterMetricsConfigurations_ListByCluster.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterMetricsConfigurations_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_ContinueUpdateVersion.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Deploy.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Deploy_SkipValidation.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_ListByResourceGroup.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Patch_AggregatorOrSingleRackDefinition.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Patch_CommandOutput.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Patch_Location.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Patch_RuntimeProtectionConfiguration.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Patch_SecretArchive.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Patch_UpdateStrategy.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_ScanRuntime.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_UpdateVersion.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Consoles_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Consoles_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Consoles_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Consoles_ListByVirtualMachine.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Consoles_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusterFeatures_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusterFeatures_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusterFeatures_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusterFeatures_ListByKubernetesCluster.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusterFeatures_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_L2LoadBalancer_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_ListByResourceGroup.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_RestartNode.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L2Networks_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L2Networks_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L2Networks_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L2Networks_ListByResourceGroup.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L2Networks_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L2Networks_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L3Networks_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L3Networks_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L3Networks_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L3Networks_ListByResourceGroup.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L3Networks_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L3Networks_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Operations_List.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/RackSkus_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/RackSkus_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Racks_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Racks_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Racks_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Racks_ListByResourceGroup.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Racks_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Racks_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_DisableRemoteVendorManagement.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_EnableRemoteVendorManagement.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_ListByResourceGroup.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/TrunkedNetworks_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/TrunkedNetworks_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/TrunkedNetworks_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/TrunkedNetworks_ListByResourceGroup.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/TrunkedNetworks_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/TrunkedNetworks_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_ListByResourceGroup.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_PowerOff.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Reimage.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Restart.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Start.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Volumes_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Volumes_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Volumes_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Volumes_ListByResourceGroup.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Volumes_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Volumes_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/networkcloud.json diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_Create.json new file mode 100644 index 000000000000..42d3e07dc559 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_Create.json @@ -0,0 +1,255 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "agentPoolName": "agentPoolName", + "agentPoolParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_P46_224_v1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/agentPools", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_P46_224_v1", + "provisioningState": "Succeeded", + "kubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Agent pool is available" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/agentPools", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_P46_224_v1", + "provisioningState": "Accepted", + "kubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Agent pool is available" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_Delete.json new file mode 100644 index 000000000000..93068874e326 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "agentPoolName": "agentPoolName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_Get.json new file mode 100644 index 000000000000..23431d3e334e --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_Get.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "agentPoolName": "agentPoolName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/agentPools", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_P46_224_v1", + "provisioningState": "Succeeded", + "kubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Agent pool is available" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_ListByKubernetesCluster.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_ListByKubernetesCluster.json new file mode 100644 index 000000000000..910f8ec85e08 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_ListByKubernetesCluster.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/agentPools", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_P46_224_v1", + "provisioningState": "Succeeded", + "kubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Agent pool is available" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_Patch.json new file mode 100644 index 000000000000..594f5155ecd3 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/AgentPools_Patch.json @@ -0,0 +1,208 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "agentPoolName": "agentPoolName", + "agentPoolUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "administratorConfiguration": { + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "count": 3, + "upgradeSettings": { + "maxSurge": "1", + "maxUnavailable": "0", + "drainTimeout": 1800 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/agentPools", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_P46_224_v1", + "provisioningState": "Succeeded", + "kubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Agent pool is available" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/agentPools", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_P46_224_v1", + "provisioningState": "Accepted", + "kubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Agent pool is available" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachineKeySets_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachineKeySets_Create.json new file mode 100644 index 000000000000..61bbf83b8826 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachineKeySets_Create.json @@ -0,0 +1,174 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "bareMetalMachineKeySetName": "bareMetalMachineKeySetName", + "bareMetalMachineKeySetParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Standard", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "osGroupName": "standardAccessGroup", + "jumpHostsAllowed": [ + "192.0.2.1", + "192.0.2.5" + ], + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bareMetalMachineKeySets/bareMetalMachineKeySetName", + "name": "bareMetalMachineKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bareMetalMachineKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Standard", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "osGroupName": "standardAccessGroup", + "jumpHostsAllowed": [ + "192.0.2.1", + "192.0.2.5" + ], + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Succeeded", + "userListStatus": [ + { + "azureUserName": "userABC", + "status": "Active", + "statusMessage": "User has been provisioned" + }, + { + "azureUserName": "userXYZ", + "status": "Invalid", + "statusMessage": "User is not a valid Azure user" + } + ], + "lastValidation": "2022-12-12T12:00:00.008Z", + "detailedStatus": "SomeInvalid", + "detailedStatusMessage": "Invalid Azure user(s) were provided: userXYZ" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bareMetalMachineKeySets/bareMetalMachineKeySetName", + "name": "bareMetalMachineKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bareMetalMachineKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Standard", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "osGroupName": "standardAccessGroup", + "jumpHostsAllowed": [ + "192.0.2.1", + "192.0.2.5" + ], + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Accepted" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachineKeySets_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachineKeySets_Delete.json new file mode 100644 index 000000000000..44ad1af616c5 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachineKeySets_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "bareMetalMachineKeySetName": "bareMetalMachineKeySetName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachineKeySets_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachineKeySets_Get.json new file mode 100644 index 000000000000..92af571ee2a4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachineKeySets_Get.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "bareMetalMachineKeySetName": "bareMetalMachineKeySetName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bareMetalMachineKeySets/bareMetalMachineKeySetName", + "name": "bareMetalMachineKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bareMetalMachineKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Standard", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "osGroupName": "standardAccessGroup", + "jumpHostsAllowed": [ + "192.0.2.1", + "192.0.2.5" + ], + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Succeeded", + "userListStatus": [ + { + "azureUserName": "userABC", + "status": "Active", + "statusMessage": "User has been provisioned" + }, + { + "azureUserName": "userXYZ", + "status": "Invalid", + "statusMessage": "User is not a valid Azure user" + } + ], + "lastValidation": "2022-12-12T12:00:00.008Z", + "detailedStatus": "SomeInvalid", + "detailedStatusMessage": "Invalid Azure user(s) were provided: userXYZ" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachineKeySets_ListByCluster.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachineKeySets_ListByCluster.json new file mode 100644 index 000000000000..038a55ff9e4b --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachineKeySets_ListByCluster.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bareMetalMachineKeySets/bareMetalMachineKeySetName", + "name": "bareMetalMachineKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bareMetalMachineKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Standard", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "osGroupName": "standardAccessGroup", + "jumpHostsAllowed": [ + "192.0.2.1", + "192.0.2.5" + ], + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Succeeded", + "userListStatus": [ + { + "azureUserName": "userABC", + "status": "Active", + "statusMessage": "User has been provisioned" + }, + { + "azureUserName": "userXYZ", + "status": "Invalid", + "statusMessage": "User is not a valid Azure user" + } + ], + "lastValidation": "2022-12-12T12:00:00.008Z", + "detailedStatus": "SomeInvalid", + "detailedStatusMessage": "Invalid Azure user(s) were provided: userXYZ" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachineKeySets_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachineKeySets_Patch.json new file mode 100644 index 000000000000..61614a61458b --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachineKeySets_Patch.json @@ -0,0 +1,170 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "bareMetalMachineKeySetName": "bareMetalMachineKeySetName", + "bareMetalMachineKeySetUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "expiration": "2022-12-31T23:59:59.008Z", + "jumpHostsAllowed": [ + "192.0.2.1", + "192.0.2.5" + ], + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bareMetalMachineKeySets/bareMetalMachineKeySetName", + "name": "bareMetalMachineKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bareMetalMachineKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Standard", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "osGroupName": "standardAccessGroup", + "jumpHostsAllowed": [ + "192.0.2.1", + "192.0.2.5" + ], + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Succeeded", + "userListStatus": [ + { + "azureUserName": "userABC", + "status": "Active", + "statusMessage": "User has been provisioned" + }, + { + "azureUserName": "userXYZ", + "status": "Invalid", + "statusMessage": "User is not a valid Azure user" + } + ], + "lastValidation": "2022-12-12T12:00:00.008Z", + "detailedStatus": "SomeInvalid", + "detailedStatusMessage": "Invalid Azure user(s) were provided: userXYZ" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bareMetalMachineKeySets/bareMetalMachineKeySetName", + "name": "bareMetalMachineKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bareMetalMachineKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Standard", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "osGroupName": "standardAccessGroup", + "jumpHostsAllowed": [ + "192.0.2.1", + "192.0.2.5" + ], + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Accepted", + "lastValidation": "2022-12-12T12:00:00.008Z", + "detailedStatus": "SomeInvalid", + "detailedStatusMessage": "Invalid Azure user(s) were provided: userXYZ" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Cordon.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Cordon.json new file mode 100644 index 000000000000..40e994cda190 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Cordon.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName", + "bareMetalMachineCordonParameters": { + "evacuate": "True" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Create.json new file mode 100644 index 000000000000..787a22a4edd2 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Create.json @@ -0,0 +1,225 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName", + "bareMetalMachineParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "machineSkuId": "684E-3B16-399E", + "rackSlot": 1, + "machineName": "r01c001", + "bootMacAddress": "00:00:4e:00:58:af", + "bmcMacAddress": "00:00:4f:00:57:00", + "bmcCredentials": { + "username": "bmcuser", + "password": "{password}" + }, + "bmcConnectionString": "bmcconnectionstring", + "machineDetails": "User-provided machine details.", + "serialNumber": "BM1219XXX" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "name": "bareMetalMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/bareMetalMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "machineSkuId": "684E-3B16-399E", + "rackSlot": 1, + "machineName": "r01c001", + "bootMacAddress": "00:00:4e:00:58:af", + "bmcMacAddress": "00:00:4f:00:57:00", + "bmcCredentials": { + "username": "bmcuser" + }, + "bmcConnectionString": "bmcconnectionstring", + "machineDetails": "User-provided machine details.", + "serialNumber": "BM1219XXX", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "readyState": "True", + "cordonStatus": "Uncordoned", + "powerState": "On", + "hardwareInventory": { + "interfaces": [ + { + "name": "networkInterfaceName", + "macAddress": "2C:54:91:88:C9:E3", + "linkStatus": "Up", + "networkInterfaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" + } + ], + "additionalHostInformation": "Machine specific information..." + }, + "detailedStatus": "Available", + "detailedStatusMessage": "DetailedStatusMessage", + "serviceTag": "ST1219XXX", + "kubernetesNodeName": "node01", + "kubernetesVersion": "1.28.3", + "machineClusterVersion": "3.8.7", + "osImage": "v20220805e", + "oamIpv4Address": "192.0.2.1", + "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", + "hardwareValidationStatus": { + "result": "Pass", + "lastValidationTime": "2022-09-30T13:27:03.008Z" + }, + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "machineRoles": [ + "platform.afo-nc.microsoft.com/management-plane=true" + ], + "runtimeProtectionStatus": { + "scanScheduledTime": "2023-10-01T13:00:00.000Z", + "scanStartedTime": "2023-09-30T13:00:03.008Z", + "scanCompletedTime": "2023-09-30T13:27:23.103Z", + "definitionsLastUpdated": "2023-09-28T13:27:03.008Z", + "definitionsVersion": "1.2.3" + }, + "secretRotationStatus": [ + { + "secretType": "Bare Metal Machine Identity - console", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-console-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "name": "bareMetalMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/bareMetalMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "machineSkuId": "684E-3B16-399E", + "rackSlot": 1, + "machineName": "r01c001", + "bootMacAddress": "00:00:4e:00:58:af", + "bmcMacAddress": "00:00:4f:00:57:00", + "bmcCredentials": { + "username": "bmcuser" + }, + "bmcConnectionString": "bmcconnectionstring", + "machineDetails": "User-provided machine details.", + "serialNumber": "BM1219XXX", + "provisioningState": "Accepted", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "readyState": "True", + "cordonStatus": "Uncordoned", + "powerState": "On", + "hardwareInventory": { + "interfaces": [ + { + "name": "networkInterfaceName", + "macAddress": "2C:54:91:88:C9:E3", + "linkStatus": "Up", + "networkInterfaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" + } + ], + "additionalHostInformation": "Machine specific information..." + }, + "detailedStatus": "Available", + "detailedStatusMessage": "DetailedStatusMessage", + "serviceTag": "ST1219XXX", + "kubernetesNodeName": "node01", + "kubernetesVersion": "1.28.3", + "machineClusterVersion": "3.8.7", + "osImage": "v20220805e", + "oamIpv4Address": "192.0.2.1", + "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", + "hardwareValidationStatus": { + "result": "Pass", + "lastValidationTime": "2022-09-30T13:27:03.008Z" + }, + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "machineRoles": [ + "platform.afo-nc.microsoft.com/management-plane=true" + ], + "runtimeProtectionStatus": { + "scanScheduledTime": "2023-10-01T13:00:00.000Z", + "scanStartedTime": "2023-09-30T13:00:03.008Z", + "scanCompletedTime": "2023-09-30T13:27:23.103Z", + "definitionsLastUpdated": "2023-09-28T13:27:03.008Z", + "definitionsVersion": "1.2.3" + }, + "secretRotationStatus": [ + { + "secretType": "Bare Metal Machine Identity - console", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-console-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Delete.json new file mode 100644 index 000000000000..1f82bebf6de7 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Get.json new file mode 100644 index 000000000000..be243e59a52c --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Get.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "name": "bareMetalMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/bareMetalMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "machineSkuId": "684E-3B16-399E", + "rackSlot": 1, + "machineName": "r01c001", + "bootMacAddress": "00:00:4e:00:58:af", + "bmcMacAddress": "00:00:4f:00:57:00", + "bmcCredentials": { + "username": "bmcuser" + }, + "bmcConnectionString": "bmcconnectionstring", + "machineDetails": "User-provided machine details.", + "serialNumber": "BM1219XXX", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "readyState": "True", + "cordonStatus": "Uncordoned", + "powerState": "On", + "hardwareInventory": { + "interfaces": [ + { + "name": "networkInterfaceName", + "macAddress": "2C:54:91:88:C9:E3", + "linkStatus": "Up", + "networkInterfaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" + } + ], + "additionalHostInformation": "Machine specific information..." + }, + "detailedStatus": "Available", + "detailedStatusMessage": "DetailedStatusMessage", + "serviceTag": "ST1219XXX", + "kubernetesNodeName": "node01", + "kubernetesVersion": "1.28.3", + "machineClusterVersion": "3.8.7", + "osImage": "v20220805e", + "oamIpv4Address": "192.0.2.1", + "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", + "hardwareValidationStatus": { + "result": "Pass", + "lastValidationTime": "2022-09-30T13:27:03.008Z" + }, + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "machineRoles": [ + "platform.afo-nc.microsoft.com/management-plane=true" + ], + "runtimeProtectionStatus": { + "scanScheduledTime": "2023-10-01T13:00:00.000Z", + "scanStartedTime": "2023-09-30T13:00:03.008Z", + "scanCompletedTime": "2023-09-30T13:27:23.103Z", + "definitionsLastUpdated": "2023-09-28T13:27:03.008Z", + "definitionsVersion": "1.2.3" + }, + "secretRotationStatus": [ + { + "secretType": "Bare Metal Machine Identity - console", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-console-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ] + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_ListByResourceGroup.json new file mode 100644 index 000000000000..77b149339144 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_ListByResourceGroup.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "name": "bareMetalMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/bareMetalMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "machineSkuId": "684E-3B16-399E", + "rackSlot": 1, + "machineName": "r01c001", + "bootMacAddress": "00:00:4e:00:58:af", + "bmcMacAddress": "00:00:4f:00:57:00", + "bmcCredentials": { + "username": "bmcuser" + }, + "bmcConnectionString": "bmcconnectionstring", + "machineDetails": "User-provided machine details.", + "serialNumber": "BM1219XXX", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "readyState": "True", + "cordonStatus": "Uncordoned", + "powerState": "On", + "hardwareInventory": { + "interfaces": [ + { + "name": "networkInterfaceName", + "macAddress": "2C:54:91:88:C9:E3", + "linkStatus": "Up", + "networkInterfaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" + } + ], + "additionalHostInformation": "Machine specific information..." + }, + "detailedStatus": "Available", + "detailedStatusMessage": "DetailedStatusMessage", + "serviceTag": "ST1219XXX", + "kubernetesNodeName": "node01", + "kubernetesVersion": "1.28.3", + "machineClusterVersion": "3.8.7", + "osImage": "v20220805e", + "oamIpv4Address": "192.0.2.1", + "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", + "hardwareValidationStatus": { + "result": "Pass", + "lastValidationTime": "2022-09-30T13:27:03.008Z" + }, + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "machineRoles": [ + "platform.afo-nc.microsoft.com/management-plane=true" + ], + "runtimeProtectionStatus": { + "scanScheduledTime": "2023-10-01T13:00:00.000Z", + "scanStartedTime": "2023-09-30T13:00:03.008Z", + "scanCompletedTime": "2023-09-30T13:27:23.103Z", + "definitionsLastUpdated": "2023-09-28T13:27:03.008Z", + "definitionsVersion": "1.2.3" + }, + "secretRotationStatus": [ + { + "secretType": "Bare Metal Machine Identity - console", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-console-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ] + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_ListBySubscription.json new file mode 100644 index 000000000000..bd1df1caa894 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_ListBySubscription.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "name": "bareMetalMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/bareMetalMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "machineSkuId": "684E-3B16-399E", + "rackSlot": 1, + "machineName": "r01c001", + "bootMacAddress": "00:00:4e:00:58:af", + "bmcMacAddress": "00:00:4f:00:57:00", + "bmcCredentials": { + "username": "bmcuser" + }, + "bmcConnectionString": "bmcconnectionstring", + "machineDetails": "User-provided machine details.", + "serialNumber": "BM1219XXX", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "readyState": "True", + "cordonStatus": "Uncordoned", + "powerState": "On", + "hardwareInventory": { + "interfaces": [ + { + "name": "networkInterfaceName", + "macAddress": "2C:54:91:88:C9:E3", + "linkStatus": "Up", + "networkInterfaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" + } + ], + "additionalHostInformation": "Machine specific information..." + }, + "detailedStatus": "Available", + "detailedStatusMessage": "DetailedStatusMessage", + "serviceTag": "ST1219XXX", + "kubernetesNodeName": "node01", + "kubernetesVersion": "1.28.3", + "machineClusterVersion": "3.8.7", + "osImage": "v20220805e", + "oamIpv4Address": "192.0.2.1", + "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", + "hardwareValidationStatus": { + "result": "Pass", + "lastValidationTime": "2022-09-30T13:27:03.008Z" + }, + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "machineRoles": [ + "platform.afo-nc.microsoft.com/management-plane=true" + ], + "runtimeProtectionStatus": { + "scanScheduledTime": "2023-10-01T13:00:00.000Z", + "scanStartedTime": "2023-09-30T13:00:03.008Z", + "scanCompletedTime": "2023-09-30T13:27:23.103Z", + "definitionsLastUpdated": "2023-09-28T13:27:03.008Z", + "definitionsVersion": "1.2.3" + }, + "secretRotationStatus": [ + { + "secretType": "Bare Metal Machine Identity - console", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-console-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ] + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Patch.json new file mode 100644 index 000000000000..0322286e661a --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Patch.json @@ -0,0 +1,209 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName", + "bareMetalMachineUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "machineDetails": "machinedetails" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "name": "bareMetalMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/bareMetalMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "machineSkuId": "684E-3B16-399E", + "rackSlot": 1, + "machineName": "r01c001", + "bootMacAddress": "00:00:4e:00:58:af", + "bmcMacAddress": "00:00:4f:00:57:00", + "bmcCredentials": { + "username": "bmcuser" + }, + "bmcConnectionString": "bmcconnectionstring", + "machineDetails": "User-provided machine details.", + "serialNumber": "BM1219XXX", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "readyState": "True", + "cordonStatus": "Uncordoned", + "powerState": "On", + "hardwareInventory": { + "interfaces": [ + { + "name": "networkInterfaceName", + "macAddress": "2C:54:91:88:C9:E3", + "linkStatus": "Up", + "networkInterfaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" + } + ], + "additionalHostInformation": "Machine specific information..." + }, + "detailedStatus": "Available", + "detailedStatusMessage": "DetailedStatusMessage", + "serviceTag": "ST1219XXX", + "kubernetesNodeName": "node01", + "kubernetesVersion": "1.28.3", + "machineClusterVersion": "3.8.7", + "osImage": "v20220805e", + "oamIpv4Address": "192.0.2.1", + "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", + "hardwareValidationStatus": { + "result": "Pass", + "lastValidationTime": "2022-09-30T13:27:03.008Z" + }, + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "machineRoles": [ + "platform.afo-nc.microsoft.com/management-plane=true" + ], + "runtimeProtectionStatus": { + "scanScheduledTime": "2023-10-01T13:00:00.000Z", + "scanStartedTime": "2023-09-30T13:00:03.008Z", + "scanCompletedTime": "2023-09-30T13:27:23.103Z", + "definitionsLastUpdated": "2023-09-28T13:27:03.008Z", + "definitionsVersion": "1.2.3" + }, + "secretRotationStatus": [ + { + "secretType": "Bare Metal Machine Identity - console", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-console-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ] + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "name": "bareMetalMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/bareMetalMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "machineSkuId": "684E-3B16-399E", + "rackSlot": 1, + "machineName": "r01c001", + "bootMacAddress": "00:00:4e:00:58:af", + "bmcMacAddress": "00:00:4f:00:57:00", + "bmcCredentials": { + "username": "bmcuser" + }, + "bmcConnectionString": "bmcconnectionstring", + "machineDetails": "User-provided machine details.", + "serialNumber": "BM1219XXX", + "provisioningState": "Accepted", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "readyState": "True", + "cordonStatus": "Uncordoned", + "powerState": "On", + "hardwareInventory": { + "interfaces": [ + { + "name": "networkInterfaceName", + "macAddress": "2C:54:91:88:C9:E3", + "linkStatus": "Up", + "networkInterfaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" + } + ], + "additionalHostInformation": "Machine specific information..." + }, + "detailedStatus": "Available", + "detailedStatusMessage": "DetailedStatusMessage", + "serviceTag": "ST1219XXX", + "kubernetesNodeName": "node01", + "kubernetesVersion": "1.28.3", + "machineClusterVersion": "3.8.7", + "osImage": "v20220805e", + "oamIpv4Address": "192.0.2.1", + "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", + "hardwareValidationStatus": { + "result": "Pass", + "lastValidationTime": "2022-09-30T13:27:03.008Z" + }, + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "machineRoles": [ + "platform.afo-nc.microsoft.com/management-plane=true" + ], + "runtimeProtectionStatus": { + "scanScheduledTime": "2023-10-01T13:00:00.000Z", + "scanStartedTime": "2023-09-30T13:00:03.008Z", + "scanCompletedTime": "2023-09-30T13:27:23.103Z", + "definitionsLastUpdated": "2023-09-28T13:27:03.008Z", + "definitionsVersion": "1.2.3" + }, + "secretRotationStatus": [ + { + "secretType": "Bare Metal Machine Identity - console", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-console-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_PowerOff.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_PowerOff.json new file mode 100644 index 000000000000..7e5a4e590463 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_PowerOff.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName", + "bareMetalMachinePowerOffParameters": { + "skipShutdown": "True" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Reimage.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Reimage.json new file mode 100644 index 000000000000..c3a14029caa4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Reimage.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Replace.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Replace.json new file mode 100644 index 000000000000..ac2b7f5aecf4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Replace.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName", + "bareMetalMachineReplaceParameters": { + "bootMacAddress": "00:00:4e:00:58:af", + "bmcCredentials": { + "username": "bmcuser", + "password": "{password}" + }, + "serialNumber": "BM1219XXX", + "bmcMacAddress": "00:00:4f:00:57:ad", + "machineName": "name" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Restart.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Restart.json new file mode 100644 index 000000000000..c3a14029caa4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Restart.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_RunCommand.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_RunCommand.json new file mode 100644 index 000000000000..f903d4fa9d8b --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_RunCommand.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName", + "bareMetalMachineRunCommandParameters": { + "script": "cHdkCg==", + "arguments": [ + "--argument1", + "argument2" + ], + "limitTimeSeconds": 60 + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_RunDataExtracts.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_RunDataExtracts.json new file mode 100644 index 000000000000..6675fc063055 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_RunDataExtracts.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName", + "bareMetalMachineRunDataExtractsParameters": { + "commands": [ + { + "command": "hardware-support-data-collection", + "arguments": [ + "SysInfo", + "TTYLog" + ] + } + ], + "limitTimeSeconds": 60 + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_RunReadCommands.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_RunReadCommands.json new file mode 100644 index 000000000000..fbeab1a0d3b7 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_RunReadCommands.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName", + "bareMetalMachineRunReadCommandsParameters": { + "commands": [ + { + "command": "kubectl get", + "arguments": [ + "pods", + "-A" + ] + }, + { + "command": "ping", + "arguments": [ + "192.168.0.99", + "-c", + "3" + ] + } + ], + "limitTimeSeconds": 60 + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Start.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Start.json new file mode 100644 index 000000000000..c3a14029caa4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Start.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Uncordon.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Uncordon.json new file mode 100644 index 000000000000..c3a14029caa4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Uncordon.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BmcKeySets_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BmcKeySets_Create.json new file mode 100644 index 000000000000..cd06a0436113 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BmcKeySets_Create.json @@ -0,0 +1,159 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "bmcKeySetName": "bmcKeySetName", + "bmcKeySetParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Administrator", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName", + "name": "bmcKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bmcKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Administrator", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userXYZ@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Succeeded", + "userListStatus": [ + { + "azureUserName": "userABC", + "status": "Active", + "statusMessage": "User has been provisioned" + }, + { + "azureUserName": "userXYZ", + "status": "Invalid", + "statusMessage": "User is not a valid Azure user" + } + ], + "lastValidation": "2022-12-12T12:00:00.008Z", + "detailedStatus": "SomeInvalid", + "detailedStatusMessage": "Invalid Azure user(s) were provided: userXYZ" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName", + "name": "bmcKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bmcKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Administrator", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userXYZ@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Accepted" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BmcKeySets_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BmcKeySets_Delete.json new file mode 100644 index 000000000000..a8e48135fba6 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BmcKeySets_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "bmcKeySetName": "bmcKeySetName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BmcKeySets_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BmcKeySets_Get.json new file mode 100644 index 000000000000..29d76ee5a02a --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BmcKeySets_Get.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "bmcKeySetName": "bmcKeySetName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName", + "name": "bmcKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bmcKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Administrator", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userXYZ@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Succeeded", + "userListStatus": [ + { + "azureUserName": "userABC", + "status": "Active", + "statusMessage": "User has been provisioned" + }, + { + "azureUserName": "userXYZ", + "status": "Invalid", + "statusMessage": "User is not a valid Azure user" + } + ], + "lastValidation": "2022-12-12T12:00:00.008Z", + "detailedStatus": "SomeInvalid", + "detailedStatusMessage": "Invalid Azure user(s) were provided: userXYZ" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BmcKeySets_ListByCluster.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BmcKeySets_ListByCluster.json new file mode 100644 index 000000000000..eaa0dd2970ef --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BmcKeySets_ListByCluster.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName", + "name": "bmcKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bmcKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Administrator", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userXYZ@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Succeeded", + "userListStatus": [ + { + "azureUserName": "userABC", + "status": "Active", + "statusMessage": "User has been provisioned" + }, + { + "azureUserName": "userXYZ", + "status": "Invalid", + "statusMessage": "User is not a valid Azure user" + } + ], + "lastValidation": "2022-12-12T12:00:00.008Z", + "detailedStatus": "SomeInvalid", + "detailedStatusMessage": "Invalid Azure user(s) were provided: userXYZ" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BmcKeySets_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BmcKeySets_Patch.json new file mode 100644 index 000000000000..7db7afad61b1 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BmcKeySets_Patch.json @@ -0,0 +1,156 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "bmcKeySetName": "bmcKeySetName", + "bmcKeySetUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "expiration": "2022-12-31T23:59:59.008Z", + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName", + "name": "bmcKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bmcKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Administrator", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userXYZ@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Succeeded", + "userListStatus": [ + { + "azureUserName": "userABC", + "status": "Active", + "statusMessage": "User has been provisioned" + }, + { + "azureUserName": "userXYZ", + "status": "Invalid", + "statusMessage": "User is not a valid Azure user" + } + ], + "lastValidation": "2022-12-12T12:00:00.008Z", + "detailedStatus": "SomeInvalid", + "detailedStatusMessage": "Invalid Azure user(s) were provided: userXYZ" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName", + "name": "bmcKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bmcKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Administrator", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userXYZ@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Accepted", + "lastValidation": "2022-12-12T12:00:00.008Z", + "detailedStatus": "SomeInvalid", + "detailedStatusMessage": "Invalid Azure user(s) were provided: userXYZ" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/CloudServicesNetworks_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/CloudServicesNetworks_Create.json new file mode 100644 index 000000000000..0996783851e4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/CloudServicesNetworks_Create.json @@ -0,0 +1,152 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "cloudServicesNetworkName": "cloudServicesNetworkName", + "cloudServicesNetworkParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "name": "cloudServicesNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/cloudServicesNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False", + "provisioningState": "Succeeded", + "interfaceName": "eth0", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "enabledEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Cloud services network is up" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "name": "cloudServicesNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/cloudServicesNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False", + "provisioningState": "Succeeded", + "interfaceName": "eth0", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "enabledEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Cloud services network is up" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/CloudServicesNetworks_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/CloudServicesNetworks_Delete.json new file mode 100644 index 000000000000..0e8cbe960b84 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/CloudServicesNetworks_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "cloudServicesNetworkName": "cloudServicesNetworkName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/CloudServicesNetworks_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/CloudServicesNetworks_Get.json new file mode 100644 index 000000000000..dfdbea3c3c03 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/CloudServicesNetworks_Get.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "cloudServicesNetworkName": "cloudServicesNetworkName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "name": "cloudServicesNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/cloudServicesNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False", + "provisioningState": "Succeeded", + "interfaceName": "eth0", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "enabledEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Cloud services network is up" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/CloudServicesNetworks_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/CloudServicesNetworks_ListByResourceGroup.json new file mode 100644 index 000000000000..2eeacf49c92a --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/CloudServicesNetworks_ListByResourceGroup.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "name": "cloudServicesNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/cloudServicesNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False", + "provisioningState": "Succeeded", + "interfaceName": "eth0", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "enabledEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Cloud services network is up" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/CloudServicesNetworks_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/CloudServicesNetworks_ListBySubscription.json new file mode 100644 index 000000000000..8cc717091c5e --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/CloudServicesNetworks_ListBySubscription.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "name": "cloudServicesNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/cloudServicesNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False", + "provisioningState": "Succeeded", + "interfaceName": "eth0", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "enabledEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Cloud services network is up" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/CloudServicesNetworks_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/CloudServicesNetworks_Patch.json new file mode 100644 index 000000000000..a9b0c58f40e1 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/CloudServicesNetworks_Patch.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "cloudServicesNetworkName": "cloudServicesNetworkName", + "cloudServicesNetworkUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "name": "cloudServicesNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/cloudServicesNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False", + "provisioningState": "Succeeded", + "interfaceName": "eth0", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "enabledEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Cloud services network is up" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "name": "cloudServicesNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/cloudServicesNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False", + "provisioningState": "Accepted", + "interfaceName": "eth0", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "enabledEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Cloud services network is up" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Create.json new file mode 100644 index 000000000000..bac18e2c7bec --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Create.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterManagerName": "clusterManagerName", + "clusterManagerParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "name": "clusterManagerName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusterManagers", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "identity": { + "principalId": "321e7654-e89b-12d3-a456-426655449999", + "tenantId": "199e9999-e89b-12d3-a456-426655441111", + "type": "SystemAssigned" + }, + "properties": { + "managerExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterVersions": [ + { + "targetClusterVersion": "1.0.0", + "supportExpiryDate": "2023-04-29" + }, + { + "targetClusterVersion": "1.0.2", + "supportExpiryDate": "2025-01-01" + } + ], + "provisioningState": "Accepted", + "detailedStatus": "Available", + "detailedStatusMessage": "cluster manager is up and running", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "name": "clusterManagerName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusterManagers", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "identity": { + "principalId": "321e7654-e89b-12d3-a456-426655449999", + "tenantId": "199e9999-e89b-12d3-a456-426655441111", + "type": "SystemAssigned" + }, + "properties": { + "managerExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterVersions": [ + { + "targetClusterVersion": "1.0.0", + "supportExpiryDate": "2023-04-29" + }, + { + "targetClusterVersion": "1.0.2", + "supportExpiryDate": "2025-01-01" + } + ], + "provisioningState": "Accepted", + "detailedStatus": "Available", + "detailedStatusMessage": "cluster manager is up and running", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Create_Uami.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Create_Uami.json new file mode 100644 index 000000000000..4430d6de0125 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Create_Uami.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterManagerName": "clusterManagerName", + "clusterManagerParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "name": "clusterManagerName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusterManagers", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": { + "clientId": "200e0000-e89b-12d3-a456-426655440000", + "principalId": "321e7654-e89b-12d3-a456-426655449999" + } + } + }, + "properties": { + "managerExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterVersions": [ + { + "targetClusterVersion": "1.0.0", + "supportExpiryDate": "2023-04-29" + }, + { + "targetClusterVersion": "1.0.2", + "supportExpiryDate": "2025-01-01" + } + ], + "provisioningState": "Accepted", + "detailedStatus": "Available", + "detailedStatusMessage": "cluster manager is up and running", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "name": "clusterManagerName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusterManagers", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": { + "clientId": "200e0000-e89b-12d3-a456-426655440000", + "principalId": "321e7654-e89b-12d3-a456-426655449999" + } + } + }, + "properties": { + "managerExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterVersions": [ + { + "targetClusterVersion": "1.0.0", + "supportExpiryDate": "2023-04-29" + }, + { + "targetClusterVersion": "1.0.2", + "supportExpiryDate": "2025-01-01" + } + ], + "provisioningState": "Accepted", + "detailedStatus": "Available", + "detailedStatusMessage": "cluster manager is up and running", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Delete.json new file mode 100644 index 000000000000..190fe020d833 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterManagerName": "clusterManagerName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Get.json new file mode 100644 index 000000000000..6472ed14ee9f --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Get.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterManagerName": "clusterManagerName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "name": "clusterManagerName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusterManagers", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "identity": { + "principalId": "321e7654-e89b-12d3-a456-426655449999", + "tenantId": "199e9999-e89b-12d3-a456-426655441111", + "type": "SystemAssigned" + }, + "properties": { + "managerExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterVersions": [ + { + "targetClusterVersion": "1.0.0", + "supportExpiryDate": "2023-04-29" + }, + { + "targetClusterVersion": "1.0.2", + "supportExpiryDate": "2025-01-01" + } + ], + "provisioningState": "Succeeded", + "detailedStatus": "Available", + "detailedStatusMessage": "cluster manager is up and running", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_ListByResourceGroup.json new file mode 100644 index 000000000000..26ec56e9b651 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_ListByResourceGroup.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "name": "clusterManagerName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusterManagers", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "identity": { + "principalId": "321e7654-e89b-12d3-a456-426655449999", + "tenantId": "199e9999-e89b-12d3-a456-426655441111", + "type": "SystemAssigned" + }, + "properties": { + "managerExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterVersions": [ + { + "targetClusterVersion": "1.0.0", + "supportExpiryDate": "2023-04-29" + }, + { + "targetClusterVersion": "1.0.2", + "supportExpiryDate": "2025-01-01" + } + ], + "provisioningState": "Succeeded", + "detailedStatus": "Available", + "detailedStatusMessage": "cluster manager is up and running", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_ListBySubscription.json new file mode 100644 index 000000000000..8377f0a62e6a --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_ListBySubscription.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "name": "clusterManagerName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusterManagers", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "identity": { + "principalId": "321e7654-e89b-12d3-a456-426655449999", + "tenantId": "199e9999-e89b-12d3-a456-426655441111", + "type": "SystemAssigned" + }, + "properties": { + "managerExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterVersions": [ + { + "targetClusterVersion": "1.0.0", + "supportExpiryDate": "2023-04-29" + }, + { + "targetClusterVersion": "1.0.2", + "supportExpiryDate": "2025-01-01" + } + ], + "provisioningState": "Succeeded", + "detailedStatus": "Available", + "detailedStatusMessage": "cluster manager is up and running", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Patch.json new file mode 100644 index 000000000000..b2f3b73bbb2d --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterManagers_Patch.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterManagerName": "clusterManagerName", + "clusterManagerUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": null, + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity2": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "name": "clusterManagerName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusterManagers", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity2": { + "clientId": "200e0000-e89b-12d3-a456-426655440000", + "principalId": "321e7654-e89b-12d3-a456-426655449999" + } + } + }, + "properties": { + "managerExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterVersions": [ + { + "targetClusterVersion": "1.0.0", + "supportExpiryDate": "2023-04-29" + }, + { + "targetClusterVersion": "1.0.2", + "supportExpiryDate": "2025-01-01" + } + ], + "provisioningState": "Succeeded", + "detailedStatus": "Available", + "detailedStatusMessage": "cluster manager is up and running", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterMetricsConfigurations_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterMetricsConfigurations_Create.json new file mode 100644 index 000000000000..938492b9e48a --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterMetricsConfigurations_Create.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "metricsConfigurationName": "default", + "metricsConfigurationParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "enabledMetrics": [ + "metric1", + "metric2" + ], + "collectionInterval": 15 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/metricsConfigurations/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/metricsConfigurations", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "enabledMetrics": [ + "metric1", + "metric2" + ], + "collectionInterval": 15, + "provisioningState": "Succeeded", + "disabledMetrics": [ + "metric3", + "metric4" + ], + "detailedStatus": "Applied", + "detailedStatusMessage": "Metrics configuration has been successfully applied to all resources." + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/metricsConfigurations/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/metricsConfigurations", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "enabledMetrics": [ + "metric1", + "metric2" + ], + "collectionInterval": 15, + "provisioningState": "Accepted", + "disabledMetrics": [ + "metric3", + "metric4" + ], + "detailedStatus": "Applied", + "detailedStatusMessage": "Metrics configuration has been successfully applied to all resources." + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterMetricsConfigurations_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterMetricsConfigurations_Delete.json new file mode 100644 index 000000000000..ca479dfa83b0 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterMetricsConfigurations_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "metricsConfigurationName": "default" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterMetricsConfigurations_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterMetricsConfigurations_Get.json new file mode 100644 index 000000000000..dcc4cfa451e1 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterMetricsConfigurations_Get.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "metricsConfigurationName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/metricsConfigurations/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/metricsConfigurations", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "enabledMetrics": [ + "metric1", + "metric2" + ], + "collectionInterval": 15, + "provisioningState": "Succeeded", + "disabledMetrics": [ + "metric3", + "metric4" + ], + "detailedStatus": "Applied", + "detailedStatusMessage": "Metrics configuration has been successfully applied to all resources." + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterMetricsConfigurations_ListByCluster.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterMetricsConfigurations_ListByCluster.json new file mode 100644 index 000000000000..70f2a9ae7485 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterMetricsConfigurations_ListByCluster.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/metricsConfigurations/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/metricsConfigurations", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "enabledMetrics": [ + "metric1", + "metric2" + ], + "collectionInterval": 15, + "provisioningState": "Succeeded", + "disabledMetrics": [ + "metric3", + "metric4" + ], + "detailedStatus": "Applied", + "detailedStatusMessage": "Metrics configuration has been successfully applied to all resources." + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterMetricsConfigurations_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterMetricsConfigurations_Patch.json new file mode 100644 index 000000000000..1cfd279aee01 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/ClusterMetricsConfigurations_Patch.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "metricsConfigurationName": "default", + "metricsConfigurationUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "enabledMetrics": [ + "metric1", + "metric2" + ], + "collectionInterval": 15 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/metricsConfigurations/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/metricsConfigurations", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "enabledMetrics": [ + "metric1", + "metric2" + ], + "collectionInterval": 15, + "provisioningState": "Succeeded", + "disabledMetrics": [ + "metric3", + "metric4" + ], + "detailedStatus": "Applied", + "detailedStatusMessage": "Metrics configuration has been successfully applied to all resources." + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/metricsConfigurations/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/metricsConfigurations", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "enabledMetrics": [ + "metric1", + "metric2" + ], + "collectionInterval": 15, + "provisioningState": "Accepted", + "disabledMetrics": [ + "metric3", + "metric4" + ], + "detailedStatus": "Applied", + "detailedStatusMessage": "Metrics configuration has been successfully applied to all resources." + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_ContinueUpdateVersion.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_ContinueUpdateVersion.json new file mode 100644 index 000000000000..e731f82d9709 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_ContinueUpdateVersion.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterContinueUpdateVersionParameters": { + "machineGroupTargetingMode": "AlphaByRack" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Create.json new file mode 100644 index 000000000000..515ea66a672a --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Create.json @@ -0,0 +1,547 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username", + "password": "{password}" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username", + "password": "{password}" + }, + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username", + "password": "{password}" + }, + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username", + "password": "{password}" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username", + "password": "{password}" + }, + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username", + "password": "{password}" + }, + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012", + "password": "{password}" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Accepted", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "PendingDeployment", + "detailedStatusMessage": "Cluster creation is accepted. Deployment is pending.", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Delete.json new file mode 100644 index 000000000000..231cb86e1743 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Deploy.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Deploy.json new file mode 100644 index 000000000000..c960f8dd5bc8 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Deploy.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterDeployParameters": {} + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Deploy_SkipValidation.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Deploy_SkipValidation.json new file mode 100644 index 000000000000..b937b144f37b --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Deploy_SkipValidation.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterDeployParameters": { + "skipValidationsForMachines": [ + "bmmName1" + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Get.json new file mode 100644 index 000000000000..42c7e4458a03 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Get.json @@ -0,0 +1,203 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_ListByResourceGroup.json new file mode 100644 index 000000000000..8b715860e0e4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_ListByResourceGroup.json @@ -0,0 +1,207 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_ListBySubscription.json new file mode 100644 index 000000000000..bbd7a9fab7de --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_ListBySubscription.json @@ -0,0 +1,206 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Patch_AggregatorOrSingleRackDefinition.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Patch_AggregatorOrSingleRackDefinition.json new file mode 100644 index 000000000000..594d6f881ad0 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Patch_AggregatorOrSingleRackDefinition.json @@ -0,0 +1,456 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "newSerialNumber", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username", + "password": "{password}" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username", + "password": "{password}" + }, + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username", + "password": "{password}" + }, + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "newSerialNumber", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Accepted", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "newSerialNumber", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Accepted", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Patch_CommandOutput.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Patch_CommandOutput.json new file mode 100644 index 000000000000..ba9dc8304188 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Patch_CommandOutput.json @@ -0,0 +1,428 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": null, + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity2": {} + } + }, + "properties": { + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity2" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity2": { + "clientId": "200e0000-e89b-12d3-a456-426655440000", + "principalId": "321e7654-e89b-12d3-a456-426655449999" + } + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity2" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity2": { + "clientId": "200e0000-e89b-12d3-a456-426655440000", + "principalId": "321e7654-e89b-12d3-a456-426655449999" + } + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity2" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Accepted", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Patch_Location.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Patch_Location.json new file mode 100644 index 000000000000..0fb9680b50e2 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Patch_Location.json @@ -0,0 +1,409 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "clusterLocation": "Foo Street, 3rd Floor, row 9" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Accepted", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Patch_RuntimeProtectionConfiguration.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Patch_RuntimeProtectionConfiguration.json new file mode 100644 index 000000000000..90968dfe7368 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Patch_RuntimeProtectionConfiguration.json @@ -0,0 +1,411 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Accepted", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Patch_SecretArchive.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Patch_SecretArchive.json new file mode 100644 index 000000000000..d7555427fa7e --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Patch_SecretArchive.json @@ -0,0 +1,412 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Accepted", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Patch_UpdateStrategy.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Patch_UpdateStrategy.json new file mode 100644 index 000000000000..6f14d0820b02 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_Patch_UpdateStrategy.json @@ -0,0 +1,415 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Accepted", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_ScanRuntime.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_ScanRuntime.json new file mode 100644 index 000000000000..28570f45d0a4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_ScanRuntime.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterScanRuntimeParameters": { + "scanActivity": "Scan" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_UpdateVersion.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_UpdateVersion.json new file mode 100644 index 000000000000..09046cafbb42 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Clusters_UpdateVersion.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterUpdateVersionParameters": { + "targetClusterVersion": "2.0" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Consoles_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Consoles_Create.json new file mode 100644 index 000000000000..dc1fef2f11a4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Consoles_Create.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName", + "consoleName": "default", + "consoleParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "enabled": "True", + "expiration": "2022-06-01T01:27:03.008Z" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines/consoles", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "enabled": "True", + "expiration": "2022-06-01T01:27:03.008Z", + "provisioningState": "Succeeded", + "privateLinkServiceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls", + "virtualMachineAccessId": "VirtualMachineAccessId", + "detailedStatus": "Ready", + "detailedStatusMessage": "Console is ready for use" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines/consoles", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "enabled": "True", + "expiration": "2022-06-01T01:27:03.008Z", + "provisioningState": "Accepted", + "privateLinkServiceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls", + "virtualMachineAccessId": "VirtualMachineAccessId", + "detailedStatus": "Ready", + "detailedStatusMessage": "Console is ready for use" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Consoles_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Consoles_Delete.json new file mode 100644 index 000000000000..946191ad6fe0 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Consoles_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName", + "consoleName": "default" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Consoles_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Consoles_Get.json new file mode 100644 index 000000000000..2b1637819e03 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Consoles_Get.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName", + "consoleName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines/consoles", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "enabled": "True", + "expiration": "2022-06-01T01:27:03.008Z", + "provisioningState": "Succeeded", + "privateLinkServiceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls", + "virtualMachineAccessId": "VirtualMachineAccessId", + "detailedStatus": "Ready", + "detailedStatusMessage": "Console is ready for use" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Consoles_ListByVirtualMachine.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Consoles_ListByVirtualMachine.json new file mode 100644 index 000000000000..a80d37e5d66f --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Consoles_ListByVirtualMachine.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines/consoles", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "enabled": "True", + "expiration": "2022-06-01T01:27:03.008Z", + "provisioningState": "Succeeded", + "privateLinkServiceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls", + "virtualMachineAccessId": "VirtualMachineAccessId", + "detailedStatus": "Ready", + "detailedStatusMessage": "Console is ready for use" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Consoles_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Consoles_Patch.json new file mode 100644 index 000000000000..314e737c24e9 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Consoles_Patch.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName", + "consoleName": "default", + "consoleUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "expiration": "2022-06-01T01:27:03.008Z", + "enabled": "True" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines/consoles", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "enabled": "True", + "expiration": "2022-06-01T01:27:03.008Z", + "provisioningState": "Succeeded", + "privateLinkServiceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls", + "virtualMachineAccessId": "VirtualMachineAccessId", + "detailedStatus": "Ready", + "detailedStatusMessage": "Console is ready for use" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines/consoles", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "enabled": "True", + "expiration": "2022-06-01T01:27:03.008Z", + "provisioningState": "Accepted", + "privateLinkServiceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls", + "virtualMachineAccessId": "VirtualMachineAccessId", + "detailedStatus": "Ready", + "detailedStatusMessage": "Console is ready for use" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusterFeatures_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusterFeatures_Create.json new file mode 100644 index 000000000000..afb17120c096 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusterFeatures_Create.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "featureName": "featureName", + "kubernetesClusterFeatureParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "options": [ + { + "key": "featureOptionName", + "value": "featureOptionValue" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/features/featureName", + "name": "featureName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/features", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "options": [ + { + "key": "featureOptionName", + "value": "featureOptionValue" + } + ], + "availabilityLifecycle": "GenerallyAvailable", + "detailedStatus": "Installed", + "detailedStatusMessage": "The feature is successfully installed.", + "required": "True", + "version": "1.2.3", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/features/featureName", + "name": "featureName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/features", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "options": [ + { + "key": "featureOptionName", + "value": "featureOptionValue" + } + ], + "availabilityLifecycle": "GenerallyAvailable", + "detailedStatus": "Installed", + "detailedStatusMessage": "The feature is successfully installed.", + "required": "True", + "version": "1.2.3", + "provisioningState": "Accepted" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusterFeatures_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusterFeatures_Delete.json new file mode 100644 index 000000000000..ce4857b43a7d --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusterFeatures_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "featureName": "featureName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusterFeatures_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusterFeatures_Get.json new file mode 100644 index 000000000000..d9b0759c2a6e --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusterFeatures_Get.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "featureName": "featureName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/features/featureName", + "name": "featureName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/features", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "options": [ + { + "key": "featureOptionName", + "value": "featureOptionValue" + } + ], + "availabilityLifecycle": "GenerallyAvailable", + "detailedStatus": "Installed", + "detailedStatusMessage": "The feature is successfully installed.", + "required": "True", + "version": "1.2.3", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusterFeatures_ListByKubernetesCluster.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusterFeatures_ListByKubernetesCluster.json new file mode 100644 index 000000000000..5eae440f000b --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusterFeatures_ListByKubernetesCluster.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/features/featureName", + "name": "featureName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/features", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "options": [ + { + "key": "featureOptionName", + "value": "featureOptionValue" + } + ], + "availabilityLifecycle": "GenerallyAvailable", + "detailedStatus": "Installed", + "detailedStatusMessage": "The feature is successfully installed.", + "required": "True", + "version": "1.2.3", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusterFeatures_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusterFeatures_Patch.json new file mode 100644 index 000000000000..d3c3725252bd --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusterFeatures_Patch.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "featureName": "featureName", + "kubernetesClusterFeatureUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "options": [ + { + "key": "featureOptionName", + "value": "featureOptionValue" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/features/featureName", + "name": "featureName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/features", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "options": [ + { + "key": "featureOptionName", + "value": "featureOptionValue" + } + ], + "availabilityLifecycle": "GenerallyAvailable", + "detailedStatus": "Installed", + "detailedStatusMessage": "The feature is successfully installed.", + "required": "True", + "version": "1.2.3", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/features/featureName", + "name": "featureName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/features", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "options": [ + { + "key": "featureOptionName", + "value": "featureOptionValue" + } + ], + "availabilityLifecycle": "GenerallyAvailable", + "detailedStatus": "Installed", + "detailedStatusMessage": "The feature is successfully installed.", + "required": "True", + "version": "1.2.3", + "provisioningState": "Accepted" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_Create.json new file mode 100644 index 000000000000..2ed1c63f543e --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_Create.json @@ -0,0 +1,798 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "kubernetesClusterParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_P46_224_v1", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_G6_28_v1" + }, + "kubernetesVersion": "1.XX.Y", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "bgpAdvertisements": [ + { + "advertiseToFabric": "True", + "communities": [ + "64512:100" + ], + "ipAddressPools": [ + "pool1" + ], + "peers": [ + "peer1" + ] + } + ], + "fabricPeeringEnabled": "True", + "bgpPeers": [ + { + "bfdEnabled": "False", + "bgpMultiHop": "False", + "holdTime": "P300s", + "keepAliveTime": "P300s", + "myAsn": 64512, + "name": "peer1", + "peerAddress": "203.0.113.254", + "peerAsn": 64497, + "peerPort": 179 + } + ], + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.0/24" + ], + "autoAssign": "True", + "name": "pool1", + "onlyUseHostIps": "True" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_P46_224_v1", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_G6_28_v1" + }, + "kubernetesVersion": "1.XX.Y", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "bgpAdvertisements": [ + { + "advertiseToFabric": "True", + "communities": [ + "64512:100" + ], + "ipAddressPools": [ + "pool1" + ], + "peers": [ + "peer1" + ] + } + ], + "fabricPeeringEnabled": "True", + "bgpPeers": [ + { + "bfdEnabled": "False", + "bgpMultiHop": "False", + "holdTime": "P300s", + "keepAliveTime": "P300s", + "myAsn": 64512, + "name": "peer1", + "peerAddress": "203.0.113.254", + "peerAsn": 64497, + "peerPort": 179 + } + ], + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.0/24" + ], + "autoAssign": "True", + "name": "pool1", + "onlyUseHostIps": "True" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Succeeded", + "availableUpgrades": [ + { + "version": "1.XX.Y", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 46, + "detailedStatus": "Running", + "detailedStatusMessage": "Running - virtual machine is running.", + "diskSizeGB": 300, + "image": "mariner-guest-image-qcow2-k8s-1.XX.Y", + "kubernetesVersion": "v1.XX.Y", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 224, + "mode": "System", + "name": "kubernetesClusterName-SystemPool-1-md-cqjvd", + "networkAttachments": [ + { + "networkAttachmentName": "cloudservices", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "169.254.8.4", + "macAddress": "aa:bb:cc:06:79:2a", + "defaultGateway": "False" + }, + { + "networkAttachmentName": "defaultcni", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "10.14.48.12", + "ipv6Address": "fda0:d59c:da0a:e30::a", + "macAddress": "aa:bb:cc:ad:40:cf", + "defaultGateway": "False" + } + ], + "powerState": "On", + "role": "Worker", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "vmSkuName": "NC_P46_224_v1" + }, + { + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 6, + "detailedStatus": "Running", + "detailedStatusMessage": "Running - virtual machine is running.", + "diskSizeGB": 300, + "image": "mariner-guest-image-qcow2-k8s-1.XX.Y", + "kubernetesVersion": "v1.XX.Y", + "memorySizeGB": 28, + "name": "kubernetesClusterName-control-plane-7nsh2", + "networkAttachments": [ + { + "networkAttachmentName": "cloudservices", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "169.254.8.2", + "macAddress": "aa:bb:cc:fa:91:71", + "defaultGateway": "False" + }, + { + "networkAttachmentName": "defaultcni", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "10.14.48.11", + "ipv6Address": "fda0:d59c:da0a:e30::9", + "macAddress": "aa:bb:cc:c8:a2:40", + "defaultGateway": "False" + } + ], + "powerState": "On", + "role": "ControlPlane", + "vmSkuName": "NC_G6_28_v1" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_P46_224_v1", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_G6_28_v1" + }, + "kubernetesVersion": "1.XX.Y", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "bgpAdvertisements": [ + { + "advertiseToFabric": "True", + "communities": [ + "64512:100" + ], + "ipAddressPools": [ + "pool1" + ], + "peers": [ + "peer1" + ] + } + ], + "fabricPeeringEnabled": "True", + "bgpPeers": [ + { + "bfdEnabled": "False", + "bgpMultiHop": "False", + "holdTime": "P300s", + "keepAliveTime": "P300s", + "myAsn": 64512, + "name": "peer1", + "peerAddress": "203.0.113.254", + "peerAsn": 64497, + "peerPort": 179 + } + ], + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.0/24" + ], + "autoAssign": "True", + "name": "pool1", + "onlyUseHostIps": "True" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Accepted", + "availableUpgrades": [ + { + "version": "1.XX.Y", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 46, + "detailedStatus": "Running", + "detailedStatusMessage": "Running - virtual machine is running.", + "diskSizeGB": 300, + "image": "mariner-guest-image-qcow2-k8s-1.XX.Y", + "kubernetesVersion": "v1.XX.Y", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 224, + "mode": "System", + "name": "kubernetesClusterName-SystemPool-1-md-cqjvd", + "networkAttachments": [ + { + "networkAttachmentName": "cloudservices", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "169.254.8.4", + "macAddress": "aa:bb:cc:06:79:2a", + "defaultGateway": "False" + }, + { + "networkAttachmentName": "defaultcni", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "10.14.48.12", + "ipv6Address": "fda0:d59c:da0a:e30::a", + "macAddress": "aa:bb:cc:ad:40:cf", + "defaultGateway": "False" + } + ], + "powerState": "On", + "role": "Worker", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "vmSkuName": "NC_P46_224_v1" + }, + { + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 6, + "detailedStatus": "Running", + "detailedStatusMessage": "Running - virtual machine is running.", + "diskSizeGB": 300, + "image": "mariner-guest-image-qcow2-k8s-1.XX.Y", + "kubernetesVersion": "v1.XX.Y", + "memorySizeGB": 28, + "name": "kubernetesClusterName-control-plane-7nsh2", + "networkAttachments": [ + { + "networkAttachmentName": "cloudservices", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "169.254.8.2", + "macAddress": "aa:bb:cc:fa:91:71", + "defaultGateway": "False" + }, + { + "networkAttachmentName": "defaultcni", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "10.14.48.11", + "ipv6Address": "fda0:d59c:da0a:e30::9", + "macAddress": "aa:bb:cc:c8:a2:40", + "defaultGateway": "False" + } + ], + "powerState": "On", + "role": "ControlPlane", + "vmSkuName": "NC_G6_28_v1" + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_Delete.json new file mode 100644 index 000000000000..83072054c957 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_Get.json new file mode 100644 index 000000000000..3801d503fbe4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_Get.json @@ -0,0 +1,312 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_P46_224_v1", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_G6_28_v1" + }, + "kubernetesVersion": "1.XX.Y", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "bgpAdvertisements": [ + { + "advertiseToFabric": "True", + "communities": [ + "64512:100" + ], + "ipAddressPools": [ + "pool1" + ], + "peers": [ + "peer1" + ] + } + ], + "fabricPeeringEnabled": "True", + "bgpPeers": [ + { + "bfdEnabled": "False", + "bgpMultiHop": "False", + "holdTime": "P300s", + "keepAliveTime": "P300s", + "myAsn": 64512, + "name": "peer1", + "peerAddress": "203.0.113.254", + "peerAsn": 64497, + "peerPort": 179 + } + ], + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.0/24" + ], + "autoAssign": "True", + "name": "pool1", + "onlyUseHostIps": "True" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Succeeded", + "availableUpgrades": [ + { + "version": "1.XX.Y", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 46, + "detailedStatus": "Running", + "detailedStatusMessage": "Running - virtual machine is running.", + "diskSizeGB": 300, + "image": "mariner-guest-image-qcow2-k8s-1.XX.Y", + "kubernetesVersion": "v1.XX.Y", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 224, + "mode": "System", + "name": "kubernetesClusterName-SystemPool-1-md-cqjvd", + "networkAttachments": [ + { + "networkAttachmentName": "cloudservices", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "169.254.8.4", + "macAddress": "aa:bb:cc:06:79:2a", + "defaultGateway": "False" + }, + { + "networkAttachmentName": "defaultcni", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "10.14.48.12", + "ipv6Address": "fda0:d59c:da0a:e30::a", + "macAddress": "aa:bb:cc:ad:40:cf", + "defaultGateway": "False" + } + ], + "powerState": "On", + "role": "Worker", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "vmSkuName": "NC_P46_224_v1" + }, + { + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 6, + "detailedStatus": "Running", + "detailedStatusMessage": "Running - virtual machine is running.", + "diskSizeGB": 300, + "image": "mariner-guest-image-qcow2-k8s-1.XX.Y", + "kubernetesVersion": "v1.XX.Y", + "memorySizeGB": 28, + "name": "kubernetesClusterName-control-plane-7nsh2", + "networkAttachments": [ + { + "networkAttachmentName": "cloudservices", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "169.254.8.2", + "macAddress": "aa:bb:cc:fa:91:71", + "defaultGateway": "False" + }, + { + "networkAttachmentName": "defaultcni", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "10.14.48.11", + "ipv6Address": "fda0:d59c:da0a:e30::9", + "macAddress": "aa:bb:cc:c8:a2:40", + "defaultGateway": "False" + } + ], + "powerState": "On", + "role": "ControlPlane", + "vmSkuName": "NC_G6_28_v1" + } + ] + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_L2LoadBalancer_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_L2LoadBalancer_Create.json new file mode 100644 index 000000000000..6989f2728f26 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_L2LoadBalancer_Create.json @@ -0,0 +1,711 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "kubernetesClusterParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_P46_224_v1", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_G6_28_v1" + }, + "kubernetesVersion": "1.XX.Y", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "l2ServiceLoadBalancerConfiguration": { + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.2-198.51.102.254" + ], + "autoAssign": "True", + "name": "pool1" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_P46_224_v1", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_G6_28_v1" + }, + "kubernetesVersion": "1.XX.Y", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "l2ServiceLoadBalancerConfiguration": { + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.2-198.51.102.254" + ], + "autoAssign": "True", + "name": "pool1" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Succeeded", + "availableUpgrades": [ + { + "version": "1.XX.Y", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 46, + "detailedStatus": "Running", + "detailedStatusMessage": "Running - virtual machine is running.", + "diskSizeGB": 300, + "image": "mariner-guest-image-qcow2-k8s-1.XX.Y", + "kubernetesVersion": "v1.XX.Y", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 224, + "mode": "System", + "name": "kubernetesClusterName-SystemPool-1-md-cqjvd", + "networkAttachments": [ + { + "networkAttachmentName": "cloudservices", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "169.254.8.4", + "macAddress": "aa:bb:cc:06:79:2a", + "defaultGateway": "False" + }, + { + "networkAttachmentName": "defaultcni", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "10.14.48.12", + "ipv6Address": "fda0:d59c:da0a:e30::a", + "macAddress": "aa:bb:cc:ad:40:cf", + "defaultGateway": "False" + } + ], + "powerState": "On", + "role": "Worker", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "vmSkuName": "NC_P46_224_v1" + }, + { + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 6, + "detailedStatus": "Running", + "detailedStatusMessage": "Running - virtual machine is running.", + "diskSizeGB": 300, + "image": "mariner-guest-image-qcow2-k8s-1.XX.Y", + "kubernetesVersion": "v1.XX.Y", + "memorySizeGB": 28, + "name": "kubernetesClusterName-control-plane-7nsh2", + "networkAttachments": [ + { + "networkAttachmentName": "cloudservices", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "169.254.8.2", + "macAddress": "aa:bb:cc:fa:91:71", + "defaultGateway": "False" + }, + { + "networkAttachmentName": "defaultcni", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "10.14.48.11", + "ipv6Address": "fda0:d59c:da0a:e30::9", + "macAddress": "aa:bb:cc:c8:a2:40", + "defaultGateway": "False" + } + ], + "powerState": "On", + "role": "ControlPlane", + "vmSkuName": "NC_G6_28_v1" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_P46_224_v1", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_G6_28_v1" + }, + "kubernetesVersion": "1.XX.Y", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "l2ServiceLoadBalancerConfiguration": { + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.2-198.51.102.254" + ], + "autoAssign": "True", + "name": "pool1" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Accepted", + "availableUpgrades": [ + { + "version": "1.XX.Y", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 46, + "detailedStatus": "Running", + "detailedStatusMessage": "Running - virtual machine is running.", + "diskSizeGB": 300, + "image": "mariner-guest-image-qcow2-k8s-1.XX.Y", + "kubernetesVersion": "v1.XX.Y", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 224, + "mode": "System", + "name": "kubernetesClusterName-SystemPool-1-md-cqjvd", + "networkAttachments": [ + { + "networkAttachmentName": "cloudservices", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "169.254.8.4", + "macAddress": "aa:bb:cc:06:79:2a", + "defaultGateway": "False" + }, + { + "networkAttachmentName": "defaultcni", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "10.14.48.12", + "ipv6Address": "fda0:d59c:da0a:e30::a", + "macAddress": "aa:bb:cc:ad:40:cf", + "defaultGateway": "False" + } + ], + "powerState": "On", + "role": "Worker", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "vmSkuName": "NC_P46_224_v1" + }, + { + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 6, + "detailedStatus": "Running", + "detailedStatusMessage": "Running - virtual machine is running.", + "diskSizeGB": 300, + "image": "mariner-guest-image-qcow2-k8s-1.XX.Y", + "kubernetesVersion": "v1.XX.Y", + "memorySizeGB": 28, + "name": "kubernetesClusterName-control-plane-7nsh2", + "networkAttachments": [ + { + "networkAttachmentName": "cloudservices", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "169.254.8.2", + "macAddress": "aa:bb:cc:fa:91:71", + "defaultGateway": "False" + }, + { + "networkAttachmentName": "defaultcni", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "10.14.48.11", + "ipv6Address": "fda0:d59c:da0a:e30::9", + "macAddress": "aa:bb:cc:c8:a2:40", + "defaultGateway": "False" + } + ], + "powerState": "On", + "role": "ControlPlane", + "vmSkuName": "NC_G6_28_v1" + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_ListByResourceGroup.json new file mode 100644 index 000000000000..df0bbe463559 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_ListByResourceGroup.json @@ -0,0 +1,316 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_P46_224_v1", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_G6_28_v1" + }, + "kubernetesVersion": "1.XX.Y", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "bgpAdvertisements": [ + { + "advertiseToFabric": "True", + "communities": [ + "64512:100" + ], + "ipAddressPools": [ + "pool1" + ], + "peers": [ + "peer1" + ] + } + ], + "fabricPeeringEnabled": "True", + "bgpPeers": [ + { + "bfdEnabled": "False", + "bgpMultiHop": "False", + "holdTime": "P300s", + "keepAliveTime": "P300s", + "myAsn": 64512, + "name": "peer1", + "peerAddress": "203.0.113.254", + "peerAsn": 64497, + "peerPort": 179 + } + ], + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.0/24" + ], + "autoAssign": "True", + "name": "pool1", + "onlyUseHostIps": "True" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Succeeded", + "availableUpgrades": [ + { + "version": "1.XX.Y", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 46, + "detailedStatus": "Running", + "detailedStatusMessage": "Running - virtual machine is running.", + "diskSizeGB": 300, + "image": "mariner-guest-image-qcow2-k8s-1.XX.Y", + "kubernetesVersion": "v1.XX.Y", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 224, + "mode": "System", + "name": "kubernetesClusterName-SystemPool-1-md-cqjvd", + "networkAttachments": [ + { + "networkAttachmentName": "cloudservices", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "169.254.8.4", + "macAddress": "aa:bb:cc:06:79:2a", + "defaultGateway": "False" + }, + { + "networkAttachmentName": "defaultcni", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "10.14.48.12", + "ipv6Address": "fda0:d59c:da0a:e30::a", + "macAddress": "aa:bb:cc:ad:40:cf", + "defaultGateway": "False" + } + ], + "powerState": "On", + "role": "Worker", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "vmSkuName": "NC_P46_224_v1" + }, + { + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 6, + "detailedStatus": "Running", + "detailedStatusMessage": "Running - virtual machine is running.", + "diskSizeGB": 300, + "image": "mariner-guest-image-qcow2-k8s-1.XX.Y", + "kubernetesVersion": "v1.XX.Y", + "memorySizeGB": 28, + "name": "kubernetesClusterName-control-plane-7nsh2", + "networkAttachments": [ + { + "networkAttachmentName": "cloudservices", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "169.254.8.2", + "macAddress": "aa:bb:cc:fa:91:71", + "defaultGateway": "False" + }, + { + "networkAttachmentName": "defaultcni", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "10.14.48.11", + "ipv6Address": "fda0:d59c:da0a:e30::9", + "macAddress": "aa:bb:cc:c8:a2:40", + "defaultGateway": "False" + } + ], + "powerState": "On", + "role": "ControlPlane", + "vmSkuName": "NC_G6_28_v1" + } + ] + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_ListBySubscription.json new file mode 100644 index 000000000000..268041c26b2a --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_ListBySubscription.json @@ -0,0 +1,314 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_P46_224_v1", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_G6_28_v1" + }, + "kubernetesVersion": "1.XX.Y", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "bgpAdvertisements": [ + { + "advertiseToFabric": "True", + "communities": [ + "64512:100" + ], + "ipAddressPools": [ + "pool1" + ], + "peers": [ + "peer1" + ] + } + ], + "fabricPeeringEnabled": "True", + "bgpPeers": [ + { + "bfdEnabled": "False", + "bgpMultiHop": "False", + "holdTime": "P300s", + "keepAliveTime": "P300s", + "myAsn": 64512, + "name": "peer1", + "peerAddress": "203.0.113.254", + "peerAsn": 64497, + "peerPort": 179 + } + ], + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.0/24" + ], + "autoAssign": "True", + "name": "pool1", + "onlyUseHostIps": "True" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Succeeded", + "availableUpgrades": [ + { + "version": "1.XX.Y", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 46, + "detailedStatus": "Running", + "detailedStatusMessage": "Running - virtual machine is running.", + "diskSizeGB": 300, + "image": "mariner-guest-image-qcow2-k8s-1.XX.Y", + "kubernetesVersion": "v1.XX.Y", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 224, + "mode": "System", + "name": "kubernetesClusterName-SystemPool-1-md-cqjvd", + "networkAttachments": [ + { + "networkAttachmentName": "cloudservices", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "169.254.8.4", + "macAddress": "aa:bb:cc:06:79:2a", + "defaultGateway": "False" + }, + { + "networkAttachmentName": "defaultcni", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "10.14.48.12", + "ipv6Address": "fda0:d59c:da0a:e30::a", + "macAddress": "aa:bb:cc:ad:40:cf", + "defaultGateway": "False" + } + ], + "powerState": "On", + "role": "Worker", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "vmSkuName": "NC_P46_224_v1" + }, + { + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 6, + "detailedStatus": "Running", + "detailedStatusMessage": "Running - virtual machine is running.", + "diskSizeGB": 300, + "image": "mariner-guest-image-qcow2-k8s-1.XX.Y", + "kubernetesVersion": "v1.XX.Y", + "memorySizeGB": 28, + "name": "kubernetesClusterName-control-plane-7nsh2", + "networkAttachments": [ + { + "networkAttachmentName": "cloudservices", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "169.254.8.2", + "macAddress": "aa:bb:cc:fa:91:71", + "defaultGateway": "False" + }, + { + "networkAttachmentName": "defaultcni", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "10.14.48.11", + "ipv6Address": "fda0:d59c:da0a:e30::9", + "macAddress": "aa:bb:cc:c8:a2:40", + "defaultGateway": "False" + } + ], + "powerState": "On", + "role": "ControlPlane", + "vmSkuName": "NC_G6_28_v1" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_Patch.json new file mode 100644 index 000000000000..3c7e866cec7f --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_Patch.json @@ -0,0 +1,644 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "kubernetesClusterUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "administratorConfiguration": { + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "count": 3 + }, + "kubernetesVersion": "1.XX.Y" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_P46_224_v1", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_G6_28_v1" + }, + "kubernetesVersion": "1.XX.Y", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "bgpAdvertisements": [ + { + "advertiseToFabric": "True", + "communities": [ + "64512:100" + ], + "ipAddressPools": [ + "pool1" + ], + "peers": [ + "peer1" + ] + } + ], + "fabricPeeringEnabled": "True", + "bgpPeers": [ + { + "bfdEnabled": "False", + "bgpMultiHop": "False", + "holdTime": "P300s", + "keepAliveTime": "P300s", + "myAsn": 64512, + "name": "peer1", + "peerAddress": "203.0.113.254", + "peerAsn": 64497, + "peerPort": 179 + } + ], + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.0/24" + ], + "autoAssign": "True", + "name": "pool1", + "onlyUseHostIps": "True" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Succeeded", + "availableUpgrades": [ + { + "version": "1.XX.Y", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 46, + "detailedStatus": "Running", + "detailedStatusMessage": "Running - virtual machine is running.", + "diskSizeGB": 300, + "image": "mariner-guest-image-qcow2-k8s-1.XX.Y", + "kubernetesVersion": "v1.XX.Y", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 224, + "mode": "System", + "name": "kubernetesClusterName-SystemPool-1-md-cqjvd", + "networkAttachments": [ + { + "networkAttachmentName": "cloudservices", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "169.254.8.4", + "macAddress": "aa:bb:cc:06:79:2a", + "defaultGateway": "False" + }, + { + "networkAttachmentName": "defaultcni", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "10.14.48.12", + "ipv6Address": "fda0:d59c:da0a:e30::a", + "macAddress": "aa:bb:cc:ad:40:cf", + "defaultGateway": "False" + } + ], + "powerState": "On", + "role": "Worker", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "vmSkuName": "NC_P46_224_v1" + }, + { + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 6, + "detailedStatus": "Running", + "detailedStatusMessage": "Running - virtual machine is running.", + "diskSizeGB": 300, + "image": "mariner-guest-image-qcow2-k8s-1.XX.Y", + "kubernetesVersion": "v1.XX.Y", + "memorySizeGB": 28, + "name": "kubernetesClusterName-control-plane-7nsh2", + "networkAttachments": [ + { + "networkAttachmentName": "cloudservices", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "169.254.8.2", + "macAddress": "aa:bb:cc:fa:91:71", + "defaultGateway": "False" + }, + { + "networkAttachmentName": "defaultcni", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "10.14.48.11", + "ipv6Address": "fda0:d59c:da0a:e30::9", + "macAddress": "aa:bb:cc:c8:a2:40", + "defaultGateway": "False" + } + ], + "powerState": "On", + "role": "ControlPlane", + "vmSkuName": "NC_G6_28_v1" + } + ] + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_P46_224_v1", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_G6_28_v1" + }, + "kubernetesVersion": "1.XX.Y", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "bgpAdvertisements": [ + { + "advertiseToFabric": "True", + "communities": [ + "64512:100" + ], + "ipAddressPools": [ + "pool1" + ], + "peers": [ + "peer1" + ] + } + ], + "fabricPeeringEnabled": "True", + "bgpPeers": [ + { + "bfdEnabled": "False", + "bgpMultiHop": "False", + "holdTime": "P300s", + "keepAliveTime": "P300s", + "myAsn": 64512, + "name": "peer1", + "peerAddress": "203.0.113.254", + "peerAsn": 64497, + "peerPort": 179 + } + ], + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.0/24" + ], + "autoAssign": "True", + "name": "pool1", + "onlyUseHostIps": "True" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Accepted", + "availableUpgrades": [ + { + "version": "1.XX.Y", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 46, + "detailedStatus": "Running", + "detailedStatusMessage": "Running - virtual machine is running.", + "diskSizeGB": 300, + "image": "mariner-guest-image-qcow2-k8s-1.XX.Y", + "kubernetesVersion": "v1.XX.Y", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 224, + "mode": "System", + "name": "kubernetesClusterName-SystemPool-1-md-cqjvd", + "networkAttachments": [ + { + "networkAttachmentName": "cloudservices", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "169.254.8.4", + "macAddress": "aa:bb:cc:06:79:2a", + "defaultGateway": "False" + }, + { + "networkAttachmentName": "defaultcni", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "10.14.48.12", + "ipv6Address": "fda0:d59c:da0a:e30::a", + "macAddress": "aa:bb:cc:ad:40:cf", + "defaultGateway": "False" + } + ], + "powerState": "On", + "role": "Worker", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true:NoSchedule" + } + ], + "vmSkuName": "NC_P46_224_v1" + }, + { + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 6, + "detailedStatus": "Running", + "detailedStatusMessage": "Running - virtual machine is running.", + "diskSizeGB": 300, + "image": "mariner-guest-image-qcow2-k8s-1.XX.Y", + "kubernetesVersion": "v1.XX.Y", + "memorySizeGB": 28, + "name": "kubernetesClusterName-control-plane-7nsh2", + "networkAttachments": [ + { + "networkAttachmentName": "cloudservices", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "169.254.8.2", + "macAddress": "aa:bb:cc:fa:91:71", + "defaultGateway": "False" + }, + { + "networkAttachmentName": "defaultcni", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "10.14.48.11", + "ipv6Address": "fda0:d59c:da0a:e30::9", + "macAddress": "aa:bb:cc:c8:a2:40", + "defaultGateway": "False" + } + ], + "powerState": "On", + "role": "ControlPlane", + "vmSkuName": "NC_G6_28_v1" + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_RestartNode.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_RestartNode.json new file mode 100644 index 000000000000..a52ec9832d95 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/KubernetesClusters_RestartNode.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "kubernetesClusterRestartNodeParameters": { + "nodeName": "nodeName" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L2Networks_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L2Networks_Create.json new file mode 100644 index 000000000000..b290cf78157f --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L2Networks_Create.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "l2NetworkName": "l2NetworkName", + "l2NetworkParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l2IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "hybridAksPluginType": "DPDK" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "name": "l2NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l2Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l2IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L2 network is up" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "name": "l2NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l2Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l2IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L2 network is up" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L2Networks_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L2Networks_Delete.json new file mode 100644 index 000000000000..d9fe86d35b7c --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L2Networks_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "l2NetworkName": "l2NetworkName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L2Networks_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L2Networks_Get.json new file mode 100644 index 000000000000..225290a25eae --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L2Networks_Get.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "l2NetworkName": "l2NetworkName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "name": "l2NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l2Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l2IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L2 network is up" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L2Networks_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L2Networks_ListByResourceGroup.json new file mode 100644 index 000000000000..698de9329c02 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L2Networks_ListByResourceGroup.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "name": "l2NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l2Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l2IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L2 network is up" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L2Networks_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L2Networks_ListBySubscription.json new file mode 100644 index 000000000000..3ce4e100d1e3 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L2Networks_ListBySubscription.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "name": "l2NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l2Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l2IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L2 network is up" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L2Networks_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L2Networks_Patch.json new file mode 100644 index 000000000000..01bee8c3edb4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L2Networks_Patch.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "l2NetworkName": "l2NetworkName", + "l2NetworkUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "name": "l2NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l2Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l2IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L2 network is up" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L3Networks_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L3Networks_Create.json new file mode 100644 index 000000000000..8e6ce685c6b9 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L3Networks_Create.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "l3NetworkName": "l3NetworkName", + "l3NetworkParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l3IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", + "vlan": 12, + "ipAllocationType": "DualStack", + "ipv4ConnectedPrefix": "198.51.100.0/24", + "ipv6ConnectedPrefix": "2001:db8::/64" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "name": "l3NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l3Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l3IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", + "vlan": 12, + "ipAllocationType": "DualStack", + "ipv4ConnectedPrefix": "198.51.100.0/24", + "ipv6ConnectedPrefix": "2001:db8::/64", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L3 network is up" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "name": "l3NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l3Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l3IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", + "vlan": 12, + "ipAllocationType": "DualStack", + "ipv4ConnectedPrefix": "198.51.100.0/24", + "ipv6ConnectedPrefix": "2001:db8::/64", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L3 network is up" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L3Networks_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L3Networks_Delete.json new file mode 100644 index 000000000000..4f42f7b8cf16 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L3Networks_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "l3NetworkName": "l3NetworkName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L3Networks_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L3Networks_Get.json new file mode 100644 index 000000000000..06846f8d5efc --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L3Networks_Get.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "l3NetworkName": "l3NetworkName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "name": "l3NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l3Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l3IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", + "vlan": 12, + "ipAllocationType": "DualStack", + "ipv4ConnectedPrefix": "198.51.100.0/24", + "ipv6ConnectedPrefix": "2001:db8::/64", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L3 network is up" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L3Networks_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L3Networks_ListByResourceGroup.json new file mode 100644 index 000000000000..eeb7af05197a --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L3Networks_ListByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "name": "l3NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l3Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l3IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", + "vlan": 12, + "ipAllocationType": "DualStack", + "ipv4ConnectedPrefix": "198.51.100.0/24", + "ipv6ConnectedPrefix": "2001:db8::/64", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L3 network is up" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L3Networks_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L3Networks_ListBySubscription.json new file mode 100644 index 000000000000..24e5d0fe30fe --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L3Networks_ListBySubscription.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "name": "l3NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l3Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l3IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", + "vlan": 12, + "ipAllocationType": "DualStack", + "ipv4ConnectedPrefix": "198.51.100.0/24", + "ipv6ConnectedPrefix": "2001:db8::/64", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L3 network is up" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L3Networks_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L3Networks_Patch.json new file mode 100644 index 000000000000..e386bad3b955 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/L3Networks_Patch.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "l3NetworkName": "l3NetworkName", + "l3NetworkUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "name": "l3NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l3Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l3IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", + "vlan": 12, + "ipAllocationType": "DualStack", + "ipv4ConnectedPrefix": "198.51.100.0/24", + "ipv6ConnectedPrefix": "2001:db8::/64", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L3 network is up" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Operations_List.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Operations_List.json new file mode 100644 index 000000000000..73239419f942 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Operations_List.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://fully.qualified.hyperlink", + "value": [ + { + "actionType": "Internal", + "display": { + "description": "Reads Network Cloud cluster(s)", + "operation": "Get/list Network Cloud cluster resources", + "provider": "Microsoft Network Cloud", + "resource": "Network Cloud cluster" + }, + "isDataAction": true, + "name": "Microsoft.NetworkCloud/clusters/Read", + "origin": "user,system" + }, + { + "actionType": "Internal", + "display": { + "description": "Writes Network Cloud cluster(s)", + "operation": "Create/update Network Cloud cluster resources", + "provider": "Microsoft Network Cloud", + "resource": "Network Cloud cluster" + }, + "isDataAction": true, + "name": "Microsoft.NetworkCloud/clusters/Write", + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/RackSkus_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/RackSkus_Get.json new file mode 100644 index 000000000000..b6edaaf3339d --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/RackSkus_Get.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "rackSkuName": "rackSkuName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "name": "rackSkuName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/rackSkus", + "properties": { + "provisioningState": "Succeeded", + "rackType": "Single", + "maxClusterSlots": 0, + "description": "Sample SKU for the single rack.", + "controllerMachines": [ + { + "properties": { + "vendor": "Dell", + "model": "PowerEdge R650", + "generation": "8", + "hardwareVersion": "3", + "bootstrapProtocol": "PXE", + "cpuSockets": 1, + "cpuCores": 8, + "totalThreads": 16, + "memoryCapacityGB": 128, + "disks": [ + { + "capacityGB": 893, + "type": "SSD", + "connection": "SAS" + } + ], + "networkInterfaces": [ + { + "address": "04:00.0", + "physicalSlot": 2, + "portCount": 2, + "portSpeed": 1, + "deviceConnectionType": "PCI", + "vendor": "Broadcom Corp", + "model": "Broadcom Gigabit Ethernet BCM5720" + } + ] + }, + "rackSlot": 5 + } + ], + "computeMachines": [ + { + "properties": { + "vendor": "Dell", + "model": "PowerEdge R750", + "generation": "8", + "hardwareVersion": "3", + "bootstrapProtocol": "PXE", + "cpuSockets": 2, + "cpuCores": 28, + "totalThreads": 112, + "memoryCapacityGB": 512, + "disks": [ + { + "capacityGB": 893, + "type": "SSD", + "connection": "SAS" + } + ], + "networkInterfaces": [ + { + "address": "04:00.0", + "physicalSlot": 1, + "portCount": 2, + "portSpeed": 1, + "deviceConnectionType": "PCI", + "vendor": "Broadcom Corp", + "model": "Broadcom Gigabit Ethernet BCM5720" + } + ] + }, + "rackSlot": 1 + } + ], + "storageAppliances": [ + { + "properties": { + "capacityGB": 9100, + "model": "x70r3-9" + }, + "rackSlot": 2 + } + ] + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/RackSkus_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/RackSkus_ListBySubscription.json new file mode 100644 index 000000000000..69d581ab55ae --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/RackSkus_ListBySubscription.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "name": "rackSkuName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/rackSkus", + "properties": { + "provisioningState": "Succeeded", + "rackType": "Single", + "maxClusterSlots": 0, + "description": "Sample SKU for the single rack.", + "controllerMachines": [ + { + "properties": { + "vendor": "Dell", + "model": "PowerEdge R650", + "generation": "8", + "hardwareVersion": "3", + "bootstrapProtocol": "PXE", + "cpuSockets": 1, + "cpuCores": 8, + "totalThreads": 16, + "memoryCapacityGB": 128, + "disks": [ + { + "capacityGB": 893, + "type": "SSD", + "connection": "SAS" + } + ], + "networkInterfaces": [ + { + "address": "04:00.0", + "physicalSlot": 2, + "portCount": 2, + "portSpeed": 1, + "deviceConnectionType": "PCI", + "vendor": "Broadcom Corp", + "model": "Broadcom Gigabit Ethernet BCM5720" + } + ] + }, + "rackSlot": 5 + } + ], + "computeMachines": [ + { + "properties": { + "vendor": "Dell", + "model": "PowerEdge R750", + "generation": "8", + "hardwareVersion": "3", + "bootstrapProtocol": "PXE", + "cpuSockets": 2, + "cpuCores": 28, + "totalThreads": 112, + "memoryCapacityGB": 512, + "disks": [ + { + "capacityGB": 893, + "type": "SSD", + "connection": "SAS" + } + ], + "networkInterfaces": [ + { + "address": "04:00.0", + "physicalSlot": 1, + "portCount": 2, + "portSpeed": 1, + "deviceConnectionType": "PCI", + "vendor": "Broadcom Corp", + "model": "Broadcom Gigabit Ethernet BCM5720" + } + ] + }, + "rackSlot": 1 + } + ], + "storageAppliances": [ + { + "properties": { + "capacityGB": 9100, + "model": "x70r3-9" + }, + "rackSlot": 2 + } + ] + } + } + ] + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Racks_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Racks_Create.json new file mode 100644 index 000000000000..331afc106a81 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Racks_Create.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "rackName": "rackName", + "rackParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "availabilityZone": "1", + "rackLocation": "Rack 28" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "name": "rackName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/racks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "availabilityZone": "1", + "rackLocation": "Rack 28", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "detailedStatus": "Available", + "detailedStatusMessage": "Rack is operational" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "name": "rackName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/racks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "availabilityZone": "1", + "rackLocation": "Rack 28", + "provisioningState": "Accepted", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "detailedStatus": "Available", + "detailedStatusMessage": "Rack is operational" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Racks_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Racks_Delete.json new file mode 100644 index 000000000000..cfaea7e68141 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Racks_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "rackName": "rackName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Racks_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Racks_Get.json new file mode 100644 index 000000000000..b784a6d1162f --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Racks_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "rackName": "rackName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "name": "rackName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/racks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "availabilityZone": "1", + "rackLocation": "Rack 28", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "detailedStatus": "Available", + "detailedStatusMessage": "Rack is operational" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Racks_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Racks_ListByResourceGroup.json new file mode 100644 index 000000000000..f6e54adb1a0f --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Racks_ListByResourceGroup.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "name": "rackName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/racks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "availabilityZone": "1", + "rackLocation": "Rack 28", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "detailedStatus": "Available", + "detailedStatusMessage": "Rack is operational" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Racks_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Racks_ListBySubscription.json new file mode 100644 index 000000000000..3fe0620c7e81 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Racks_ListBySubscription.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "name": "rackName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/racks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "availabilityZone": "1", + "rackLocation": "Rack 28", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "detailedStatus": "Available", + "detailedStatusMessage": "Rack is operational" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Racks_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Racks_Patch.json new file mode 100644 index 000000000000..5cec48d017e0 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Racks_Patch.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "rackName": "rackName", + "rackUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "rackLocation": "Rack 2B" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "name": "rackName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/racks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "availabilityZone": "1", + "rackLocation": "Rack 28", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "detailedStatus": "Available", + "detailedStatusMessage": "Rack is operational" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "name": "rackName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/racks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "availabilityZone": "1", + "rackLocation": "Rack 28", + "provisioningState": "Accepted", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "detailedStatus": "Available", + "detailedStatusMessage": "Rack is operational" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_Create.json new file mode 100644 index 000000000000..27f398ac9ec3 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_Create.json @@ -0,0 +1,150 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "storageApplianceName": "storageApplianceName", + "storageApplianceParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "storageApplianceSkuId": "684E-3B16-399E", + "rackSlot": 1, + "serialNumber": "BM1219XXX", + "administratorCredentials": { + "username": "adminUser", + "password": "{password}" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", + "name": "storageApplianceName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/storageAppliances", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "storageApplianceSkuId": "684E-3B16-399E", + "rackSlot": 1, + "serialNumber": "BM1219XXX", + "administratorCredentials": { + "username": "adminUser" + }, + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "capacity": 893, + "capacityUsed": 500, + "remoteVendorManagementStatus": "Enabled", + "remoteVendorManagementFeature": "Supported", + "detailedStatus": "Available", + "detailedStatusMessage": "Storage appliance is up and running", + "managementIpv4Address": "192.0.2.2", + "manufacturer": "Contoso Storage", + "model": "ArrayStore-Flash70", + "secretRotationStatus": [ + { + "secretType": "Storage Appliance User", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-storage-appliance-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ], + "version": "9.9.9" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", + "name": "storageApplianceName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/storageAppliances", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "storageApplianceSkuId": "684E-3B16-399E", + "rackSlot": 1, + "serialNumber": "BM1219XXX", + "administratorCredentials": { + "username": "adminUser" + }, + "provisioningState": "Accepted", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "capacity": 893, + "capacityUsed": 500, + "remoteVendorManagementStatus": "Enabled", + "remoteVendorManagementFeature": "Supported", + "detailedStatus": "Available", + "detailedStatusMessage": "Storage appliance is up and running", + "managementIpv4Address": "192.0.2.2", + "manufacturer": "Contoso Storage", + "model": "ArrayStore-Flash70", + "secretRotationStatus": [ + { + "secretType": "Storage Appliance User", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-storage-appliance-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ], + "version": "9.9.9" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_Delete.json new file mode 100644 index 000000000000..a614e0dd3378 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "storageApplianceName": "storageApplianceName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_DisableRemoteVendorManagement.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_DisableRemoteVendorManagement.json new file mode 100644 index 000000000000..9d45a0b9cc0c --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_DisableRemoteVendorManagement.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "storageApplianceName": "storageApplianceName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_EnableRemoteVendorManagement.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_EnableRemoteVendorManagement.json new file mode 100644 index 000000000000..cd730b76f1b5 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_EnableRemoteVendorManagement.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "storageApplianceName": "storageApplianceName", + "storageApplianceEnableRemoteVendorManagementParameters": { + "supportEndpoints": [ + "10.0.0.0/24" + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_Get.json new file mode 100644 index 000000000000..2fa75cba46e2 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_Get.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "storageApplianceName": "storageApplianceName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", + "name": "storageApplianceName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/storageAppliances", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "storageApplianceSkuId": "684E-3B16-399E", + "rackSlot": 1, + "serialNumber": "BM1219XXX", + "administratorCredentials": { + "username": "adminUser" + }, + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "capacity": 893, + "capacityUsed": 500, + "remoteVendorManagementStatus": "Enabled", + "remoteVendorManagementFeature": "Supported", + "detailedStatus": "Available", + "detailedStatusMessage": "Storage appliance is up and running", + "managementIpv4Address": "192.0.2.2", + "manufacturer": "Contoso Storage", + "model": "ArrayStore-Flash70", + "secretRotationStatus": [ + { + "secretType": "Storage Appliance User", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-storage-appliance-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ], + "version": "9.9.9" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_ListByResourceGroup.json new file mode 100644 index 000000000000..ec444809bd8a --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_ListByResourceGroup.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", + "name": "storageApplianceName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/storageAppliances", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "storageApplianceSkuId": "684E-3B16-399E", + "rackSlot": 1, + "serialNumber": "BM1219XXX", + "administratorCredentials": { + "username": "adminUser" + }, + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "capacity": 893, + "capacityUsed": 500, + "remoteVendorManagementStatus": "Enabled", + "remoteVendorManagementFeature": "Supported", + "detailedStatus": "Available", + "detailedStatusMessage": "Storage appliance is up and running", + "managementIpv4Address": "192.0.2.2", + "manufacturer": "Contoso Storage", + "model": "ArrayStore-Flash70", + "secretRotationStatus": [ + { + "secretType": "Storage Appliance User", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-storage-appliance-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ], + "version": "9.9.9" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_ListBySubscription.json new file mode 100644 index 000000000000..257069834cde --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_ListBySubscription.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", + "name": "storageApplianceName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/storageAppliances", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "storageApplianceSkuId": "684E-3B16-399E", + "rackSlot": 1, + "serialNumber": "BM1219XXX", + "administratorCredentials": { + "username": "adminUser" + }, + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "capacity": 893, + "capacityUsed": 500, + "remoteVendorManagementStatus": "Enabled", + "remoteVendorManagementFeature": "Supported", + "detailedStatus": "Available", + "detailedStatusMessage": "Storage appliance is up and running", + "managementIpv4Address": "192.0.2.2", + "manufacturer": "Contoso Storage", + "model": "ArrayStore-Flash70", + "secretRotationStatus": [ + { + "secretType": "Storage Appliance User", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-storage-appliance-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ], + "version": "9.9.9" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_Patch.json new file mode 100644 index 000000000000..5629c4fe7928 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/StorageAppliances_Patch.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "storageApplianceName": "storageApplianceName", + "storageApplianceUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "serialNumber": "BM1219XXX" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", + "name": "storageApplianceName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/storageAppliances", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "storageApplianceSkuId": "684E-3B16-399E", + "rackSlot": 1, + "serialNumber": "BM1219XXX", + "administratorCredentials": { + "username": "adminUser" + }, + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "capacity": 893, + "capacityUsed": 500, + "remoteVendorManagementStatus": "Enabled", + "remoteVendorManagementFeature": "Supported", + "detailedStatus": "Available", + "detailedStatusMessage": "Storage appliance is up and running", + "managementIpv4Address": "192.0.2.2", + "manufacturer": "Contoso Storage", + "model": "ArrayStore-Flash70", + "secretRotationStatus": [ + { + "secretType": "Storage Appliance User", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-storage-appliance-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ], + "version": "9.9.9" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", + "name": "storageApplianceName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/storageAppliances", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "storageApplianceSkuId": "684E-3B16-399E", + "rackSlot": 1, + "serialNumber": "BM1219XXX", + "administratorCredentials": { + "username": "adminUser" + }, + "provisioningState": "Accepted", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "capacity": 893, + "capacityUsed": 500, + "remoteVendorManagementStatus": "Enabled", + "remoteVendorManagementFeature": "Supported", + "detailedStatus": "Available", + "detailedStatusMessage": "Storage appliance is up and running", + "managementIpv4Address": "192.0.2.2", + "manufacturer": "Contoso Storage", + "model": "ArrayStore-Flash70", + "secretRotationStatus": [ + { + "secretType": "Storage Appliance User", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-storage-appliance-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ], + "version": "9.9.9" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/TrunkedNetworks_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/TrunkedNetworks_Create.json new file mode 100644 index 000000000000..878ebe82ec52 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/TrunkedNetworks_Create.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "trunkedNetworkName": "trunkedNetworkName", + "trunkedNetworkParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "isolationDomainIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" + ], + "vlans": [ + 12, + 14 + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "name": "trunkedNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/trunkedNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "isolationDomainIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" + ], + "vlans": [ + 12, + 14 + ], + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Trunked network is up" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "name": "trunkedNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/trunkedNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "isolationDomainIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" + ], + "vlans": [ + 12, + 14 + ], + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Trunked network is up" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/TrunkedNetworks_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/TrunkedNetworks_Delete.json new file mode 100644 index 000000000000..a97c7650f200 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/TrunkedNetworks_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "trunkedNetworkName": "trunkedNetworkName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/TrunkedNetworks_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/TrunkedNetworks_Get.json new file mode 100644 index 000000000000..06e32301c149 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/TrunkedNetworks_Get.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "trunkedNetworkName": "trunkedNetworkName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "name": "trunkedNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/trunkedNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "isolationDomainIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" + ], + "vlans": [ + 12, + 14 + ], + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Trunked network is up" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/TrunkedNetworks_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/TrunkedNetworks_ListByResourceGroup.json new file mode 100644 index 000000000000..b20a5af83685 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/TrunkedNetworks_ListByResourceGroup.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "name": "trunkedNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/trunkedNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "isolationDomainIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" + ], + "vlans": [ + 12, + 14 + ], + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Trunked network is up" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/TrunkedNetworks_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/TrunkedNetworks_ListBySubscription.json new file mode 100644 index 000000000000..5d687caac7b5 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/TrunkedNetworks_ListBySubscription.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "name": "trunkedNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/trunkedNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "isolationDomainIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" + ], + "vlans": [ + 12, + 14 + ], + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Trunked network is up" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/TrunkedNetworks_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/TrunkedNetworks_Patch.json new file mode 100644 index 000000000000..29b42d90fd7d --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/TrunkedNetworks_Patch.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "trunkedNetworkName": "trunkedNetworkName", + "trunkedNetworkUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "name": "trunkedNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/trunkedNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "isolationDomainIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" + ], + "vlans": [ + 12, + 14 + ], + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Trunked network is up" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Create.json new file mode 100644 index 000000000000..3b66a62134c6 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Create.json @@ -0,0 +1,248 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName", + "virtualMachineParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "vmImage": "myacr.azurecr.io/foobar:latest", + "vmImageRepositoryCredentials": { + "username": "myuser", + "password": "{password}", + "registryUrl": "myacr.azurecr.io" + }, + "vmDeviceModel": "T2", + "cpuCores": 2, + "memorySizeGB": 8, + "storageProfile": { + "osDisk": { + "createOption": "Ephemeral", + "deleteOption": "Delete", + "diskSizeGB": 120 + }, + "volumeAttachments": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + }, + "cloudServicesNetworkAttachment": { + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic" + }, + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "defaultGateway": "True" + } + ], + "placementHints": [ + { + "hintType": "Affinity", + "schedulingExecution": "Hard", + "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "scope": "" + } + ], + "userData": "dXNlckRhdGVTYW1wbGU=", + "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", + "bootMethod": "UEFI", + "adminUsername": "username", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", + "name": "virtualMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "vmImage": "myacr.azurecr.io/foobar:latest", + "vmImageRepositoryCredentials": { + "username": "myuser", + "registryUrl": "myacr.azurecr.io" + }, + "vmDeviceModel": "T2", + "cpuCores": 2, + "memorySizeGB": 8, + "storageProfile": { + "osDisk": { + "createOption": "Ephemeral", + "deleteOption": "Delete", + "diskSizeGB": 120 + }, + "volumeAttachments": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + }, + "cloudServicesNetworkAttachment": { + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic" + }, + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "placementHints": [ + { + "hintType": "Affinity", + "schedulingExecution": "Hard", + "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "scope": "" + } + ], + "userData": "dXNlckRhdGVTYW1wbGU=", + "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", + "bootMethod": "UEFI", + "adminUsername": "username", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ], + "provisioningState": "Succeeded", + "availabilityZone": "1", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "powerState": "On", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "detailedStatus": "Available", + "detailedStatusMessage": "VM is up and healthy", + "volumes": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", + "name": "virtualMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "vmImage": "myacr.azurecr.io/foobar:latest", + "vmImageRepositoryCredentials": { + "username": "myuser", + "registryUrl": "myacr.azurecr.io" + }, + "vmDeviceModel": "T2", + "cpuCores": 2, + "memorySizeGB": 8, + "storageProfile": { + "osDisk": { + "createOption": "Ephemeral", + "deleteOption": "Delete", + "diskSizeGB": 120 + }, + "volumeAttachments": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + }, + "cloudServicesNetworkAttachment": { + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic" + }, + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "placementHints": [ + { + "hintType": "Affinity", + "schedulingExecution": "Hard", + "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "scope": "" + } + ], + "userData": "dXNlckRhdGVTYW1wbGU=", + "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", + "bootMethod": "UEFI", + "adminUsername": "username", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ], + "provisioningState": "Accepted", + "availabilityZone": "1", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "powerState": "On", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "detailedStatus": "Available", + "detailedStatusMessage": "VM is up and healthy", + "volumes": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Delete.json new file mode 100644 index 000000000000..4512ff2b6d76 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Get.json new file mode 100644 index 000000000000..a75fd514b5b4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Get.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", + "name": "virtualMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "vmImage": "myacr.azurecr.io/foobar:latest", + "vmImageRepositoryCredentials": { + "username": "myuser", + "registryUrl": "myacr.azurecr.io" + }, + "vmDeviceModel": "T2", + "cpuCores": 2, + "memorySizeGB": 8, + "storageProfile": { + "osDisk": { + "createOption": "Ephemeral", + "deleteOption": "Delete", + "diskSizeGB": 120 + }, + "volumeAttachments": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + }, + "cloudServicesNetworkAttachment": { + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic" + }, + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "placementHints": [ + { + "hintType": "Affinity", + "schedulingExecution": "Hard", + "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "scope": "" + } + ], + "userData": "dXNlckRhdGVTYW1wbGU=", + "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", + "bootMethod": "UEFI", + "adminUsername": "username", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ], + "provisioningState": "Succeeded", + "availabilityZone": "1", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "powerState": "On", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "detailedStatus": "Available", + "detailedStatusMessage": "VM is up and healthy", + "volumes": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_ListByResourceGroup.json new file mode 100644 index 000000000000..c75651101b3b --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_ListByResourceGroup.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", + "name": "virtualMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "vmImage": "myacr.azurecr.io/foobar:latest", + "vmImageRepositoryCredentials": { + "username": "myuser", + "registryUrl": "myacr.azurecr.io" + }, + "vmDeviceModel": "T2", + "cpuCores": 2, + "memorySizeGB": 8, + "storageProfile": { + "osDisk": { + "createOption": "Ephemeral", + "deleteOption": "Delete", + "diskSizeGB": 120 + }, + "volumeAttachments": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + }, + "cloudServicesNetworkAttachment": { + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic" + }, + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "placementHints": [ + { + "hintType": "Affinity", + "schedulingExecution": "Hard", + "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "scope": "" + } + ], + "userData": "dXNlckRhdGVTYW1wbGU=", + "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", + "bootMethod": "UEFI", + "adminUsername": "username", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ], + "provisioningState": "Succeeded", + "availabilityZone": "1", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "powerState": "On", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "detailedStatus": "Available", + "detailedStatusMessage": "VM is up and healthy", + "volumes": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_ListBySubscription.json new file mode 100644 index 000000000000..14277d3412da --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_ListBySubscription.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", + "name": "virtualMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "vmImage": "myacr.azurecr.io/foobar:latest", + "vmImageRepositoryCredentials": { + "username": "myuser", + "registryUrl": "myacr.azurecr.io" + }, + "vmDeviceModel": "T2", + "cpuCores": 2, + "memorySizeGB": 8, + "storageProfile": { + "osDisk": { + "createOption": "Ephemeral", + "deleteOption": "Delete", + "diskSizeGB": 120 + }, + "volumeAttachments": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + }, + "cloudServicesNetworkAttachment": { + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic" + }, + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "placementHints": [ + { + "hintType": "Affinity", + "schedulingExecution": "Hard", + "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "scope": "" + } + ], + "userData": "dXNlckRhdGVTYW1wbGU=", + "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", + "bootMethod": "UEFI", + "adminUsername": "username", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ], + "provisioningState": "Succeeded", + "availabilityZone": "1", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "powerState": "On", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "detailedStatus": "Available", + "detailedStatusMessage": "VM is up and healthy", + "volumes": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Patch.json new file mode 100644 index 000000000000..235ef5d1b12b --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Patch.json @@ -0,0 +1,199 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName", + "virtualMachineUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "vmImageRepositoryCredentials": { + "username": "myuser", + "password": "{password}", + "registryUrl": "myacr.azurecr.io" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", + "name": "virtualMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "vmImage": "myacr.azurecr.io/foobar:latest", + "vmImageRepositoryCredentials": { + "username": "myuser", + "registryUrl": "myacr.azurecr.io" + }, + "vmDeviceModel": "T2", + "cpuCores": 2, + "memorySizeGB": 8, + "storageProfile": { + "osDisk": { + "createOption": "Ephemeral", + "deleteOption": "Delete", + "diskSizeGB": 120 + }, + "volumeAttachments": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + }, + "cloudServicesNetworkAttachment": { + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic" + }, + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "placementHints": [ + { + "hintType": "Affinity", + "schedulingExecution": "Hard", + "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "scope": "" + } + ], + "userData": "dXNlckRhdGVTYW1wbGU=", + "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", + "bootMethod": "UEFI", + "adminUsername": "username", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ], + "provisioningState": "Succeeded", + "availabilityZone": "1", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "powerState": "On", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "detailedStatus": "Available", + "detailedStatusMessage": "VM is up and healthy", + "volumes": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", + "name": "virtualMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "vmImage": "myacr.azurecr.io/foobar:latest", + "vmImageRepositoryCredentials": { + "username": "myuser", + "registryUrl": "myacr.azurecr.io" + }, + "vmDeviceModel": "T2", + "cpuCores": 2, + "memorySizeGB": 8, + "storageProfile": { + "osDisk": { + "createOption": "Ephemeral", + "deleteOption": "Delete", + "diskSizeGB": 120 + }, + "volumeAttachments": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + }, + "cloudServicesNetworkAttachment": { + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic" + }, + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "placementHints": [ + { + "hintType": "Affinity", + "schedulingExecution": "Hard", + "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "scope": "" + } + ], + "userData": "dXNlckRhdGVTYW1wbGU=", + "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", + "bootMethod": "UEFI", + "adminUsername": "username", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ], + "provisioningState": "Accepted", + "availabilityZone": "1", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "powerState": "On", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "detailedStatus": "Available", + "detailedStatusMessage": "VM is up and healthy", + "volumes": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_PowerOff.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_PowerOff.json new file mode 100644 index 000000000000..62725e3b0683 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_PowerOff.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName", + "virtualMachinePowerOffParameters": { + "skipShutdown": "True" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Reimage.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Reimage.json new file mode 100644 index 000000000000..6700c733f4a1 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Reimage.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Restart.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Restart.json new file mode 100644 index 000000000000..6700c733f4a1 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Restart.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Start.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Start.json new file mode 100644 index 000000000000..6700c733f4a1 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/VirtualMachines_Start.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Volumes_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Volumes_Create.json new file mode 100644 index 000000000000..1bb9de4438c0 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Volumes_Create.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "volumeName": "volumeName", + "volumeParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "sizeMiB": 10000 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName", + "name": "volumeName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/volumes", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "sizeMiB": 10000, + "provisioningState": "Succeeded", + "serialNumber": "XXXX-XXXX-XXXX-XXXX", + "attachedTo": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Active", + "detailedStatusMessage": "Volume is available" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName", + "name": "volumeName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/volumes", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "sizeMiB": 10000, + "provisioningState": "Succeeded", + "serialNumber": "XXXX-XXXX-XXXX-XXXX", + "attachedTo": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Active", + "detailedStatusMessage": "Volume is available" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Volumes_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Volumes_Delete.json new file mode 100644 index 000000000000..b1685eb71234 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Volumes_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "volumeName": "volumeName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Volumes_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Volumes_Get.json new file mode 100644 index 000000000000..d270e7765a3d --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Volumes_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "volumeName": "volumeName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName", + "name": "volumeName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/volumes", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "sizeMiB": 10000, + "provisioningState": "Succeeded", + "serialNumber": "XXXX-XXXX-XXXX-XXXX", + "attachedTo": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Active", + "detailedStatusMessage": "Volume is available" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Volumes_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Volumes_ListByResourceGroup.json new file mode 100644 index 000000000000..2ae7a805c3f0 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Volumes_ListByResourceGroup.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName", + "name": "volumeName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/volumes", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "sizeMiB": 10000, + "provisioningState": "Succeeded", + "serialNumber": "XXXX-XXXX-XXXX-XXXX", + "attachedTo": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Active", + "detailedStatusMessage": "Volume is available" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Volumes_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Volumes_ListBySubscription.json new file mode 100644 index 000000000000..b3a87732f1e6 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Volumes_ListBySubscription.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName", + "name": "volumeName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/volumes", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "sizeMiB": 10000, + "provisioningState": "Succeeded", + "serialNumber": "XXXX-XXXX-XXXX-XXXX", + "attachedTo": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Active", + "detailedStatusMessage": "Volume is available" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Volumes_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Volumes_Patch.json new file mode 100644 index 000000000000..8b03447c9c79 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/Volumes_Patch.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "volumeName": "volumeName", + "volumeUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName", + "name": "volumeName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/volumes", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "sizeMiB": 10000, + "provisioningState": "Succeeded", + "serialNumber": "XXXX-XXXX-XXXX-XXXX", + "attachedTo": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Active", + "detailedStatusMessage": "Volume is available" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/networkcloud.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/networkcloud.json new file mode 100644 index 000000000000..dc8410954ba5 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/networkcloud.json @@ -0,0 +1,13441 @@ +{ + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "description": "The Network Cloud APIs provide management of the Azure Operator Nexus compute resources such as on-premises clusters, hardware resources, and workload infrastructure resources.", + "title": "NetworkCloud", + "version": "2024-07-01" + }, + "host": "management.azure.com", + "paths": { + "/providers/Microsoft.NetworkCloud/operations": { + "get": { + "description": "Get a list of all available resource provider operations. It contains a URL link to get the next set of results.", + "summary": "List resource provider operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List resource provider operations": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/bareMetalMachines": { + "get": { + "description": "Get a list of bare metal machines in the provided subscription.", + "summary": "List bare metal machines in the subscription.", + "operationId": "BareMetalMachines_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/BareMetalMachineList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List bare metal machines for subscription": { + "$ref": "./examples/BareMetalMachines_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/cloudServicesNetworks": { + "get": { + "description": "Get a list of cloud services networks in the provided subscription.", + "summary": "List cloud services networks in the subscription.", + "operationId": "CloudServicesNetworks_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/CloudServicesNetworkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List cloud services networks for subscription": { + "$ref": "./examples/CloudServicesNetworks_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/clusterManagers": { + "get": { + "description": "Get a list of cluster managers in the provided subscription.", + "summary": "List cluster managers in the subscription.", + "operationId": "ClusterManagers_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/ClusterManagerList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List cluster managers for subscription": { + "$ref": "./examples/ClusterManagers_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/clusters": { + "get": { + "description": "Get a list of clusters in the provided subscription.", + "summary": "List clusters in the subscription.", + "operationId": "Clusters_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/ClusterList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List clusters for subscription": { + "$ref": "./examples/Clusters_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/kubernetesClusters": { + "get": { + "description": "Get a list of Kubernetes clusters in the provided subscription.", + "summary": "List Kubernetes clusters in the subscription.", + "operationId": "KubernetesClusters_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/KubernetesClusterList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Kubernetes clusters for subscription": { + "$ref": "./examples/KubernetesClusters_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/l2Networks": { + "get": { + "description": "Get a list of layer 2 (L2) networks in the provided subscription.", + "summary": "List layer 2 (L2) networks in the subscription.", + "operationId": "L2Networks_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/L2NetworkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List L2 networks for subscription": { + "$ref": "./examples/L2Networks_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/l3Networks": { + "get": { + "description": "Get a list of layer 3 (L3) networks in the provided subscription.", + "summary": "List layer 3 (L3) networks in the subscription.", + "operationId": "L3Networks_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/L3NetworkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List L3 networks for subscription": { + "$ref": "./examples/L3Networks_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/rackSkus": { + "get": { + "description": "Get a list of rack SKUs in the provided subscription.", + "summary": "List rack SKUs in the subscription.", + "operationId": "RackSkus_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/RackSkuList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List rack SKUs for subscription": { + "$ref": "./examples/RackSkus_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/rackSkus/{rackSkuName}": { + "get": { + "description": "Get the properties of the provided rack SKU.", + "summary": "Retrieve the rack SKU.", + "operationId": "RackSkus_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/RackSkuNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/RackSku" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get rack SKU resource": { + "$ref": "./examples/RackSkus_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/racks": { + "get": { + "description": "Get a list of racks in the provided subscription.", + "summary": "List racks in the subscription.", + "operationId": "Racks_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/RackList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List racks for subscription": { + "$ref": "./examples/Racks_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/storageAppliances": { + "get": { + "description": "Get a list of storage appliances in the provided subscription.", + "summary": "List storage appliances in the subscription.", + "operationId": "StorageAppliances_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/StorageApplianceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List storage appliances for subscription": { + "$ref": "./examples/StorageAppliances_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/trunkedNetworks": { + "get": { + "description": "Get a list of trunked networks in the provided subscription.", + "summary": "List trunked networks in the subscription.", + "operationId": "TrunkedNetworks_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/TrunkedNetworkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List trunked networks for subscription": { + "$ref": "./examples/TrunkedNetworks_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/virtualMachines": { + "get": { + "description": "Get a list of virtual machines in the provided subscription.", + "summary": "List virtual machines in the subscription.", + "operationId": "VirtualMachines_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/VirtualMachineList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List virtual machines for subscription": { + "$ref": "./examples/VirtualMachines_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/volumes": { + "get": { + "description": "Get a list of volumes in the provided subscription.", + "summary": "List volumes in the subscription.", + "operationId": "Volumes_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/VolumeList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List volume for subscription": { + "$ref": "./examples/Volumes_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines": { + "get": { + "description": "Get a list of bare metal machines in the provided resource group.", + "summary": "List bare metal machines in the resource group.", + "operationId": "BareMetalMachines_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/BareMetalMachineList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List bare metal machines for resource group": { + "$ref": "./examples/BareMetalMachines_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}": { + "get": { + "description": "Get properties of the provided bare metal machine.", + "summary": "Retrieve the bare metal machine.", + "operationId": "BareMetalMachines_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/BareMetalMachine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get bare metal machine": { + "$ref": "./examples/BareMetalMachines_Get.json" + } + } + }, + "put": { + "description": "Create a new bare metal machine or update the properties of the existing one.\nAll customer initiated requests will be rejected as the life cycle of this resource is managed by the system.", + "summary": "Create or update the bare metal machine.", + "operationId": "BareMetalMachines_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + }, + { + "description": "The request body.", + "name": "bareMetalMachineParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BareMetalMachine" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/BareMetalMachine" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/BareMetalMachine" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update bare metal machine": { + "$ref": "./examples/BareMetalMachines_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided bare metal machine.\nAll customer initiated requests will be rejected as the life cycle of this resource is managed by the system.", + "summary": "Delete the bare metal machine.", + "operationId": "BareMetalMachines_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete bare metal machine": { + "$ref": "./examples/BareMetalMachines_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Patch properties of the provided bare metal machine, or update tags associated with the bare metal machine. Properties and tag updates can be done independently.", + "summary": "Patch the bare metal machine.", + "operationId": "BareMetalMachines_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + }, + { + "description": "The request body.", + "name": "bareMetalMachineUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/BareMetalMachinePatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/BareMetalMachine" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/BareMetalMachine" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch bare metal machine": { + "$ref": "./examples/BareMetalMachines_Patch.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.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/cordon": { + "post": { + "description": "Cordon the provided bare metal machine's Kubernetes node.", + "summary": "Cordon the bare metal machine.", + "operationId": "BareMetalMachines_Cordon", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + }, + { + "description": "The request body.", + "name": "bareMetalMachineCordonParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/BareMetalMachineCordonParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Cordon bare metal machine": { + "$ref": "./examples/BareMetalMachines_Cordon.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/powerOff": { + "post": { + "description": "Power off the provided bare metal machine.", + "summary": "Power off the bare metal machine.", + "operationId": "BareMetalMachines_PowerOff", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + }, + { + "description": "The request body.", + "name": "bareMetalMachinePowerOffParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/BareMetalMachinePowerOffParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Power off bare metal machine": { + "$ref": "./examples/BareMetalMachines_PowerOff.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/reimage": { + "post": { + "description": "Reimage the provided bare metal machine.", + "summary": "Reimage the bare metal machine.", + "operationId": "BareMetalMachines_Reimage", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Reimage bare metal machine": { + "$ref": "./examples/BareMetalMachines_Reimage.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/replace": { + "post": { + "description": "Replace the provided bare metal machine.", + "summary": "Replace (service) the bare metal machine.", + "operationId": "BareMetalMachines_Replace", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + }, + { + "description": "The request body.", + "name": "bareMetalMachineReplaceParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/BareMetalMachineReplaceParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Replace bare metal machine": { + "$ref": "./examples/BareMetalMachines_Replace.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/restart": { + "post": { + "description": "Restart the provided bare metal machine.", + "summary": "Restart the bare metal machine.", + "operationId": "BareMetalMachines_Restart", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Restart bare metal machine": { + "$ref": "./examples/BareMetalMachines_Restart.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/runCommand": { + "post": { + "description": "Run the command or the script on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available.", + "summary": "Run the command on the bare metal machine.", + "operationId": "BareMetalMachines_RunCommand", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + }, + { + "description": "The request body.", + "name": "bareMetalMachineRunCommandParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BareMetalMachineRunCommandParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Run command on bare metal machine": { + "$ref": "./examples/BareMetalMachines_RunCommand.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/runDataExtracts": { + "post": { + "description": "Run one or more data extractions on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available.", + "summary": "Run data extraction for a bare metal machine.", + "operationId": "BareMetalMachines_RunDataExtracts", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + }, + { + "description": "The request body.", + "name": "bareMetalMachineRunDataExtractsParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BareMetalMachineRunDataExtractsParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Run data extraction on bare metal machine": { + "$ref": "./examples/BareMetalMachines_RunDataExtracts.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/runReadCommands": { + "post": { + "description": "Run one or more read-only commands on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available.", + "summary": "Run read-only commands against a bare metal machine.", + "operationId": "BareMetalMachines_RunReadCommands", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + }, + { + "description": "The request body.", + "name": "bareMetalMachineRunReadCommandsParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BareMetalMachineRunReadCommandsParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Run and retrieve output from read only commands on bare metal machine.": { + "$ref": "./examples/BareMetalMachines_RunReadCommands.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/start": { + "post": { + "description": "Start the provided bare metal machine.", + "summary": "Start the bare metal machine.", + "operationId": "BareMetalMachines_Start", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Start bare metal machine": { + "$ref": "./examples/BareMetalMachines_Start.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/uncordon": { + "post": { + "description": "Uncordon the provided bare metal machine's Kubernetes node.", + "summary": "Uncordon the bare metal machine.", + "operationId": "BareMetalMachines_Uncordon", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Uncordon bare metal machine": { + "$ref": "./examples/BareMetalMachines_Uncordon.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/cloudServicesNetworks": { + "get": { + "description": "Get a list of cloud services networks in the provided resource group.", + "summary": "List cloud services networks in the resource group.", + "operationId": "CloudServicesNetworks_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/CloudServicesNetworkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List cloud services networks for resource group": { + "$ref": "./examples/CloudServicesNetworks_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/cloudServicesNetworks/{cloudServicesNetworkName}": { + "get": { + "description": "Get properties of the provided cloud services network.", + "summary": "Retrieve the cloud services network.", + "operationId": "CloudServicesNetworks_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CloudServicesNetworkNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/CloudServicesNetwork" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get cloud services network": { + "$ref": "./examples/CloudServicesNetworks_Get.json" + } + } + }, + "put": { + "description": "Create a new cloud services network or update the properties of the existing cloud services network.", + "summary": "Create or update the cloud services network.", + "operationId": "CloudServicesNetworks_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CloudServicesNetworkNameParameter" + }, + { + "description": "The request body.", + "name": "cloudServicesNetworkParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CloudServicesNetwork" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/CloudServicesNetwork" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/CloudServicesNetwork" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update cloud services network": { + "$ref": "./examples/CloudServicesNetworks_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided cloud services network.", + "summary": "Delete the cloud services network.", + "operationId": "CloudServicesNetworks_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CloudServicesNetworkNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete cloud services network": { + "$ref": "./examples/CloudServicesNetworks_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Update properties of the provided cloud services network, or update the tags associated with it. Properties and tag updates can be done independently.", + "summary": "Patch the cloud services network.", + "operationId": "CloudServicesNetworks_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CloudServicesNetworkNameParameter" + }, + { + "description": "The request body.", + "name": "cloudServicesNetworkUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/CloudServicesNetworkPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/CloudServicesNetwork" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/CloudServicesNetwork" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch cloud services network": { + "$ref": "./examples/CloudServicesNetworks_Patch.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.NetworkCloud/clusterManagers": { + "get": { + "description": "Get a list of cluster managers in the provided resource group.", + "summary": "List cluster managers in the resource group.", + "operationId": "ClusterManagers_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/ClusterManagerList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List cluster managers for resource group": { + "$ref": "./examples/ClusterManagers_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusterManagers/{clusterManagerName}": { + "get": { + "description": "Get the properties of the provided cluster manager.", + "summary": "Retrieve the cluster manager.", + "operationId": "ClusterManagers_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterManagerNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/ClusterManager" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get cluster manager": { + "$ref": "./examples/ClusterManagers_Get.json" + } + } + }, + "put": { + "description": "Create a new cluster manager or update properties of the cluster manager if it exists.", + "summary": "Create or update the cluster manager.", + "operationId": "ClusterManagers_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterManagerNameParameter" + }, + { + "description": "The request body.", + "name": "clusterManagerParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterManager" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/ClusterManager" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/ClusterManager" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update cluster manager": { + "$ref": "./examples/ClusterManagers_Create.json" + }, + "Create or update cluster manager with user assigned identity": { + "$ref": "./examples/ClusterManagers_Create_Uami.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided cluster manager.", + "summary": "Delete the cluster manager.", + "operationId": "ClusterManagers_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterManagerNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete cluster manager": { + "$ref": "./examples/ClusterManagers_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Patch properties of the provided cluster manager, or update the tags assigned to the cluster manager. Properties and tag updates can be done independently.", + "summary": "Patch the cluster manager.", + "operationId": "ClusterManagers_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterManagerNameParameter" + }, + { + "description": "The request body.", + "name": "clusterManagerUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/ClusterManagerPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/ClusterManager" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch cluster manager": { + "$ref": "./examples/ClusterManagers_Patch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters": { + "get": { + "description": "Get a list of clusters in the provided resource group.", + "summary": "List clusters in the resource group.", + "operationId": "Clusters_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/ClusterList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List clusters for resource group": { + "$ref": "./examples/Clusters_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}": { + "get": { + "description": "Get properties of the provided cluster.", + "summary": "Retrieve the cluster.", + "operationId": "Clusters_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get cluster": { + "$ref": "./examples/Clusters_Get.json" + } + } + }, + "put": { + "description": "Create a new cluster or update the properties of the cluster if it exists.", + "summary": "Create or update the cluster.", + "operationId": "Clusters_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "description": "The request body.", + "name": "clusterParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Cluster" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/Cluster" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update cluster": { + "$ref": "./examples/Clusters_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided cluster.", + "summary": "Delete the cluster.", + "operationId": "Clusters_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete cluster": { + "$ref": "./examples/Clusters_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Patch the properties of the provided cluster, or update the tags associated with the cluster. Properties and tag updates can be done independently.", + "summary": "Patch the cluster.", + "operationId": "Clusters_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "description": "The request body.", + "name": "clusterUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/ClusterPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/Cluster" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch cluster AggregatorOrSingleRackDefinition": { + "$ref": "./examples/Clusters_Patch_AggregatorOrSingleRackDefinition.json" + }, + "Patch cluster command output": { + "$ref": "./examples/Clusters_Patch_CommandOutput.json" + }, + "Patch cluster location": { + "$ref": "./examples/Clusters_Patch_Location.json" + }, + "Patch runtime protection configuration": { + "$ref": "./examples/Clusters_Patch_RuntimeProtectionConfiguration.json" + }, + "Patch secret archive": { + "$ref": "./examples/Clusters_Patch_SecretArchive.json" + }, + "Patch update strategy": { + "$ref": "./examples/Clusters_Patch_UpdateStrategy.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.NetworkCloud/clusters/{clusterName}/bareMetalMachineKeySets": { + "get": { + "description": "Get a list of bare metal machine key sets for the provided cluster.", + "summary": "List bare metal machine key sets of the cluster.", + "operationId": "BareMetalMachineKeySets_ListByCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/BareMetalMachineKeySetList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List bare metal machine key sets of the cluster": { + "$ref": "./examples/BareMetalMachineKeySets_ListByCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bareMetalMachineKeySets/{bareMetalMachineKeySetName}": { + "get": { + "description": "Get bare metal machine key set of the provided cluster.", + "summary": "Retrieve the bare metal machine key set of the cluster.", + "operationId": "BareMetalMachineKeySets_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineKeySetNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/BareMetalMachineKeySet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get bare metal machine key set of cluster": { + "$ref": "./examples/BareMetalMachineKeySets_Get.json" + } + } + }, + "put": { + "description": "Create a new bare metal machine key set or update the existing one for the provided cluster.", + "summary": "Create or update the bare metal machine key set of the cluster.", + "operationId": "BareMetalMachineKeySets_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineKeySetNameParameter" + }, + { + "description": "The request body.", + "name": "bareMetalMachineKeySetParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BareMetalMachineKeySet" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/BareMetalMachineKeySet" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/BareMetalMachineKeySet" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update bare metal machine key set of cluster": { + "$ref": "./examples/BareMetalMachineKeySets_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the bare metal machine key set of the provided cluster.", + "summary": "Delete the bare metal machine key set of the cluster.", + "operationId": "BareMetalMachineKeySets_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineKeySetNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete bare metal machine key set of cluster": { + "$ref": "./examples/BareMetalMachineKeySets_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Patch properties of bare metal machine key set for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently.", + "summary": "Patch bare metal machine key set of the cluster.", + "operationId": "BareMetalMachineKeySets_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineKeySetNameParameter" + }, + { + "description": "The request body.", + "name": "bareMetalMachineKeySetUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/BareMetalMachineKeySetPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/BareMetalMachineKeySet" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/BareMetalMachineKeySet" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch bare metal machine key set of cluster": { + "$ref": "./examples/BareMetalMachineKeySets_Patch.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.NetworkCloud/clusters/{clusterName}/bmcKeySets": { + "get": { + "description": "Get a list of baseboard management controller key sets for the provided cluster.", + "summary": "List baseboard management controller key sets of the cluster.", + "operationId": "BmcKeySets_ListByCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/BmcKeySetList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List baseboard management controller key sets of the cluster": { + "$ref": "./examples/BmcKeySets_ListByCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bmcKeySets/{bmcKeySetName}": { + "get": { + "description": "Get baseboard management controller key set of the provided cluster.", + "summary": "Retrieve the baseboard management controller key set of the cluster.", + "operationId": "BmcKeySets_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/BmcKeySetNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/BmcKeySet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get baseboard management controller key set of cluster": { + "$ref": "./examples/BmcKeySets_Get.json" + } + } + }, + "put": { + "description": "Create a new baseboard management controller key set or update the existing one for the provided cluster.", + "summary": "Create or update the baseboard management controller key set of the cluster.", + "operationId": "BmcKeySets_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/BmcKeySetNameParameter" + }, + { + "description": "The request body.", + "name": "bmcKeySetParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BmcKeySet" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/BmcKeySet" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/BmcKeySet" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update baseboard management controller key set of cluster": { + "$ref": "./examples/BmcKeySets_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the baseboard management controller key set of the provided cluster.", + "summary": "Delete the baseboard management controller key set of the cluster.", + "operationId": "BmcKeySets_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/BmcKeySetNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete baseboard management controller key set of cluster": { + "$ref": "./examples/BmcKeySets_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Patch properties of baseboard management controller key set for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently.", + "summary": "Patch baseboard management controller key set of the cluster.", + "operationId": "BmcKeySets_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/BmcKeySetNameParameter" + }, + { + "description": "The request body.", + "name": "bmcKeySetUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/BmcKeySetPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/BmcKeySet" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/BmcKeySet" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch baseboard management controller key set of cluster": { + "$ref": "./examples/BmcKeySets_Patch.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.NetworkCloud/clusters/{clusterName}/continueUpdateVersion": { + "post": { + "description": "Trigger the continuation of an update for a cluster with a matching update strategy that has paused after completing a segment of the update.", + "summary": "Continue a paused update to the cluster version.", + "operationId": "Clusters_ContinueUpdateVersion", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "description": "The request body.", + "name": "clusterContinueUpdateVersionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterContinueUpdateVersionParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Continue update cluster version": { + "$ref": "./examples/Clusters_ContinueUpdateVersion.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/deploy": { + "post": { + "description": "Deploy the cluster using the rack configuration provided during creation.", + "summary": "Deploy the cluster.", + "operationId": "Clusters_Deploy", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "description": "The request body.", + "name": "clusterDeployParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/ClusterDeployParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deploy cluster": { + "$ref": "./examples/Clusters_Deploy.json" + }, + "Deploy cluster skipping validation": { + "$ref": "./examples/Clusters_Deploy_SkipValidation.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/metricsConfigurations": { + "get": { + "description": "Get a list of metrics configurations for the provided cluster.", + "summary": "List metrics configurations of the cluster.", + "operationId": "MetricsConfigurations_ListByCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/ClusterMetricsConfigurationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List metrics configurations of the cluster": { + "$ref": "./examples/ClusterMetricsConfigurations_ListByCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/metricsConfigurations/{metricsConfigurationName}": { + "get": { + "description": "Get metrics configuration of the provided cluster.", + "summary": "Retrieve the metrics configuration of the cluster.", + "operationId": "MetricsConfigurations_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/MetricsConfigurationName" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/ClusterMetricsConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get metrics configuration of cluster": { + "$ref": "./examples/ClusterMetricsConfigurations_Get.json" + } + } + }, + "put": { + "description": "Create new or update the existing metrics configuration of the provided cluster.", + "summary": "Create or update metrics configuration of the cluster.", + "operationId": "MetricsConfigurations_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/MetricsConfigurationName" + }, + { + "description": "The request body.", + "name": "metricsConfigurationParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterMetricsConfiguration" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/ClusterMetricsConfiguration" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/ClusterMetricsConfiguration" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update metrics configuration of cluster": { + "$ref": "./examples/ClusterMetricsConfigurations_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the metrics configuration of the provided cluster.", + "summary": "Delete the metrics configuration of the cluster.", + "operationId": "MetricsConfigurations_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/MetricsConfigurationName" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete metrics configuration of cluster": { + "$ref": "./examples/ClusterMetricsConfigurations_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Patch properties of metrics configuration for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently.", + "summary": "Patch metrics configuration of the cluster.", + "operationId": "MetricsConfigurations_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/MetricsConfigurationName" + }, + { + "description": "The request body.", + "name": "metricsConfigurationUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/ClusterMetricsConfigurationPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/ClusterMetricsConfiguration" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/ClusterMetricsConfiguration" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch metrics configuration of cluster": { + "$ref": "./examples/ClusterMetricsConfigurations_Patch.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.NetworkCloud/clusters/{clusterName}/scanRuntime": { + "post": { + "description": "Triggers the execution of a runtime protection scan to detect and remediate detected issues, in accordance with the cluster configuration.", + "summary": "Execute a runtime protection scan on the cluster.", + "operationId": "Clusters_ScanRuntime", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "description": "The request body.", + "name": "ClusterScanRuntimeParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/ClusterScanRuntimeParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Execute a runtime protection scan on the cluster": { + "$ref": "./examples/Clusters_ScanRuntime.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/updateVersion": { + "post": { + "description": "Update the version of the provided cluster to one of the available supported versions.", + "summary": "Update the cluster version.", + "operationId": "Clusters_UpdateVersion", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "description": "The request body.", + "name": "clusterUpdateVersionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUpdateVersionParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update cluster version": { + "$ref": "./examples/Clusters_UpdateVersion.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters": { + "get": { + "description": "Get a list of Kubernetes clusters in the provided resource group.", + "summary": "List Kubernetes clusters in the resource group.", + "operationId": "KubernetesClusters_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/KubernetesClusterList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Kubernetes clusters for resource group": { + "$ref": "./examples/KubernetesClusters_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}": { + "get": { + "description": "Get properties of the provided the Kubernetes cluster.", + "summary": "Retrieve the Kubernetes cluster.", + "operationId": "KubernetesClusters_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/KubernetesCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Kubernetes cluster": { + "$ref": "./examples/KubernetesClusters_Get.json" + } + } + }, + "put": { + "description": "Create a new Kubernetes cluster or update the properties of the existing one.", + "summary": "Create or update the Kubernetes cluster.", + "operationId": "KubernetesClusters_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + }, + { + "description": "The request body.", + "name": "kubernetesClusterParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/KubernetesCluster" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/KubernetesCluster" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/KubernetesCluster" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update Kubernetes cluster": { + "$ref": "./examples/KubernetesClusters_Create.json" + }, + "Create or update Kubernetes cluster with a layer 2 load balancer": { + "$ref": "./examples/KubernetesClusters_L2LoadBalancer_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided Kubernetes cluster.", + "summary": "Delete the Kubernetes cluster.", + "operationId": "KubernetesClusters_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Kubernetes cluster": { + "$ref": "./examples/KubernetesClusters_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Patch the properties of the provided Kubernetes cluster, or update the tags associated with the Kubernetes cluster. Properties and tag updates can be done independently.", + "summary": "Patch the Kubernetes cluster.", + "operationId": "KubernetesClusters_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + }, + { + "description": "The request body.", + "name": "kubernetesClusterUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/KubernetesClusterPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/KubernetesCluster" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/KubernetesCluster" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Kubernetes cluster": { + "$ref": "./examples/KubernetesClusters_Patch.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.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/agentPools": { + "get": { + "description": "Get a list of agent pools for the provided Kubernetes cluster.", + "summary": "List agent pools of the Kubernetes cluster.", + "operationId": "AgentPools_ListByKubernetesCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/AgentPoolList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List agent pools of the Kubernetes cluster": { + "$ref": "./examples/AgentPools_ListByKubernetesCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/agentPools/{agentPoolName}": { + "get": { + "description": "Get properties of the provided Kubernetes cluster agent pool.", + "summary": "Retrieve the Kubernetes cluster agent pool.", + "operationId": "AgentPools_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Kubernetes cluster agent pool": { + "$ref": "./examples/AgentPools_Get.json" + } + } + }, + "put": { + "description": "Create a new Kubernetes cluster agent pool or update the properties of the existing one.", + "summary": "Create or update the Kubernetes cluster agent pool.", + "operationId": "AgentPools_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "description": "The request body.", + "name": "agentPoolParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentPool" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/AgentPool" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update Kubernetes cluster agent pool": { + "$ref": "./examples/AgentPools_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided Kubernetes cluster agent pool.", + "summary": "Delete the Kubernetes cluster agent pool.", + "operationId": "AgentPools_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Kubernetes cluster agent pool": { + "$ref": "./examples/AgentPools_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Patch the properties of the provided Kubernetes cluster agent pool, or update the tags associated with the Kubernetes cluster agent pool. Properties and tag updates can be done independently.", + "summary": "Patch the Kubernetes cluster agent pool.", + "operationId": "AgentPools_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "description": "The request body.", + "name": "agentPoolUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/AgentPoolPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/AgentPool" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Kubernetes cluster agent pool": { + "$ref": "./examples/AgentPools_Patch.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.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/features": { + "get": { + "description": "Get a list of features for the provided Kubernetes cluster.", + "summary": "List features for the Kubernetes cluster.", + "operationId": "KubernetesClusterFeatures_ListByKubernetesCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/KubernetesClusterFeatureList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List features for the Kubernetes cluster.": { + "$ref": "./examples/KubernetesClusterFeatures_ListByKubernetesCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/features/{featureName}": { + "get": { + "description": "Get properties of the provided the Kubernetes cluster feature.", + "summary": "Retrieve the Kubernetes cluster feature.", + "operationId": "KubernetesClusterFeatures_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + }, + { + "$ref": "#/parameters/FeatureNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/KubernetesClusterFeature" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Kubernetes cluster feature": { + "$ref": "./examples/KubernetesClusterFeatures_Get.json" + } + } + }, + "put": { + "description": "Create a new Kubernetes cluster feature or update properties of the Kubernetes cluster feature if it exists.", + "summary": "Create or update the Kubernetes cluster feature.", + "operationId": "KubernetesClusterFeatures_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + }, + { + "$ref": "#/parameters/FeatureNameParameter" + }, + { + "description": "The request body.", + "name": "kubernetesClusterFeatureParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/KubernetesClusterFeature" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/KubernetesClusterFeature" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/KubernetesClusterFeature" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update Kubernetes cluster feature": { + "$ref": "./examples/KubernetesClusterFeatures_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided Kubernetes cluster feature.", + "summary": "Delete the Kubernetes cluster feature.", + "operationId": "KubernetesClusterFeatures_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + }, + { + "$ref": "#/parameters/FeatureNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Kubernetes cluster feature": { + "$ref": "./examples/KubernetesClusterFeatures_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Patch properties of the provided Kubernetes cluster feature.", + "summary": "Patch the Kubernetes cluster feature.", + "operationId": "KubernetesClusterFeatures_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + }, + { + "$ref": "#/parameters/FeatureNameParameter" + }, + { + "description": "The request body.", + "name": "kubernetesClusterFeatureUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/KubernetesClusterFeaturePatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/KubernetesClusterFeature" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/KubernetesClusterFeature" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Kubernetes cluster feature": { + "$ref": "./examples/KubernetesClusterFeatures_Patch.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.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/restartNode": { + "post": { + "description": "Restart a targeted node of a Kubernetes cluster.", + "summary": "Restart a targeted node.", + "operationId": "KubernetesClusters_RestartNode", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + }, + { + "description": "The request body.", + "name": "kubernetesClusterRestartNodeParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/KubernetesClusterRestartNodeParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Restart a Kubernetes cluster node": { + "$ref": "./examples/KubernetesClusters_RestartNode.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l2Networks": { + "get": { + "description": "Get a list of layer 2 (L2) networks in the provided resource group.", + "summary": "List layer 2 (L2) networks in the resource group.", + "operationId": "L2Networks_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/L2NetworkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List L2 networks for resource group": { + "$ref": "./examples/L2Networks_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l2Networks/{l2NetworkName}": { + "get": { + "description": "Get properties of the provided layer 2 (L2) network.", + "summary": "Retrieve the layer 2 (L2) network.", + "operationId": "L2Networks_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/L2NetworkNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/L2Network" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get L2 network": { + "$ref": "./examples/L2Networks_Get.json" + } + } + }, + "put": { + "description": "Create a new layer 2 (L2) network or update the properties of the existing network.", + "summary": "Create or update the layer 2 (L2) network.", + "operationId": "L2Networks_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/L2NetworkNameParameter" + }, + { + "description": "The request body.", + "name": "l2NetworkParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/L2Network" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/L2Network" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/L2Network" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update L2 network": { + "$ref": "./examples/L2Networks_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided layer 2 (L2) network.", + "summary": "Delete the layer 2 (L2) network.", + "operationId": "L2Networks_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/L2NetworkNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete L2 network": { + "$ref": "./examples/L2Networks_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Update tags associated with the provided layer 2 (L2) network.", + "summary": "Patch the layer 2 (L2) network.", + "operationId": "L2Networks_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/L2NetworkNameParameter" + }, + { + "description": "The request body.", + "name": "l2NetworkUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/L2NetworkPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/L2Network" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch L2 network": { + "$ref": "./examples/L2Networks_Patch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l3Networks": { + "get": { + "description": "Get a list of layer 3 (L3) networks in the provided resource group.", + "summary": "List layer 3 (L3) networks in the resource group.", + "operationId": "L3Networks_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/L3NetworkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List L3 networks for resource group": { + "$ref": "./examples/L3Networks_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l3Networks/{l3NetworkName}": { + "get": { + "description": "Get properties of the provided layer 3 (L3) network.", + "summary": "Retrieve the layer 3 (L3) network.", + "operationId": "L3Networks_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/L3NetworkNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/L3Network" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get L3network": { + "$ref": "./examples/L3Networks_Get.json" + } + } + }, + "put": { + "description": "Create a new layer 3 (L3) network or update the properties of the existing network.", + "summary": "Create or update the layer 3 (L3) network.", + "operationId": "L3Networks_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/L3NetworkNameParameter" + }, + { + "description": "The request body.", + "name": "l3NetworkParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/L3Network" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/L3Network" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/L3Network" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update L3 network": { + "$ref": "./examples/L3Networks_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided layer 3 (L3) network.", + "summary": "Delete the layer 3 (L3) network.", + "operationId": "L3Networks_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/L3NetworkNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete L3 network": { + "$ref": "./examples/L3Networks_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Update tags associated with the provided layer 3 (L3) network.", + "summary": "Patch the layer 3 (L3) network.", + "operationId": "L3Networks_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/L3NetworkNameParameter" + }, + { + "description": "The request body.", + "name": "l3NetworkUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/L3NetworkPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/L3Network" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch L3 network": { + "$ref": "./examples/L3Networks_Patch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/racks": { + "get": { + "description": "Get a list of racks in the provided resource group.", + "summary": "List racks in the resource group.", + "operationId": "Racks_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/RackList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List racks for resource group": { + "$ref": "./examples/Racks_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/racks/{rackName}": { + "get": { + "description": "Get properties of the provided rack.", + "summary": "Retrieve the rack.", + "operationId": "Racks_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RackNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/Rack" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get rack": { + "$ref": "./examples/Racks_Get.json" + } + } + }, + "put": { + "description": "Create a new rack or update properties of the existing one.\nAll customer initiated requests will be rejected as the life cycle of this resource is managed by the system.", + "summary": "Create or update the rack.", + "operationId": "Racks_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RackNameParameter" + }, + { + "description": "The request body.", + "name": "rackParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Rack" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/Rack" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/Rack" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update rack": { + "$ref": "./examples/Racks_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided rack.\nAll customer initiated requests will be rejected as the life cycle of this resource is managed by the system.", + "summary": "Delete the rack.", + "operationId": "Racks_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RackNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete rack": { + "$ref": "./examples/Racks_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Patch properties of the provided rack, or update the tags associated with the rack. Properties and tag updates can be done independently.", + "summary": "Patch the rack.", + "operationId": "Racks_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RackNameParameter" + }, + { + "description": "The request body.", + "name": "rackUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/RackPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/Rack" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/Rack" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch rack": { + "$ref": "./examples/Racks_Patch.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.NetworkCloud/storageAppliances": { + "get": { + "description": "Get a list of storage appliances in the provided resource group.", + "summary": "List storage appliances in the resource group.", + "operationId": "StorageAppliances_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/StorageApplianceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List storage appliances for resource group": { + "$ref": "./examples/StorageAppliances_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances/{storageApplianceName}": { + "get": { + "description": "Get properties of the provided storage appliance.", + "summary": "Retrieve the storage appliance.", + "operationId": "StorageAppliances_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageApplianceNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/StorageAppliance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get storage appliance": { + "$ref": "./examples/StorageAppliances_Get.json" + } + } + }, + "put": { + "description": "Create a new storage appliance or update the properties of the existing one.\nAll customer initiated requests will be rejected as the life cycle of this resource is managed by the system.", + "summary": "Create or update the storage appliance.", + "operationId": "StorageAppliances_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageApplianceNameParameter" + }, + { + "description": "The request body.", + "name": "storageApplianceParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAppliance" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/StorageAppliance" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/StorageAppliance" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update storage appliance": { + "$ref": "./examples/StorageAppliances_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided storage appliance.\nAll customer initiated requests will be rejected as the life cycle of this resource is managed by the system.", + "summary": "Delete the storage appliance.", + "operationId": "StorageAppliances_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageApplianceNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete storage appliance": { + "$ref": "./examples/StorageAppliances_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Update properties of the provided storage appliance, or update tags associated with the storage appliance Properties and tag updates can be done independently.", + "summary": "Patch the storage appliance.", + "operationId": "StorageAppliances_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageApplianceNameParameter" + }, + { + "description": "The request body.", + "name": "storageApplianceUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/StorageAppliancePatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/StorageAppliance" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/StorageAppliance" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch storage appliance": { + "$ref": "./examples/StorageAppliances_Patch.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.NetworkCloud/storageAppliances/{storageApplianceName}/disableRemoteVendorManagement": { + "post": { + "description": "Disable remote vendor management of the provided storage appliance.", + "summary": "Turn off remote vendor management for a storage appliance, if supported.", + "operationId": "StorageAppliances_DisableRemoteVendorManagement", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageApplianceNameParameter" + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Turn off remote vendor management for storage appliance": { + "$ref": "./examples/StorageAppliances_DisableRemoteVendorManagement.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances/{storageApplianceName}/enableRemoteVendorManagement": { + "post": { + "description": "Enable remote vendor management of the provided storage appliance.", + "summary": "Turn on remote vendor management for a storage appliance, if supported.", + "operationId": "StorageAppliances_EnableRemoteVendorManagement", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageApplianceNameParameter" + }, + { + "description": "The request body.", + "name": "storageApplianceEnableRemoteVendorManagementParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/StorageApplianceEnableRemoteVendorManagementParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Turn on remote vendor management for storage appliance": { + "$ref": "./examples/StorageAppliances_EnableRemoteVendorManagement.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/trunkedNetworks": { + "get": { + "description": "Get a list of trunked networks in the provided resource group.", + "summary": "List trunked networks in the resource group.", + "operationId": "TrunkedNetworks_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/TrunkedNetworkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Trunked networks for resource group": { + "$ref": "./examples/TrunkedNetworks_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/trunkedNetworks/{trunkedNetworkName}": { + "get": { + "description": "Get properties of the provided trunked network.", + "summary": "Retrieve the trunked network.", + "operationId": "TrunkedNetworks_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TrunkedNetworkNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/TrunkedNetwork" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Trunked network": { + "$ref": "./examples/TrunkedNetworks_Get.json" + } + } + }, + "put": { + "description": "Create a new trunked network or update the properties of the existing trunked network.", + "summary": "Create or update the trunked network.", + "operationId": "TrunkedNetworks_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TrunkedNetworkNameParameter" + }, + { + "description": "The request body.", + "name": "trunkedNetworkParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TrunkedNetwork" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/TrunkedNetwork" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/TrunkedNetwork" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update trunked network": { + "$ref": "./examples/TrunkedNetworks_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided trunked network.", + "summary": "Delete the trunked network.", + "operationId": "TrunkedNetworks_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TrunkedNetworkNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete trunked network": { + "$ref": "./examples/TrunkedNetworks_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Update tags associated with the provided trunked network.", + "summary": "Patch the trunked network.", + "operationId": "TrunkedNetworks_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TrunkedNetworkNameParameter" + }, + { + "description": "The request body.", + "name": "trunkedNetworkUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/TrunkedNetworkPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/TrunkedNetwork" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch trunked network": { + "$ref": "./examples/TrunkedNetworks_Patch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines": { + "get": { + "description": "Get a list of virtual machines in the provided resource group.", + "summary": "List virtual machines in the resource group.", + "operationId": "VirtualMachines_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/VirtualMachineList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List virtual machines for resource group": { + "$ref": "./examples/VirtualMachines_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}": { + "get": { + "description": "Get properties of the provided virtual machine.", + "summary": "Retrieve the virtual machine.", + "operationId": "VirtualMachines_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get virtual machine": { + "$ref": "./examples/VirtualMachines_Get.json" + } + } + }, + "put": { + "description": "Create a new virtual machine or update the properties of the existing virtual machine.", + "summary": "Create or update the virtual machine.", + "operationId": "VirtualMachines_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + }, + { + "description": "The request body.", + "name": "virtualMachineParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/VirtualMachine" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update virtual machine": { + "$ref": "./examples/VirtualMachines_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided virtual machine.", + "summary": "Delete the virtual machine.", + "operationId": "VirtualMachines_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete virtual machine": { + "$ref": "./examples/VirtualMachines_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Patch the properties of the provided virtual machine, or update the tags associated with the virtual machine. Properties and tag updates can be done independently.", + "summary": "Patch the virtual machine.", + "operationId": "VirtualMachines_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + }, + { + "description": "The request body.", + "name": "virtualMachineUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/VirtualMachinePatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/VirtualMachine" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch virtual machine": { + "$ref": "./examples/VirtualMachines_Patch.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.NetworkCloud/virtualMachines/{virtualMachineName}/consoles": { + "get": { + "description": "Get a list of consoles for the provided virtual machine.", + "summary": "List consoles of the virtual machine.", + "operationId": "Consoles_ListByVirtualMachine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/ConsoleList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List consoles of the virtual machine": { + "$ref": "./examples/Consoles_ListByVirtualMachine.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/consoles/{consoleName}": { + "get": { + "description": "Get properties of the provided virtual machine console.", + "summary": "Retrieve the virtual machine console.", + "operationId": "Consoles_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + }, + { + "$ref": "#/parameters/ConsoleNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/Console" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get virtual machine console": { + "$ref": "./examples/Consoles_Get.json" + } + } + }, + "put": { + "description": "Create a new virtual machine console or update the properties of the existing virtual machine console.", + "summary": "Create or update the virtual machine console.", + "operationId": "Consoles_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + }, + { + "$ref": "#/parameters/ConsoleNameParameter" + }, + { + "description": "The request body.", + "name": "consoleParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Console" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/Console" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/Console" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update virtual machine console": { + "$ref": "./examples/Consoles_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided virtual machine console.", + "summary": "Delete the virtual machine console.", + "operationId": "Consoles_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + }, + { + "$ref": "#/parameters/ConsoleNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete virtual machine console": { + "$ref": "./examples/Consoles_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Patch the properties of the provided virtual machine console, or update the tags associated with the virtual machine console. Properties and tag updates can be done independently.", + "summary": "Patch the virtual machine console.", + "operationId": "Consoles_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + }, + { + "$ref": "#/parameters/ConsoleNameParameter" + }, + { + "description": "The request body.", + "name": "consoleUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/ConsolePatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/Console" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/Console" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch virtual machine console": { + "$ref": "./examples/Consoles_Patch.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.NetworkCloud/virtualMachines/{virtualMachineName}/powerOff": { + "post": { + "description": "Power off the provided virtual machine.", + "summary": "Power off the virtual machine.", + "operationId": "VirtualMachines_PowerOff", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + }, + { + "description": "The request body.", + "name": "virtualMachinePowerOffParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/VirtualMachinePowerOffParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Power off virtual machine": { + "$ref": "./examples/VirtualMachines_PowerOff.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/reimage": { + "post": { + "description": "Reimage the provided virtual machine.", + "summary": "Reimage the virtual machine.", + "operationId": "VirtualMachines_Reimage", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Reimage virtual machine": { + "$ref": "./examples/VirtualMachines_Reimage.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/restart": { + "post": { + "description": "Restart the provided virtual machine.", + "summary": "Restart the virtual machine.", + "operationId": "VirtualMachines_Restart", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Restart virtual machine": { + "$ref": "./examples/VirtualMachines_Restart.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/start": { + "post": { + "description": "Start the provided virtual machine.", + "summary": "Start the virtual machine.", + "operationId": "VirtualMachines_Start", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Start virtual machine": { + "$ref": "./examples/VirtualMachines_Start.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/volumes": { + "get": { + "description": "Get a list of volumes in the provided resource group.", + "summary": "List volumes in the resource group.", + "operationId": "Volumes_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/VolumeList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List volumes for resource group": { + "$ref": "./examples/Volumes_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/volumes/{volumeName}": { + "get": { + "description": "Get properties of the provided volume.", + "summary": "Retrieve the volume.", + "operationId": "Volumes_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VolumeNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/Volume" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get volume": { + "$ref": "./examples/Volumes_Get.json" + } + } + }, + "put": { + "description": "Create a new volume or update the properties of the existing one.", + "summary": "Create or update the volume.", + "operationId": "Volumes_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VolumeNameParameter" + }, + { + "description": "The request body.", + "name": "volumeParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Volume" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/Volume" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/Volume" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update volume": { + "$ref": "./examples/Volumes_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided volume.", + "summary": "Delete the volume.", + "operationId": "Volumes_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VolumeNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete volume": { + "$ref": "./examples/Volumes_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Update tags associated with the provided volume.", + "summary": "Patch the volume.", + "operationId": "Volumes_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VolumeNameParameter" + }, + { + "description": "The request body.", + "name": "volumeUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/VolumePatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/Volume" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch volume": { + "$ref": "./examples/Volumes_Patch.json" + } + } + } + } + }, + "definitions": { + "AadConfiguration": { + "type": "object", + "title": "AadConfiguration represents the Azure Active Directory Integration properties.", + "required": [ + "adminGroupObjectIds" + ], + "properties": { + "adminGroupObjectIds": { + "description": "The list of Azure Active Directory group object IDs that will have an administrative role on the Kubernetes cluster.", + "type": "array", + "minItems": 1, + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "AdministrativeCredentials": { + "type": "object", + "title": "AdministrativeCredentials represents the admin credentials for the device requiring password-based authentication.", + "required": [ + "username", + "password" + ], + "properties": { + "password": { + "description": "The password of the administrator of the device used during initialization.", + "type": "string", + "minLength": 1, + "x-ms-secret": true + }, + "username": { + "description": "The username of the administrator of the device used during initialization.", + "type": "string", + "minLength": 1 + } + } + }, + "AdministratorConfiguration": { + "type": "object", + "title": "AdministratorConfiguration represents the administrative credentials that will be applied to the control plane and agent pool nodes in Kubernetes clusters.", + "properties": { + "adminUsername": { + "description": "The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sshPublicKeys": { + "description": "The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment.", + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + } + } + } + }, + "AdministratorConfigurationPatch": { + "type": "object", + "title": "AdministratorConfigurationPatch represents the patching capabilities for the administrator configuration.", + "properties": { + "sshPublicKeys": { + "description": "SshPublicKey represents the public key used to authenticate with a resource through SSH.", + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "x-ms-identifiers": [ + "keyData" + ] + } + } + }, + "AgentOptions": { + "type": "object", + "title": "AgentOptions are configurations that will be applied to each agent in an agent pool.", + "required": [ + "hugepagesCount" + ], + "properties": { + "hugepagesCount": { + "description": "The number of hugepages to allocate.", + "type": "integer", + "format": "int64" + }, + "hugepagesSize": { + "description": "The size of the hugepages to allocate.", + "type": "string", + "default": "2M", + "enum": [ + "2M", + "1G" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "HugepagesSize" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "AgentPool": { + "type": "object", + "title": "AgentPool represents the agent pool of Kubernetes cluster.", + "required": [ + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/AgentPoolProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "AgentPoolConfiguration": { + "type": "object", + "title": "AgentPoolConfiguration specifies the configuration of a pool of nodes.", + "required": [ + "count", + "mode", + "vmSkuName" + ], + "properties": { + "administratorConfiguration": { + "$ref": "#/definitions/AdministratorConfiguration", + "description": "The administrator credentials to be used for the nodes in this agent pool." + }, + "agentOptions": { + "$ref": "#/definitions/AgentOptions", + "description": "The configurations that will be applied to each agent in this agent pool.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "attachedNetworkConfiguration": { + "$ref": "#/definitions/AttachedNetworkConfiguration", + "description": "The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "availabilityZones": { + "description": "The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "count": { + "description": "The number of virtual machines that use this configuration.", + "type": "integer", + "format": "int64" + }, + "labels": { + "description": "The labels applied to the nodes in this agent pool.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesLabel" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "mode": { + "description": "The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.", + "type": "string", + "enum": [ + "System", + "User", + "NotApplicable" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AgentPoolMode" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "taints": { + "description": "The taints applied to the nodes in this agent pool.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesLabel" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "The configuration of the agent pool." + }, + "vmSkuName": { + "description": "The name of the VM SKU that determines the size of resources allocated for node VMs.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "AgentPoolList": { + "type": "object", + "title": "AgentPoolList represents a list of Kubernetes cluster agent pools.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of agent pools.", + "type": "array", + "items": { + "$ref": "#/definitions/AgentPool" + } + } + } + }, + "AgentPoolPatchParameters": { + "type": "object", + "title": "AgentPoolPatchParameters represents the body of the request to patch the Kubernetes cluster agent pool.", + "properties": { + "properties": { + "$ref": "#/definitions/AgentPoolPatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "AgentPoolPatchProperties": { + "type": "object", + "title": "AgentPoolPatchProperties represents the properties of an agent pool that can be modified.", + "properties": { + "administratorConfiguration": { + "$ref": "#/definitions/NodePoolAdministratorConfigurationPatch", + "description": "The configuration of administrator credentials for the control plane nodes." + }, + "count": { + "description": "The number of virtual machines that use this configuration.", + "type": "integer", + "format": "int64" + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "The configuration of the agent pool." + } + } + }, + "AgentPoolProperties": { + "type": "object", + "title": "AgentPoolProperties represents the properties of the Kubernetes cluster agent pool.", + "required": [ + "count", + "mode", + "vmSkuName" + ], + "properties": { + "administratorConfiguration": { + "$ref": "#/definitions/AdministratorConfiguration", + "description": "The administrator credentials to be used for the nodes in this agent pool.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "agentOptions": { + "$ref": "#/definitions/AgentOptions", + "description": "The configurations that will be applied to each agent in this agent pool.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "attachedNetworkConfiguration": { + "$ref": "#/definitions/AttachedNetworkConfiguration", + "description": "The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "availabilityZones": { + "description": "The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "count": { + "description": "The number of virtual machines that use this configuration.", + "type": "integer", + "format": "int64" + }, + "detailedStatus": { + "description": "The current status of the agent pool.", + "type": "string", + "enum": [ + "Available", + "Error", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AgentPoolDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "kubernetesVersion": { + "description": "The Kubernetes version running in this agent pool.", + "type": "string", + "readOnly": true + }, + "labels": { + "description": "The labels applied to the nodes in this agent pool.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesLabel" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "mode": { + "description": "The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.", + "type": "string", + "enum": [ + "System", + "User", + "NotApplicable" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AgentPoolMode" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "description": "The provisioning state of the agent pool.", + "type": "string", + "enum": [ + "Accepted", + "Canceled", + "Deleting", + "Failed", + "InProgress", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AgentPoolProvisioningState" + }, + "readOnly": true + }, + "taints": { + "description": "The taints applied to the nodes in this agent pool.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesLabel" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "The configuration of the agent pool." + }, + "vmSkuName": { + "description": "The name of the VM SKU that determines the size of resources allocated for node VMs.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "AgentPoolUpgradeSettings": { + "type": "object", + "title": "AgentPoolUpgradeSettings specifies the upgrade settings for an agent pool.", + "properties": { + "drainTimeout": { + "description": "The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used.", + "type": "integer", + "format": "int64", + "maximum": 86400, + "minimum": 60 + }, + "maxSurge": { + "description": "The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0.", + "type": "string" + }, + "maxUnavailable": { + "description": "The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0.", + "type": "string" + } + } + }, + "AttachedNetworkConfiguration": { + "type": "object", + "title": "AttachedNetworkConfiguration represents the set of workload networks to attach to a resource.", + "properties": { + "l2Networks": { + "description": "The list of Layer 2 Networks and related configuration for attachment.", + "type": "array", + "items": { + "$ref": "#/definitions/L2NetworkAttachmentConfiguration" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "l3Networks": { + "description": "The list of Layer 3 Networks and related configuration for attachment.", + "type": "array", + "items": { + "$ref": "#/definitions/L3NetworkAttachmentConfiguration" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "trunkedNetworks": { + "description": "The list of Trunked Networks and related configuration for attachment.", + "type": "array", + "items": { + "$ref": "#/definitions/TrunkedNetworkAttachmentConfiguration" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "AvailableUpgrade": { + "type": "object", + "title": "AvailableUpgrade represents an upgrade available for a Kubernetes cluster.", + "properties": { + "availabilityLifecycle": { + "description": "The version lifecycle indicator.", + "type": "string", + "enum": [ + "Preview", + "GenerallyAvailable" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AvailabilityLifecycle" + }, + "readOnly": true + }, + "version": { + "description": "The version available for upgrading.", + "type": "string", + "readOnly": true + } + } + }, + "BareMetalMachine": { + "type": "object", + "title": "BareMetalMachine represents the physical machine in the rack.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/BareMetalMachineProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "BareMetalMachineCommandSpecification": { + "type": "object", + "title": "BareMetalMachineCommandSpecification represents the command and optional arguments to exercise against the bare metal machine.", + "required": [ + "command" + ], + "properties": { + "arguments": { + "description": "The list of string arguments that will be passed to the script in order as separate arguments.", + "type": "array", + "items": { + "type": "string" + } + }, + "command": { + "description": "The command to execute against the bare metal machine.", + "type": "string" + } + } + }, + "BareMetalMachineConfigurationData": { + "type": "object", + "title": "BareMetalMachineConfigurationData represents configuration for the bare metal machine.", + "required": [ + "rackSlot", + "bootMacAddress", + "bmcCredentials", + "bmcMacAddress", + "serialNumber" + ], + "properties": { + "bmcConnectionString": { + "description": "The connection string for the baseboard management controller including IP address and protocol.", + "type": "string", + "readOnly": true + }, + "bmcCredentials": { + "$ref": "#/definitions/AdministrativeCredentials", + "description": "The credentials of the baseboard management controller on this bare metal machine." + }, + "bmcMacAddress": { + "description": "The MAC address of the BMC for this machine.", + "type": "string", + "pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$" + }, + "bootMacAddress": { + "description": "The MAC address associated with the PXE NIC card.", + "type": "string", + "pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$" + }, + "machineDetails": { + "description": "The free-form additional information about the machine, e.g. an asset tag.", + "type": "string", + "maxLength": 256 + }, + "machineName": { + "description": "The user-provided name for the bare metal machine created from this specification.\nIf not provided, the machine name will be generated programmatically.", + "type": "string", + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$" + }, + "rackSlot": { + "description": "The slot the physical machine is in the rack based on the BOM configuration.", + "type": "integer", + "format": "int64", + "maximum": 256, + "minimum": 1 + }, + "serialNumber": { + "description": "The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag.", + "type": "string", + "maxLength": 64 + } + } + }, + "BareMetalMachineCordonParameters": { + "type": "object", + "title": "BareMetalMachineCordonParameters represents the body of the request to evacuate workloads from node on a bare metal machine.", + "properties": { + "evacuate": { + "description": "The indicator of whether to evacuate the node workload when the bare metal machine is cordoned.", + "type": "string", + "default": "False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachineEvacuate" + } + } + } + }, + "BareMetalMachineKeySet": { + "type": "object", + "title": "BareMetalMachineKeySet represents the bare metal machine key set.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/BareMetalMachineKeySetProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "BareMetalMachineKeySetList": { + "type": "object", + "title": "BareMetalMachineKeySetList represents a list of bare metal machine key sets.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of bare metal machine key sets.", + "type": "array", + "items": { + "$ref": "#/definitions/BareMetalMachineKeySet" + } + } + } + }, + "BareMetalMachineKeySetPatchParameters": { + "type": "object", + "title": "BareMetalMachineKeySetPatchParameters represents the body of the request to patch the bare metal machine key set.", + "properties": { + "properties": { + "$ref": "#/definitions/BareMetalMachineKeySetPatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "BareMetalMachineKeySetPatchProperties": { + "type": "object", + "title": "BareMetalMachineKeySetPatchProperties represents the properties of bare metal machine key set that can be patched.", + "properties": { + "expiration": { + "description": "The date and time after which the users in this key set will be removed from the bare metal machines.", + "type": "string", + "format": "date-time" + }, + "jumpHostsAllowed": { + "description": "The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users.", + "type": "array", + "items": { + "type": "string" + } + }, + "userList": { + "description": "The unique list of permitted users.", + "type": "array", + "items": { + "$ref": "#/definitions/KeySetUser" + }, + "x-ms-identifiers": [ + "azureUserName" + ] + } + } + }, + "BareMetalMachineKeySetProperties": { + "type": "object", + "title": "BareMetalMachineKeySetProperties represents the properties of bare metal machine key set.", + "required": [ + "privilegeLevel", + "expiration", + "azureGroupId", + "jumpHostsAllowed", + "userList" + ], + "properties": { + "azureGroupId": { + "description": "The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "detailedStatus": { + "description": "The more detailed status of the key set.", + "type": "string", + "enum": [ + "AllActive", + "SomeInvalid", + "AllInvalid", + "Validating" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachineKeySetDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "expiration": { + "description": "The date and time after which the users in this key set will be removed from the bare metal machines.", + "type": "string", + "format": "date-time" + }, + "jumpHostsAllowed": { + "description": "The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users.", + "type": "array", + "items": { + "type": "string" + } + }, + "lastValidation": { + "description": "The last time this key set was validated.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "osGroupName": { + "description": "The name of the group that users will be assigned to on the operating system of the machines.", + "type": "string", + "maxLength": 32, + "pattern": "^([A-Za-z]([A-Za-z0-9]*))$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "privilegeLevel": { + "description": "The access level allowed for the users in this key set.", + "type": "string", + "enum": [ + "Standard", + "Superuser" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachineKeySetPrivilegeLevel" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "description": "The provisioning state of the bare metal machine key set.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachineKeySetProvisioningState" + }, + "readOnly": true + }, + "userList": { + "description": "The unique list of permitted users.", + "type": "array", + "items": { + "$ref": "#/definitions/KeySetUser" + }, + "x-ms-identifiers": [ + "azureUserName" + ] + }, + "userListStatus": { + "description": "The status evaluation of each user.", + "type": "array", + "items": { + "$ref": "#/definitions/KeySetUserStatus" + }, + "x-ms-identifiers": [ + "azureUserName" + ], + "readOnly": true + } + } + }, + "BareMetalMachineList": { + "type": "object", + "title": "BareMetalMachineList represents a list of bare metal machines.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of bare metal machines.", + "type": "array", + "items": { + "$ref": "#/definitions/BareMetalMachine" + } + } + } + }, + "BareMetalMachinePatchParameters": { + "type": "object", + "title": "BareMetalMachinePatchParameters represents the body of the request to patch bare metal machine properties.", + "properties": { + "properties": { + "$ref": "#/definitions/BareMetalMachinePatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "BareMetalMachinePatchProperties": { + "type": "object", + "title": "BareMetalMachinePatchProperties represents the properties of the bare metal machine that can be patched.", + "properties": { + "machineDetails": { + "description": "The details provided by the customer during the creation of rack manifests\nthat allows for custom data to be associated with this machine.", + "type": "string", + "maxLength": 256 + } + } + }, + "BareMetalMachinePowerOffParameters": { + "type": "object", + "title": "BareMetalMachinePowerOffParameters represents the body of the request to power off bare metal machine.", + "properties": { + "skipShutdown": { + "description": "The indicator of whether to skip the graceful OS shutdown and power off the bare metal machine immediately.", + "type": "string", + "default": "False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachineSkipShutdown" + } + } + } + }, + "BareMetalMachineProperties": { + "type": "object", + "title": "BareMetalMachineProperties represents the properties of a bare metal machine.", + "required": [ + "rackId", + "machineSkuId", + "rackSlot", + "machineName", + "bootMacAddress", + "bmcMacAddress", + "bmcCredentials", + "bmcConnectionString", + "machineDetails", + "serialNumber" + ], + "properties": { + "associatedResourceIds": { + "description": "The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "bmcConnectionString": { + "description": "The connection string for the baseboard management controller including IP address and protocol.", + "type": "string" + }, + "bmcCredentials": { + "$ref": "#/definitions/AdministrativeCredentials", + "description": "The credentials of the baseboard management controller on this bare metal machine." + }, + "bmcMacAddress": { + "description": "The MAC address of the BMC device.", + "type": "string", + "pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$" + }, + "bootMacAddress": { + "description": "The MAC address of a NIC connected to the PXE network.", + "type": "string", + "pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$" + }, + "clusterId": { + "description": "The resource ID of the cluster this bare metal machine is associated with.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "cordonStatus": { + "description": "The cordon status of the bare metal machine.", + "type": "string", + "enum": [ + "Cordoned", + "Uncordoned" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachineCordonStatus" + }, + "readOnly": true + }, + "detailedStatus": { + "description": "The more detailed status of the bare metal machine.", + "type": "string", + "enum": [ + "Preparing", + "Error", + "Available", + "Provisioning", + "Provisioned", + "Deprovisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachineDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "hardwareInventory": { + "$ref": "#/definitions/HardwareInventory", + "description": "The hardware inventory, including information acquired from the model/sku information and from the ironic inspector.", + "readOnly": true + }, + "hardwareValidationStatus": { + "$ref": "#/definitions/HardwareValidationStatus", + "description": "The details of the latest hardware validation performed for this bare metal machine.", + "readOnly": true + }, + "hybridAksClustersAssociatedIds": { + "description": "Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the HybridAksClusters that have nodes hosted on this bare metal machine.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "kubernetesNodeName": { + "description": "The name of this machine represented by the host object in the Cluster's Kubernetes control plane.", + "type": "string", + "readOnly": true + }, + "kubernetesVersion": { + "description": "The version of Kubernetes running on this machine.", + "type": "string", + "readOnly": true + }, + "machineClusterVersion": { + "description": "The cluster version that has been applied to this machine during deployment or a version update.", + "type": "string" + }, + "machineDetails": { + "description": "The custom details provided by the customer.", + "type": "string", + "maxLength": 256 + }, + "machineName": { + "description": "The OS-level hostname assigned to this machine.", + "type": "string", + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$" + }, + "machineRoles": { + "description": "The list of roles that are assigned to the cluster node running on this machine.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "machineSkuId": { + "description": "The unique internal identifier of the bare metal machine SKU.", + "type": "string" + }, + "oamIpv4Address": { + "description": "The IPv4 address that is assigned to the bare metal machine during the cluster deployment.", + "type": "string", + "readOnly": true + }, + "oamIpv6Address": { + "description": "The IPv6 address that is assigned to the bare metal machine during the cluster deployment.", + "type": "string", + "readOnly": true + }, + "osImage": { + "description": "The image that is currently provisioned to the OS disk.", + "type": "string", + "readOnly": true + }, + "powerState": { + "description": "The power state derived from the baseboard management controller.", + "type": "string", + "enum": [ + "On", + "Off" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachinePowerState" + }, + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the bare metal machine.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Accepted" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachineProvisioningState" + }, + "readOnly": true + }, + "rackId": { + "description": "The resource ID of the rack where this bare metal machine resides.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetworkCloud/racks" + } + ] + } + }, + "rackSlot": { + "description": "The rack slot in which this bare metal machine is located, ordered from the bottom up i.e. the lowest slot is 1.", + "type": "integer", + "format": "int64", + "maximum": 256, + "minimum": 1 + }, + "readyState": { + "description": "The indicator of whether the bare metal machine is ready to receive workloads.", + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachineReadyState" + }, + "readOnly": true + }, + "runtimeProtectionStatus": { + "$ref": "#/definitions/RuntimeProtectionStatus", + "description": "The runtime protection status of the bare metal machine.", + "readOnly": true + }, + "secretRotationStatus": { + "description": "The list of statuses that represent secret rotation activity.", + "type": "array", + "items": { + "$ref": "#/definitions/SecretRotationStatus" + }, + "x-ms-identifiers": [ + "secretType" + ], + "readOnly": true + }, + "serialNumber": { + "description": "The serial number of the bare metal machine.", + "type": "string", + "maxLength": 64, + "minLength": 1 + }, + "serviceTag": { + "description": "The discovered value of the machine's service tag.", + "type": "string", + "readOnly": true + }, + "virtualMachinesAssociatedIds": { + "description": "Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the VirtualMachines that are hosted on this bare metal machine.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "BareMetalMachineReplaceParameters": { + "type": "object", + "title": "BareMetalMachineReplaceParameters represents the body of the request to physically swap a bare metal machine for another.", + "properties": { + "bmcCredentials": { + "$ref": "#/definitions/AdministrativeCredentials", + "description": "The credentials of the baseboard management controller on this bare metal machine." + }, + "bmcMacAddress": { + "description": "The MAC address of the BMC device.", + "type": "string", + "pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$" + }, + "bootMacAddress": { + "description": "The MAC address of a NIC connected to the PXE network.", + "type": "string", + "pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$" + }, + "machineName": { + "description": "The OS-level hostname assigned to this machine.", + "type": "string", + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$" + }, + "serialNumber": { + "description": "The serial number of the bare metal machine.", + "type": "string", + "maxLength": 64, + "minLength": 1 + } + } + }, + "BareMetalMachineRunCommandParameters": { + "type": "object", + "title": "BareMetalMachineRunCommandParameters represents the body of the request to execute a script on the bare metal machine.", + "required": [ + "script", + "limitTimeSeconds" + ], + "properties": { + "arguments": { + "description": "The list of string arguments that will be passed to the script in order as separate arguments.", + "type": "array", + "items": { + "type": "string" + } + }, + "limitTimeSeconds": { + "description": "The maximum time the script is allowed to run.\nIf the execution time exceeds the maximum, the script will be stopped, any output produced until then will be captured, and the exit code matching a timeout will be returned (252).", + "type": "integer", + "format": "int64", + "maximum": 14400, + "minimum": 60 + }, + "script": { + "description": "The base64 encoded script to execute on the bare metal machine.", + "type": "string" + } + } + }, + "BareMetalMachineRunDataExtractsParameters": { + "type": "object", + "title": "BareMetalMachineRunDataExtractsParameters represents the body of request containing list of curated data extraction commands to run on the bare metal machine.", + "required": [ + "commands", + "limitTimeSeconds" + ], + "properties": { + "commands": { + "description": "The list of curated data extraction commands to be executed directly against the target machine.", + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/definitions/BareMetalMachineCommandSpecification" + }, + "x-ms-identifiers": [] + }, + "limitTimeSeconds": { + "description": "The maximum time the commands are allowed to run.\nIf the execution time exceeds the maximum, the script will be stopped, any output produced until then will be captured, and the exit code matching a timeout will be returned (252).", + "type": "integer", + "format": "int64", + "maximum": 14400, + "minimum": 60 + } + } + }, + "BareMetalMachineRunReadCommandsParameters": { + "type": "object", + "title": "BareMetalMachineRunReadCommandsParameters represents the body of request containing list of read-only commands to run on the bare metal machine.", + "required": [ + "commands", + "limitTimeSeconds" + ], + "properties": { + "commands": { + "description": "The list of read-only commands to be executed directly against the target machine.", + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/definitions/BareMetalMachineCommandSpecification" + }, + "x-ms-identifiers": [] + }, + "limitTimeSeconds": { + "description": "The maximum time the commands are allowed to run.\nIf the execution time exceeds the maximum, the script will be stopped, any output produced until then will be captured, and the exit code matching a timeout will be returned (252).", + "type": "integer", + "format": "int64", + "maximum": 14400, + "minimum": 60 + } + } + }, + "BgpAdvertisement": { + "type": "object", + "title": "BgpAdvertisement represents the association of IP address pools to the communities and peers.", + "required": [ + "ipAddressPools" + ], + "properties": { + "advertiseToFabric": { + "description": "The indicator of if this advertisement is also made to the network fabric associated with the Network Cloud Cluster. This field is ignored if fabricPeeringEnabled is set to False.", + "type": "string", + "default": "True", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AdvertiseToFabric" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "communities": { + "description": "The names of the BGP communities to be associated with the announcement, utilizing a BGP community string in 1234:1234 format.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ipAddressPools": { + "description": "The names of the IP address pools associated with this announcement.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "peers": { + "description": "The names of the BGP peers to limit this advertisement to. If no values are specified, all BGP peers will receive this advertisement.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "BgpServiceLoadBalancerConfiguration": { + "type": "object", + "title": "BgpServiceLoadBalancerConfiguration represents the configuration of a BGP service load balancer.", + "properties": { + "bgpAdvertisements": { + "description": "The association of IP address pools to the communities and peers, allowing for announcement of IPs.", + "type": "array", + "items": { + "$ref": "#/definitions/BgpAdvertisement" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "create" + ] + }, + "bgpPeers": { + "description": "The list of additional BgpPeer entities that the Kubernetes cluster will peer with. All peering must be explicitly defined.", + "type": "array", + "items": { + "$ref": "#/definitions/ServiceLoadBalancerBgpPeer" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "create" + ] + }, + "fabricPeeringEnabled": { + "description": "The indicator to specify if the load balancer peers with the network fabric.", + "type": "string", + "default": "True", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "FabricPeeringEnabled" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ipAddressPools": { + "description": "The list of pools of IP addresses that can be allocated to load balancer services.", + "type": "array", + "items": { + "$ref": "#/definitions/IpAddressPool" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "BmcKeySet": { + "type": "object", + "title": "BmcKeySet represents the baseboard management controller key set.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/BmcKeySetProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "BmcKeySetList": { + "type": "object", + "title": "BmcKeySetList represents a list of baseboard management controller key sets.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of baseboard management controller key sets.", + "type": "array", + "items": { + "$ref": "#/definitions/BmcKeySet" + } + } + } + }, + "BmcKeySetPatchParameters": { + "type": "object", + "title": "BmcKeySetPatchParameters represents the body of the request to patch the baseboard management controller key set.", + "properties": { + "properties": { + "$ref": "#/definitions/BmcKeySetPatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "BmcKeySetPatchProperties": { + "type": "object", + "title": "BmcKeySetPatchProperties represents the properties of baseboard management controller key set that are patchable.", + "properties": { + "expiration": { + "description": "The date and time after which the users in this key set will be removed from the baseboard management controllers.", + "type": "string", + "format": "date-time" + }, + "userList": { + "description": "The unique list of permitted users.", + "type": "array", + "items": { + "$ref": "#/definitions/KeySetUser" + }, + "x-ms-identifiers": [ + "azureUserName" + ] + } + } + }, + "BmcKeySetProperties": { + "type": "object", + "title": "BmcKeySetProperties represents the properties of baseboard management controller key set.", + "required": [ + "privilegeLevel", + "expiration", + "azureGroupId", + "userList" + ], + "properties": { + "azureGroupId": { + "description": "The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "detailedStatus": { + "description": "The more detailed status of the key set.", + "type": "string", + "enum": [ + "AllActive", + "SomeInvalid", + "AllInvalid", + "Validating" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BmcKeySetDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "expiration": { + "description": "The date and time after which the users in this key set will be removed from the baseboard management controllers.", + "type": "string", + "format": "date-time" + }, + "lastValidation": { + "description": "The last time this key set was validated.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "privilegeLevel": { + "description": "The access level allowed for the users in this key set.", + "type": "string", + "enum": [ + "ReadOnly", + "Administrator" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BmcKeySetPrivilegeLevel" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "description": "The provisioning state of the baseboard management controller key set.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BmcKeySetProvisioningState" + }, + "readOnly": true + }, + "userList": { + "description": "The unique list of permitted users.", + "type": "array", + "items": { + "$ref": "#/definitions/KeySetUser" + }, + "x-ms-identifiers": [ + "azureUserName" + ] + }, + "userListStatus": { + "description": "The status evaluation of each user.", + "type": "array", + "items": { + "$ref": "#/definitions/KeySetUserStatus" + }, + "x-ms-identifiers": [ + "azureUserName" + ], + "readOnly": true + } + } + }, + "CloudServicesNetwork": { + "description": "Upon creation, the additional services that are provided by the platform will be allocated and\nrepresented in the status of this resource. All resources associated with this cloud services network will be part\nof the same layer 2 (L2) isolation domain. At least one service network must be created but may be reused across many\nvirtual machines and/or Hybrid AKS clusters.", + "type": "object", + "title": "CloudServicesNetwork represents additional egress information that will be used by associated virtual machines or hybrid AKS clusters.", + "required": [ + "extendedLocation" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/CloudServicesNetworkProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "CloudServicesNetworkList": { + "type": "object", + "title": "CloudServicesNetworkList represents a list of cloud services networks.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of cloud services networks.", + "type": "array", + "items": { + "$ref": "#/definitions/CloudServicesNetwork" + } + } + } + }, + "CloudServicesNetworkPatchParameters": { + "type": "object", + "title": "CloudServicesNetworkPatchParameters represents the body of the request to patch the cloud services network.", + "properties": { + "properties": { + "$ref": "#/definitions/CloudServicesNetworkPatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "CloudServicesNetworkPatchProperties": { + "type": "object", + "title": "CloudServicesNetworkPatchProperties represents the properties of the cloud services network that can be updated using a patch request.", + "properties": { + "additionalEgressEndpoints": { + "description": "The list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/EgressEndpoint" + }, + "x-ms-identifiers": [] + }, + "enableDefaultEgressEndpoints": { + "description": "The indicator of whether the platform default endpoints are allowed for the egress traffic.", + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "CloudServicesNetworkEnableDefaultEgressEndpoints" + } + } + } + }, + "CloudServicesNetworkProperties": { + "type": "object", + "title": "CloudServicesNetworkProperties represents properties of the cloud services network.", + "properties": { + "additionalEgressEndpoints": { + "description": "The list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/EgressEndpoint" + }, + "x-ms-identifiers": [] + }, + "associatedResourceIds": { + "description": "The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "clusterId": { + "description": "The resource ID of the Network Cloud cluster this cloud services network is associated with.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "detailedStatus": { + "description": "The more detailed status of the cloud services network.", + "type": "string", + "enum": [ + "Error", + "Available", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "CloudServicesNetworkDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "enableDefaultEgressEndpoints": { + "description": "The indicator of whether the platform default endpoints are allowed for the egress traffic.", + "type": "string", + "default": "True", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "CloudServicesNetworkEnableDefaultEgressEndpoints" + } + }, + "enabledEgressEndpoints": { + "description": "The full list of additional and default egress endpoints that are currently enabled.", + "type": "array", + "items": { + "$ref": "#/definitions/EgressEndpoint" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "hybridAksClustersAssociatedIds": { + "description": "Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this cloud services network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "interfaceName": { + "description": "The name of the interface that will be present in the virtual machine to represent this network.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the cloud services network.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Accepted" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "CloudServicesNetworkProvisioningState" + }, + "readOnly": true + }, + "virtualMachinesAssociatedIds": { + "description": "Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this cloud services network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "Cluster": { + "type": "object", + "title": "Cluster represents the on-premises Network Cloud cluster.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster manager associated with the cluster." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity for the resource." + }, + "properties": { + "$ref": "#/definitions/ClusterProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "ClusterAvailableUpgradeVersion": { + "type": "object", + "title": "ClusterAvailableUpgradeVersion represents the various cluster upgrade parameters.", + "properties": { + "controlImpact": { + "description": "The indicator of whether the control plane will be impacted during the upgrade.", + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ControlImpact" + }, + "readOnly": true + }, + "expectedDuration": { + "description": "The expected duration needed for this upgrade.", + "type": "string", + "readOnly": true + }, + "impactDescription": { + "description": "The impact description including the specific details and release notes.", + "type": "string", + "readOnly": true + }, + "supportExpiryDate": { + "description": "The last date the version of the platform is supported.", + "type": "string", + "readOnly": true + }, + "targetClusterVersion": { + "description": "The target version this cluster will be upgraded to.", + "type": "string", + "readOnly": true + }, + "workloadImpact": { + "description": "The indicator of whether the workload will be impacted during the upgrade.", + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "WorkloadImpact" + }, + "readOnly": true + } + } + }, + "ClusterAvailableVersion": { + "type": "object", + "title": "ClusterAvailableVersion represents the cluster version that the cluster manager can be asked to create and manage.", + "properties": { + "supportExpiryDate": { + "description": "The last date the version of the platform is supported.", + "type": "string", + "readOnly": true + }, + "targetClusterVersion": { + "description": "The version of the cluster to be deployed.", + "type": "string", + "readOnly": true + } + } + }, + "ClusterCapacity": { + "type": "object", + "title": "ClusterCapacity represents various details regarding compute capacity.", + "properties": { + "availableApplianceStorageGB": { + "description": "The remaining appliance-based storage in GB available for workload use. Measured in gibibytes.", + "type": "integer", + "format": "int64" + }, + "availableCoreCount": { + "description": "The remaining number of cores that are available in this cluster for workload use.", + "type": "integer", + "format": "int64" + }, + "availableHostStorageGB": { + "description": "The remaining machine or host-based storage in GB available for workload use. Measured in gibibytes.", + "type": "integer", + "format": "int64" + }, + "availableMemoryGB": { + "description": "The remaining memory in GB that are available in this cluster for workload use. Measured in gibibytes.", + "type": "integer", + "format": "int64" + }, + "totalApplianceStorageGB": { + "description": "The total appliance-based storage in GB supported by this cluster for workload use. Measured in gibibytes.", + "type": "integer", + "format": "int64" + }, + "totalCoreCount": { + "description": "The total number of cores that are supported by this cluster for workload use.", + "type": "integer", + "format": "int64" + }, + "totalHostStorageGB": { + "description": "The total machine or host-based storage in GB supported by this cluster for workload use. Measured in gibibytes.", + "type": "integer", + "format": "int64" + }, + "totalMemoryGB": { + "description": "The total memory supported by this cluster for workload use. Measured in gibibytes.", + "type": "integer", + "format": "int64" + } + } + }, + "ClusterContinueUpdateVersionParameters": { + "type": "object", + "title": "ClusterContinueUpdateVersionParameters represents the body of the request to continue the update of a cluster version.", + "properties": { + "machineGroupTargetingMode": { + "description": "The mode by which the cluster will target the next grouping of servers to continue the update.", + "type": "string", + "default": "AlphaByRack", + "enum": [ + "AlphaByRack" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterContinueUpdateVersionMachineGroupTargetingMode" + } + } + } + }, + "ClusterDeployParameters": { + "type": "object", + "title": "ClusterDeployParameters represents the body of the request to deploy cluster.", + "properties": { + "skipValidationsForMachines": { + "description": "The names of bare metal machines in the cluster that should be skipped during environment validation.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ClusterList": { + "type": "object", + "title": "ClusterList represents a list of clusters.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of clusters.", + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + } + } + } + }, + "ClusterManager": { + "type": "object", + "title": "ClusterManager represents a control-plane to manage one or more on-premises clusters.", + "required": [ + "properties" + ], + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the cluster manager." + }, + "properties": { + "$ref": "#/definitions/ClusterManagerProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "ClusterManagerList": { + "type": "object", + "title": "ClusterManagerList represents a list of cluster manager objects.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of cluster managers.", + "type": "array", + "items": { + "$ref": "#/definitions/ClusterManager" + } + } + } + }, + "ClusterManagerPatchParameters": { + "type": "object", + "title": "ClusterManagerPatchParameters represents the body of the request to patch the cluster properties.", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity for the resource." + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ClusterManagerProperties": { + "type": "object", + "title": "ClusterManagerProperties represents the properties of a cluster manager.", + "required": [ + "fabricControllerId" + ], + "properties": { + "analyticsWorkspaceId": { + "description": "The resource ID of the Log Analytics workspace that is used for the logs collection.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "availabilityZones": { + "description": "Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The Azure availability zones within the region that will be used to support the cluster manager resource.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "create" + ] + }, + "clusterVersions": { + "description": "The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource.", + "type": "array", + "items": { + "$ref": "#/definitions/ClusterAvailableVersion" + }, + "x-ms-identifiers": [ + "targetClusterVersion" + ], + "readOnly": true + }, + "detailedStatus": { + "description": "The detailed status that provides additional information about the cluster manager.", + "type": "string", + "enum": [ + "Error", + "Available", + "Provisioning", + "ProvisioningFailed", + "Updating", + "UpdateFailed" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterManagerDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "fabricControllerId": { + "description": "The resource ID of the fabric controller that has one to one mapping with the cluster manager.", + "type": "string", + "format": "arm-id", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "managedResourceGroupConfiguration": { + "$ref": "#/definitions/ManagedResourceGroupConfiguration", + "description": "The configuration of the managed resource group associated with the resource." + }, + "managerExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location (custom location) that represents the cluster manager's control plane location. This extended location is used when creating cluster and rack manifest resources.", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the cluster manager.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Accepted", + "Updating" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterManagerProvisioningState" + }, + "readOnly": true + }, + "vmSize": { + "description": "Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The size of the Azure virtual machines to use for hosting the cluster manager resource.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "ClusterMetricsConfiguration": { + "type": "object", + "title": "ClusterMetricsConfiguration represents the metrics configuration of an on-premises Network Cloud cluster.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/ClusterMetricsConfigurationProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "ClusterMetricsConfigurationList": { + "type": "object", + "title": "ClusterMetricsConfigurationList represents a list of metrics configuration of the cluster.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of metrics configurations.", + "type": "array", + "items": { + "$ref": "#/definitions/ClusterMetricsConfiguration" + } + } + } + }, + "ClusterMetricsConfigurationPatchParameters": { + "type": "object", + "title": "ClusterMetricsConfigurationPatchParameters represents the body of the request to patch the metrics configuration of cluster.", + "properties": { + "properties": { + "$ref": "#/definitions/ClusterMetricsConfigurationPatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ClusterMetricsConfigurationPatchProperties": { + "type": "object", + "title": "ClusterMetricsConfigurationPatchProperties represents the properties of metrics configuration for the cluster for patching.", + "properties": { + "collectionInterval": { + "description": "The interval in minutes by which metrics will be collected.", + "type": "integer", + "format": "int64", + "maximum": 1440, + "minimum": 1 + }, + "enabledMetrics": { + "description": "The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ClusterMetricsConfigurationProperties": { + "type": "object", + "title": "ClusterMetricsConfigurationProperties represents the properties of metrics configuration for the cluster.", + "required": [ + "collectionInterval" + ], + "properties": { + "collectionInterval": { + "description": "The interval in minutes by which metrics will be collected.", + "type": "integer", + "format": "int64", + "maximum": 1440, + "minimum": 1 + }, + "detailedStatus": { + "description": "The more detailed status of the metrics configuration.", + "type": "string", + "enum": [ + "Processing", + "Applied", + "Error" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterMetricsConfigurationDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "disabledMetrics": { + "description": "The list of metrics that are available for the cluster but disabled at the moment.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "enabledMetrics": { + "description": "The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics.", + "type": "array", + "items": { + "type": "string" + } + }, + "provisioningState": { + "description": "The provisioning state of the metrics configuration.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterMetricsConfigurationProvisioningState" + }, + "readOnly": true + } + } + }, + "ClusterPatchParameters": { + "type": "object", + "title": "ClusterPatchParameters represents the body of the request to patch the cluster properties.", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity for the resource." + }, + "properties": { + "$ref": "#/definitions/ClusterPatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ClusterPatchProperties": { + "type": "object", + "title": "ClusterPatchProperties represents the properties of the cluster for patching.", + "properties": { + "aggregatorOrSingleRackDefinition": { + "$ref": "#/definitions/RackDefinition", + "description": "The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster." + }, + "clusterLocation": { + "description": "The customer-provided location information to identify where the cluster resides.", + "type": "string" + }, + "clusterServicePrincipal": { + "$ref": "#/definitions/ServicePrincipalInformation", + "description": "The service principal to be used by the cluster during Arc Appliance installation." + }, + "commandOutputSettings": { + "$ref": "#/definitions/CommandOutputSettings", + "description": "The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts." + }, + "computeDeploymentThreshold": { + "$ref": "#/definitions/ValidationThreshold", + "description": "The validation threshold indicating the allowable failures of compute machines during environment validation and deployment." + }, + "computeRackDefinitions": { + "description": "The list of rack definitions for the compute racks in a multi-rack\ncluster, or an empty list in a single-rack cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/RackDefinition" + }, + "x-ms-identifiers": [ + "networkRackId" + ] + }, + "runtimeProtectionConfiguration": { + "$ref": "#/definitions/RuntimeProtectionConfiguration", + "description": "The settings for cluster runtime protection." + }, + "secretArchive": { + "$ref": "#/definitions/ClusterSecretArchive", + "description": "The configuration for use of a key vault to store secrets for later retrieval by the operator." + }, + "updateStrategy": { + "$ref": "#/definitions/ClusterUpdateStrategy", + "description": "The strategy for updating the cluster." + } + } + }, + "ClusterProperties": { + "type": "object", + "title": "ClusterProperties represents the properties of a cluster.", + "required": [ + "networkFabricId", + "clusterType", + "clusterVersion", + "aggregatorOrSingleRackDefinition" + ], + "properties": { + "aggregatorOrSingleRackDefinition": { + "$ref": "#/definitions/RackDefinition", + "description": "The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster." + }, + "analyticsWorkspaceId": { + "description": "The resource ID of the Log Analytics Workspace that will be used for storing relevant logs.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "availableUpgradeVersions": { + "description": "The list of cluster runtime version upgrades available for this cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/ClusterAvailableUpgradeVersion" + }, + "x-ms-identifiers": [ + "targetClusterVersion" + ], + "readOnly": true + }, + "clusterCapacity": { + "$ref": "#/definitions/ClusterCapacity", + "description": "The capacity supported by this cluster.", + "readOnly": true + }, + "clusterConnectionStatus": { + "description": "The latest heartbeat status between the cluster manager and the cluster.", + "type": "string", + "enum": [ + "Connected", + "Disconnected", + "Timeout", + "Undefined" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterConnectionStatus" + }, + "readOnly": true + }, + "clusterExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location (custom location) that represents the cluster's control plane location. This extended location is used to route the requests of child objects of the cluster that are handled by the platform operator.", + "readOnly": true + }, + "clusterLocation": { + "description": "The customer-provided location information to identify where the cluster resides.", + "type": "string", + "maxLength": 256 + }, + "clusterManagerConnectionStatus": { + "description": "The latest connectivity status between cluster manager and the cluster.", + "type": "string", + "enum": [ + "Connected", + "Unreachable" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterManagerConnectionStatus" + }, + "readOnly": true + }, + "clusterManagerId": { + "description": "The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetworkCloud/clusterManagers" + } + ] + }, + "readOnly": true + }, + "clusterServicePrincipal": { + "$ref": "#/definitions/ServicePrincipalInformation", + "description": "The service principal to be used by the cluster during Arc Appliance installation." + }, + "clusterType": { + "description": "The type of rack configuration for the cluster.", + "type": "string", + "enum": [ + "SingleRack", + "MultiRack" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterType" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "clusterVersion": { + "description": "The current runtime version of the cluster.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "commandOutputSettings": { + "$ref": "#/definitions/CommandOutputSettings", + "description": "The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts." + }, + "computeDeploymentThreshold": { + "$ref": "#/definitions/ValidationThreshold", + "description": "The validation threshold indicating the allowable failures of compute machines during environment validation and deployment." + }, + "computeRackDefinitions": { + "description": "The list of rack definitions for the compute racks in a multi-rack\ncluster, or an empty list in a single-rack cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/RackDefinition" + }, + "x-ms-identifiers": [ + "networkRackId" + ] + }, + "detailedStatus": { + "description": "The current detailed status of the cluster.", + "type": "string", + "enum": [ + "PendingDeployment", + "Deploying", + "Running", + "Updating", + "UpdatePaused", + "Degraded", + "Deleting", + "Disconnected", + "Failed" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the detailed status.", + "type": "string", + "readOnly": true + }, + "hybridAksExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters).", + "readOnly": true + }, + "managedResourceGroupConfiguration": { + "$ref": "#/definitions/ManagedResourceGroupConfiguration", + "description": "The configuration of the managed resource group associated with the resource." + }, + "manualActionCount": { + "description": "The count of Manual Action Taken (MAT) events that have not been validated.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "networkFabricId": { + "description": "The resource ID of the Network Fabric associated with the cluster.", + "type": "string", + "format": "arm-id", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "description": "The provisioning state of the cluster.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Validating", + "Updating" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterProvisioningState" + }, + "readOnly": true + }, + "runtimeProtectionConfiguration": { + "$ref": "#/definitions/RuntimeProtectionConfiguration", + "description": "The settings for cluster runtime protection." + }, + "secretArchive": { + "$ref": "#/definitions/ClusterSecretArchive", + "description": "The configuration for use of a key vault to store secrets for later retrieval by the operator." + }, + "supportExpiryDate": { + "description": "The support end date of the runtime version of the cluster.", + "type": "string", + "readOnly": true + }, + "updateStrategy": { + "$ref": "#/definitions/ClusterUpdateStrategy", + "description": "The strategy for updating the cluster." + }, + "workloadResourceIds": { + "description": "The list of workload resource IDs that are hosted within this cluster.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "ClusterScanRuntimeParameters": { + "type": "object", + "title": "ClusterScanRuntimeParameters defines the parameters for the cluster scan runtime operation.", + "properties": { + "scanActivity": { + "description": "The choice of if the scan operation should run the scan.", + "type": "string", + "default": "Scan", + "enum": [ + "Scan", + "Skip" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterScanRuntimeParametersScanActivity" + } + } + } + }, + "ClusterSecretArchive": { + "type": "object", + "title": "ClusterSecretArchive configures the key vault to archive the secrets of the cluster for later retrieval.", + "required": [ + "keyVaultId" + ], + "properties": { + "keyVaultId": { + "description": "The resource ID of the key vault to archive the secrets of the cluster.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + } + }, + "useKeyVault": { + "description": "The indicator if the specified key vault should be used to archive the secrets of the cluster.", + "type": "string", + "default": "False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterSecretArchiveEnabled" + } + } + } + }, + "ClusterUpdateStrategy": { + "type": "object", + "title": "ClusterUpdateStrategy represents the strategy for updating the cluster.", + "required": [ + "strategyType", + "thresholdType", + "thresholdValue" + ], + "properties": { + "maxUnavailable": { + "description": "The maximum number of worker nodes that can be offline within the increment of update, e.g., rack-by-rack.\nLimited by the maximum number of machines in the increment. Defaults to the whole increment size.", + "type": "integer", + "format": "int64", + "minimum": 1 + }, + "strategyType": { + "description": "The mode of operation for runtime protection.", + "type": "string", + "enum": [ + "Rack", + "PauseAfterRack" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterUpdateStrategyType" + } + }, + "thresholdType": { + "description": "Selection of how the threshold should be evaluated.", + "type": "string", + "enum": [ + "CountSuccess", + "PercentSuccess" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ValidationThresholdType" + } + }, + "thresholdValue": { + "description": "The numeric threshold value.", + "type": "integer", + "format": "int64", + "minimum": 0 + }, + "waitTimeMinutes": { + "description": "The time to wait between the increments of update defined by the strategy.", + "type": "integer", + "format": "int64", + "default": 15, + "maximum": 60, + "minimum": 0 + } + } + }, + "ClusterUpdateVersionParameters": { + "type": "object", + "title": "ClusterUpdateVersionParameters represents the body of the request to update cluster version.", + "required": [ + "targetClusterVersion" + ], + "properties": { + "targetClusterVersion": { + "description": "The version to be applied to the cluster during update.", + "type": "string" + } + } + }, + "CommandOutputSettings": { + "type": "object", + "title": "CommandOutputSettings represents the settings for commands run within the cluster such as bare metal machine run read-only commands.", + "properties": { + "associatedIdentity": { + "$ref": "#/definitions/IdentitySelector", + "description": "The selection of the managed identity to use with this storage account container. The identity type must be either system assigned or user assigned." + }, + "containerUrl": { + "description": "The URL of the storage account container that is to be used by the specified identities.", + "type": "string", + "format": "uri" + } + } + }, + "Console": { + "type": "object", + "title": "Console represents the console of an on-premises Network Cloud virtual machine.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster manager associated with the cluster this virtual machine is created on." + }, + "properties": { + "$ref": "#/definitions/ConsoleProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "ConsoleList": { + "type": "object", + "title": "ConsoleList represents a list of virtual machine consoles.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of virtual machine consoles.", + "type": "array", + "items": { + "$ref": "#/definitions/Console" + } + } + } + }, + "ConsolePatchParameters": { + "type": "object", + "title": "ConsolePatchParameters represents the body of the request to patch the virtual machine console.", + "properties": { + "properties": { + "$ref": "#/definitions/ConsolePatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ConsolePatchProperties": { + "type": "object", + "title": "ConsolePatchProperties represents the properties of the virtual machine console that can be patched.", + "properties": { + "enabled": { + "description": "The indicator of whether the console access is enabled.", + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ConsoleEnabled" + } + }, + "expiration": { + "description": "The date and time after which the key will be disallowed access.", + "type": "string", + "format": "date-time" + }, + "sshPublicKey": { + "$ref": "#/definitions/SshPublicKey", + "description": "The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in." + } + } + }, + "ConsoleProperties": { + "type": "object", + "title": "ConsoleProperties represents the properties of the virtual machine console.", + "required": [ + "sshPublicKey", + "enabled" + ], + "properties": { + "detailedStatus": { + "description": "The more detailed status of the console.", + "type": "string", + "enum": [ + "Ready", + "Error" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ConsoleDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "enabled": { + "description": "The indicator of whether the console access is enabled.", + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ConsoleEnabled" + } + }, + "expiration": { + "description": "The date and time after which the key will be disallowed access.", + "type": "string", + "format": "date-time" + }, + "privateLinkServiceId": { + "description": "The resource ID of the private link service that is used to provide virtual machine console access.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/privateLinkServices" + } + ] + }, + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the virtual machine console.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Accepted" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ConsoleProvisioningState" + }, + "readOnly": true + }, + "sshPublicKey": { + "$ref": "#/definitions/SshPublicKey", + "description": "The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in." + }, + "virtualMachineAccessId": { + "description": "The unique identifier for the virtual machine that is used to access the console.", + "type": "string", + "readOnly": true + } + } + }, + "ControlPlaneNodeConfiguration": { + "type": "object", + "title": "ControlPlaneNodeConfiguration represents the selection of virtual machines and size of the control plane for a Kubernetes cluster.", + "required": [ + "count", + "vmSkuName" + ], + "properties": { + "administratorConfiguration": { + "$ref": "#/definitions/AdministratorConfiguration", + "description": "The administrator credentials to be used for the nodes in the control plane.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "availabilityZones": { + "description": "The list of availability zones of the Network Cloud cluster to be used for the provisioning of nodes in the control plane. If not specified, all availability zones will be used.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "count": { + "description": "The number of virtual machines that use this configuration.", + "type": "integer", + "format": "int64", + "minimum": 1 + }, + "vmSkuName": { + "description": "The name of the VM SKU supplied during creation.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "ControlPlaneNodePatchConfiguration": { + "type": "object", + "title": "ControlPlaneNodePatchConfiguration represents the properties of the control plane that can be patched for this Kubernetes cluster.", + "properties": { + "administratorConfiguration": { + "$ref": "#/definitions/AdministratorConfigurationPatch", + "description": "The configuration of administrator credentials for the control plane nodes." + }, + "count": { + "description": "The number of virtual machines that use this configuration.", + "type": "integer", + "format": "int64", + "minimum": 1 + } + } + }, + "EgressEndpoint": { + "type": "object", + "title": "EgressEndpoint represents the connection from a cloud services network to the specified endpoint for a common purpose.", + "required": [ + "category", + "endpoints" + ], + "properties": { + "category": { + "description": "The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'.", + "type": "string" + }, + "endpoints": { + "description": "The list of endpoint dependencies.", + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/definitions/EndpointDependency" + }, + "x-ms-identifiers": [] + } + } + }, + "EndpointDependency": { + "type": "object", + "title": "EndpointDependency represents the definition of an endpoint, including the domain and details.", + "required": [ + "domainName" + ], + "properties": { + "domainName": { + "description": "The domain name of the dependency.", + "type": "string" + }, + "port": { + "description": "The port of this endpoint.", + "type": "integer", + "format": "int64", + "maximum": 65535, + "minimum": 1 + } + } + }, + "ExtendedLocation": { + "type": "object", + "title": "ExtendedLocation represents the Azure custom location where the resource will be created.", + "required": [ + "type", + "name" + ], + "properties": { + "name": { + "description": "The resource ID of the extended location on which the resource will be created.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "type": { + "description": "The extended location type, for example, CustomLocation.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "FeatureStatus": { + "type": "object", + "title": "FeatureStatus contains information regarding a Kubernetes cluster feature.", + "properties": { + "detailedStatus": { + "description": "The status representing the state of this feature.", + "type": "string", + "enum": [ + "Running", + "Failed", + "Unknown" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "FeatureDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the feature.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version of the feature.", + "type": "string", + "readOnly": true + } + } + }, + "HardwareInventory": { + "type": "object", + "title": "HardwareInventory represents the hardware configuration of this machine as exposed to the customer, including information acquired from the model/sku information and from the ironic inspector.", + "properties": { + "additionalHostInformation": { + "description": "Freeform data extracted from the environment about this machine. This information varies depending on the specific hardware and configuration.", + "type": "string", + "readOnly": true + }, + "interfaces": { + "description": "The list of network interfaces and associated details for the bare metal machine.", + "type": "array", + "items": { + "$ref": "#/definitions/HardwareInventoryNetworkInterface" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + }, + "nics": { + "description": "Field Deprecated. Will be removed in an upcoming version. The list of network interface cards and associated details for the bare metal machine.", + "type": "array", + "items": { + "$ref": "#/definitions/Nic" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + } + } + }, + "HardwareInventoryNetworkInterface": { + "type": "object", + "title": "HardwareInventoryNetworkInterface represents the network interface details as part of a hardware inventory.", + "properties": { + "linkStatus": { + "description": "The current status of the link.", + "type": "string", + "readOnly": true + }, + "macAddress": { + "description": "The MAC address associated with this interface.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the interface.", + "type": "string", + "readOnly": true + }, + "networkInterfaceId": { + "description": "The resource ID of the network interface for the port on the switch that this machine's interface is connected to.", + "type": "string", + "readOnly": true + } + } + }, + "HardwareValidationStatus": { + "type": "object", + "title": "HardwareValidationStatus represents the latest hardware validation details performed for this bare metal machine.", + "properties": { + "lastValidationTime": { + "description": "The timestamp of the hardware validation execution.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "result": { + "description": "The outcome of the hardware validation.", + "type": "string", + "enum": [ + "Pass", + "Fail" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachineHardwareValidationResult" + }, + "readOnly": true + } + } + }, + "IdentitySelector": { + "type": "object", + "title": "IdentitySelector represents the selection of a managed identity for use.", + "properties": { + "identityType": { + "description": "The type of managed identity that is being selected.", + "type": "string", + "enum": [ + "SystemAssignedIdentity", + "UserAssignedIdentity" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ManagedServiceIdentitySelectorType" + } + }, + "userAssignedIdentityResourceId": { + "description": "The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type.", + "type": "string", + "format": "arm-id" + } + } + }, + "ImageRepositoryCredentials": { + "type": "object", + "title": "ImageRepositoryCredentials represents the credentials used to login to the image repository.", + "required": [ + "username", + "password", + "registryUrl" + ], + "properties": { + "password": { + "description": "The password or token used to access an image in the target repository.", + "type": "string", + "minLength": 1, + "x-ms-secret": true + }, + "registryUrl": { + "description": "The URL of the authentication server used to validate the repository credentials.", + "type": "string" + }, + "username": { + "description": "The username used to access an image in the target repository.", + "type": "string", + "minLength": 1 + } + } + }, + "InitialAgentPoolConfiguration": { + "type": "object", + "title": "InitialAgentPoolConfiguration specifies the configuration of a pool of virtual machines that are initially defined with a Kubernetes cluster.", + "required": [ + "count", + "mode", + "vmSkuName", + "name" + ], + "properties": { + "administratorConfiguration": { + "$ref": "#/definitions/AdministratorConfiguration", + "description": "The administrator credentials to be used for the nodes in this agent pool.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "agentOptions": { + "$ref": "#/definitions/AgentOptions", + "description": "The configurations that will be applied to each agent in this agent pool.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "attachedNetworkConfiguration": { + "$ref": "#/definitions/AttachedNetworkConfiguration", + "description": "The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "availabilityZones": { + "description": "The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "count": { + "description": "The number of virtual machines that use this configuration.", + "type": "integer", + "format": "int64", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "labels": { + "description": "The labels applied to the nodes in this agent pool.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesLabel" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "mode": { + "description": "The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.", + "type": "string", + "enum": [ + "System", + "User", + "NotApplicable" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AgentPoolMode" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "name": { + "description": "The name that will be used for the agent pool resource representing this agent pool.", + "type": "string", + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "taints": { + "description": "The taints applied to the nodes in this agent pool.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesLabel" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "The configuration of the agent pool." + }, + "vmSkuName": { + "description": "The name of the VM SKU that determines the size of resources allocated for node VMs.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "IpAddressPool": { + "type": "object", + "title": "IpAddressPool represents a pool of IP addresses that can be allocated to a service.", + "required": [ + "addresses", + "name" + ], + "properties": { + "addresses": { + "description": "The list of IP address ranges. Each range can be a either a subnet in CIDR format or an explicit start-end range of IP addresses. For a BGP service load balancer configuration, only CIDR format is supported and excludes /32 (IPv4) and /128 (IPv6) prefixes.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "autoAssign": { + "description": "The indicator to determine if automatic allocation from the pool should occur.", + "type": "string", + "default": "True", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BfdEnabled" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "name": { + "description": "The name used to identify this IP address pool for association with a BGP advertisement.", + "type": "string", + "pattern": "^[a-z0-9]([a-z0-9.-]{0,61}[a-z0-9]){0,1}$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "onlyUseHostIps": { + "description": "The indicator to prevent the use of IP addresses ending with .0 and .255 for this pool. Enabling this option will only use IP addresses between .1 and .254 inclusive.", + "type": "string", + "default": "True", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BfdEnabled" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "KeySetUser": { + "type": "object", + "title": "KeySetUser represents the properties of the user in the key set.", + "required": [ + "azureUserName", + "sshPublicKey" + ], + "properties": { + "azureUserName": { + "description": "The user name that will be used for access.", + "type": "string" + }, + "description": { + "description": "The free-form description for this user.", + "type": "string", + "maxLength": 256 + }, + "sshPublicKey": { + "$ref": "#/definitions/SshPublicKey", + "description": "The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in." + }, + "userPrincipalName": { + "description": "The user principal name (email format) used to validate this user's group membership.", + "type": "string" + } + } + }, + "KeySetUserStatus": { + "type": "object", + "title": "KeySetUserStatus represents the status of the key set user.", + "properties": { + "azureUserName": { + "description": "The user name that will be used for access.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The indicator of whether the user is currently deployed for access.", + "type": "string", + "enum": [ + "Active", + "Invalid" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachineKeySetUserSetupStatus" + }, + "readOnly": true + }, + "statusMessage": { + "description": "The additional information describing the current status of this user, if any available.", + "type": "string", + "maxLength": 256, + "readOnly": true + } + } + }, + "KubernetesCluster": { + "type": "object", + "title": "KubernetesCluster represents the Kubernetes cluster hosted on Network Cloud.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/KubernetesClusterProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "KubernetesClusterFeature": { + "type": "object", + "title": "KubernetesClusterFeature represents the feature of a Kubernetes cluster.", + "properties": { + "properties": { + "$ref": "#/definitions/KubernetesClusterFeatureProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "KubernetesClusterFeatureList": { + "type": "object", + "title": "KubernetesClusterFeatureList represents the list of Kubernetes cluster feature resources.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of Kubernetes cluster features.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesClusterFeature" + } + } + } + }, + "KubernetesClusterFeaturePatchParameters": { + "type": "object", + "title": "KubernetesClusterFeaturePatchParameters represents the body of the request to patch the Kubernetes cluster feature.", + "properties": { + "properties": { + "$ref": "#/definitions/KubernetesClusterFeaturePatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "KubernetesClusterFeaturePatchProperties": { + "type": "object", + "title": "KubernetesClusterFeaturePatchProperties represents the Kubernetes cluster feature properties for patching.", + "properties": { + "options": { + "description": "The configured options for the feature.", + "type": "array", + "items": { + "$ref": "#/definitions/StringKeyValuePair" + }, + "x-ms-identifiers": [ + "key" + ] + } + } + }, + "KubernetesClusterFeatureProperties": { + "type": "object", + "title": "KubernetesClusterFeatureProperties represents the properties of a Kubernetes cluster feature.", + "properties": { + "availabilityLifecycle": { + "description": "The lifecycle indicator of the feature.", + "type": "string", + "enum": [ + "Preview", + "GenerallyAvailable" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesClusterFeatureAvailabilityLifecycle" + }, + "readOnly": true + }, + "detailedStatus": { + "description": "The detailed status of the feature.", + "type": "string", + "enum": [ + "Error", + "Provisioning", + "Installed" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesClusterFeatureDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message for the detailed status of the feature.", + "type": "string", + "readOnly": true + }, + "options": { + "description": "The configured options for the feature.", + "type": "array", + "items": { + "$ref": "#/definitions/StringKeyValuePair" + }, + "x-ms-identifiers": [ + "key" + ] + }, + "provisioningState": { + "description": "The provisioning state of the Kubernetes cluster feature.", + "type": "string", + "enum": [ + "Accepted", + "Canceled", + "Deleting", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesClusterFeatureProvisioningState" + }, + "readOnly": true + }, + "required": { + "description": "The indicator of if the feature is required or optional. Optional features may be deleted by the user, while required features are managed with the kubernetes cluster lifecycle.", + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesClusterFeatureRequired" + }, + "readOnly": true + }, + "version": { + "description": "The version of the feature.", + "type": "string", + "readOnly": true + } + } + }, + "KubernetesClusterList": { + "type": "object", + "title": "KubernetesClusterList represents a list of Kubernetes clusters.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of additional details related to Kubernetes clusters.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesCluster" + } + } + } + }, + "KubernetesClusterNode": { + "type": "object", + "title": "KubernetesClusterNode represents the details of a node in a Kubernetes cluster.", + "properties": { + "agentPoolId": { + "description": "The resource ID of the agent pool that this node belongs to. This value is not represented on control plane nodes.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetworkCloud/kubernetesClusters/agentPools" + } + ] + }, + "readOnly": true + }, + "availabilityZone": { + "description": "The availability zone this node is running within.", + "type": "string", + "readOnly": true + }, + "bareMetalMachineId": { + "description": "The resource ID of the bare metal machine that hosts this node.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "cpuCores": { + "description": "The number of CPU cores configured for this node, derived from the VM SKU specified.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "detailedStatus": { + "description": "The detailed state of this node.", + "type": "string", + "enum": [ + "Available", + "Error", + "Provisioning", + "Running", + "Scheduling", + "Stopped", + "Terminating", + "Unknown" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesClusterNodeDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "diskSizeGB": { + "description": "The size of the disk configured for this node. Allocations are measured in gibibytes.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "image": { + "description": "The machine image used to deploy this node.", + "type": "string", + "readOnly": true + }, + "kubernetesVersion": { + "description": "The currently running version of Kubernetes and bundled features running on this node.", + "type": "string", + "readOnly": true + }, + "labels": { + "description": "The list of labels on this node that have been assigned to the agent pool containing this node.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesLabel" + }, + "x-ms-identifiers": [ + "key" + ], + "readOnly": true + }, + "memorySizeGB": { + "description": "The amount of memory configured for this node, derived from the vm SKU specified. Allocations are measured in gibibytes.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "mode": { + "description": "The mode of the agent pool containing this node. Not applicable for control plane nodes.", + "type": "string", + "enum": [ + "System", + "User", + "NotApplicable" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AgentPoolMode" + }, + "readOnly": true + }, + "name": { + "description": "The name of this node, as realized in the Kubernetes cluster.", + "type": "string", + "readOnly": true + }, + "networkAttachments": { + "description": "The NetworkAttachments made to this node.", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkAttachment" + }, + "x-ms-identifiers": [ + "networkAttachmentName" + ], + "readOnly": true + }, + "powerState": { + "description": "The power state of this node.", + "type": "string", + "enum": [ + "On", + "Off", + "Unknown" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesNodePowerState" + }, + "readOnly": true + }, + "role": { + "description": "The role of this node in the cluster.", + "type": "string", + "enum": [ + "ControlPlane", + "Worker" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesNodeRole" + }, + "readOnly": true + }, + "taints": { + "description": "The list of taints that have been assigned to the agent pool containing this node.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesLabel" + }, + "x-ms-identifiers": [ + "key" + ], + "readOnly": true + }, + "vmSkuName": { + "description": "The VM SKU name that was used to create this cluster node.", + "type": "string", + "readOnly": true + } + } + }, + "KubernetesClusterPatchParameters": { + "type": "object", + "title": "KubernetesClusterPatchParameters represents the body of the request to patch the Hybrid AKS cluster.", + "properties": { + "properties": { + "$ref": "#/definitions/KubernetesClusterPatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "KubernetesClusterPatchProperties": { + "type": "object", + "title": "KubernetesClusterPatchProperties represents the properties of the Kubernetes cluster that can be patched.", + "properties": { + "administratorConfiguration": { + "$ref": "#/definitions/AdministratorConfigurationPatch", + "description": "The configuration of the default administrator credentials." + }, + "controlPlaneNodeConfiguration": { + "$ref": "#/definitions/ControlPlaneNodePatchConfiguration", + "description": "The defining characteristics of the control plane that can be patched for this Kubernetes cluster." + }, + "kubernetesVersion": { + "description": "The Kubernetes version for this cluster.", + "type": "string" + } + } + }, + "KubernetesClusterProperties": { + "type": "object", + "title": "KubernetesClusterProperties represents the properties of Kubernetes cluster resource.", + "required": [ + "initialAgentPoolConfigurations", + "controlPlaneNodeConfiguration", + "kubernetesVersion", + "networkConfiguration" + ], + "properties": { + "aadConfiguration": { + "$ref": "#/definitions/AadConfiguration", + "description": "The Azure Active Directory Integration properties.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "administratorConfiguration": { + "$ref": "#/definitions/AdministratorConfiguration", + "description": "The administrative credentials that will be applied to the control plane and agent pool nodes that do not specify their own values." + }, + "attachedNetworkIds": { + "description": "The full list of network resource IDs that are attached to this cluster, including those attached only to specific agent pools.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "availableUpgrades": { + "description": "The list of versions that this Kubernetes cluster can be upgraded to.", + "type": "array", + "items": { + "$ref": "#/definitions/AvailableUpgrade" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "clusterId": { + "description": "The resource ID of the Network Cloud cluster.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "connectedClusterId": { + "description": "The resource ID of the connected cluster set up when this Kubernetes cluster is created.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Kubernetes/connectedClusters" + } + ] + }, + "readOnly": true + }, + "controlPlaneKubernetesVersion": { + "description": "The current running version of Kubernetes on the control plane.", + "type": "string", + "readOnly": true + }, + "controlPlaneNodeConfiguration": { + "$ref": "#/definitions/ControlPlaneNodeConfiguration", + "description": "The defining characteristics of the control plane for this Kubernetes Cluster." + }, + "detailedStatus": { + "description": "The current status of the Kubernetes cluster.", + "type": "string", + "enum": [ + "Available", + "Error", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesClusterDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "featureStatuses": { + "description": "The current feature settings.", + "type": "array", + "items": { + "$ref": "#/definitions/FeatureStatus" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + }, + "initialAgentPoolConfigurations": { + "description": "The agent pools that are created with this Kubernetes cluster for running critical system services and workloads. This data in this field is only used during creation, and the field will be empty following the creation of the Kubernetes Cluster. After creation, the management of agent pools is done using the agentPools sub-resource.", + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/definitions/InitialAgentPoolConfiguration" + }, + "x-ms-identifiers": [ + "name" + ], + "x-ms-mutability": [ + "read", + "create" + ] + }, + "kubernetesVersion": { + "description": "The Kubernetes version for this cluster.", + "type": "string" + }, + "managedResourceGroupConfiguration": { + "$ref": "#/definitions/ManagedResourceGroupConfiguration", + "description": "The configuration of the managed resource group associated with the resource." + }, + "networkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration", + "description": "The configuration of the Kubernetes cluster networking, including the attachment of networks that span the cluster.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "nodes": { + "description": "The details of the nodes in this cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesClusterNode" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the Kubernetes cluster resource.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "InProgress", + "Created", + "Updating", + "Deleting" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesClusterProvisioningState" + }, + "readOnly": true + } + } + }, + "KubernetesClusterRestartNodeParameters": { + "type": "object", + "title": "KubernetesClusterRestartNodeParameters represents the body of the request to restart the node of a Kubernetes cluster.", + "required": [ + "nodeName" + ], + "properties": { + "nodeName": { + "description": "The name of the node to restart.", + "type": "string" + } + } + }, + "KubernetesLabel": { + "type": "object", + "title": "KubernetesLabel represents a single entry for a Kubernetes label or taint such as those used on a node or pod.", + "required": [ + "key", + "value" + ], + "properties": { + "key": { + "description": "The name of the label or taint.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "value": { + "description": "The value of the label or taint.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "L2Network": { + "type": "object", + "title": "L2Network represents a network that utilizes a single isolation domain set up for layer-2 resources.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/L2NetworkProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "L2NetworkAttachmentConfiguration": { + "type": "object", + "title": "L2NetworkAttachmentConfiguration represents the configuration of the attachment of a Layer 2 network.", + "required": [ + "networkId" + ], + "properties": { + "networkId": { + "description": "The resource ID of the network that is being configured for attachment.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetworkCloud/l2Networks" + } + ] + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "pluginType": { + "description": "The indicator of how this network will be utilized by the Kubernetes cluster.", + "type": "string", + "default": "SRIOV", + "enum": [ + "DPDK", + "SRIOV", + "OSDevice", + "MACVLAN", + "IPVLAN" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesPluginType" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "L2NetworkList": { + "type": "object", + "title": "L2NetworkList represents a list of L2 networks.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of L2 networks.", + "type": "array", + "items": { + "$ref": "#/definitions/L2Network" + } + } + } + }, + "L2NetworkPatchParameters": { + "type": "object", + "title": "L2NetworkPatchParameters represents the body of the request to patch the L2 network.", + "properties": { + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "L2NetworkProperties": { + "type": "object", + "title": "L2NetworkProperties represents properties of the L2 network.", + "required": [ + "l2IsolationDomainId" + ], + "properties": { + "associatedResourceIds": { + "description": "The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "clusterId": { + "description": "The resource ID of the Network Cloud cluster this L2 network is associated with.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "detailedStatus": { + "description": "The more detailed status of the L2 network.", + "type": "string", + "enum": [ + "Error", + "Available", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "L2NetworkDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "hybridAksClustersAssociatedIds": { + "description": "Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource ID(s) that are associated with this L2 network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "hybridAksPluginType": { + "description": "Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS.", + "type": "string", + "default": "SRIOV", + "enum": [ + "DPDK", + "SRIOV", + "OSDevice" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "HybridAksPluginType" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "interfaceName": { + "description": "The default interface name for this L2 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine.", + "type": "string", + "maxLength": 12, + "pattern": "^[a-zA-Z0-9@._-]*$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "l2IsolationDomainId": { + "description": "The resource ID of the Network Fabric l2IsolationDomain.", + "type": "string", + "format": "arm-id", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "description": "The provisioning state of the L2 network.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Accepted" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "L2NetworkProvisioningState" + }, + "readOnly": true + }, + "virtualMachinesAssociatedIds": { + "description": "Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource ID(s), excluding any Hybrid AKS virtual machines, that are currently using this L2 network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "L2ServiceLoadBalancerConfiguration": { + "type": "object", + "title": "L2ServiceLoadBalancerConfiguration represents the configuration of a layer 2 service load balancer.", + "properties": { + "ipAddressPools": { + "description": "The list of pools of IP addresses that can be allocated to load balancer services.", + "type": "array", + "items": { + "$ref": "#/definitions/IpAddressPool" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "L3Network": { + "type": "object", + "title": "L3Network represents a network that utilizes a single isolation domain set up for layer-3 resources.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/L3NetworkProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "L3NetworkAttachmentConfiguration": { + "type": "object", + "title": "L3NetworkAttachmentConfiguration represents the configuration of the attachment of a Layer 3 network.", + "required": [ + "networkId" + ], + "properties": { + "ipamEnabled": { + "description": "The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached.", + "type": "string", + "default": "False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "L3NetworkConfigurationIpamEnabled" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "networkId": { + "description": "The resource ID of the network that is being configured for attachment.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetworkCloud/l3Networks" + } + ] + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "pluginType": { + "description": "The indicator of how this network will be utilized by the Kubernetes cluster.", + "type": "string", + "default": "SRIOV", + "enum": [ + "DPDK", + "SRIOV", + "OSDevice", + "MACVLAN", + "IPVLAN" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesPluginType" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "L3NetworkList": { + "type": "object", + "title": "L3NetworkList represents a list of L3 networks.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of L3 networks.", + "type": "array", + "items": { + "$ref": "#/definitions/L3Network" + } + } + } + }, + "L3NetworkPatchParameters": { + "type": "object", + "title": "L3NetworkPatchParameters represents the body of the request to patch the cloud services network.", + "properties": { + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "L3NetworkProperties": { + "type": "object", + "title": "L3NetworkProperties represents properties of the L3 network.", + "required": [ + "l3IsolationDomainId", + "vlan" + ], + "properties": { + "associatedResourceIds": { + "description": "The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "clusterId": { + "description": "The resource ID of the Network Cloud cluster this L3 network is associated with.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "detailedStatus": { + "description": "The more detailed status of the L3 network.", + "type": "string", + "enum": [ + "Error", + "Available", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "L3NetworkDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "hybridAksClustersAssociatedIds": { + "description": "Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this L3 network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "hybridAksIpamEnabled": { + "description": "Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The indicator of whether or not to disable IPAM allocation on the network attachment definition injected into the Hybrid AKS Cluster.", + "type": "string", + "default": "True", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "HybridAksIpamEnabled" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "hybridAksPluginType": { + "description": "Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS.", + "type": "string", + "default": "SRIOV", + "enum": [ + "DPDK", + "SRIOV", + "OSDevice" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "HybridAksPluginType" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "interfaceName": { + "description": "The default interface name for this L3 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine.", + "type": "string", + "maxLength": 12, + "pattern": "^[a-zA-Z0-9@._-]*$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ipAllocationType": { + "description": "The type of the IP address allocation, defaulted to \"DualStack\".", + "type": "string", + "default": "DualStack", + "enum": [ + "IPV4", + "IPV6", + "DualStack" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "IpAllocationType" + } + }, + "ipv4ConnectedPrefix": { + "description": "The IPV4 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type\nis IPV4 or DualStack.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ipv6ConnectedPrefix": { + "description": "The IPV6 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type\nis IPV6 or DualStack.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "l3IsolationDomainId": { + "description": "The resource ID of the Network Fabric l3IsolationDomain.", + "type": "string", + "format": "arm-id", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "description": "The provisioning state of the L3 network.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Accepted" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "L3NetworkProvisioningState" + }, + "readOnly": true + }, + "virtualMachinesAssociatedIds": { + "description": "Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this L3 network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "vlan": { + "description": "The VLAN from the l3IsolationDomain that is used for this network.", + "type": "integer", + "format": "int64", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "LldpNeighbor": { + "type": "object", + "title": "Type Deprecated. Will be removed in an upcoming version. LldpNeighbor represents the details about the device connected to the NIC.", + "properties": { + "portDescription": { + "description": "The descriptive information about the port on the connected device.", + "type": "string", + "readOnly": true + }, + "portName": { + "description": "The system-assigned name of the port on the connected device.", + "type": "string", + "readOnly": true + }, + "systemDescription": { + "description": "The descriptive information about the connected device.", + "type": "string", + "readOnly": true + }, + "systemName": { + "description": "The system-assigned name of the connected device.", + "type": "string", + "readOnly": true + } + } + }, + "MachineDisk": { + "type": "object", + "title": "Disk represents the properties of the disk.", + "properties": { + "capacityGB": { + "description": "The maximum amount of storage. Measured in gibibytes.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "connection": { + "description": "The connection type of the rack SKU resource.", + "type": "string", + "enum": [ + "PCIE", + "SATA", + "RAID", + "SAS" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "MachineSkuDiskConnectionType" + }, + "readOnly": true + }, + "type": { + "description": "The disk type of rack SKU resource.", + "type": "string", + "enum": [ + "HDD", + "SSD" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "DiskType" + }, + "readOnly": true + } + } + }, + "MachineSkuProperties": { + "type": "object", + "title": "MachineSkuProperties represents the properties of the machine SKU.", + "properties": { + "bootstrapProtocol": { + "description": "The type of bootstrap protocol used.", + "type": "string", + "enum": [ + "PXE" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BootstrapProtocol" + }, + "readOnly": true + }, + "cpuCores": { + "description": "The count of CPU cores for this machine.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "cpuSockets": { + "description": "The count of CPU sockets for this machine.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "disks": { + "description": "The list of disks.", + "type": "array", + "items": { + "$ref": "#/definitions/MachineDisk" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "generation": { + "description": "The generation of the architecture.", + "type": "string", + "readOnly": true + }, + "hardwareVersion": { + "description": "The hardware version of the machine.", + "type": "string", + "readOnly": true + }, + "memoryCapacityGB": { + "description": "The maximum amount of memory. Measured in gibibytes.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "model": { + "description": "The model of the machine.", + "type": "string", + "readOnly": true + }, + "networkInterfaces": { + "description": "The list of network interfaces.", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterface" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "totalThreads": { + "description": "The count of SMT and physical core threads for this machine.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "vendor": { + "description": "The make of the machine.", + "type": "string", + "readOnly": true + } + } + }, + "MachineSkuSlot": { + "type": "object", + "title": "MachineSkuSlot represents a single SKU and rack slot associated with the machine.", + "properties": { + "properties": { + "$ref": "#/definitions/MachineSkuProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "rackSlot": { + "description": "The position in the rack for the machine.", + "type": "integer", + "format": "int64", + "readOnly": true + } + } + }, + "ManagedResourceGroupConfiguration": { + "type": "object", + "title": "ManagedResourceGroupConfiguration represents the configuration of the resource group managed by Azure.", + "properties": { + "location": { + "description": "The location of the managed resource group. If not specified, the location of the parent resource is chosen.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "name": { + "description": "The name for the managed resource group. If not specified, the unique name is automatically generated.", + "type": "string", + "maxLength": 75, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "NetworkAttachment": { + "type": "object", + "title": "NetworkAttachment represents the single network attachment.", + "required": [ + "attachedNetworkId", + "ipAllocationMethod" + ], + "properties": { + "attachedNetworkId": { + "description": "The resource ID of the associated network attached to the virtual machine.\nIt can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources.", + "type": "string", + "format": "arm-id", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "defaultGateway": { + "description": "The indicator of whether this is the default gateway.\nOnly one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True.", + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "DefaultGateway" + } + }, + "ipAllocationMethod": { + "description": "The IP allocation mechanism for the virtual machine.\nDynamic and Static are only valid for l3Network which may also specify Disabled.\nOtherwise, Disabled is the only permitted value.", + "type": "string", + "enum": [ + "Dynamic", + "Static", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VirtualMachineIPAllocationMethod" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ipv4Address": { + "description": "The IPv4 address of the virtual machine.\n\nThis field is used only if the attached network has IPAllocationType of IPV4 or DualStack.\n\nIf IPAllocationMethod is:\nStatic - this field must contain a user specified IPv4 address from within the subnet specified in the attached network.\nDynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network.\nDisabled - this field will be empty.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ipv6Address": { + "description": "The IPv6 address of the virtual machine.\n\nThis field is used only if the attached network has IPAllocationType of IPV6 or DualStack.\n\nIf IPAllocationMethod is:\nStatic - this field must contain an IPv6 address range from within the range specified in the attached network.\nDynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network.\nDisabled - this field will be empty.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "macAddress": { + "description": "The MAC address of the interface for the virtual machine that corresponds to this network attachment.", + "type": "string", + "readOnly": true + }, + "networkAttachmentName": { + "description": "The associated network's interface name.\nIf specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine.\nIf the user doesn’t specify this value, the default interface name of the network resource will be used.\nFor a CloudServicesNetwork resource, this name will be ignored.", + "type": "string", + "maxLength": 15, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "NetworkConfiguration": { + "type": "object", + "title": "NetworkConfiguration specifies the Kubernetes cluster network related configuration.", + "required": [ + "cloudServicesNetworkId", + "cniNetworkId" + ], + "properties": { + "attachedNetworkConfiguration": { + "$ref": "#/definitions/AttachedNetworkConfiguration", + "description": "The configuration of networks being attached to the cluster for use by the workloads that run on this Kubernetes cluster.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "$ref": "#/definitions/BgpServiceLoadBalancerConfiguration", + "description": "The configuration of the BGP service load balancer for this Kubernetes cluster. A maximum of one service load balancer may be specified, either Layer 2 or BGP.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cloudServicesNetworkId": { + "description": "The resource ID of the associated Cloud Services network.", + "type": "string", + "format": "arm-id", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cniNetworkId": { + "description": "The resource ID of the Layer 3 network that is used for creation of the Container Networking Interface network.", + "type": "string", + "format": "arm-id", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "dnsServiceIp": { + "description": "The IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in service CIDR.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "l2ServiceLoadBalancerConfiguration": { + "$ref": "#/definitions/L2ServiceLoadBalancerConfiguration", + "description": "The configuration of the Layer 2 service load balancer for this Kubernetes cluster. A maximum of one service load balancer may be specified, either Layer 2 or BGP.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "podCidrs": { + "description": "The CIDR notation IP ranges from which to assign pod IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "serviceCidrs": { + "description": "The CIDR notation IP ranges from which to assign service IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "NetworkInterface": { + "type": "object", + "title": "NetworkInterface represents properties of the network interface.", + "properties": { + "address": { + "description": "The partial address of Peripheral Component Interconnect (PCI).", + "type": "string", + "readOnly": true + }, + "deviceConnectionType": { + "description": "The connection type of the device.", + "type": "string", + "enum": [ + "PCI" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "DeviceConnectionType" + }, + "readOnly": true + }, + "model": { + "description": "The model name of the device.", + "type": "string", + "readOnly": true + }, + "physicalSlot": { + "description": "The physical slot for this device.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "portCount": { + "description": "The number of ports on the device.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "portSpeed": { + "description": "The maximum amount of data in gigabits that the line card transmits through a port at any given second.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "vendor": { + "description": "The vendor name of the device.", + "type": "string", + "readOnly": true + } + } + }, + "Nic": { + "type": "object", + "title": "Type Deprecated. Will be removed in an upcoming version. Nic represents the network interface card details.", + "properties": { + "lldpNeighbor": { + "$ref": "#/definitions/LldpNeighbor", + "description": "The information about the device connected to this NIC.", + "readOnly": true + }, + "macAddress": { + "description": "The MAC address associated with this NIC.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the NIC/interface.", + "type": "string", + "readOnly": true + } + } + }, + "NodePoolAdministratorConfigurationPatch": { + "type": "object", + "title": "NodePoolAdministratorConfigurationPatch represents the patching capabilities for the administrator configuration.", + "properties": { + "sshPublicKeys": { + "description": "SshPublicKey represents the public key used to authenticate with a resource through SSH.", + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "x-ms-identifiers": [ + "keyData" + ] + } + } + }, + "OperationStatusResult": { + "type": "object", + "title": "The current status of an async operation.", + "required": [ + "status" + ], + "properties": { + "endTime": { + "description": "The end time of the operation.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", + "description": "If present, details of the operation error.", + "readOnly": true + }, + "id": { + "description": "Fully qualified ID for the async operation.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the async operation.", + "type": "string", + "readOnly": true + }, + "operations": { + "description": "The operations list.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationStatusResult" + }, + "readOnly": true + }, + "percentComplete": { + "description": "Percent of the operation that is complete.", + "type": "number", + "maximum": 100, + "minimum": 0, + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/OperationStatusResultProperties", + "description": "The additional properties of the operation status result.", + "x-ms-client-flatten": true + }, + "resourceId": { + "description": "Fully qualified ID of the resource against which the original async operation was started.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "startTime": { + "description": "The start time of the operation.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "status": { + "description": "Operation status.", + "type": "string" + } + } + }, + "OperationStatusResultProperties": { + "type": "object", + "title": "OperationStatusResultProperties represents additional properties of the operation status result.", + "properties": { + "exitCode": { + "description": "For actions that run commands or scripts, the exit code of the script execution.", + "type": "string", + "readOnly": true + }, + "outputHead": { + "description": "For actions that run commands or scripts, the leading bytes of the output of the script execution.", + "type": "string", + "readOnly": true + }, + "resultRef": { + "description": "For actions that run commands or scripts, a reference to the location of the result.", + "type": "string", + "format": "uri", + "readOnly": true + }, + "resultUrl": { + "description": "For actions that run commands or scripts, the URL where the full output of the script output can be retrieved.", + "type": "string", + "format": "uri", + "readOnly": true + } + } + }, + "OsDisk": { + "type": "object", + "title": "OsDisk represents configuration of the boot disk.", + "required": [ + "diskSizeGB" + ], + "properties": { + "createOption": { + "description": "The strategy for creating the OS disk.", + "type": "string", + "default": "Ephemeral", + "enum": [ + "Ephemeral" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "OsDiskCreateOption" + } + }, + "deleteOption": { + "description": "The strategy for deleting the OS disk.", + "type": "string", + "default": "Delete", + "enum": [ + "Delete" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "OsDiskDeleteOption" + } + }, + "diskSizeGB": { + "description": "The size of the disk. Required if the createOption is Ephemeral. Allocations are measured in gibibytes.", + "type": "integer", + "format": "int64" + } + } + }, + "Rack": { + "type": "object", + "title": "Rack represents the hardware of the rack and is dependent upon the cluster for lifecycle.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/RackProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "RackDefinition": { + "type": "object", + "title": "RackDefinition represents details regarding the rack.", + "required": [ + "networkRackId", + "rackSkuId", + "rackSerialNumber" + ], + "properties": { + "availabilityZone": { + "description": "The zone name used for this rack when created. Availability zones are used for workload placement.", + "type": "string", + "pattern": "^[a-zA-Z0-9]{1,10}$" + }, + "bareMetalMachineConfigurationData": { + "description": "The unordered list of bare metal machine configuration.", + "type": "array", + "items": { + "$ref": "#/definitions/BareMetalMachineConfigurationData" + }, + "x-ms-identifiers": [] + }, + "networkRackId": { + "description": "The resource ID of the network rack that matches this rack definition.", + "type": "string", + "format": "arm-id" + }, + "rackLocation": { + "description": "The free-form description of the rack's location.", + "type": "string", + "maxLength": 256 + }, + "rackSerialNumber": { + "description": "The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired.", + "type": "string", + "maxLength": 64, + "minLength": 1 + }, + "rackSkuId": { + "description": "The resource ID of the sku for the rack being added.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetworkCloud/rackSkus" + } + ] + } + }, + "storageApplianceConfigurationData": { + "description": "The list of storage appliance configuration data for this rack.", + "type": "array", + "items": { + "$ref": "#/definitions/StorageApplianceConfigurationData" + }, + "x-ms-identifiers": [] + } + } + }, + "RackList": { + "type": "object", + "title": "RackList represents a list of racks.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of racks.", + "type": "array", + "items": { + "$ref": "#/definitions/Rack" + } + } + } + }, + "RackPatchParameters": { + "type": "object", + "title": "RackPatchParameters represents the body of the request to patch the rack properties.", + "properties": { + "properties": { + "$ref": "#/definitions/RacksPatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "RackProperties": { + "type": "object", + "title": "RackProperties represents the properties of the rack.", + "required": [ + "rackSkuId", + "rackSerialNumber", + "availabilityZone", + "rackLocation" + ], + "properties": { + "availabilityZone": { + "description": "The value that will be used for machines in this rack to represent the availability zones that can be referenced by Hybrid AKS Clusters for node arrangement.", + "type": "string", + "pattern": "^[a-zA-Z0-9]{1,10}$" + }, + "clusterId": { + "description": "The resource ID of the cluster the rack is created for. This value is set when the rack is created by the cluster.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "detailedStatus": { + "description": "The more detailed status of the rack.", + "type": "string", + "enum": [ + "Error", + "Available", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "RackDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the rack resource.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Accepted" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "RackProvisioningState" + }, + "readOnly": true + }, + "rackLocation": { + "description": "The free-form description of the rack location. (e.g. “DTN Datacenter, Floor 3, Isle 9, Rack 2B”)", + "type": "string", + "maxLength": 256 + }, + "rackSerialNumber": { + "description": "The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired.", + "type": "string", + "maxLength": 64, + "minLength": 1 + }, + "rackSkuId": { + "description": "The SKU for the rack.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetworkCloud/rackSkus" + } + ] + } + } + } + }, + "RackSku": { + "type": "object", + "title": "RackSku represents the SKU information of the rack.", + "required": [ + "properties" + ], + "properties": { + "properties": { + "$ref": "#/definitions/RackSkuProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "x-ms-azure-resource": true + }, + "RackSkuList": { + "type": "object", + "title": "RackSkuList represents a list of rack SKUs.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of Rack SKUs.", + "type": "array", + "items": { + "$ref": "#/definitions/RackSku" + } + } + } + }, + "RackSkuProperties": { + "type": "object", + "title": "RackSkuProperties represents the properties of compute-related hardware for a rack. This supports both aggregator and compute racks.", + "properties": { + "computeMachines": { + "description": "The list of machine SKUs and associated rack slot for the compute-dedicated machines in this rack model.", + "type": "array", + "items": { + "$ref": "#/definitions/MachineSkuSlot" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "controllerMachines": { + "description": "The list of machine SKUs and associated rack slot for the control-plane dedicated machines in this rack model.", + "type": "array", + "items": { + "$ref": "#/definitions/MachineSkuSlot" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "description": { + "description": "The free-form text describing the rack.", + "type": "string", + "readOnly": true + }, + "maxClusterSlots": { + "description": "The maximum number of compute racks supported by an aggregator rack. 0 if this is a compute rack or a rack for a single rack cluster(rackType=\"Single\").", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the rack SKU resource.", + "type": "string", + "enum": [ + "Canceled", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "RackSkuProvisioningState" + }, + "readOnly": true + }, + "rackType": { + "description": "The type of the rack.", + "type": "string", + "enum": [ + "Aggregator", + "Compute", + "Single" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "RackSkuType" + }, + "readOnly": true + }, + "storageAppliances": { + "description": "The list of appliance SKUs and associated rack slot for the storage appliance(s) in this rack model.", + "type": "array", + "items": { + "$ref": "#/definitions/StorageApplianceSkuSlot" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "supportedRackSkuIds": { + "description": "The list of supported SKUs if the rack is an aggregator.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "RacksPatchProperties": { + "type": "object", + "title": "RacksPatchProperties represents the properties of the rack during patching.", + "properties": { + "rackLocation": { + "description": "The free-form description of the rack location. (e.g. “DTN Datacenter, Floor 3, Isle 9, Rack 2B”)", + "type": "string", + "maxLength": 256 + }, + "rackSerialNumber": { + "description": "The globally unique identifier for the rack.", + "type": "string", + "maxLength": 64, + "minLength": 1 + } + } + }, + "RuntimeProtectionConfiguration": { + "type": "object", + "title": "RuntimeProtectionConfiguration represents the runtime protection configuration for the cluster.", + "properties": { + "enforcementLevel": { + "description": "The mode of operation for runtime protection.", + "type": "string", + "default": "Disabled", + "enum": [ + "Audit", + "Disabled", + "OnDemand", + "Passive", + "RealTime" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "RuntimeProtectionEnforcementLevel" + } + } + } + }, + "RuntimeProtectionStatus": { + "type": "object", + "title": "RuntimeProtectionStatus represents the runtime protection status of the bare metal machine.", + "properties": { + "definitionsLastUpdated": { + "description": "The timestamp when the malware definitions were last updated.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "definitionsVersion": { + "description": "The version of the malware definitions.", + "type": "string", + "readOnly": true + }, + "scanCompletedTime": { + "description": "The timestamp of the most recently completed scan, or empty if there has never been a scan.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "scanScheduledTime": { + "description": "The timestamp of the most recently scheduled scan, or empty if no scan has been scheduled.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "scanStartedTime": { + "description": "The timestamp of the most recently started scan, or empty if there has never been a scan.", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + }, + "SecretArchiveReference": { + "type": "object", + "title": "SecretArchiveReference represents the reference to a secret in a key vault.", + "properties": { + "keyVaultId": { + "description": "The resource ID of the key vault containing the secret.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + }, + "readOnly": true + }, + "secretName": { + "description": "The name of the secret in the key vault.", + "type": "string", + "readOnly": true + }, + "secretVersion": { + "description": "The version of the secret in the key vault.", + "type": "string", + "readOnly": true + } + } + }, + "SecretRotationStatus": { + "type": "object", + "title": "SecretRotationStatus represents the status of a secret rotation.", + "properties": { + "expirePeriodDays": { + "description": "The maximum number of days the secret may be used before it must be changed.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "lastRotationTime": { + "description": "The date and time when the secret was last changed.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "rotationPeriodDays": { + "description": "The number of days a secret exists before rotations will be attempted.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "secretArchiveReference": { + "$ref": "#/definitions/SecretArchiveReference", + "description": "The reference to the secret in a key vault.", + "readOnly": true + }, + "secretType": { + "description": "The type name used to identify the purpose of the secret.", + "type": "string", + "readOnly": true + } + } + }, + "ServiceLoadBalancerBgpPeer": { + "type": "object", + "title": "ServiceLoadBalancerBgpPeer represents the configuration of the BGP service load balancer for the Kubernetes cluster.", + "required": [ + "name", + "peerAddress", + "peerAsn" + ], + "properties": { + "bfdEnabled": { + "description": "The indicator of BFD enablement for this BgpPeer.", + "type": "string", + "default": "False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BfdEnabled" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "bgpMultiHop": { + "description": "The indicator to enable multi-hop peering support.", + "type": "string", + "default": "False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BgpMultiHop" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "holdTime": { + "description": "Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The requested BGP hold time value. This field uses ISO 8601 duration format, for example P1H.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "keepAliveTime": { + "description": "Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The requested BGP keepalive time value. This field uses ISO 8601 duration format, for example P1H.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "myAsn": { + "description": "The autonomous system number used for the local end of the BGP session.", + "type": "integer", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "name": { + "description": "The name used to identify this BGP peer for association with a BGP advertisement.", + "type": "string", + "pattern": "^[a-z0-9]([a-z0-9.-]{0,61}[a-z0-9]){0,1}$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "password": { + "description": "The authentication password for routers enforcing TCP MD5 authenticated sessions.", + "type": "string", + "maxLength": 80, + "pattern": "^[a-zA-Z0-9]{0,80}$", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "peerAddress": { + "description": "The IPv4 or IPv6 address used to connect this BGP session.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "peerAsn": { + "description": "The autonomous system number expected from the remote end of the BGP session.", + "type": "integer", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "peerPort": { + "description": "The port used to connect this BGP session.", + "type": "integer", + "format": "int64", + "default": 179, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "ServicePrincipalInformation": { + "type": "object", + "title": "ServicePrincipalInformation represents the details of the service principal to be used by the cluster during Arc Appliance installation.", + "required": [ + "tenantId", + "principalId", + "applicationId", + "password" + ], + "properties": { + "applicationId": { + "description": "The application ID, also known as client ID, of the service principal.", + "type": "string" + }, + "password": { + "description": "The password of the service principal.", + "type": "string", + "x-ms-secret": true + }, + "principalId": { + "description": "The principal ID, also known as the object ID, of the service principal.", + "type": "string" + }, + "tenantId": { + "description": "The tenant ID, also known as the directory ID, of the tenant in which the service principal is created.", + "type": "string" + } + } + }, + "SshPublicKey": { + "type": "object", + "title": "SshPublicKey represents the public key used to authenticate with a resource through SSH.", + "required": [ + "keyData" + ], + "properties": { + "keyData": { + "description": "The SSH public key data.", + "type": "string", + "minLength": 1 + } + } + }, + "StorageAppliance": { + "type": "object", + "title": "StorageAppliance represents on-premises Network Cloud storage appliance.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/StorageApplianceProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "StorageApplianceConfigurationData": { + "type": "object", + "title": "StorageApplianceConfigurationData represents configuration for the storage application.", + "required": [ + "rackSlot", + "adminCredentials", + "serialNumber" + ], + "properties": { + "adminCredentials": { + "$ref": "#/definitions/AdministrativeCredentials", + "description": "The credentials of the administrative interface on this storage appliance." + }, + "rackSlot": { + "description": "The slot that storage appliance is in the rack based on the BOM configuration.", + "type": "integer", + "format": "int64", + "maximum": 256, + "minimum": 1 + }, + "serialNumber": { + "description": "The serial number of the appliance.", + "type": "string" + }, + "storageApplianceName": { + "description": "The user-provided name for the storage appliance that will be created from this specification.", + "type": "string", + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$" + } + } + }, + "StorageApplianceEnableRemoteVendorManagementParameters": { + "type": "object", + "title": "StorageApplianceEnableRemoteVendorManagementParameters represents the body of the request to enable remote vendor management of a storage appliance.", + "properties": { + "supportEndpoints": { + "description": "Field Deprecated. This field is not used and will be rejected if provided. The list of IPv4 subnets (in CIDR format), IPv6 subnets (in CIDR format), or hostnames that the storage appliance needs accessible in order to turn on the remote vendor management.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "StorageApplianceList": { + "type": "object", + "title": "StorageApplianceList represents a list of storage appliances.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of storage appliances.", + "type": "array", + "items": { + "$ref": "#/definitions/StorageAppliance" + } + } + } + }, + "StorageAppliancePatchParameters": { + "type": "object", + "title": "StorageAppliancePatchParameters represents the body of the request to patch storage appliance properties.", + "properties": { + "properties": { + "$ref": "#/definitions/StorageAppliancePatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "StorageAppliancePatchProperties": { + "type": "object", + "title": "StorageAppliancePatchProperties represents the properties of the storage appliance that can be patched.", + "properties": { + "serialNumber": { + "description": "The serial number for the storage appliance.", + "type": "string" + } + } + }, + "StorageApplianceProperties": { + "type": "object", + "title": "StorageApplianceProperties represents the properties of the storage appliance.", + "required": [ + "rackId", + "storageApplianceSkuId", + "rackSlot", + "serialNumber", + "administratorCredentials" + ], + "properties": { + "administratorCredentials": { + "$ref": "#/definitions/AdministrativeCredentials", + "description": "The credentials of the administrative interface on this storage appliance.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "capacity": { + "description": "The total capacity of the storage appliance.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "capacityUsed": { + "description": "The amount of storage consumed.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "clusterId": { + "description": "The resource ID of the cluster this storage appliance is associated with.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "detailedStatus": { + "description": "The detailed status of the storage appliance.", + "type": "string", + "enum": [ + "Error", + "Available", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "StorageApplianceDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "managementIpv4Address": { + "description": "The endpoint for the management interface of the storage appliance.", + "type": "string", + "readOnly": true + }, + "manufacturer": { + "description": "The manufacturer of the storage appliance.", + "type": "string", + "readOnly": true + }, + "model": { + "description": "The model of the storage appliance.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the storage appliance.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Accepted" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "StorageApplianceProvisioningState" + }, + "readOnly": true + }, + "rackId": { + "description": "The resource ID of the rack where this storage appliance resides.", + "type": "string", + "format": "arm-id", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "rackSlot": { + "description": "The slot the storage appliance is in the rack based on the BOM configuration.", + "type": "integer", + "format": "int64", + "maximum": 256, + "minimum": 1, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "remoteVendorManagementFeature": { + "description": "The indicator of whether the storage appliance supports remote vendor management.", + "type": "string", + "enum": [ + "Supported", + "Unsupported" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "RemoteVendorManagementFeature" + }, + "readOnly": true + }, + "remoteVendorManagementStatus": { + "description": "The indicator of whether the remote vendor management feature is enabled or disabled, or unsupported if it is an unsupported feature.", + "type": "string", + "enum": [ + "Enabled", + "Disabled", + "Unsupported" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "RemoteVendorManagementStatus" + }, + "readOnly": true + }, + "secretRotationStatus": { + "description": "The list of statuses that represent secret rotation activity.", + "type": "array", + "items": { + "$ref": "#/definitions/SecretRotationStatus" + }, + "x-ms-identifiers": [ + "secretType" + ], + "readOnly": true + }, + "serialNumber": { + "description": "The serial number for the storage appliance.", + "type": "string" + }, + "storageApplianceSkuId": { + "description": "The SKU for the storage appliance.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "version": { + "description": "The version of the storage appliance.", + "type": "string", + "readOnly": true + } + } + }, + "StorageApplianceSkuProperties": { + "type": "object", + "title": "StorageApplianceSkuProperties represents the properties of the storage appliance SKU.", + "properties": { + "capacityGB": { + "description": "The maximum capacity of the storage appliance. Measured in gibibytes.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "model": { + "description": "The model of the storage appliance.", + "type": "string", + "readOnly": true + } + } + }, + "StorageApplianceSkuSlot": { + "type": "object", + "title": "StorageApplianceSkuSlot represents the single SKU and rack slot associated with the storage appliance.", + "properties": { + "properties": { + "$ref": "#/definitions/StorageApplianceSkuProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "rackSlot": { + "description": "The position in the rack for the storage appliance.", + "type": "integer", + "format": "int64", + "readOnly": true + } + } + }, + "StorageProfile": { + "type": "object", + "title": "StorageProfile represents information about a disk.", + "required": [ + "osDisk" + ], + "properties": { + "osDisk": { + "$ref": "#/definitions/OsDisk", + "description": "The disk to use with this virtual machine." + }, + "volumeAttachments": { + "description": "The resource IDs of volumes that are requested to be attached to the virtual machine.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "StringKeyValuePair": { + "type": "object", + "title": "StringKeyValuePair represents a single entry in a mapping of keys to values.", + "required": [ + "key", + "value" + ], + "properties": { + "key": { + "description": "The key to the mapped value.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "value": { + "description": "The value of the mapping key.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "TagsParameter": { + "type": "object", + "title": "TagsParameter represents the resource tags.", + "properties": { + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TrunkedNetwork": { + "type": "object", + "title": "TrunkedNetwork represents a network that utilizes multiple isolation domains and specified VLANs to create a trunked network.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/TrunkedNetworkProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "TrunkedNetworkAttachmentConfiguration": { + "type": "object", + "title": "TrunkedNetworkAttachmentConfiguration represents the configuration of the attachment of a trunked network.", + "required": [ + "networkId" + ], + "properties": { + "networkId": { + "description": "The resource ID of the network that is being configured for attachment.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetworkCloud/trunkedNetworks" + } + ] + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "pluginType": { + "description": "The indicator of how this network will be utilized by the Kubernetes cluster.", + "type": "string", + "default": "SRIOV", + "enum": [ + "DPDK", + "SRIOV", + "OSDevice", + "MACVLAN", + "IPVLAN" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesPluginType" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "TrunkedNetworkList": { + "type": "object", + "title": "TrunkedNetworkList represents a list of trunked networks.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of trunked networks.", + "type": "array", + "items": { + "$ref": "#/definitions/TrunkedNetwork" + } + } + } + }, + "TrunkedNetworkPatchParameters": { + "type": "object", + "title": "TrunkedNetworkPatchParameters represents the body of the request to patch the Trunked network.", + "properties": { + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TrunkedNetworkProperties": { + "type": "object", + "title": "TrunkedNetworkProperties represents properties of the trunked network.", + "required": [ + "isolationDomainIds", + "vlans" + ], + "properties": { + "associatedResourceIds": { + "description": "The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "clusterId": { + "description": "The resource ID of the Network Cloud cluster this trunked network is associated with.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "detailedStatus": { + "description": "The more detailed status of the trunked network.", + "type": "string", + "enum": [ + "Error", + "Available", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "TrunkedNetworkDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "hybridAksClustersAssociatedIds": { + "description": "Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this trunked network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "hybridAksPluginType": { + "description": "Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS.", + "type": "string", + "default": "SRIOV", + "enum": [ + "DPDK", + "SRIOV", + "OSDevice" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "HybridAksPluginType" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "interfaceName": { + "description": "The default interface name for this trunked network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine.", + "type": "string", + "maxLength": 12, + "pattern": "^[a-zA-Z0-9@._-]*$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "isolationDomainIds": { + "description": "The list of resource IDs representing the Network Fabric isolation domains. It can be any combination of l2IsolationDomain and l3IsolationDomain resources.", + "type": "array", + "minItems": 1, + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "description": "The provisioning state of the trunked network.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Accepted" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "TrunkedNetworkProvisioningState" + }, + "readOnly": true + }, + "virtualMachinesAssociatedIds": { + "description": "Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this trunked network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "vlans": { + "description": "The list of vlans that are selected from the isolation domains for trunking.", + "type": "array", + "minItems": 1, + "items": { + "type": "integer", + "format": "int64" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "ValidationThreshold": { + "type": "object", + "title": "ValidationThreshold indicates allowed machine and node hardware and deployment failures.", + "required": [ + "type", + "grouping", + "value" + ], + "properties": { + "grouping": { + "description": "Selection of how the type evaluation is applied to the cluster calculation.", + "type": "string", + "enum": [ + "PerCluster", + "PerRack" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ValidationThresholdGrouping" + } + }, + "type": { + "description": "Selection of how the threshold should be evaluated.", + "type": "string", + "enum": [ + "CountSuccess", + "PercentSuccess" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ValidationThresholdType" + } + }, + "value": { + "description": "The numeric threshold value.", + "type": "integer", + "format": "int64", + "minimum": 0 + } + } + }, + "VirtualMachine": { + "type": "object", + "title": "VirtualMachine represents the on-premises Network Cloud virtual machine.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/VirtualMachineProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "VirtualMachineList": { + "type": "object", + "title": "VirtualMachineList represents a list of virtual machines.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of virtual machines.", + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachine" + } + } + } + }, + "VirtualMachinePatchParameters": { + "type": "object", + "title": "VirtualMachinePatchParameters represents the body of the request to patch the virtual machine.", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualMachinePatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VirtualMachinePatchProperties": { + "type": "object", + "title": "VirtualMachinePatchProperties represents the properties of the virtual machine that can be patched.", + "properties": { + "vmImageRepositoryCredentials": { + "$ref": "#/definitions/ImageRepositoryCredentials", + "description": "The credentials used to login to the image repository that has access to the specified image." + } + } + }, + "VirtualMachinePlacementHint": { + "type": "object", + "title": "VirtualMachinePlacementHint represents a single scheduling hint of the virtual machine.", + "required": [ + "hintType", + "schedulingExecution", + "resourceId", + "scope" + ], + "properties": { + "hintType": { + "description": "The specification of whether this hint supports affinity or anti-affinity with the referenced resources.", + "type": "string", + "enum": [ + "Affinity", + "AntiAffinity" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VirtualMachinePlacementHintType" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "resourceId": { + "description": "The resource ID of the target object that the placement hints will be checked against, e.g., the bare metal node to host the virtual machine.", + "type": "string", + "format": "arm-id", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "schedulingExecution": { + "description": "The indicator of whether the hint is a hard or soft requirement during scheduling.", + "type": "string", + "enum": [ + "Hard", + "Soft" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VirtualMachineSchedulingExecution" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "scope": { + "description": "The scope for the virtual machine affinity or anti-affinity placement hint. It should always be \"Machine\" in the case of node affinity.", + "type": "string", + "enum": [ + "Rack", + "Machine" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VirtualMachinePlacementHintPodAffinityScope" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "VirtualMachinePowerOffParameters": { + "type": "object", + "title": "VirtualMachinePowerOffParameters represents the body of the request to power off virtual machine.", + "properties": { + "skipShutdown": { + "description": "The indicator of whether to skip the graceful OS shutdown and power off the virtual machine immediately.", + "type": "string", + "default": "False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "SkipShutdown" + } + } + } + }, + "VirtualMachineProperties": { + "type": "object", + "title": "VirtualMachineProperties represents the properties of the virtual machine.", + "required": [ + "vmImage", + "cpuCores", + "memorySizeGB", + "storageProfile", + "cloudServicesNetworkAttachment", + "adminUsername" + ], + "properties": { + "adminUsername": { + "description": "The name of the administrator to which the ssh public keys will be added into the authorized keys.", + "type": "string", + "maxLength": 32, + "minLength": 1, + "pattern": "^[a-z_][a-z0-9_]{0,31}$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "availabilityZone": { + "description": "The cluster availability zone containing this virtual machine.", + "type": "string", + "readOnly": true + }, + "bareMetalMachineId": { + "description": "The resource ID of the bare metal machine that hosts the virtual machine.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "bootMethod": { + "description": "Selects the boot method for the virtual machine.", + "type": "string", + "default": "UEFI", + "enum": [ + "UEFI", + "BIOS" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VirtualMachineBootMethod" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cloudServicesNetworkAttachment": { + "$ref": "#/definitions/NetworkAttachment", + "description": "The cloud service network that provides platform-level services for the virtual machine.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "clusterId": { + "description": "The resource ID of the cluster the virtual machine is created for.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "cpuCores": { + "description": "The number of CPU cores in the virtual machine.", + "type": "integer", + "format": "int64", + "minimum": 2, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "detailedStatus": { + "description": "The more detailed status of the virtual machine.", + "type": "string", + "enum": [ + "Available", + "Error", + "Provisioning", + "Running", + "Scheduling", + "Stopped", + "Terminating", + "Unknown" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VirtualMachineDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "isolateEmulatorThread": { + "description": "Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine.", + "type": "string", + "default": "True", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VirtualMachineIsolateEmulatorThread" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "memorySizeGB": { + "description": "The memory size of the virtual machine. Allocations are measured in gibibytes.", + "type": "integer", + "format": "int64", + "minimum": 1, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "networkAttachments": { + "description": "The list of network attachments to the virtual machine.", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkAttachment" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "create" + ] + }, + "networkData": { + "description": "The Base64 encoded cloud-init network data.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "placementHints": { + "description": "The scheduling hints for the virtual machine.", + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachinePlacementHint" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "create" + ] + }, + "powerState": { + "description": "The power state of the virtual machine.", + "type": "string", + "enum": [ + "On", + "Off", + "Unknown" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VirtualMachinePowerState" + }, + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the virtual machine.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Accepted" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VirtualMachineProvisioningState" + }, + "readOnly": true + }, + "sshPublicKeys": { + "description": "The list of ssh public keys. Each key will be added to the virtual machine using the cloud-init ssh_authorized_keys mechanism for the adminUsername.", + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "create" + ] + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "The storage profile that specifies size and other parameters about the disks related to the virtual machine.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "userData": { + "description": "The Base64 encoded cloud-init user data.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "virtioInterface": { + "description": "Field Deprecated, use virtualizationModel instead. The type of the virtio interface.", + "type": "string", + "default": "Modern", + "enum": [ + "Modern", + "Transitional" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VirtualMachineVirtioInterfaceType" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "vmDeviceModel": { + "description": "The type of the device model to use.", + "type": "string", + "default": "T2", + "enum": [ + "T1", + "T2" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VirtualMachineDeviceModelType" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "vmImage": { + "description": "The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "vmImageRepositoryCredentials": { + "$ref": "#/definitions/ImageRepositoryCredentials", + "description": "The credentials used to login to the image repository that has access to the specified image." + }, + "volumes": { + "description": "The resource IDs of volumes that are attached to the virtual machine.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "Volume": { + "type": "object", + "title": "Volume represents storage made available for use by resources running on the cluster.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/VolumeProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "VolumeList": { + "type": "object", + "title": "VolumeList represents a list of volumes.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of volumes.", + "type": "array", + "items": { + "$ref": "#/definitions/Volume" + } + } + } + }, + "VolumePatchParameters": { + "type": "object", + "title": "VolumePatchParameters represents the body of the request to patch the volume resource.", + "properties": { + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VolumeProperties": { + "type": "object", + "title": "VolumeProperties represents properties of the volume resource.", + "required": [ + "sizeMiB" + ], + "properties": { + "attachedTo": { + "description": "The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "detailedStatus": { + "description": "The more detailed status of the volume.", + "type": "string", + "enum": [ + "Error", + "Active", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VolumeDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the volume.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Accepted" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VolumeProvisioningState" + }, + "readOnly": true + }, + "serialNumber": { + "description": "The unique identifier of the volume.", + "type": "string", + "readOnly": true + }, + "sizeMiB": { + "description": "The size of the allocation for this volume in Mebibytes.", + "type": "integer", + "format": "int64", + "minimum": 1, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + } + }, + "parameters": { + "AgentPoolNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the Kubernetes cluster agent pool.", + "name": "agentPoolName", + "in": "path", + "required": true + }, + "BareMetalMachineKeySetNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the bare metal machine key set.", + "name": "bareMetalMachineKeySetName", + "in": "path", + "required": true + }, + "BareMetalMachineNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the bare metal machine.", + "name": "bareMetalMachineName", + "in": "path", + "required": true + }, + "BmcKeySetNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the baseboard management controller key set.", + "name": "bmcKeySetName", + "in": "path", + "required": true + }, + "CloudServicesNetworkNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the cloud services network.", + "name": "cloudServicesNetworkName", + "in": "path", + "required": true + }, + "ClusterManagerNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the cluster manager.", + "name": "clusterManagerName", + "in": "path", + "required": true + }, + "ClusterNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the cluster.", + "name": "clusterName", + "in": "path", + "required": true + }, + "ConsoleNameParameter": { + "pattern": "^default$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the virtual machine console.", + "name": "consoleName", + "in": "path", + "required": true + }, + "FeatureNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the feature.", + "name": "featureName", + "in": "path", + "required": true + }, + "KubernetesClusterNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the Kubernetes cluster.", + "name": "kubernetesClusterName", + "in": "path", + "required": true + }, + "L2NetworkNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the L2 network.", + "name": "l2NetworkName", + "in": "path", + "required": true + }, + "L3NetworkNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the L3 network.", + "name": "l3NetworkName", + "in": "path", + "required": true + }, + "MetricsConfigurationName": { + "pattern": "^default$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the metrics configuration for the cluster.", + "name": "metricsConfigurationName", + "in": "path", + "required": true + }, + "RackNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the rack.", + "name": "rackName", + "in": "path", + "required": true + }, + "RackSkuNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,126}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the rack SKU.", + "name": "rackSkuName", + "in": "path", + "required": true + }, + "StorageApplianceNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the storage appliance.", + "name": "storageApplianceName", + "in": "path", + "required": true + }, + "TrunkedNetworkNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the trunked network.", + "name": "trunkedNetworkName", + "in": "path", + "required": true + }, + "VirtualMachineNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the virtual machine.", + "name": "virtualMachineName", + "in": "path", + "required": true + }, + "VolumeNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,62}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the volume.", + "name": "volumeName", + "in": "path", + "required": true + } + }, + "securityDefinitions": { + "azure_auth": { + "description": "Azure Active Directory OAuth2 Flow.", + "type": "oauth2", + "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/networkcloud/resource-manager/readme.md b/specification/networkcloud/resource-manager/readme.md index 9f894133362c..07d7ea977c62 100644 --- a/specification/networkcloud/resource-manager/readme.md +++ b/specification/networkcloud/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for NetworkCloud. ```yaml openapi-type: arm openapi-subtype: providerHub -tag: package-2024-06-01-preview +tag: package-2024-07-01 ``` --- @@ -75,6 +75,31 @@ suppressions: reason: Bug in Linter, see https://github.com/Azure/azure-openapi-validator/issues/722 ``` +### Tag: package-2024-07-01 + +These settings apply only when `--tag=package-2024-07-01` is specified on the command line. + +```yaml $(tag) == 'package-2024-07-01' +input-file: + - Microsoft.NetworkCloud/stable/2024-07-01/networkcloud.json +suppressions: + - code: PatchBodyParametersSchema + from: networkcloud.json + reason: False positive based on Azure common types. Managed Service Identity requires type, and the Managed Service Identity can be patched. + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}"].patch.parameters[4].schema.properties.identity + - code: PatchBodyParametersSchema + from: networkcloud.json + reason: False positive based on Azure common types. Managed Service Identity requires type, and the Managed Service Identity can be patched. + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusterManagers/{clusterManagerName}"].patch.parameters[4].schema.properties.identity + - code: PatchBodyParametersSchema + from: networkcloud.json + reason: Nested objects that share a structure with PUT have required fields. The required field is present in the patch structure as well, because it reuses types. The nested structure needs to be updated in full by the user. + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}"].patch.parameters[4].schema.properties.properties + - code: BodyTopLevelProperties + from: networkcloud.json + reason: Bug in Linter, see https://github.com/Azure/azure-openapi-validator/issues/722 +``` + --- # Code Generation @@ -87,7 +112,7 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js From 9e4de416466c100eb1245a89279d327b63d555fd Mon Sep 17 00:00:00 2001 From: James Suplizio Date: Tue, 24 Sep 2024 10:48:15 -0700 Subject: [PATCH 09/48] Give CODEOWNERS file an owner in CODEOWNERS (#30710) --- .github/CODEOWNERS | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 7c5113ae9f70..93f36b82c2c7 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -278,13 +278,14 @@ ########### # Eng Sys ########### -/.gitattributes @weshaggard @mikeharder -/.gitignore @weshaggard @mikeharder -/.prettierrc.json @weshaggard @mikeharder -/package-lock.json @weshaggard @mikeharder -/package.json @weshaggard @mikeharder -/tsconfig.json @weshaggard @mikeharder +/.gitattributes @weshaggard @mikeharder +/.gitignore @weshaggard @mikeharder +/.prettierrc.json @weshaggard @mikeharder +/package-lock.json @weshaggard @mikeharder +/package.json @weshaggard @mikeharder +/tsconfig.json @weshaggard @mikeharder /.azure-pipelines/ @weshaggard @mikeharder @benbp /.github/ @weshaggard @mikeharder @benbp /eng/ @weshaggard @mikeharder @benbp -/scripts/ @weshaggard @mikeharder +/scripts/ @weshaggard @mikeharder +/.github/CODEOWNERS @Azure/azure-sdk-eng \ No newline at end of file From 7189fb57f69468c56df76f9a4d68dd9ff04ab100 Mon Sep 17 00:00:00 2001 From: Chenjie Shi Date: Wed, 25 Sep 2024 03:37:40 +0800 Subject: [PATCH 10/48] bump typespec arm lib to 0.46.1 (#30706) --- package-lock.json | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package-lock.json b/package-lock.json index b3ba9f903407..e54bdd8e9b3c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -10,7 +10,7 @@ "@azure-tools/typespec-autorest": "0.46.0", "@azure-tools/typespec-azure-core": "0.46.0", "@azure-tools/typespec-azure-portal-core": "0.46.0", - "@azure-tools/typespec-azure-resource-manager": "0.46.0", + "@azure-tools/typespec-azure-resource-manager": "0.46.1", "@azure-tools/typespec-azure-rulesets": "0.46.0", "@azure-tools/typespec-client-generator-cli": "0.13.0", "@azure-tools/typespec-client-generator-core": "0.46.0", @@ -927,9 +927,9 @@ } }, "node_modules/@azure-tools/typespec-azure-resource-manager": { - "version": "0.46.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-resource-manager/-/typespec-azure-resource-manager-0.46.0.tgz", - "integrity": "sha512-ileS/0OMp0pmtWU3k0g2ZGfA957nOiEHtFJzAILsYYBFeBWgWuEuCPcKaGYScvlYTTK4Pyplpb7u00RBZBBObQ==", + "version": "0.46.1", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-resource-manager/-/typespec-azure-resource-manager-0.46.1.tgz", + "integrity": "sha512-8md8AwnxoYVkDBavQL5dbToUTS10PTSkcF+emd9BKEdnF9MKuA542vZudzaQOz2BzFbArMVUE/PLm2mhuwRkLw==", "dev": true, "license": "MIT", "dependencies": { diff --git a/package.json b/package.json index 735613026a16..2159e8f89683 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,7 @@ "@azure-tools/typespec-autorest": "0.46.0", "@azure-tools/typespec-azure-core": "0.46.0", "@azure-tools/typespec-azure-portal-core": "0.46.0", - "@azure-tools/typespec-azure-resource-manager": "0.46.0", + "@azure-tools/typespec-azure-resource-manager": "0.46.1", "@azure-tools/typespec-azure-rulesets": "0.46.0", "@azure-tools/typespec-client-generator-cli": "0.13.0", "@azure-tools/typespec-client-generator-core": "0.46.0", From d79d73bea550b643c312dde6a7e817840c1ac914 Mon Sep 17 00:00:00 2001 From: Xiaofei Cao <92354331+XiaofeiCao@users.noreply.github.com> Date: Wed, 25 Sep 2024 10:49:14 +0800 Subject: [PATCH 11/48] java, compute schedule (#30703) --- .../ComputeSchedule.Management/tspconfig.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml b/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml index 74029a03414b..c73e44824afb 100644 --- a/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml +++ b/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml @@ -20,6 +20,11 @@ options: flavor: azure clear-output-folder: true namespace: "{package-dir}" + "@azure-tools/typespec-java": + package-dir: "azure-resourcemanager-computeschedule" + flavor: "azure" + namespace: "com.azure.resourcemanager.computeschedule" + service-name: "Compute Schedule" linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" From 8984bf482fab98d3a51376e50248f77fba359ae0 Mon Sep 17 00:00:00 2001 From: Weidong Xu Date: Wed, 25 Sep 2024 13:45:15 +0800 Subject: [PATCH 12/48] mongocluster, java, client.tsp modify client name (#30725) --- .../mongocluster/DocumentDB.MongoCluster.Management/client.tsp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/mongocluster/DocumentDB.MongoCluster.Management/client.tsp b/specification/mongocluster/DocumentDB.MongoCluster.Management/client.tsp index 176fb186556d..4e464d9b59f4 100644 --- a/specification/mongocluster/DocumentDB.MongoCluster.Management/client.tsp +++ b/specification/mongocluster/DocumentDB.MongoCluster.Management/client.tsp @@ -8,7 +8,7 @@ using Microsoft.DocumentDB; @@clientName(Microsoft.DocumentDB, "MongoClusterMgmtClient", "python"); @@clientName(Microsoft.DocumentDB, "MongoClusterManagementClient", - "javascript" + "javascript,java" ); @@access(Operations.list, Access.internal, "csharp"); @@clientName(CheckNameAvailabilityResponse, From 0c8907726e747c2fa5ddee356826fdb69fc73433 Mon Sep 17 00:00:00 2001 From: fengzhe ding <76160279+Mitse1n@users.noreply.github.com> Date: Wed, 25 Sep 2024 13:45:23 +0800 Subject: [PATCH 13/48] add standyby pool typespec go (#30726) Co-authored-by: fz --- .../standbypool/StandbyPool.Management/tspconfig.yaml | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/specification/standbypool/StandbyPool.Management/tspconfig.yaml b/specification/standbypool/StandbyPool.Management/tspconfig.yaml index 5e682fe881ab..09ee2ea103a3 100644 --- a/specification/standbypool/StandbyPool.Management/tspconfig.yaml +++ b/specification/standbypool/StandbyPool.Management/tspconfig.yaml @@ -47,3 +47,14 @@ options: generate-test: true generate-sample: true examples-dir: "{project-root}/examples" + "@azure-tools/typespec-go": + service-dir: "sdk/resourcemanager/standbypool" + package-dir: "armstandbypool" + module: "github.com/Azure/azure-sdk-for-go/{service-dir}/{package-dir}" + fix-const-stuttering: true + flavor: "azure" + generate-examples: true + generate-fakes: true + head-as-boolean: true + inject-spans: true + remove-unreferenced-types: true From 24fb335f3adce78299c9eca5fd43f66dfc5dadf7 Mon Sep 17 00:00:00 2001 From: Yuchao Yan Date: Wed, 25 Sep 2024 14:41:04 +0800 Subject: [PATCH 14/48] [mongocluster] Update tspconfig.yaml for python (#30729) Update tspconfig.yaml for python SDK release of https://github.com/Azure/sdk-release-request/issues/5433 --- .../DocumentDB.MongoCluster.Management/tspconfig.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml b/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml index f9a171843585..963bdd54531f 100644 --- a/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml +++ b/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml @@ -16,7 +16,6 @@ options: generate-test: true generate-sample: true examples-dir: "{project-root}/examples" - api-version: "2024-06-01-preview" "@azure-tools/typespec-java": package-dir: "azure-resourcemanager-mongocluster" flavor: "azure" From f93850874010501f216ceadf19459402efd16d9e Mon Sep 17 00:00:00 2001 From: Haoling Dong <87355844+haolingdong-msft@users.noreply.github.com> Date: Wed, 25 Sep 2024 14:45:51 +0800 Subject: [PATCH 15/48] Update readme.java.md (#30720) --- .../desktopvirtualization/resource-manager/readme.java.md | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/desktopvirtualization/resource-manager/readme.java.md b/specification/desktopvirtualization/resource-manager/readme.java.md index 8168d6e19a0a..305c55c8c403 100644 --- a/specification/desktopvirtualization/resource-manager/readme.java.md +++ b/specification/desktopvirtualization/resource-manager/readme.java.md @@ -4,4 +4,5 @@ These settings apply only when `--java` is specified on the command line. ```yaml $(java) generate-async-methods: true +uuid-as-string: true ``` From 2cec543b4bf04ccd1971ae69a136cf06878439b2 Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Wed, 25 Sep 2024 16:38:24 +0800 Subject: [PATCH 16/48] Update readme.python.md (#30730) --- specification/mysql/resource-manager/readme.python.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/mysql/resource-manager/readme.python.md b/specification/mysql/resource-manager/readme.python.md index d2fcfa9ebd8c..b92accab8f42 100644 --- a/specification/mysql/resource-manager/readme.python.md +++ b/specification/mysql/resource-manager/readme.python.md @@ -10,12 +10,12 @@ no-namespace-folders: true clear-output-folder: true ``` -### Tag: package-flexibleserver-2024-02-01-preview and python +### Tag: package-flexibleserver-2024-06-01-preview and python -These settings apply only when `--tag=package-flexibleserver-2024-02-01-preview --python` is specified on the command line. +These settings apply only when `--tag=package-flexibleserver-2024-06-01-preview --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-flexibleserver-2024-02-01-preview' && $(python) +``` yaml $(tag) == 'package-flexibleserver-2024-06-01-preview' && $(python) title: MySQLManagementClient package-version: 1.0.0b1 package-name: azure-mgmt-mysqlflexibleservers From befbed40f82c444b19d6aaf5d4ac6bdf50960d54 Mon Sep 17 00:00:00 2001 From: Vikas Choudhary Date: Wed, 25 Sep 2024 18:24:22 +0530 Subject: [PATCH 17/48] Appended "update" @visibility to BaseResourceProperties::marketplace field (#30626) * Appended "update" @visibility to marketplace field [Reason] ----------------- - For recurring billing patch operation, appended "update" @visibility to BaseResourceProperties::marketplace * Fixing "Swagger PrettierCheck" and "TypeSpec Validation" issues * Fixing swagger check issues --- .../LiftrBase/main.tsp | 2 +- .../Organizations_Update_MaximumSet_Gen.json | 90 +++++++++++-------- .../Organizations_Update_MaximumSet_Gen.json | 90 +++++++++++-------- .../Organizations_Update_MaximumSet_Gen.json | 89 ++++++++++-------- .../Organizations_Update_MaximumSet_Gen.json | 89 ++++++++++-------- .../2023-08-01-preview/astronomer.json | 58 ++++++++++++ .../Organizations_Update_MaximumSet_Gen.json | 90 +++++++++++-------- .../2024-08-27-preview/astronomer.json | 62 +++++++++++++ .../Organizations_Update_MaximumSet_Gen.json | 89 ++++++++++-------- .../stable/2023-08-01/astronomer.json | 58 ++++++++++++ .../Organizations_Update_MaximumSet_Gen.json | 90 +++++++++++-------- .../stable/2024-08-27/astronomer.json | 62 +++++++++++++ .../Organizations_Update_MaximumSet_Gen.json | 89 ++++++++++-------- 13 files changed, 649 insertions(+), 309 deletions(-) diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/LiftrBase/main.tsp b/specification/liftrastronomer/Astronomer.Astro.Management/LiftrBase/main.tsp index 01d6f4beeda1..34f517b11aba 100644 --- a/specification/liftrastronomer/Astronomer.Astro.Management/LiftrBase/main.tsp +++ b/specification/liftrastronomer/Astronomer.Astro.Management/LiftrBase/main.tsp @@ -124,7 +124,7 @@ model UserDetails { @doc("Base resource properties that can be extended for arm resources.") model BaseResourceProperties { @doc("Marketplace details of the resource.") - @visibility("create", "read") + @visibility("create", "read", "update") marketplace: MarketplaceDetails; @doc("Details of the user.") diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01-preview/Organizations_Update_MaximumSet_Gen.json b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01-preview/Organizations_Update_MaximumSet_Gen.json index c8ccca13a19c..b8c59d0efa8b 100644 --- a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01-preview/Organizations_Update_MaximumSet_Gen.json +++ b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01-preview/Organizations_Update_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "operationId": "Organizations_Update", "parameters": { "api-version": "2023-08-01-preview", - "subscriptionId": "43454B17-172A-40FE-80FA-549EA23D12B3", + "subscriptionId": "DB5A8803-2521-4C23-B308-7152F9E1A18B", "resourceGroupName": "rgastronomer", "organizationName": "6.", "properties": { @@ -15,24 +15,36 @@ "key1474": "bqqyipxnbbxryhznyaosmtpo" }, "properties": { + "marketplace": { + "subscriptionId": "fpw", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "aboicevbhvmoihqct", + "offerId": "hrwyzmjocfrli", + "planId": "xxscqzzcgp", + "planName": "ewjpobpxhvm", + "termUnit": "tgwvwydtcdldy", + "termId": "guhlhmfyqyguftsjr" + } + }, "user": { - "firstName": "qeuofehzypzljgcuysugefbgxde", - "lastName": "g", + "firstName": "ndcrxgdwepkowtgxafkhzz", + "lastName": "cnnubonwjtwoaeiewpcmyyggk", "emailAddress": ".K_@e7N-g1.xjqnbPs", - "upn": "uwtprzdfpsqmktx", - "phoneNumber": "aqpyxznvqpgkzohevynofrjdfgoo" + "upn": "mpopoqzmcjnofgxxhyzn", + "phoneNumber": "mybpqzaqslyvxm" }, "partnerOrganizationProperties": { - "organizationId": "lrtmbkvyvvoszhjevohkmyjhfyty", - "workspaceId": "xsepuskdhejaadusyxq", - "organizationName": "U2P_", + "organizationId": "lgfrhysvavtlkdzycmtvf", + "workspaceId": "tzvtdrvn", + "organizationName": "6.", "workspaceName": "L.-y_--:", "singleSignOnProperties": { "singleSignOnState": "Initial", - "enterpriseAppId": "mklfypyujwumgwdzae", - "singleSignOnUrl": "ymmtzkyghvinvhgnqlzwrr", + "enterpriseAppId": "huxbjdcojsgdpcaehcvzllddhwwcr", + "singleSignOnUrl": "iuxjnaxhuwvla", "aadDomains": [ - "kfbleh" + "jmvzsbllhkuch" ], "provisioningState": "Succeeded" } @@ -45,59 +57,59 @@ "body": { "properties": { "marketplace": { - "subscriptionId": null, + "subscriptionId": "fpw", "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { - "publisherId": "gfsqxygpnerxmvols", - "offerId": "krzkefmpxztqyusidzgpchfaswuyce", - "planId": "kndxzygsanuiqzwbfbbvoipv", - "planName": "pwqjwlq", - "termUnit": "xyygyzcazkuelz", - "termId": "pwds" + "publisherId": "aboicevbhvmoihqct", + "offerId": "hrwyzmjocfrli", + "planId": "xxscqzzcgp", + "planName": "ewjpobpxhvm", + "termUnit": "tgwvwydtcdldy", + "termId": "guhlhmfyqyguftsjr" } }, "user": { - "firstName": "qeuofehzypzljgcuysugefbgxde", - "lastName": "g", + "firstName": "ndcrxgdwepkowtgxafkhzz", + "lastName": "cnnubonwjtwoaeiewpcmyyggk", "emailAddress": ".K_@e7N-g1.xjqnbPs", - "upn": "uwtprzdfpsqmktx", - "phoneNumber": "aqpyxznvqpgkzohevynofrjdfgoo" + "upn": "mpopoqzmcjnofgxxhyzn", + "phoneNumber": "mybpqzaqslyvxm" }, "provisioningState": "Succeeded", "partnerOrganizationProperties": { - "organizationId": "lrtmbkvyvvoszhjevohkmyjhfyty", - "workspaceId": "xsepuskdhejaadusyxq", - "organizationName": "U2P_", + "organizationId": "lgfrhysvavtlkdzycmtvf", + "workspaceId": "tzvtdrvn", + "organizationName": "6.", "workspaceName": "L.-y_--:", "singleSignOnProperties": { "singleSignOnState": "Initial", - "enterpriseAppId": "mklfypyujwumgwdzae", - "singleSignOnUrl": "ymmtzkyghvinvhgnqlzwrr", + "enterpriseAppId": "huxbjdcojsgdpcaehcvzllddhwwcr", + "singleSignOnUrl": "iuxjnaxhuwvla", "aadDomains": [ - "kfbleh" + "jmvzsbllhkuch" ], "provisioningState": "Succeeded" } } }, "identity": { - "type": "None", - "userAssignedIdentities": {}, "principalId": "b5684bd7-7958-4c0e-9795-d686c31746d2", - "tenantId": "b5684bd7-7958-4c0e-9795-d686c31746d2" + "tenantId": "b5684bd7-7958-4c0e-9795-d686c31746d2", + "type": "None", + "userAssignedIdentities": {} }, "tags": {}, - "location": "mhqthlsatwvqkl", - "id": "bhslekyvgkfomahtvjiin", - "name": "ycyrfvupthkudm", - "type": "ldwwclcpqssjomo", + "location": "iebkfcpjypgwoxawpyggre", + "id": "fdyntfenvxohkoscvnvdtkxv", + "name": "hstnxzyjtp", + "type": "fpcthygiqzjswaedu", "systemData": { - "createdBy": "zw", + "createdBy": "w", "createdByType": "User", - "createdAt": "2023-07-25T11:16:12.868Z", - "lastModifiedBy": "isirkhwcppaqoqzoebybzikzbzkjzf", + "createdAt": "2024-09-18T07:31:02.305Z", + "lastModifiedBy": "thgjkgdjdwliegeadwqhevldr", "lastModifiedByType": "User", - "lastModifiedAt": "2023-07-25T11:16:12.868Z" + "lastModifiedAt": "2024-09-18T07:31:02.306Z" } } }, diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_Update_MaximumSet_Gen.json b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_Update_MaximumSet_Gen.json index 3e35f8e7a994..4b57e965ae81 100644 --- a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_Update_MaximumSet_Gen.json +++ b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_Update_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "operationId": "Organizations_Update", "parameters": { "api-version": "2023-08-01", - "subscriptionId": "43454B17-172A-40FE-80FA-549EA23D12B3", + "subscriptionId": "35FBF232-4B65-40E8-ADA3-49FE99B824D6", "resourceGroupName": "rgastronomer", "organizationName": "6.", "properties": { @@ -15,24 +15,36 @@ "key1474": "bqqyipxnbbxryhznyaosmtpo" }, "properties": { + "marketplace": { + "subscriptionId": "bpoiahcvraqjhwpqcyvmxl", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "zhnlxf", + "offerId": "rh", + "planId": "uqlecfuht", + "planName": "secxe", + "termUnit": "skbmivxsechzkyuxvd", + "termId": "qvnaspsilt" + } + }, "user": { - "firstName": "qeuofehzypzljgcuysugefbgxde", - "lastName": "g", + "firstName": "pantcaqwknzxnjs", + "lastName": "loytwkjq", "emailAddress": ".K_@e7N-g1.xjqnbPs", - "upn": "uwtprzdfpsqmktx", - "phoneNumber": "aqpyxznvqpgkzohevynofrjdfgoo" + "upn": "sbfjcucbtwvnnhyzpfycykerzqjvo", + "phoneNumber": "smwcipwxoxdmzgj" }, "partnerOrganizationProperties": { - "organizationId": "lrtmbkvyvvoszhjevohkmyjhfyty", - "workspaceId": "xsepuskdhejaadusyxq", - "organizationName": "U2P_", + "organizationId": "ugyxg", + "workspaceId": "jbpphzsonkhnaxbwlpmgrwuklcx", + "organizationName": "6.", "workspaceName": "L.-y_--:", "singleSignOnProperties": { "singleSignOnState": "Initial", - "enterpriseAppId": "mklfypyujwumgwdzae", - "singleSignOnUrl": "ymmtzkyghvinvhgnqlzwrr", + "enterpriseAppId": "hkqosvz", + "singleSignOnUrl": "mgr", "aadDomains": [ - "kfbleh" + "ynmjdshvcxpusrtv" ], "provisioningState": "Succeeded" } @@ -45,59 +57,59 @@ "body": { "properties": { "marketplace": { - "subscriptionId": null, + "subscriptionId": "bpoiahcvraqjhwpqcyvmxl", "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { - "publisherId": "gfsqxygpnerxmvols", - "offerId": "krzkefmpxztqyusidzgpchfaswuyce", - "planId": "kndxzygsanuiqzwbfbbvoipv", - "planName": "pwqjwlq", - "termUnit": "xyygyzcazkuelz", - "termId": "pwds" + "publisherId": "zhnlxf", + "offerId": "rh", + "planId": "uqlecfuht", + "planName": "secxe", + "termUnit": "skbmivxsechzkyuxvd", + "termId": "qvnaspsilt" } }, "user": { - "firstName": "qeuofehzypzljgcuysugefbgxde", - "lastName": "g", + "firstName": "pantcaqwknzxnjs", + "lastName": "loytwkjq", "emailAddress": ".K_@e7N-g1.xjqnbPs", - "upn": "uwtprzdfpsqmktx", - "phoneNumber": "aqpyxznvqpgkzohevynofrjdfgoo" + "upn": "sbfjcucbtwvnnhyzpfycykerzqjvo", + "phoneNumber": "smwcipwxoxdmzgj" }, "provisioningState": "Succeeded", "partnerOrganizationProperties": { - "organizationId": "lrtmbkvyvvoszhjevohkmyjhfyty", - "workspaceId": "xsepuskdhejaadusyxq", - "organizationName": "U2P_", + "organizationId": "ugyxg", + "workspaceId": "jbpphzsonkhnaxbwlpmgrwuklcx", + "organizationName": "6.", "workspaceName": "L.-y_--:", "singleSignOnProperties": { "singleSignOnState": "Initial", - "enterpriseAppId": "mklfypyujwumgwdzae", - "singleSignOnUrl": "ymmtzkyghvinvhgnqlzwrr", + "enterpriseAppId": "hkqosvz", + "singleSignOnUrl": "mgr", "aadDomains": [ - "kfbleh" + "ynmjdshvcxpusrtv" ], "provisioningState": "Succeeded" } } }, "identity": { - "type": "None", - "userAssignedIdentities": {}, "principalId": "b5684bd7-7958-4c0e-9795-d686c31746d2", - "tenantId": "b5684bd7-7958-4c0e-9795-d686c31746d2" + "tenantId": "b5684bd7-7958-4c0e-9795-d686c31746d2", + "type": "None", + "userAssignedIdentities": {} }, "tags": {}, - "location": "mhqthlsatwvqkl", - "id": "bhslekyvgkfomahtvjiin", - "name": "ycyrfvupthkudm", - "type": "ldwwclcpqssjomo", + "location": "eyzfomwguzlzdrifqurd", + "id": "bmbatenoclkyauippgw", + "name": "vagudclsnq", + "type": "tjkxdhcixbtpudzrkvlsr", "systemData": { - "createdBy": "zw", + "createdBy": "aubmkgdmuh", "createdByType": "User", - "createdAt": "2023-07-25T11:16:12.868Z", - "lastModifiedBy": "isirkhwcppaqoqzoebybzikzbzkjzf", + "createdAt": "2024-09-18T09:27:35.952Z", + "lastModifiedBy": "wqcubsxcrhxakigychifzumhtqjtr", "lastModifiedByType": "User", - "lastModifiedAt": "2023-07-25T11:16:12.868Z" + "lastModifiedAt": "2024-09-18T09:27:35.953Z" } } }, diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2024-08-27-preview/Organizations_Update_MaximumSet_Gen.json b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2024-08-27-preview/Organizations_Update_MaximumSet_Gen.json index c9a1adb0d56f..c12d00589d32 100644 --- a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2024-08-27-preview/Organizations_Update_MaximumSet_Gen.json +++ b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2024-08-27-preview/Organizations_Update_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "operationId": "Organizations_Update", "parameters": { "api-version": "2024-08-27-preview", - "subscriptionId": "F7135278-5976-4A8C-826F-B0253284766A", + "subscriptionId": "F87A8461-5F6A-4CE6-8DB2-8BA69C81F2ED", "resourceGroupName": "rgastronomer", "organizationName": "U.1-:7", "properties": { @@ -13,24 +13,37 @@ }, "tags": {}, "properties": { + "marketplace": { + "subscriptionId": "mxkcsrymflps", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "lottiiwyu", + "offerId": "fesrfmuukwxhopsgsjzmm", + "planId": "edxt", + "planName": "gyzvtm", + "termUnit": "oybzzbnxp", + "termId": "rloaguotiowgrievdwytyjrqou", + "renewalMode": "Auto" + } + }, "user": { - "firstName": "xcmtuuaibinwxpalnwdt", - "lastName": "iarmpsjunul", + "firstName": "ddjhcuzarhnieckbbbxacglrl", + "lastName": "xrewtcupqcyrtnenrx", "emailAddress": ".K_@e7N-g1.xjqnbPs", - "upn": "yrjsazdcfiyftpagvlfugjcku", - "phoneNumber": "decxxjtkpyjhuahrkbmxlpib" + "upn": "uwgltcopuyvpskdtm", + "phoneNumber": "oxtdknmwp" }, "partnerOrganizationProperties": { - "organizationId": "rcvoemps", - "workspaceId": "xnmfrhmzzcuutcs", + "organizationId": "uxlyazcd", + "workspaceId": "eofnym", "organizationName": "U.1-:7", "workspaceName": "9.:06", "singleSignOnProperties": { "singleSignOnState": "Initial", - "enterpriseAppId": "uv", - "singleSignOnUrl": "zyrtiwivlbtptrszloo", + "enterpriseAppId": "dslcwodcitlxknfqgqyjftucfijyt", + "singleSignOnUrl": "vpneskurdmj", "aadDomains": [ - "rvyrbq" + "fzqllipgsmtwwtbobdhzdcgrkwa" ], "provisioningState": "Succeeded" } @@ -43,61 +56,61 @@ "body": { "properties": { "marketplace": { - "subscriptionId": "bgvtjtkpxtceyc", + "subscriptionId": "mxkcsrymflps", "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { - "publisherId": "ckrwwvgcfnuzejhmnywtxgtemd", - "offerId": "o", - "planId": "iirdyveiuvufxgnzbggfbnr", - "planName": "lmzofmdkochgzgqzxsuvipuagqizz", - "termUnit": "pzatfjfycsonpuagfzqsz", - "termId": "nrmbsljsrbwsafuwvpa", + "publisherId": "lottiiwyu", + "offerId": "fesrfmuukwxhopsgsjzmm", + "planId": "edxt", + "planName": "gyzvtm", + "termUnit": "oybzzbnxp", + "termId": "rloaguotiowgrievdwytyjrqou", "renewalMode": "Auto", - "endDate": "2024-09-09T11:32:38.546Z" + "endDate": "2024-09-18T07:46:35.613Z" } }, "user": { - "firstName": "xcmtuuaibinwxpalnwdt", - "lastName": "iarmpsjunul", + "firstName": "ddjhcuzarhnieckbbbxacglrl", + "lastName": "xrewtcupqcyrtnenrx", "emailAddress": ".K_@e7N-g1.xjqnbPs", - "upn": "yrjsazdcfiyftpagvlfugjcku", - "phoneNumber": "decxxjtkpyjhuahrkbmxlpib" + "upn": "uwgltcopuyvpskdtm", + "phoneNumber": "oxtdknmwp" }, "provisioningState": "Succeeded", "partnerOrganizationProperties": { - "organizationId": "rcvoemps", - "workspaceId": "xnmfrhmzzcuutcs", + "organizationId": "uxlyazcd", + "workspaceId": "eofnym", "organizationName": "U.1-:7", "workspaceName": "9.:06", "singleSignOnProperties": { "singleSignOnState": "Initial", - "enterpriseAppId": "uv", - "singleSignOnUrl": "zyrtiwivlbtptrszloo", + "enterpriseAppId": "dslcwodcitlxknfqgqyjftucfijyt", + "singleSignOnUrl": "vpneskurdmj", "aadDomains": [ - "rvyrbq" + "fzqllipgsmtwwtbobdhzdcgrkwa" ], "provisioningState": "Succeeded" } } }, "identity": { - "type": "None", - "userAssignedIdentities": {}, "principalId": "b5684bd7-7958-4c0e-9795-d686c31746d2", - "tenantId": "b5684bd7-7958-4c0e-9795-d686c31746d2" + "tenantId": "b5684bd7-7958-4c0e-9795-d686c31746d2", + "type": "None", + "userAssignedIdentities": {} }, "tags": {}, - "location": "vyrzuaajyirwimtahombrbsaejcqs", - "id": "mialkreryfu", - "name": "lmdyn", - "type": "tzpcxamgfdfxervw", + "location": "hzltyfpyjjcoriwa", + "id": "mwvpxxptqzrydqpbtuzedfuy", + "name": "eidomhauxyovtkno", + "type": "qhpkcbyovjlfco", "systemData": { - "createdBy": "yeyzuhlzka", + "createdBy": "eodlruyfalpdhlwbnlysmblujs", "createdByType": "User", - "createdAt": "2024-08-27T06:00:59.057Z", - "lastModifiedBy": "k", + "createdAt": "2024-09-18T07:46:35.614Z", + "lastModifiedBy": "xpuwfqolnygdvfrysxzsfu", "lastModifiedByType": "User", - "lastModifiedAt": "2024-08-27T06:00:59.057Z" + "lastModifiedAt": "2024-09-18T07:46:35.614Z" } } }, diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2024-08-27/Organizations_Update_MaximumSet_Gen.json b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2024-08-27/Organizations_Update_MaximumSet_Gen.json index 2444ba26245b..9b2a104e3592 100644 --- a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2024-08-27/Organizations_Update_MaximumSet_Gen.json +++ b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2024-08-27/Organizations_Update_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "operationId": "Organizations_Update", "parameters": { "api-version": "2024-08-27", - "subscriptionId": "A4679760-5C37-44EA-A4B8-8A7628B13824", + "subscriptionId": "ECBF1ABA-FCBB-46A5-BFC3-3334D65EC8F7", "resourceGroupName": "rgastronomer", "organizationName": "U.1-:7", "properties": { @@ -13,24 +13,37 @@ }, "tags": {}, "properties": { + "marketplace": { + "subscriptionId": "ujl", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "bywzycdrucjkx", + "offerId": "aljpaprqzpnivwol", + "planId": "fcpnstrwetlrajanh", + "planName": "wjgnlhqqkdi", + "termUnit": "pvpk", + "termId": "xg", + "renewalMode": "Auto" + } + }, "user": { - "firstName": "e", - "lastName": "puain", + "firstName": "wyoaxocyjfpgicvketuiayfxrxq", + "lastName": "vlwybhfayupjpwfhy", "emailAddress": ".K_@e7N-g1.xjqnbPs", - "upn": "beyxdwtwshcujyjtowjdvgytygpp", - "phoneNumber": "hepjqujjthtlxeoiltnchwqi" + "upn": "ezefcwbsbgcxrdiixmzphibt", + "phoneNumber": "eibhsslqzufgshuzrjjyymsb" }, "partnerOrganizationProperties": { - "organizationId": "fbjg", - "workspaceId": "ywwywdafdtvnntfevhnwszi", + "organizationId": "linzwcqhrpqrxpnghxjnxzetfdps", + "workspaceId": "tmmxzlagmdrc", "organizationName": "U.1-:7", "workspaceName": "9.:06", "singleSignOnProperties": { "singleSignOnState": "Initial", - "enterpriseAppId": "srkwxktx", - "singleSignOnUrl": "l", + "enterpriseAppId": "jspfkoxolosmvyixpktbwyoqrx", + "singleSignOnUrl": "aatouxlmqqizijszlu", "aadDomains": [ - "fcnqoizqxcdclmy" + "gwzhrfmnhbeitagjdlzw" ], "provisioningState": "Succeeded" } @@ -43,61 +56,61 @@ "body": { "properties": { "marketplace": { - "subscriptionId": "emasc", + "subscriptionId": "ujl", "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { - "publisherId": "kt", - "offerId": "tvidibzbxevtvnrdp", - "planId": "lwcvzdqecwkeracahmixnh", - "planName": "d", - "termUnit": "rs", - "termId": "kopnnjsp", + "publisherId": "bywzycdrucjkx", + "offerId": "aljpaprqzpnivwol", + "planId": "fcpnstrwetlrajanh", + "planName": "wjgnlhqqkdi", + "termUnit": "pvpk", + "termId": "xg", "renewalMode": "Auto", - "endDate": "2024-09-09T11:33:07.745Z" + "endDate": "2024-09-18T09:36:40.774Z" } }, "user": { - "firstName": "e", - "lastName": "puain", + "firstName": "wyoaxocyjfpgicvketuiayfxrxq", + "lastName": "vlwybhfayupjpwfhy", "emailAddress": ".K_@e7N-g1.xjqnbPs", - "upn": "beyxdwtwshcujyjtowjdvgytygpp", - "phoneNumber": "hepjqujjthtlxeoiltnchwqi" + "upn": "ezefcwbsbgcxrdiixmzphibt", + "phoneNumber": "eibhsslqzufgshuzrjjyymsb" }, "provisioningState": "Succeeded", "partnerOrganizationProperties": { - "organizationId": "fbjg", - "workspaceId": "ywwywdafdtvnntfevhnwszi", + "organizationId": "linzwcqhrpqrxpnghxjnxzetfdps", + "workspaceId": "tmmxzlagmdrc", "organizationName": "U.1-:7", "workspaceName": "9.:06", "singleSignOnProperties": { "singleSignOnState": "Initial", - "enterpriseAppId": "srkwxktx", - "singleSignOnUrl": "l", + "enterpriseAppId": "jspfkoxolosmvyixpktbwyoqrx", + "singleSignOnUrl": "aatouxlmqqizijszlu", "aadDomains": [ - "fcnqoizqxcdclmy" + "gwzhrfmnhbeitagjdlzw" ], "provisioningState": "Succeeded" } } }, "identity": { - "type": "None", - "userAssignedIdentities": {}, "principalId": "b5684bd7-7958-4c0e-9795-d686c31746d2", - "tenantId": "b5684bd7-7958-4c0e-9795-d686c31746d2" + "tenantId": "b5684bd7-7958-4c0e-9795-d686c31746d2", + "type": "None", + "userAssignedIdentities": {} }, "tags": {}, - "location": "pgfkugslgnsxeqpjs", - "id": "ec", - "name": "dfucbeviqfavjryqbflzqttvupne", - "type": "dgccugdynztwzwshuuubefte", + "location": "lpfjmjgqgqiecnek", + "id": "dxlysdjielachwxeyxqwnjxehwda", + "name": "fystkqkhbfxuotqxhft", + "type": "bipflhqhapjtuiknj", "systemData": { - "createdBy": "daq", + "createdBy": "ldetdeujxj", "createdByType": "User", - "createdAt": "2024-08-27T06:02:43.048Z", - "lastModifiedBy": "bewqhprigkbiwlmkmxctd", + "createdAt": "2024-09-18T09:36:40.776Z", + "lastModifiedBy": "hfwzlknbcscvxdr", "lastModifiedByType": "User", - "lastModifiedAt": "2024-08-27T06:02:43.048Z" + "lastModifiedAt": "2024-09-18T09:36:40.776Z" } } }, diff --git a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/astronomer.json b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/astronomer.json index 4b41720a43b1..24da6bf4e568 100644 --- a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/astronomer.json +++ b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/astronomer.json @@ -462,6 +462,7 @@ "description": "Marketplace details of the resource.", "x-ms-mutability": [ "read", + "update", "create" ] }, @@ -572,6 +573,24 @@ "offerDetails" ] }, + "LiftrBase.MarketplaceDetailsUpdate": { + "type": "object", + "description": "Marketplace details for an organization", + "properties": { + "subscriptionId": { + "type": "string", + "description": "Azure subscription id for the the marketplace offer is purchased from" + }, + "subscriptionStatus": { + "$ref": "#/definitions/LiftrBase.MarketplaceSubscriptionStatus", + "description": "Marketplace subscription status" + }, + "offerDetails": { + "$ref": "#/definitions/LiftrBase.OfferDetailsUpdate", + "description": "Offer details for the marketplace that is selected by the user" + } + } + }, "LiftrBase.MarketplaceSubscriptionStatus": { "type": "string", "description": "Marketplace subscription status of a resource.", @@ -643,6 +662,36 @@ "planId" ] }, + "LiftrBase.OfferDetailsUpdate": { + "type": "object", + "description": "Offer details for the marketplace that is selected by the user", + "properties": { + "publisherId": { + "type": "string", + "description": "Publisher Id for the marketplace offer" + }, + "offerId": { + "type": "string", + "description": "Offer Id for the marketplace offer" + }, + "planId": { + "type": "string", + "description": "Plan Id for the marketplace offer" + }, + "planName": { + "type": "string", + "description": "Plan Name for the marketplace offer" + }, + "termUnit": { + "type": "string", + "description": "Plan Display Name for the marketplace offer" + }, + "termId": { + "type": "string", + "description": "Plan Display Name for the marketplace offer" + } + } + }, "LiftrBase.SingleSignOnProperties": { "type": "object", "description": "Properties specific to Single Sign On Resource", @@ -836,6 +885,15 @@ "type": "object", "description": "The updatable properties of the OrganizationResource.", "properties": { + "marketplace": { + "$ref": "#/definitions/LiftrBase.MarketplaceDetailsUpdate", + "description": "Marketplace details of the resource.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, "user": { "$ref": "#/definitions/LiftrBase.UserDetailsUpdate", "description": "Details of the user." diff --git a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/examples/Organizations_Update_MaximumSet_Gen.json b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/examples/Organizations_Update_MaximumSet_Gen.json index c8ccca13a19c..b8c59d0efa8b 100644 --- a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/examples/Organizations_Update_MaximumSet_Gen.json +++ b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/examples/Organizations_Update_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "operationId": "Organizations_Update", "parameters": { "api-version": "2023-08-01-preview", - "subscriptionId": "43454B17-172A-40FE-80FA-549EA23D12B3", + "subscriptionId": "DB5A8803-2521-4C23-B308-7152F9E1A18B", "resourceGroupName": "rgastronomer", "organizationName": "6.", "properties": { @@ -15,24 +15,36 @@ "key1474": "bqqyipxnbbxryhznyaosmtpo" }, "properties": { + "marketplace": { + "subscriptionId": "fpw", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "aboicevbhvmoihqct", + "offerId": "hrwyzmjocfrli", + "planId": "xxscqzzcgp", + "planName": "ewjpobpxhvm", + "termUnit": "tgwvwydtcdldy", + "termId": "guhlhmfyqyguftsjr" + } + }, "user": { - "firstName": "qeuofehzypzljgcuysugefbgxde", - "lastName": "g", + "firstName": "ndcrxgdwepkowtgxafkhzz", + "lastName": "cnnubonwjtwoaeiewpcmyyggk", "emailAddress": ".K_@e7N-g1.xjqnbPs", - "upn": "uwtprzdfpsqmktx", - "phoneNumber": "aqpyxznvqpgkzohevynofrjdfgoo" + "upn": "mpopoqzmcjnofgxxhyzn", + "phoneNumber": "mybpqzaqslyvxm" }, "partnerOrganizationProperties": { - "organizationId": "lrtmbkvyvvoszhjevohkmyjhfyty", - "workspaceId": "xsepuskdhejaadusyxq", - "organizationName": "U2P_", + "organizationId": "lgfrhysvavtlkdzycmtvf", + "workspaceId": "tzvtdrvn", + "organizationName": "6.", "workspaceName": "L.-y_--:", "singleSignOnProperties": { "singleSignOnState": "Initial", - "enterpriseAppId": "mklfypyujwumgwdzae", - "singleSignOnUrl": "ymmtzkyghvinvhgnqlzwrr", + "enterpriseAppId": "huxbjdcojsgdpcaehcvzllddhwwcr", + "singleSignOnUrl": "iuxjnaxhuwvla", "aadDomains": [ - "kfbleh" + "jmvzsbllhkuch" ], "provisioningState": "Succeeded" } @@ -45,59 +57,59 @@ "body": { "properties": { "marketplace": { - "subscriptionId": null, + "subscriptionId": "fpw", "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { - "publisherId": "gfsqxygpnerxmvols", - "offerId": "krzkefmpxztqyusidzgpchfaswuyce", - "planId": "kndxzygsanuiqzwbfbbvoipv", - "planName": "pwqjwlq", - "termUnit": "xyygyzcazkuelz", - "termId": "pwds" + "publisherId": "aboicevbhvmoihqct", + "offerId": "hrwyzmjocfrli", + "planId": "xxscqzzcgp", + "planName": "ewjpobpxhvm", + "termUnit": "tgwvwydtcdldy", + "termId": "guhlhmfyqyguftsjr" } }, "user": { - "firstName": "qeuofehzypzljgcuysugefbgxde", - "lastName": "g", + "firstName": "ndcrxgdwepkowtgxafkhzz", + "lastName": "cnnubonwjtwoaeiewpcmyyggk", "emailAddress": ".K_@e7N-g1.xjqnbPs", - "upn": "uwtprzdfpsqmktx", - "phoneNumber": "aqpyxznvqpgkzohevynofrjdfgoo" + "upn": "mpopoqzmcjnofgxxhyzn", + "phoneNumber": "mybpqzaqslyvxm" }, "provisioningState": "Succeeded", "partnerOrganizationProperties": { - "organizationId": "lrtmbkvyvvoszhjevohkmyjhfyty", - "workspaceId": "xsepuskdhejaadusyxq", - "organizationName": "U2P_", + "organizationId": "lgfrhysvavtlkdzycmtvf", + "workspaceId": "tzvtdrvn", + "organizationName": "6.", "workspaceName": "L.-y_--:", "singleSignOnProperties": { "singleSignOnState": "Initial", - "enterpriseAppId": "mklfypyujwumgwdzae", - "singleSignOnUrl": "ymmtzkyghvinvhgnqlzwrr", + "enterpriseAppId": "huxbjdcojsgdpcaehcvzllddhwwcr", + "singleSignOnUrl": "iuxjnaxhuwvla", "aadDomains": [ - "kfbleh" + "jmvzsbllhkuch" ], "provisioningState": "Succeeded" } } }, "identity": { - "type": "None", - "userAssignedIdentities": {}, "principalId": "b5684bd7-7958-4c0e-9795-d686c31746d2", - "tenantId": "b5684bd7-7958-4c0e-9795-d686c31746d2" + "tenantId": "b5684bd7-7958-4c0e-9795-d686c31746d2", + "type": "None", + "userAssignedIdentities": {} }, "tags": {}, - "location": "mhqthlsatwvqkl", - "id": "bhslekyvgkfomahtvjiin", - "name": "ycyrfvupthkudm", - "type": "ldwwclcpqssjomo", + "location": "iebkfcpjypgwoxawpyggre", + "id": "fdyntfenvxohkoscvnvdtkxv", + "name": "hstnxzyjtp", + "type": "fpcthygiqzjswaedu", "systemData": { - "createdBy": "zw", + "createdBy": "w", "createdByType": "User", - "createdAt": "2023-07-25T11:16:12.868Z", - "lastModifiedBy": "isirkhwcppaqoqzoebybzikzbzkjzf", + "createdAt": "2024-09-18T07:31:02.305Z", + "lastModifiedBy": "thgjkgdjdwliegeadwqhevldr", "lastModifiedByType": "User", - "lastModifiedAt": "2023-07-25T11:16:12.868Z" + "lastModifiedAt": "2024-09-18T07:31:02.306Z" } } }, diff --git a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2024-08-27-preview/astronomer.json b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2024-08-27-preview/astronomer.json index 1b9d548edc9b..ce18ba933dcf 100644 --- a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2024-08-27-preview/astronomer.json +++ b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2024-08-27-preview/astronomer.json @@ -471,6 +471,7 @@ "description": "Marketplace details of the resource.", "x-ms-mutability": [ "read", + "update", "create" ] }, @@ -581,6 +582,24 @@ "offerDetails" ] }, + "LiftrBase.MarketplaceDetailsUpdate": { + "type": "object", + "description": "Marketplace details for an organization", + "properties": { + "subscriptionId": { + "type": "string", + "description": "Azure subscription id for the the marketplace offer is purchased from" + }, + "subscriptionStatus": { + "$ref": "#/definitions/LiftrBase.MarketplaceSubscriptionStatus", + "description": "Marketplace subscription status" + }, + "offerDetails": { + "$ref": "#/definitions/LiftrBase.OfferDetailsUpdate", + "description": "Offer details for the marketplace that is selected by the user" + } + } + }, "LiftrBase.MarketplaceSubscriptionStatus": { "type": "string", "description": "Marketplace subscription status of a resource.", @@ -662,6 +681,40 @@ "planId" ] }, + "LiftrBase.OfferDetailsUpdate": { + "type": "object", + "description": "Offer details for the marketplace that is selected by the user", + "properties": { + "publisherId": { + "type": "string", + "description": "Publisher Id for the marketplace offer" + }, + "offerId": { + "type": "string", + "description": "Offer Id for the marketplace offer" + }, + "planId": { + "type": "string", + "description": "Plan Id for the marketplace offer" + }, + "planName": { + "type": "string", + "description": "Plan Name for the marketplace offer" + }, + "termUnit": { + "type": "string", + "description": "Plan Display Name for the marketplace offer" + }, + "termId": { + "type": "string", + "description": "Plan Display Name for the marketplace offer" + }, + "renewalMode": { + "$ref": "#/definitions/LiftrBase.RenewalMode", + "description": "Subscription renewal mode" + } + } + }, "LiftrBase.RenewalMode": { "type": "string", "description": "Subscription renewal mode", @@ -879,6 +932,15 @@ "type": "object", "description": "The updatable properties of the OrganizationResource.", "properties": { + "marketplace": { + "$ref": "#/definitions/LiftrBase.MarketplaceDetailsUpdate", + "description": "Marketplace details of the resource.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, "user": { "$ref": "#/definitions/LiftrBase.UserDetailsUpdate", "description": "Details of the user." diff --git a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2024-08-27-preview/examples/Organizations_Update_MaximumSet_Gen.json b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2024-08-27-preview/examples/Organizations_Update_MaximumSet_Gen.json index c9a1adb0d56f..c12d00589d32 100644 --- a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2024-08-27-preview/examples/Organizations_Update_MaximumSet_Gen.json +++ b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2024-08-27-preview/examples/Organizations_Update_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "operationId": "Organizations_Update", "parameters": { "api-version": "2024-08-27-preview", - "subscriptionId": "F7135278-5976-4A8C-826F-B0253284766A", + "subscriptionId": "F87A8461-5F6A-4CE6-8DB2-8BA69C81F2ED", "resourceGroupName": "rgastronomer", "organizationName": "U.1-:7", "properties": { @@ -13,24 +13,37 @@ }, "tags": {}, "properties": { + "marketplace": { + "subscriptionId": "mxkcsrymflps", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "lottiiwyu", + "offerId": "fesrfmuukwxhopsgsjzmm", + "planId": "edxt", + "planName": "gyzvtm", + "termUnit": "oybzzbnxp", + "termId": "rloaguotiowgrievdwytyjrqou", + "renewalMode": "Auto" + } + }, "user": { - "firstName": "xcmtuuaibinwxpalnwdt", - "lastName": "iarmpsjunul", + "firstName": "ddjhcuzarhnieckbbbxacglrl", + "lastName": "xrewtcupqcyrtnenrx", "emailAddress": ".K_@e7N-g1.xjqnbPs", - "upn": "yrjsazdcfiyftpagvlfugjcku", - "phoneNumber": "decxxjtkpyjhuahrkbmxlpib" + "upn": "uwgltcopuyvpskdtm", + "phoneNumber": "oxtdknmwp" }, "partnerOrganizationProperties": { - "organizationId": "rcvoemps", - "workspaceId": "xnmfrhmzzcuutcs", + "organizationId": "uxlyazcd", + "workspaceId": "eofnym", "organizationName": "U.1-:7", "workspaceName": "9.:06", "singleSignOnProperties": { "singleSignOnState": "Initial", - "enterpriseAppId": "uv", - "singleSignOnUrl": "zyrtiwivlbtptrszloo", + "enterpriseAppId": "dslcwodcitlxknfqgqyjftucfijyt", + "singleSignOnUrl": "vpneskurdmj", "aadDomains": [ - "rvyrbq" + "fzqllipgsmtwwtbobdhzdcgrkwa" ], "provisioningState": "Succeeded" } @@ -43,61 +56,61 @@ "body": { "properties": { "marketplace": { - "subscriptionId": "bgvtjtkpxtceyc", + "subscriptionId": "mxkcsrymflps", "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { - "publisherId": "ckrwwvgcfnuzejhmnywtxgtemd", - "offerId": "o", - "planId": "iirdyveiuvufxgnzbggfbnr", - "planName": "lmzofmdkochgzgqzxsuvipuagqizz", - "termUnit": "pzatfjfycsonpuagfzqsz", - "termId": "nrmbsljsrbwsafuwvpa", + "publisherId": "lottiiwyu", + "offerId": "fesrfmuukwxhopsgsjzmm", + "planId": "edxt", + "planName": "gyzvtm", + "termUnit": "oybzzbnxp", + "termId": "rloaguotiowgrievdwytyjrqou", "renewalMode": "Auto", - "endDate": "2024-09-09T11:32:38.546Z" + "endDate": "2024-09-18T07:46:35.613Z" } }, "user": { - "firstName": "xcmtuuaibinwxpalnwdt", - "lastName": "iarmpsjunul", + "firstName": "ddjhcuzarhnieckbbbxacglrl", + "lastName": "xrewtcupqcyrtnenrx", "emailAddress": ".K_@e7N-g1.xjqnbPs", - "upn": "yrjsazdcfiyftpagvlfugjcku", - "phoneNumber": "decxxjtkpyjhuahrkbmxlpib" + "upn": "uwgltcopuyvpskdtm", + "phoneNumber": "oxtdknmwp" }, "provisioningState": "Succeeded", "partnerOrganizationProperties": { - "organizationId": "rcvoemps", - "workspaceId": "xnmfrhmzzcuutcs", + "organizationId": "uxlyazcd", + "workspaceId": "eofnym", "organizationName": "U.1-:7", "workspaceName": "9.:06", "singleSignOnProperties": { "singleSignOnState": "Initial", - "enterpriseAppId": "uv", - "singleSignOnUrl": "zyrtiwivlbtptrszloo", + "enterpriseAppId": "dslcwodcitlxknfqgqyjftucfijyt", + "singleSignOnUrl": "vpneskurdmj", "aadDomains": [ - "rvyrbq" + "fzqllipgsmtwwtbobdhzdcgrkwa" ], "provisioningState": "Succeeded" } } }, "identity": { - "type": "None", - "userAssignedIdentities": {}, "principalId": "b5684bd7-7958-4c0e-9795-d686c31746d2", - "tenantId": "b5684bd7-7958-4c0e-9795-d686c31746d2" + "tenantId": "b5684bd7-7958-4c0e-9795-d686c31746d2", + "type": "None", + "userAssignedIdentities": {} }, "tags": {}, - "location": "vyrzuaajyirwimtahombrbsaejcqs", - "id": "mialkreryfu", - "name": "lmdyn", - "type": "tzpcxamgfdfxervw", + "location": "hzltyfpyjjcoriwa", + "id": "mwvpxxptqzrydqpbtuzedfuy", + "name": "eidomhauxyovtkno", + "type": "qhpkcbyovjlfco", "systemData": { - "createdBy": "yeyzuhlzka", + "createdBy": "eodlruyfalpdhlwbnlysmblujs", "createdByType": "User", - "createdAt": "2024-08-27T06:00:59.057Z", - "lastModifiedBy": "k", + "createdAt": "2024-09-18T07:46:35.614Z", + "lastModifiedBy": "xpuwfqolnygdvfrysxzsfu", "lastModifiedByType": "User", - "lastModifiedAt": "2024-08-27T06:00:59.057Z" + "lastModifiedAt": "2024-09-18T07:46:35.614Z" } } }, diff --git a/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/astronomer.json b/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/astronomer.json index dcfc9c84ea45..524907aa97d7 100644 --- a/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/astronomer.json +++ b/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/astronomer.json @@ -462,6 +462,7 @@ "description": "Marketplace details of the resource.", "x-ms-mutability": [ "read", + "update", "create" ] }, @@ -572,6 +573,24 @@ "offerDetails" ] }, + "LiftrBase.MarketplaceDetailsUpdate": { + "type": "object", + "description": "Marketplace details for an organization", + "properties": { + "subscriptionId": { + "type": "string", + "description": "Azure subscription id for the the marketplace offer is purchased from" + }, + "subscriptionStatus": { + "$ref": "#/definitions/LiftrBase.MarketplaceSubscriptionStatus", + "description": "Marketplace subscription status" + }, + "offerDetails": { + "$ref": "#/definitions/LiftrBase.OfferDetailsUpdate", + "description": "Offer details for the marketplace that is selected by the user" + } + } + }, "LiftrBase.MarketplaceSubscriptionStatus": { "type": "string", "description": "Marketplace subscription status of a resource.", @@ -643,6 +662,36 @@ "planId" ] }, + "LiftrBase.OfferDetailsUpdate": { + "type": "object", + "description": "Offer details for the marketplace that is selected by the user", + "properties": { + "publisherId": { + "type": "string", + "description": "Publisher Id for the marketplace offer" + }, + "offerId": { + "type": "string", + "description": "Offer Id for the marketplace offer" + }, + "planId": { + "type": "string", + "description": "Plan Id for the marketplace offer" + }, + "planName": { + "type": "string", + "description": "Plan Name for the marketplace offer" + }, + "termUnit": { + "type": "string", + "description": "Plan Display Name for the marketplace offer" + }, + "termId": { + "type": "string", + "description": "Plan Display Name for the marketplace offer" + } + } + }, "LiftrBase.SingleSignOnProperties": { "type": "object", "description": "Properties specific to Single Sign On Resource", @@ -836,6 +885,15 @@ "type": "object", "description": "The updatable properties of the OrganizationResource.", "properties": { + "marketplace": { + "$ref": "#/definitions/LiftrBase.MarketplaceDetailsUpdate", + "description": "Marketplace details of the resource.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, "user": { "$ref": "#/definitions/LiftrBase.UserDetailsUpdate", "description": "Details of the user." diff --git a/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/examples/Organizations_Update_MaximumSet_Gen.json b/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/examples/Organizations_Update_MaximumSet_Gen.json index 3e35f8e7a994..4b57e965ae81 100644 --- a/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/examples/Organizations_Update_MaximumSet_Gen.json +++ b/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/examples/Organizations_Update_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "operationId": "Organizations_Update", "parameters": { "api-version": "2023-08-01", - "subscriptionId": "43454B17-172A-40FE-80FA-549EA23D12B3", + "subscriptionId": "35FBF232-4B65-40E8-ADA3-49FE99B824D6", "resourceGroupName": "rgastronomer", "organizationName": "6.", "properties": { @@ -15,24 +15,36 @@ "key1474": "bqqyipxnbbxryhznyaosmtpo" }, "properties": { + "marketplace": { + "subscriptionId": "bpoiahcvraqjhwpqcyvmxl", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "zhnlxf", + "offerId": "rh", + "planId": "uqlecfuht", + "planName": "secxe", + "termUnit": "skbmivxsechzkyuxvd", + "termId": "qvnaspsilt" + } + }, "user": { - "firstName": "qeuofehzypzljgcuysugefbgxde", - "lastName": "g", + "firstName": "pantcaqwknzxnjs", + "lastName": "loytwkjq", "emailAddress": ".K_@e7N-g1.xjqnbPs", - "upn": "uwtprzdfpsqmktx", - "phoneNumber": "aqpyxznvqpgkzohevynofrjdfgoo" + "upn": "sbfjcucbtwvnnhyzpfycykerzqjvo", + "phoneNumber": "smwcipwxoxdmzgj" }, "partnerOrganizationProperties": { - "organizationId": "lrtmbkvyvvoszhjevohkmyjhfyty", - "workspaceId": "xsepuskdhejaadusyxq", - "organizationName": "U2P_", + "organizationId": "ugyxg", + "workspaceId": "jbpphzsonkhnaxbwlpmgrwuklcx", + "organizationName": "6.", "workspaceName": "L.-y_--:", "singleSignOnProperties": { "singleSignOnState": "Initial", - "enterpriseAppId": "mklfypyujwumgwdzae", - "singleSignOnUrl": "ymmtzkyghvinvhgnqlzwrr", + "enterpriseAppId": "hkqosvz", + "singleSignOnUrl": "mgr", "aadDomains": [ - "kfbleh" + "ynmjdshvcxpusrtv" ], "provisioningState": "Succeeded" } @@ -45,59 +57,59 @@ "body": { "properties": { "marketplace": { - "subscriptionId": null, + "subscriptionId": "bpoiahcvraqjhwpqcyvmxl", "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { - "publisherId": "gfsqxygpnerxmvols", - "offerId": "krzkefmpxztqyusidzgpchfaswuyce", - "planId": "kndxzygsanuiqzwbfbbvoipv", - "planName": "pwqjwlq", - "termUnit": "xyygyzcazkuelz", - "termId": "pwds" + "publisherId": "zhnlxf", + "offerId": "rh", + "planId": "uqlecfuht", + "planName": "secxe", + "termUnit": "skbmivxsechzkyuxvd", + "termId": "qvnaspsilt" } }, "user": { - "firstName": "qeuofehzypzljgcuysugefbgxde", - "lastName": "g", + "firstName": "pantcaqwknzxnjs", + "lastName": "loytwkjq", "emailAddress": ".K_@e7N-g1.xjqnbPs", - "upn": "uwtprzdfpsqmktx", - "phoneNumber": "aqpyxznvqpgkzohevynofrjdfgoo" + "upn": "sbfjcucbtwvnnhyzpfycykerzqjvo", + "phoneNumber": "smwcipwxoxdmzgj" }, "provisioningState": "Succeeded", "partnerOrganizationProperties": { - "organizationId": "lrtmbkvyvvoszhjevohkmyjhfyty", - "workspaceId": "xsepuskdhejaadusyxq", - "organizationName": "U2P_", + "organizationId": "ugyxg", + "workspaceId": "jbpphzsonkhnaxbwlpmgrwuklcx", + "organizationName": "6.", "workspaceName": "L.-y_--:", "singleSignOnProperties": { "singleSignOnState": "Initial", - "enterpriseAppId": "mklfypyujwumgwdzae", - "singleSignOnUrl": "ymmtzkyghvinvhgnqlzwrr", + "enterpriseAppId": "hkqosvz", + "singleSignOnUrl": "mgr", "aadDomains": [ - "kfbleh" + "ynmjdshvcxpusrtv" ], "provisioningState": "Succeeded" } } }, "identity": { - "type": "None", - "userAssignedIdentities": {}, "principalId": "b5684bd7-7958-4c0e-9795-d686c31746d2", - "tenantId": "b5684bd7-7958-4c0e-9795-d686c31746d2" + "tenantId": "b5684bd7-7958-4c0e-9795-d686c31746d2", + "type": "None", + "userAssignedIdentities": {} }, "tags": {}, - "location": "mhqthlsatwvqkl", - "id": "bhslekyvgkfomahtvjiin", - "name": "ycyrfvupthkudm", - "type": "ldwwclcpqssjomo", + "location": "eyzfomwguzlzdrifqurd", + "id": "bmbatenoclkyauippgw", + "name": "vagudclsnq", + "type": "tjkxdhcixbtpudzrkvlsr", "systemData": { - "createdBy": "zw", + "createdBy": "aubmkgdmuh", "createdByType": "User", - "createdAt": "2023-07-25T11:16:12.868Z", - "lastModifiedBy": "isirkhwcppaqoqzoebybzikzbzkjzf", + "createdAt": "2024-09-18T09:27:35.952Z", + "lastModifiedBy": "wqcubsxcrhxakigychifzumhtqjtr", "lastModifiedByType": "User", - "lastModifiedAt": "2023-07-25T11:16:12.868Z" + "lastModifiedAt": "2024-09-18T09:27:35.953Z" } } }, diff --git a/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2024-08-27/astronomer.json b/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2024-08-27/astronomer.json index 564ba05e726f..f6cc8cfb93b8 100644 --- a/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2024-08-27/astronomer.json +++ b/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2024-08-27/astronomer.json @@ -471,6 +471,7 @@ "description": "Marketplace details of the resource.", "x-ms-mutability": [ "read", + "update", "create" ] }, @@ -581,6 +582,24 @@ "offerDetails" ] }, + "LiftrBase.MarketplaceDetailsUpdate": { + "type": "object", + "description": "Marketplace details for an organization", + "properties": { + "subscriptionId": { + "type": "string", + "description": "Azure subscription id for the the marketplace offer is purchased from" + }, + "subscriptionStatus": { + "$ref": "#/definitions/LiftrBase.MarketplaceSubscriptionStatus", + "description": "Marketplace subscription status" + }, + "offerDetails": { + "$ref": "#/definitions/LiftrBase.OfferDetailsUpdate", + "description": "Offer details for the marketplace that is selected by the user" + } + } + }, "LiftrBase.MarketplaceSubscriptionStatus": { "type": "string", "description": "Marketplace subscription status of a resource.", @@ -662,6 +681,40 @@ "planId" ] }, + "LiftrBase.OfferDetailsUpdate": { + "type": "object", + "description": "Offer details for the marketplace that is selected by the user", + "properties": { + "publisherId": { + "type": "string", + "description": "Publisher Id for the marketplace offer" + }, + "offerId": { + "type": "string", + "description": "Offer Id for the marketplace offer" + }, + "planId": { + "type": "string", + "description": "Plan Id for the marketplace offer" + }, + "planName": { + "type": "string", + "description": "Plan Name for the marketplace offer" + }, + "termUnit": { + "type": "string", + "description": "Plan Display Name for the marketplace offer" + }, + "termId": { + "type": "string", + "description": "Plan Display Name for the marketplace offer" + }, + "renewalMode": { + "$ref": "#/definitions/LiftrBase.RenewalMode", + "description": "Subscription renewal mode" + } + } + }, "LiftrBase.RenewalMode": { "type": "string", "description": "Subscription renewal mode", @@ -879,6 +932,15 @@ "type": "object", "description": "The updatable properties of the OrganizationResource.", "properties": { + "marketplace": { + "$ref": "#/definitions/LiftrBase.MarketplaceDetailsUpdate", + "description": "Marketplace details of the resource.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, "user": { "$ref": "#/definitions/LiftrBase.UserDetailsUpdate", "description": "Details of the user." diff --git a/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2024-08-27/examples/Organizations_Update_MaximumSet_Gen.json b/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2024-08-27/examples/Organizations_Update_MaximumSet_Gen.json index 2444ba26245b..9b2a104e3592 100644 --- a/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2024-08-27/examples/Organizations_Update_MaximumSet_Gen.json +++ b/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2024-08-27/examples/Organizations_Update_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "operationId": "Organizations_Update", "parameters": { "api-version": "2024-08-27", - "subscriptionId": "A4679760-5C37-44EA-A4B8-8A7628B13824", + "subscriptionId": "ECBF1ABA-FCBB-46A5-BFC3-3334D65EC8F7", "resourceGroupName": "rgastronomer", "organizationName": "U.1-:7", "properties": { @@ -13,24 +13,37 @@ }, "tags": {}, "properties": { + "marketplace": { + "subscriptionId": "ujl", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "bywzycdrucjkx", + "offerId": "aljpaprqzpnivwol", + "planId": "fcpnstrwetlrajanh", + "planName": "wjgnlhqqkdi", + "termUnit": "pvpk", + "termId": "xg", + "renewalMode": "Auto" + } + }, "user": { - "firstName": "e", - "lastName": "puain", + "firstName": "wyoaxocyjfpgicvketuiayfxrxq", + "lastName": "vlwybhfayupjpwfhy", "emailAddress": ".K_@e7N-g1.xjqnbPs", - "upn": "beyxdwtwshcujyjtowjdvgytygpp", - "phoneNumber": "hepjqujjthtlxeoiltnchwqi" + "upn": "ezefcwbsbgcxrdiixmzphibt", + "phoneNumber": "eibhsslqzufgshuzrjjyymsb" }, "partnerOrganizationProperties": { - "organizationId": "fbjg", - "workspaceId": "ywwywdafdtvnntfevhnwszi", + "organizationId": "linzwcqhrpqrxpnghxjnxzetfdps", + "workspaceId": "tmmxzlagmdrc", "organizationName": "U.1-:7", "workspaceName": "9.:06", "singleSignOnProperties": { "singleSignOnState": "Initial", - "enterpriseAppId": "srkwxktx", - "singleSignOnUrl": "l", + "enterpriseAppId": "jspfkoxolosmvyixpktbwyoqrx", + "singleSignOnUrl": "aatouxlmqqizijszlu", "aadDomains": [ - "fcnqoizqxcdclmy" + "gwzhrfmnhbeitagjdlzw" ], "provisioningState": "Succeeded" } @@ -43,61 +56,61 @@ "body": { "properties": { "marketplace": { - "subscriptionId": "emasc", + "subscriptionId": "ujl", "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { - "publisherId": "kt", - "offerId": "tvidibzbxevtvnrdp", - "planId": "lwcvzdqecwkeracahmixnh", - "planName": "d", - "termUnit": "rs", - "termId": "kopnnjsp", + "publisherId": "bywzycdrucjkx", + "offerId": "aljpaprqzpnivwol", + "planId": "fcpnstrwetlrajanh", + "planName": "wjgnlhqqkdi", + "termUnit": "pvpk", + "termId": "xg", "renewalMode": "Auto", - "endDate": "2024-09-09T11:33:07.745Z" + "endDate": "2024-09-18T09:36:40.774Z" } }, "user": { - "firstName": "e", - "lastName": "puain", + "firstName": "wyoaxocyjfpgicvketuiayfxrxq", + "lastName": "vlwybhfayupjpwfhy", "emailAddress": ".K_@e7N-g1.xjqnbPs", - "upn": "beyxdwtwshcujyjtowjdvgytygpp", - "phoneNumber": "hepjqujjthtlxeoiltnchwqi" + "upn": "ezefcwbsbgcxrdiixmzphibt", + "phoneNumber": "eibhsslqzufgshuzrjjyymsb" }, "provisioningState": "Succeeded", "partnerOrganizationProperties": { - "organizationId": "fbjg", - "workspaceId": "ywwywdafdtvnntfevhnwszi", + "organizationId": "linzwcqhrpqrxpnghxjnxzetfdps", + "workspaceId": "tmmxzlagmdrc", "organizationName": "U.1-:7", "workspaceName": "9.:06", "singleSignOnProperties": { "singleSignOnState": "Initial", - "enterpriseAppId": "srkwxktx", - "singleSignOnUrl": "l", + "enterpriseAppId": "jspfkoxolosmvyixpktbwyoqrx", + "singleSignOnUrl": "aatouxlmqqizijszlu", "aadDomains": [ - "fcnqoizqxcdclmy" + "gwzhrfmnhbeitagjdlzw" ], "provisioningState": "Succeeded" } } }, "identity": { - "type": "None", - "userAssignedIdentities": {}, "principalId": "b5684bd7-7958-4c0e-9795-d686c31746d2", - "tenantId": "b5684bd7-7958-4c0e-9795-d686c31746d2" + "tenantId": "b5684bd7-7958-4c0e-9795-d686c31746d2", + "type": "None", + "userAssignedIdentities": {} }, "tags": {}, - "location": "pgfkugslgnsxeqpjs", - "id": "ec", - "name": "dfucbeviqfavjryqbflzqttvupne", - "type": "dgccugdynztwzwshuuubefte", + "location": "lpfjmjgqgqiecnek", + "id": "dxlysdjielachwxeyxqwnjxehwda", + "name": "fystkqkhbfxuotqxhft", + "type": "bipflhqhapjtuiknj", "systemData": { - "createdBy": "daq", + "createdBy": "ldetdeujxj", "createdByType": "User", - "createdAt": "2024-08-27T06:02:43.048Z", - "lastModifiedBy": "bewqhprigkbiwlmkmxctd", + "createdAt": "2024-09-18T09:36:40.776Z", + "lastModifiedBy": "hfwzlknbcscvxdr", "lastModifiedByType": "User", - "lastModifiedAt": "2024-08-27T06:02:43.048Z" + "lastModifiedAt": "2024-09-18T09:36:40.776Z" } } }, From 93837eec52045805de3df1346c2abb8afe21325a Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Wed, 25 Sep 2024 14:12:42 -0700 Subject: [PATCH 18/48] [tsp-client-tests] Always log console output of command (#30739) --- eng/tools/tsp-client-tests/test/tsp-client.test.ts | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/eng/tools/tsp-client-tests/test/tsp-client.test.ts b/eng/tools/tsp-client-tests/test/tsp-client.test.ts index b35e300ef049..5a12f891ecb8 100644 --- a/eng/tools/tsp-client-tests/test/tsp-client.test.ts +++ b/eng/tools/tsp-client-tests/test/tsp-client.test.ts @@ -7,10 +7,11 @@ const repoRoot = join(__dirname, "..", "..", "..", ".."); async function npmExec(...args: string[]) { const allArgs = ["exec", "--no", "--"].concat(args); - console.log(`${repoRoot}$ npm ${allArgs.join(" ")}`); - return await execa("npm", allArgs, { all: true, cwd: repoRoot, reject: false }); + const result = await execa("npm", allArgs, { all: true, cwd: repoRoot, reject: false }); + console.log(result.all); + return result; } async function convert(expect: ExpectStatic, readme: string) { From 252cde28dc55358e310b177ee2de6a6c12cf12a4 Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Thu, 26 Sep 2024 09:52:59 +0800 Subject: [PATCH 19/48] Update readme.python.md (#30732) --- .../Microsoft.ContainerService/fleet/readme.python.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/readme.python.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/readme.python.md index 7d63e5fd397c..c1f9236ffd5d 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/readme.python.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/readme.python.md @@ -17,7 +17,7 @@ no-namespace-folders: true Generate all API versions currently shipped for this package ```yaml $(python) -default-api-version: "2024-05-02-preview" +default-api-version: "2024-04-01" multiapi: true batch: - tag: package-2024-05-preview From b478dcdabacb37945ff89daa0eda1ae1afc98db4 Mon Sep 17 00:00:00 2001 From: Sean McCullough <44180881+seanmcc-msft@users.noreply.github.com> Date: Wed, 25 Sep 2024 21:42:03 -0500 Subject: [PATCH 20/48] Storage STG 96 (#30695) --- .../Azure.Storage.Files.DataLake/readme.md | 11 +- .../stable/2025-01-05/DataLakeStorage.json | 3686 +++++ .../Microsoft.BlobStorage/readme.md | 11 +- .../stable/2025-01-05/blob.json | 12443 ++++++++++++++++ .../Microsoft.FileStorage/readme.md | 11 +- .../stable/2025-01-05/file.json | 7879 ++++++++++ 6 files changed, 24038 insertions(+), 3 deletions(-) create mode 100644 specification/storage/data-plane/Azure.Storage.Files.DataLake/stable/2025-01-05/DataLakeStorage.json create mode 100644 specification/storage/data-plane/Microsoft.BlobStorage/stable/2025-01-05/blob.json create mode 100644 specification/storage/data-plane/Microsoft.FileStorage/stable/2025-01-05/file.json diff --git a/specification/storage/data-plane/Azure.Storage.Files.DataLake/readme.md b/specification/storage/data-plane/Azure.Storage.Files.DataLake/readme.md index ac96e96c448a..044606d339bc 100644 --- a/specification/storage/data-plane/Azure.Storage.Files.DataLake/readme.md +++ b/specification/storage/data-plane/Azure.Storage.Files.DataLake/readme.md @@ -25,7 +25,7 @@ These are the global settings for the StorageDataLake API. ``` yaml openapi-type: data-plane -tag: package-2023-05 +tag: package-2025-01 use-internal-constructors: true add-credentials: true ``` @@ -93,6 +93,15 @@ input-file: - stable/2023-05-03/DataLakeStorage.json ``` +### Tag: package-2025-01 + +These settings apply only when `--tag=package-2025-01` is specified on the command line. + +``` yaml $(tag) == 'package-2025-01' +input-file: +- stable/2025-01-05/DataLakeStorage.json +``` + ### Suppression ``` yaml directive: diff --git a/specification/storage/data-plane/Azure.Storage.Files.DataLake/stable/2025-01-05/DataLakeStorage.json b/specification/storage/data-plane/Azure.Storage.Files.DataLake/stable/2025-01-05/DataLakeStorage.json new file mode 100644 index 000000000000..05675f80ea82 --- /dev/null +++ b/specification/storage/data-plane/Azure.Storage.Files.DataLake/stable/2025-01-05/DataLakeStorage.json @@ -0,0 +1,3686 @@ +{ + "swagger": "2.0", + "info": { + "description": "Azure Data Lake Storage provides storage for Hadoop and other big data workloads.", + "title": "Azure Data Lake Storage REST API", + "version": "2025-01-05", + "x-ms-code-generation-settings": { + "internalConstructors": true, + "name": "DataLakeStorageClient", + "header": "MIT", + "strictSpecAdherence": false + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{url}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "$ref": "#/parameters/Url" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": {}, + "x-ms-paths": { + "/": { + "get": { + "operationId": "Service_ListFileSystems", + "summary": "List FileSystems", + "description": "List filesystems and their properties in given account.", + "x-ms-pageable": { + "itemName": "filesystems", + "nextLinkName": null + }, + "tags": [ + "Account Operations" + ], + "parameters": [ + { + "name": "resource", + "in": "query", + "description": "The value must be \"account\" for all account operations.", + "required": true, + "type": "string", + "enum": [ + "account" + ], + "x-ms-enum": { + "name": "AccountResourceType", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/Prefix" + }, + { + "$ref": "#/parameters/Continuation" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string", + "format": "date-time-rfc1123" + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-continuation": { + "x-ms-client-name": "Continuation", + "description": "If the number of filesystems to be listed exceeds the maxResults limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the filesystems.", + "type": "string" + }, + "Content-Type": { + "description": "The content type of list filesystem response. The default content type is application/json.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/FileSystemList" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + } + }, + "/{filesystem}": { + "put": { + "operationId": "FileSystem_Create", + "summary": "Create FileSystem", + "description": "Create a FileSystem rooted at the specified location. If the FileSystem already exists, the operation fails. This operation does not support conditional HTTP requests.", + "tags": [ + "FileSystem Operations" + ], + "parameters": [ + { + "$ref": "#/parameters/Properties" + } + ], + "responses": { + "201": { + "description": "Created", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ETag": { + "description": "An HTTP entity tag associated with the FileSystem.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the filesystem was last modified. Operations on files and directories do not affect the last modified time.", + "format": "date-time-rfc1123", + "type": "string" + }, + "x-ms-request-id": { + "x-ms-client-name": "ClientRequestId", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-namespace-enabled": { + "x-ms-client-name": "NamespaceEnabled", + "description": "A bool string indicates whether the namespace feature is enabled. If \"true\", the namespace is enabled for the filesystem.", + "type": "string" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "patch": { + "operationId": "FileSystem_SetProperties", + "summary": "Set FileSystem Properties", + "description": "Set properties for the FileSystem. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "tags": [ + "FileSystem Operations" + ], + "parameters": [ + { + "$ref": "#/parameters/Properties" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + } + ], + "responses": { + "200": { + "description": "Ok", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ETag": { + "description": "An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the filesystem was last modified. Changes to filesystem properties update the last modified time, but operations on files and directories do not.", + "format": "date-time-rfc1123", + "type": "string" + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "description": "The version of the REST protocol used to process the request.", + "type": "string" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "head": { + "operationId": "FileSystem_GetProperties", + "summary": "Get FileSystem Properties.", + "description": "All system and user-defined filesystem properties are specified in the response headers.", + "tags": [ + "FileSystem Operations" + ], + "responses": { + "200": { + "description": "Ok", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ETag": { + "description": "An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the filesystem was last modified. Changes to filesystem properties update the last modified time, but operations on files and directories do not.", + "format": "date-time-rfc1123", + "type": "string" + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-properties": { + "x-ms-client-name": "Properties", + "description": "The user-defined properties associated with the filesystem. A comma-separated list of name and value pairs in the format \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", + "type": "string" + }, + "x-ms-namespace-enabled": { + "x-ms-client-name": "NamespaceEnabled", + "description": "A bool string indicates whether the namespace feature is enabled. If \"true\", the namespace is enabled for the filesystem.", + "type": "string" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "delete": { + "operationId": "FileSystem_Delete", + "summary": "Delete FileSystem", + "description": "Marks the FileSystem for deletion. When a FileSystem is deleted, a FileSystem with the same identifier cannot be created for at least 30 seconds. While the filesystem is being deleted, attempts to create a filesystem with the same identifier will fail with status code 409 (Conflict), with the service returning additional error information indicating that the filesystem is being deleted. All other operations, including operations on any files or directories within the filesystem, will fail with status code 404 (Not Found) while the filesystem is being deleted. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "tags": [ + "FileSystem Operations" + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string", + "format": "date-time-rfc1123" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + } + ] + }, + "parameters": [ + { + "$ref": "#/parameters/FileSystem" + }, + { + "$ref": "#/parameters/FileSystemResource" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ] + }, + "/{filesystem}?resource=filesystem": { + "get": { + "operationId": "FileSystem_ListPaths", + "summary": "List Paths", + "description": "List FileSystem paths and their properties.", + "x-ms-pageable": { + "itemName": "paths", + "nextLinkName": null + }, + "tags": [ + "FileSystem Operations" + ], + "parameters": [ + { + "$ref": "#/parameters/Continuation" + }, + { + "$ref": "#/parameters/Directory" + }, + { + "$ref": "#/parameters/RecursiveRequired" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/Upn" + } + ], + "responses": { + "200": { + "description": "Ok", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ETag": { + "description": "An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the filesystem was last modified. Changes to filesystem properties update the last modified time, but operations on files and directories do not.", + "format": "date-time-rfc1123", + "type": "string" + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-continuation": { + "x-ms-client-name": "Continuation", + "description": "If the number of paths to be listed exceeds the maxResults limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/PathList" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/FileSystem" + }, + { + "$ref": "#/parameters/FileSystemResource" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ] + }, + "/{filesystem}?restype=container&comp=list&hierarchy": { + "get": { + "tags": [ + "containers" + ], + "produces": [ + "application/xml" + ], + "operationId": "FileSystem_ListBlobHierarchySegment", + "description": "The List Blobs operation returns a list of the blobs under the specified container", + "parameters": [ + { + "$ref": "#/parameters/Prefix" + }, + { + "$ref": "#/parameters/Delimiter" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/ListBlobsInclude" + }, + { + "$ref": "#/parameters/ListBlobsShowOnly" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Content-Type": { + "type": "string", + "description": "The media type of the body of the response. For List Blobs this is 'application/xml'" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/ListBlobsHierarchySegmentResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "NextMarker" + } + }, + "parameters": [ + { + "$ref": "#/parameters/FileSystem" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "list" + ] + } + ] + }, + "/{filesystem}/{path}": { + "put": { + "operationId": "Path_Create", + "summary": "Create File | Create Directory | Rename File | Rename Directory", + "description": "Create or rename a file or directory. By default, the destination is overwritten and if the destination already exists and has a lease the lease is broken. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). To fail if the destination already exists, use a conditional request with If-None-Match: \"*\".", + "consumes": [ + "application/octet-stream" + ], + "tags": [ + "File and Directory Operations" + ], + "parameters": [ + { + "name": "resource", + "in": "query", + "description": "Required only for Create File and Create Directory. The value must be \"file\" or \"directory\".", + "required": false, + "type": "string", + "enum": [ + "directory", + "file" + ], + "x-ms-enum": { + "name": "PathResourceType", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/Continuation" + }, + { + "name": "mode", + "in": "query", + "description": "Optional. Valid only when namespace is enabled. This parameter determines the behavior of the rename operation. The value must be \"legacy\" or \"posix\", and the default value will be \"posix\".", + "required": false, + "type": "string", + "enum": [ + "legacy", + "posix" + ], + "x-ms-enum": { + "name": "PathRenameMode", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/CacheControl" + }, + { + "$ref": "#/parameters/ContentEncoding" + }, + { + "$ref": "#/parameters/ContentLanguage" + }, + { + "$ref": "#/parameters/ContentDisposition" + }, + { + "$ref": "#/parameters/ContentType" + }, + { + "$ref": "#/parameters/RenameSource" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/SourceLeaseId" + }, + { + "$ref": "#/parameters/Properties" + }, + { + "$ref": "#/parameters/Permissions" + }, + { + "$ref": "#/parameters/Umask" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/SourceIfMatch" + }, + { + "$ref": "#/parameters/SourceIfNoneMatch" + }, + { + "$ref": "#/parameters/SourceIfModifiedSince" + }, + { + "$ref": "#/parameters/SourceIfUnmodifiedSince" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/Owner" + }, + { + "$ref": "#/parameters/Group" + }, + { + "$ref": "#/parameters/Acl" + }, + { + "$ref": "#/parameters/ProposedLeaseIdOptional" + }, + { + "$ref": "#/parameters/LeaseDurationMethod" + }, + { + "$ref": "#/parameters/PathExpiryOptionsOptional" + }, + { + "$ref": "#/parameters/PathExpiryTime" + }, + { + "$ref": "#/parameters/EncryptionContext" + } + ], + "responses": { + "201": { + "description": "The file or directory was created.", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "format": "date-time-rfc1123", + "type": "string" + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-continuation": { + "x-ms-client-name": "Continuation", + "description": "When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory.", + "type": "string" + }, + "Content-Length": { + "description": "The size of the resource in bytes.", + "type": "integer", + "format": "int64" + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "patch": { + "operationId": "Path_Update", + "summary": "Append Data | Flush Data | Set Properties | Set Access Control", + "description": "Uploads data to be appended to a file, flushes (writes) previously uploaded data to a file, sets properties for a file or directory, or sets access control for a file or directory. Data can only be appended to a file. Concurrent writes to the same file using multiple clients are not supported. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "consumes": [ + "application/octet-stream" + ], + "tags": [ + "File and Directory Operations" + ], + "parameters": [ + { + "name": "action", + "in": "query", + "description": "The action must be \"append\" to upload data to be appended to a file, \"flush\" to flush previously uploaded data to a file, \"setProperties\" to set the properties of a file or directory, \"setAccessControl\" to set the owner, group, permissions, or access control list for a file or directory, or \"setAccessControlRecursive\" to set the access control list for a directory recursively. Note that Hierarchical Namespace must be enabled for the account in order to use access control. Also note that the Access Control List (ACL) includes permissions for the owner, owning group, and others, so the x-ms-permissions and x-ms-acl request headers are mutually exclusive.", + "required": true, + "type": "string", + "enum": [ + "append", + "flush", + "setProperties", + "setAccessControl", + "setAccessControlRecursive" + ], + "x-ms-enum": { + "name": "PathUpdateAction", + "modelAsString": false + } + }, + { + "name": "maxRecords", + "in": "query", + "description": "Optional. Valid for \"SetAccessControlRecursive\" operation. It specifies the maximum number of files or directories on which the acl change will be applied. If omitted or greater than 2,000, the request will process up to 2,000 items", + "format": "int32", + "minimum": 1, + "required": false, + "type": "integer" + }, + { + "name": "continuation", + "in": "query", + "description": "Optional. The number of paths processed with each invocation is limited. If the number of paths to be processed exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is returned in the response, it must be percent-encoded and specified in a subsequent invocation of setAccessControlRecursive operation.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/PathSetAccessControlRecursiveMode" + }, + { + "$ref": "#/parameters/ForceFlag" + }, + { + "$ref": "#/parameters/Position" + }, + { + "$ref": "#/parameters/RetainUncommittedData" + }, + { + "$ref": "#/parameters/Close" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/ContentMD5" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/CacheControl" + }, + { + "$ref": "#/parameters/ContentType" + }, + { + "$ref": "#/parameters/ContentDisposition" + }, + { + "$ref": "#/parameters/ContentEncoding" + }, + { + "$ref": "#/parameters/ContentLanguage" + }, + { + "$ref": "#/parameters/Properties" + }, + { + "$ref": "#/parameters/Owner" + }, + { + "$ref": "#/parameters/Group" + }, + { + "$ref": "#/parameters/Permissions" + }, + { + "$ref": "#/parameters/Acl" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/Body" + }, + { + "$ref": "#/parameters/StructuredBodyPut" + }, + { + "$ref": "#/parameters/StructuredContentLength" + } + ], + "responses": { + "200": { + "description": "The data was flushed (written) to the file or the properties were set successfully. Response body is optional and is valid only for \"SetAccessControlRecursive\"", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "format": "date-time-rfc1123", + "type": "string" + }, + "Accept-Ranges": { + "description": "Indicates that the service supports requests for partial file content.", + "type": "string" + }, + "Cache-Control": { + "description": "If the Cache-Control request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Disposition": { + "description": "If the Content-Disposition request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Encoding": { + "description": "If the Content-Encoding request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Language": { + "description": "If the Content-Language request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Length": { + "description": "The size of the resource in bytes.", + "type": "integer", + "format": "int64" + }, + "Content-Range": { + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header.", + "type": "string" + }, + "Content-Type": { + "description": "The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream.", + "type": "string" + }, + "Content-MD5": { + "description": "An MD5 hash of the request content. This header is only returned for \"Flush\" operation. This header is returned so that the client can check for message content integrity. This header refers to the content of the request, not actual file content.", + "type": "string" + }, + "x-ms-properties": { + "x-ms-client-name": "Properties", + "description": "User-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", + "type": "string" + }, + "x-ms-continuation": { + "description": "When performing setAccessControlRecursive on a directory, the number of paths that are processed with each invocation is limited. If the number of paths to be processed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the setAccessControlRecursive operation to continue the setAccessControlRecursive operation on the directory.", + "type": "string" + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "description": "The version of the REST protocol used to process the request.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/SetAccessControlRecursiveResponse" + } + }, + "202": { + "description": "The uploaded data was accepted.", + "headers": { + "Content-MD5": { + "description": "An MD5 hash of the request content. This header is only returned for \"Append\" operation. This header is returned so that the client can check for message content integrity. The value of this header is computed by the service; it is not necessarily the same value specified in the request headers.", + "type": "string" + }, + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string", + "format": "date-time-rfc1123" + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-structured-body": { + "x-ms-client-name": "StructuredBodyType", + "type": "string", + "description": "Indicates the structured message body was accepted and mirrors back the message schema version and properties." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "post": { + "operationId": "Path_Lease", + "summary": "Lease Path", + "description": "Create and manage a lease to restrict write and delete access to the path. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "tags": [ + "File and Directory Operations" + ], + "parameters": [ + { + "name": "x-ms-lease-action", + "in": "header", + "description": "There are five lease actions: \"acquire\", \"break\", \"change\", \"renew\", and \"release\". Use \"acquire\" and specify the \"x-ms-proposed-lease-id\" and \"x-ms-lease-duration\" to acquire a new lease. Use \"break\" to break an existing lease. When a lease is broken, the lease break period is allowed to elapse, during which time no lease operation except break and release can be performed on the file. When a lease is successfully broken, the response indicates the interval in seconds until a new lease can be acquired. Use \"change\" and specify the current lease ID in \"x-ms-lease-id\" and the new lease ID in \"x-ms-proposed-lease-id\" to change the lease ID of an active lease. Use \"renew\" and specify the \"x-ms-lease-id\" to renew an existing lease. Use \"release\" and specify the \"x-ms-lease-id\" to release a lease.", + "required": true, + "type": "string", + "enum": [ + "acquire", + "break", + "change", + "renew", + "release" + ], + "x-ms-enum": { + "name": "PathLeaseAction", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/LeaseDuration" + }, + { + "name": "x-ms-lease-break-period", + "in": "header", + "description": "The lease break period duration is optional to break a lease, and specifies the break period of the lease in seconds. The lease break duration must be between 0 and 60 seconds.", + "format": "int32", + "required": false, + "type": "integer" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ProposedLeaseIdOptional" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + } + ], + "responses": { + "200": { + "description": "The \"renew\", \"change\" or \"release\" action was successful.", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ETag": { + "description": "An HTTP entity tag associated with the file.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file was last modified. Write operations on the file update the last modified time.", + "format": "date-time-rfc1123", + "type": "string" + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "description": "A successful \"renew\" action returns the lease ID.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + } + } + }, + "201": { + "description": "A new lease has been created. The \"acquire\" action was successful.", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "format": "date-time-rfc1123", + "type": "string" + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "description": "A successful \"acquire\" action returns the lease ID.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + } + } + }, + "202": { + "description": "The \"break\" lease action was successful.", + "headers": { + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "format": "date-time-rfc1123", + "type": "string" + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-lease-time": { + "x-ms-client-name": "LeaseTime", + "description": "The time remaining in the lease period in seconds.", + "type": "string" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "operationId": "Path_Read", + "summary": "Read File", + "description": "Read the contents of a file. For read operations, range requests are supported. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "tags": [ + "File and Directory Operations" + ], + "parameters": [ + { + "in": "header", + "description": "The HTTP Range request header specifies one or more byte ranges of the resource to be retrieved.", + "required": false, + "type": "string", + "name": "Range" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "name": "x-ms-range-get-content-md5", + "in": "header", + "description": "Optional. When this header is set to \"true\" and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4MB in size. If this header is specified without the Range header, the service returns status code 400 (Bad Request). If this header is set to true when the range exceeds 4 MB in size, the service returns status code 400 (Bad Request).", + "required": false, + "type": "boolean" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + } + ], + "responses": { + "200": { + "description": "Ok", + "headers": { + "Accept-Ranges": { + "description": "Indicates that the service supports requests for partial file content.", + "type": "string" + }, + "Cache-Control": { + "description": "If the Cache-Control request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Disposition": { + "description": "If the Content-Disposition request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Encoding": { + "description": "If the Content-Encoding request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Language": { + "description": "If the Content-Language request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Length": { + "description": "The size of the resource in bytes.", + "type": "integer", + "format": "int64" + }, + "Content-Range": { + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header.", + "type": "string" + }, + "Content-Type": { + "description": "The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream.", + "type": "string" + }, + "Content-MD5": { + "description": "The MD5 hash of complete file. If the file has an MD5 hash and this read operation is to read the complete file, this response header is returned so that the client can check for message content integrity.", + "type": "string" + }, + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "format": "date-time-rfc1123", + "type": "string" + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-resource-type": { + "x-ms-client-name": "ResourceType", + "description": "The type of the resource. The value may be \"file\" or \"directory\". If not set, the value is \"file\".", + "type": "string" + }, + "x-ms-properties": { + "x-ms-client-name": "Properties", + "description": "The user-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", + "type": "string" + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a resource is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string" + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the resource.", + "type": "string" + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The lease status of the resource.", + "type": "string" + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + } + }, + "schema": { + "type": "object", + "format": "file" + } + }, + "206": { + "description": "Partial content", + "headers": { + "Accept-Ranges": { + "description": "Indicates that the service supports requests for partial file content.", + "type": "string" + }, + "Cache-Control": { + "description": "If the Cache-Control request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Disposition": { + "description": "If the Content-Disposition request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Encoding": { + "description": "If the Content-Encoding request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Language": { + "description": "If the Content-Language request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Length": { + "description": "The size of the resource in bytes.", + "type": "integer", + "format": "int64" + }, + "Content-Range": { + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header.", + "type": "string" + }, + "Content-Type": { + "description": "The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream.", + "type": "string" + }, + "Content-MD5": { + "description": "The MD5 hash of read range. If the request is to read a specified range and the \"x-ms-range-get-content-md5\" is set to true, then the request returns an MD5 hash for the range, as long as the range size is less than or equal to 4 MB.", + "type": "string" + }, + "x-ms-content-md5": { + "description": "The MD5 hash of complete file stored in storage. If the file has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the complete file's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range.", + "type": "string" + }, + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "format": "date-time-rfc1123", + "type": "string" + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-resource-type": { + "x-ms-client-name": "ResourceType", + "description": "The type of the resource. The value may be \"file\" or \"directory\". If not set, the value is \"file\".", + "type": "string" + }, + "x-ms-properties": { + "x-ms-client-name": "Properties", + "description": "The user-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", + "type": "string" + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a resource is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string" + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the resource. ", + "type": "string" + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The lease status of the resource.", + "type": "string" + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + } + }, + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "head": { + "operationId": "Path_GetProperties", + "summary": "Get Properties | Get Status | Get Access Control List", + "description": "Get Properties returns all system and user defined properties for a path. Get Status returns all system defined properties for a path. Get Access Control List returns the access control list for a path. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "tags": [ + "File and Directory Operations" + ], + "parameters": [ + { + "name": "action", + "in": "query", + "description": "Optional. If the value is \"getStatus\" only the system defined properties for the path are returned. If the value is \"getAccessControl\" the access control list is returned in the response headers (Hierarchical Namespace must be enabled for the account), otherwise the properties are returned.", + "required": false, + "type": "string", + "enum": [ + "getAccessControl", + "getStatus" + ], + "x-ms-enum": { + "name": "PathGetPropertiesAction", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/Upn" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + } + ], + "responses": { + "200": { + "description": "Returns all properties for the file or directory.", + "headers": { + "Accept-Ranges": { + "description": "Indicates that the service supports requests for partial file content.", + "type": "string" + }, + "Cache-Control": { + "description": "If the Cache-Control request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Disposition": { + "description": "If the Content-Disposition request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Encoding": { + "description": "If the Content-Encoding request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Language": { + "description": "If the Content-Language request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Length": { + "description": "The size of the resource in bytes.", + "type": "integer", + "format": "int64" + }, + "Content-Range": { + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header.", + "type": "string" + }, + "Content-Type": { + "description": "The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream.", + "type": "string" + }, + "Content-MD5": { + "description": "The MD5 hash of complete file stored in storage. This header is returned only for \"GetProperties\" operation. If the Content-MD5 header has been set for the file, this response header is returned for GetProperties call so that the client can check for message content integrity.", + "type": "string" + }, + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "format": "date-time-rfc1123", + "type": "string" + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-resource-type": { + "x-ms-client-name": "ResourceType", + "description": "The type of the resource. The value may be \"file\" or \"directory\". If not set, the value is \"file\".", + "type": "string" + }, + "x-ms-properties": { + "x-ms-client-name": "Properties", + "description": "The user-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", + "type": "string" + }, + "x-ms-owner": { + "x-ms-client-name": "Owner", + "description": "The owner of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account.", + "type": "string" + }, + "x-ms-group": { + "x-ms-client-name": "Group", + "description": "The owning group of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account.", + "type": "string" + }, + "x-ms-permissions": { + "x-ms-client-name": "Permissions", + "description": "The POSIX access permissions for the file owner, the file owning group, and others. Included in the response if Hierarchical Namespace is enabled for the account.", + "type": "string" + }, + "x-ms-acl": { + "x-ms-client-name": "ACL", + "description": "The POSIX access control list for the file or directory. Included in the response only if the action is \"getAccessControl\" and Hierarchical Namespace is enabled for the account.", + "type": "string" + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a resource is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string" + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the resource.", + "type": "string" + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The lease status of the resource.", + "type": "string" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "delete": { + "operationId": "Path_Delete", + "summary": "Delete File | Delete Directory", + "description": "Delete the file or directory. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "tags": [ + "File and Directory Operations" + ], + "parameters": [ + { + "$ref": "#/parameters/RecursiveOptional" + }, + { + "$ref": "#/parameters/Continuation" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/Paginated" + } + ], + "responses": { + "200": { + "description": "The file was deleted.", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string", + "format": "date-time-rfc1123" + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-continuation": { + "x-ms-client-name": "Continuation", + "description": "When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.", + "type": "string" + }, + "x-ms-deletion-id": { + "x-ms-client-name": "DeletionId", + "description": "Returned only for hierarchical namespace space enabled accounts when soft delete is enabled. A unique identifier for the entity that can be used to restore it. See the Undelete REST API for more information.", + "type": "string" + } + } + }, + "202": { + "description": "Delete request is accepted, applicable only when Hierarchical Namespace is enabled for the account.", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-continuation": { + "description": "Applicable only when Hierarchical Namespace is enabled for the account. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response when the following conditions are met: Delete should be on a directory with query parameters \"recursive\" and \"paginated\" set to true, the identity of the user calling the api should be a non-super user using ACL based authorization, number of paths to be deleted exceeds a limit, request version is 2023-08-03 and later. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory. Directory is successfully deleted when the continuation token returned is empty. The actual directory deletion happens only in the last invocation, the previous ones involve ACL checks in the server of the files and directories under the directory to be recursively deleted.", + "type": "string" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/FileSystem" + }, + { + "$ref": "#/parameters/Path" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ] + }, + "/{filesystem}/{path}?action=setAccessControl": { + "patch": { + "tags": [ + "directory" + ], + "operationId": "Path_SetAccessControl", + "description": "Set the owner, group, permissions, or access control list for a path.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/Owner" + }, + { + "$ref": "#/parameters/Group" + }, + { + "$ref": "#/parameters/Permissions" + }, + { + "$ref": "#/parameters/Acl" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Set directory access control response.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "ETag": { + "type": "string", + "description": "An HTTP entity tag associated with the file or directory." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "The version of the REST protocol used to process the request." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "The version of the REST protocol used to process the request." + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/FileSystem" + }, + { + "$ref": "#/parameters/Path" + }, + { + "name": "action", + "description": "action", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "setAccessControl" + ] + } + ] + }, + "/{filesystem}/{path}?action=setAccessControlRecursive": { + "patch": { + "tags": [ + "directory" + ], + "operationId": "Path_SetAccessControlRecursive", + "description": "Set the access control list for a path and sub-paths.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Continuation" + }, + { + "$ref": "#/parameters/PathSetAccessControlRecursiveMode" + }, + { + "$ref": "#/parameters/ForceFlag" + }, + { + "name": "maxRecords", + "in": "query", + "description": "Optional. It specifies the maximum number of files or directories on which the acl change will be applied. If omitted or greater than 2,000, the request will process up to 2,000 items", + "format": "int32", + "minimum": 1, + "required": false, + "type": "integer" + }, + { + "$ref": "#/parameters/Acl" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Set directory access control recursive response.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-continuation": { + "x-ms-client-name": "Continuation", + "description": "When performing setAccessControlRecursive on a directory, the number of paths that are processed with each invocation is limited. If the number of paths to be processed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the setAccessControlRecursive operation to continue the setAccessControlRecursive operation on the directory.", + "type": "string" + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "The version of the REST protocol used to process the request." + } + }, + "schema": { + "$ref": "#/definitions/SetAccessControlRecursiveResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "The version of the REST protocol used to process the request." + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/FileSystem" + }, + { + "$ref": "#/parameters/Path" + }, + { + "name": "action", + "description": "action", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "setAccessControlRecursive" + ] + } + ] + }, + "/{filesystem}/{path}?action=flush": { + "patch": { + "tags": [ + "directory" + ], + "operationId": "Path_FlushData", + "description": "Set the owner, group, permissions, or access control list for a path.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Position" + }, + { + "$ref": "#/parameters/RetainUncommittedData" + }, + { + "$ref": "#/parameters/Close" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/ContentMD5" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/LeaseAction" + }, + { + "$ref": "#/parameters/LeaseDurationMethod" + }, + { + "$ref": "#/parameters/ProposedLeaseIdOptional" + }, + { + "$ref": "#/parameters/CacheControl" + }, + { + "$ref": "#/parameters/ContentType" + }, + { + "$ref": "#/parameters/ContentDisposition" + }, + { + "$ref": "#/parameters/ContentEncoding" + }, + { + "$ref": "#/parameters/ContentLanguage" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + } + ], + "responses": { + "200": { + "description": "The data was flushed (written) to the file successfully.", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "format": "date-time-rfc1123", + "type": "string" + }, + "Content-Length": { + "description": "The size of the resource in bytes.", + "type": "integer", + "format": "int64" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-lease-renewed": { + "x-ms-client-name": "LeaseRenewed", + "type": "boolean", + "description": "If the lease was auto-renewed with this request" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "The version of the REST protocol used to process the request." + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/FileSystem" + }, + { + "$ref": "#/parameters/Path" + }, + { + "name": "action", + "description": "action", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "flush" + ] + } + ] + }, + "/{filesystem}/{path}?action=append": { + "patch": { + "tags": [ + "directory" + ], + "operationId": "Path_AppendData", + "description": "Append data to the file.", + "parameters": [ + { + "$ref": "#/parameters/Position" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/TransactionalContentMD5" + }, + { + "$ref": "#/parameters/ContentCrc64" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/LeaseAction" + }, + { + "$ref": "#/parameters/LeaseDurationMethod" + }, + { + "$ref": "#/parameters/ProposedLeaseIdOptional" + }, + { + "$ref": "#/parameters/Body" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/Flush" + }, + { + "$ref": "#/parameters/StructuredBodyPut" + }, + { + "$ref": "#/parameters/StructuredContentLength" + } + ], + "responses": { + "202": { + "description": "Append data to file control response.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "The version of the REST protocol used to process the request." + }, + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "type": "string" + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-lease-renewed": { + "x-ms-client-name": "LeaseRenewed", + "type": "boolean", + "description": "If the lease was auto-renewed with this request" + }, + "x-ms-structured-body": { + "x-ms-client-name": "StructuredBodyType", + "type": "string", + "description": "Indicates the structured message body was accepted and mirrors back the message schema version and properties." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "The version of the REST protocol used to process the request." + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/FileSystem" + }, + { + "$ref": "#/parameters/Path" + }, + { + "name": "action", + "description": "action", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "append" + ] + } + ] + }, + "/{filesystem}/{path}?comp=expiry": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Path_SetExpiry", + "description": "Sets the time a blob will expire and be deleted.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/PathExpiryOptions" + }, + { + "$ref": "#/parameters/PathExpiryTime" + } + ], + "responses": { + "200": { + "description": "The blob expiry was set successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/FileSystem" + }, + { + "$ref": "#/parameters/Path" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "expiry" + ] + } + ] + }, + "/{filesystem}/{path}?comp=undelete": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Path_Undelete", + "description": "Undelete a path that was previously soft deleted", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/UndeleteSource" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The blob was undeleted successfully.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-resource-type": { + "x-ms-client-name": "ResourceType", + "description": "The type of the resource. The value may be \"file\" or \"directory\". If not set, the value is \"file\".", + "type": "string" + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/FileSystem" + }, + { + "$ref": "#/parameters/Path" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "undelete" + ] + } + ] + } + }, + "parameters": { + "Url": { + "name": "url", + "description": "The URL of the service account, container, or blob that is the target of the desired operation.", + "required": true, + "x-ms-parameter-location": "client", + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "FileSystemResource": { + "name": "resource", + "in": "query", + "x-ms-parameter-location": "client", + "description": "The value must be \"filesystem\" for all filesystem operations.", + "required": true, + "type": "string", + "enum": [ + "filesystem" + ], + "x-ms-enum": { + "name": "FileSystemResourceType", + "modelAsString": false + } + }, + "ApiVersionParameter": { + "name": "x-ms-version", + "x-ms-parameter-location": "client", + "x-ms-client-name": "version", + "in": "header", + "required": true, + "type": "string", + "description": "Specifies the version of the operation to use for this request.", + "enum": [ + "2025-01-05" + ] + }, + "accountName": { + "description": "The Azure Storage account name.", + "in": "path", + "name": "accountName", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "method" + }, + "dnsSuffix": { + "default": "dfs.core.windows.net", + "description": "The DNS suffix for the Azure Data Lake Storage endpoint.", + "in": "path", + "name": "dnsSuffix", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "method" + }, + "ClientRequestId": { + "name": "x-ms-client-request-id", + "x-ms-client-name": "requestId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." + }, + "Timeout": { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "minimum": 0, + "x-ms-parameter-location": "method", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations." + }, + "IfMatch": { + "name": "If-Match", + "x-ms-client-name": "ifMatch", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "modified-access-conditions" + }, + "description": "Specify an ETag value to operate only on blobs with a matching value." + }, + "IfModifiedSince": { + "name": "If-Modified-Since", + "x-ms-client-name": "ifModifiedSince", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "modified-access-conditions" + }, + "description": "Specify this header value to operate only on a blob if it has been modified since the specified date/time." + }, + "IfNoneMatch": { + "name": "If-None-Match", + "x-ms-client-name": "ifNoneMatch", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "modified-access-conditions" + }, + "description": "Specify an ETag value to operate only on blobs without a matching value." + }, + "IfUnmodifiedSince": { + "name": "If-Unmodified-Since", + "x-ms-client-name": "ifUnmodifiedSince", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "modified-access-conditions" + }, + "description": "Specify this header value to operate only on a blob if it has not been modified since the specified date/time." + }, + "RecursiveOptional": { + "name": "recursive", + "x-ms-parameter-location": "method", + "in": "query", + "description": "Required", + "required": false, + "type": "boolean" + }, + "RecursiveRequired": { + "name": "recursive", + "x-ms-parameter-location": "method", + "in": "query", + "description": "Required", + "required": true, + "type": "boolean" + }, + "Continuation": { + "name": "continuation", + "x-ms-parameter-location": "method", + "in": "query", + "description": "Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.", + "required": false, + "type": "string" + }, + "PathSetAccessControlRecursiveMode": { + "name": "mode", + "in": "query", + "x-ms-parameter-location": "method", + "description": "Mode \"set\" sets POSIX access control rights on files and directories, \"modify\" modifies one or more POSIX access control rights that pre-exist on files and directories, \"remove\" removes one or more POSIX access control rights that were present earlier on files and directories", + "required": true, + "type": "string", + "enum": [ + "set", + "modify", + "remove" + ], + "x-ms-enum": { + "name": "PathSetAccessControlRecursiveMode", + "modelAsString": false + } + }, + "ForceFlag": { + "name": "forceFlag", + "x-ms-parameter-location": "method", + "in": "query", + "description": "Optional. Valid for \"SetAccessControlRecursive\" operation. If set to false, the operation will terminate quickly on encountering user errors (4XX). If true, the operation will ignore user errors and proceed with the operation on other sub-entities of the directory. Continuation token will only be returned when forceFlag is true in case of user errors. If not set the default value is false for this.", + "required": false, + "type": "boolean" + }, + "Directory": { + "name": "directory", + "x-ms-client-name": "Path", + "x-ms-parameter-location": "method", + "in": "query", + "description": "Optional. Filters results to paths within the specified directory. An error occurs if the directory does not exist.", + "required": false, + "type": "string" + }, + "LeaseIdOptional": { + "name": "x-ms-lease-id", + "x-ms-client-name": "leaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "lease-access-conditions" + }, + "description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID." + }, + "LeaseIdRequired": { + "name": "x-ms-lease-id", + "x-ms-client-name": "leaseId", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Specifies the current lease ID on the resource." + }, + "ProposedLeaseIdOptional": { + "name": "x-ms-proposed-lease-id", + "x-ms-client-name": "proposedLeaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats." + }, + "LeaseDuration": { + "name": "x-ms-lease-duration", + "in": "header", + "description": "The lease duration is required to acquire a lease, and specifies the duration of the lease in seconds. The lease duration must be between 15 and 60 seconds or -1 for infinite lease.", + "format": "int32", + "required": false, + "type": "integer", + "x-ms-parameter-location": "client" + }, + "LeaseDurationMethod": { + "name": "x-ms-lease-duration", + "x-ms-client-name": "leaseDuration", + "in": "header", + "description": "The lease duration is required to acquire a lease, and specifies the duration of the lease in seconds. The lease duration must be between 15 and 60 seconds or -1 for infinite lease.", + "format": "int64", + "required": false, + "type": "integer", + "x-ms-parameter-location": "method" + }, + "LeaseAction": { + "name": "x-ms-lease-action", + "x-ms-client-name": "leaseAction", + "in": "header", + "x-ms-parameter-location": "method", + "description": "Optional. If \"acquire\" it will acquire the lease. If \"auto-renew\" it will renew the lease. If \"release\" it will release the lease only on flush. If \"acquire-release\" it will acquire & complete the operation & release the lease once operation is done.", + "required": false, + "type": "string", + "enum": [ + "acquire", + "auto-renew", + "release", + "acquire-release" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + } + }, + "Prefix": { + "name": "prefix", + "in": "query", + "description": "Filters results to filesystems within the specified prefix.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "MaxResults": { + "name": "maxResults", + "in": "query", + "description": "An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items.", + "format": "int32", + "minimum": 1, + "required": false, + "type": "integer", + "x-ms-parameter-location": "method" + }, + "Properties": { + "name": "x-ms-properties", + "x-ms-client-name": "properties", + "description": "Optional. User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SourceIfMatch": { + "name": "x-ms-source-if-match", + "x-ms-client-name": "sourceIfMatch", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify an ETag value to operate only on blobs with a matching value." + }, + "SourceIfModifiedSince": { + "name": "x-ms-source-if-modified-since", + "x-ms-client-name": "sourceIfModifiedSince", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify this header value to operate only on a blob if it has been modified since the specified date/time." + }, + "SourceIfNoneMatch": { + "name": "x-ms-source-if-none-match", + "x-ms-client-name": "sourceIfNoneMatch", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify an ETag value to operate only on blobs without a matching value." + }, + "SourceIfUnmodifiedSince": { + "name": "x-ms-source-if-unmodified-since", + "x-ms-client-name": "sourceIfUnmodifiedSince", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify this header value to operate only on a blob if it has not been modified since the specified date/time." + }, + "SourceLeaseId": { + "name": "x-ms-source-lease-id", + "x-ms-client-name": "sourceLeaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "A lease ID for the source path. If specified, the source path must have an active lease and the lease ID must match." + }, + "FileSystem": { + "name": "filesystem", + "x-ms-parameter-location": "client", + "x-ms-client-name": "fileSystem", + "in": "path", + "description": "The filesystem identifier.", + "pattern": "^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$", + "minLength": 3, + "maxLength": 63, + "required": true, + "type": "string" + }, + "Path": { + "name": "path", + "x-ms-parameter-location": "client", + "in": "path", + "description": "The file or directory path.", + "required": true, + "type": "string" + }, + "CacheControl": { + "name": "x-ms-cache-control", + "x-ms-client-name": "cacheControl", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "path-HTTP-headers" + }, + "description": "Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request." + }, + "ContentDisposition": { + "name": "x-ms-content-disposition", + "x-ms-client-name": "contentDisposition", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "path-HTTP-headers" + }, + "description": "Optional. Sets the blob's Content-Disposition header." + }, + "ContentEncoding": { + "name": "x-ms-content-encoding", + "x-ms-client-name": "contentEncoding", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "path-HTTP-headers" + }, + "description": "Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request." + }, + "ContentLanguage": { + "name": "x-ms-content-language", + "x-ms-client-name": "contentLanguage", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "path-HTTP-headers" + }, + "description": "Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request." + }, + "ContentType": { + "name": "x-ms-content-type", + "x-ms-client-name": "contentType", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "path-HTTP-headers" + }, + "description": "Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request." + }, + "TransactionalContentMD5": { + "name": "Content-MD5", + "x-ms-client-name": "transactionalContentHash", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "path-HTTP-headers" + }, + "description": "Specify the transactional md5 for the body, to be validated by the service." + }, + "ContentMD5": { + "name": "x-ms-content-md5", + "x-ms-client-name": "contentMD5", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "path-HTTP-headers" + }, + "description": "Specify the transactional md5 for the body, to be validated by the service." + }, + "ContentCrc64": { + "name": "x-ms-content-crc64", + "x-ms-client-name": "transactionalContentCrc64", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "description": "Specify the transactional crc64 for the body, to be validated by the service." + }, + "StructuredBodyPut": { + "name": "x-ms-structured-body", + "x-ms-client-name": "StructuredBodyType", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Required if the request body is a structured message. Specifies the message schema version and properties." + }, + "StructuredContentLength": { + "name": "x-ms-structured-content-length", + "x-ms-client-name": "StructuredContentLength", + "in": "header", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method", + "description": "Required if the request body is a structured message. Specifies the length of the blob/file content inside the message body. Will always be smaller than Content-Length." + }, + "Umask": { + "name": "x-ms-umask", + "x-ms-client-name": "umask", + "description": "Optional and only valid if Hierarchical Namespace is enabled for the account. When creating a file or directory and the parent folder does not have a default ACL, the umask restricts the permissions of the file or directory to be created. The resulting permission is given by p bitwise and not u, where p is the permission and u is the umask. For example, if p is 0777 and u is 0057, then the resulting permission is 0720. The default permission is 0777 for a directory and 0666 for a file. The default umask is 0027. The umask must be specified in 4-digit octal notation (e.g. 0766).", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Permissions": { + "name": "x-ms-permissions", + "x-ms-client-name": "permissions", + "description": "Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "RenameSource": { + "name": "x-ms-rename-source", + "x-ms-client-name": "renameSource", + "in": "header", + "description": "An optional file or directory to be renamed. The value must have the following format: \"/{filesystem}/{path}\". If \"x-ms-properties\" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved. This value must be a URL percent-encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Owner": { + "name": "x-ms-owner", + "x-ms-client-name": "owner", + "in": "header", + "required": false, + "type": "string", + "description": "Optional. The owner of the blob or directory.", + "x-ms-parameter-location": "method" + }, + "Group": { + "name": "x-ms-group", + "x-ms-client-name": "group", + "in": "header", + "required": false, + "type": "string", + "description": "Optional. The owning group of the blob or directory.", + "x-ms-parameter-location": "method" + }, + "Acl": { + "name": "x-ms-acl", + "description": "Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries. Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format \"[scope:][type]:[id]:[permissions]\".", + "x-ms-client-name": "acl", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Body": { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "format": "file" + }, + "x-ms-parameter-location": "method", + "description": "Initial data" + }, + "Upn": { + "name": "upn", + "in": "query", + "description": "Optional. Valid only when Hierarchical Namespace is enabled for the account. If \"true\", the user identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active Directory Object IDs to User Principal Names. If \"false\", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have unique friendly names.", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "Position": { + "name": "position", + "in": "query", + "description": "This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. It is required when uploading data to be appended to the file and when flushing previously uploaded data to the file. The value must be the position where the data is to be appended. Uploaded data is not immediately flushed, or written, to the file. To flush, the previously uploaded data must be contiguous, the position parameter must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request.", + "format": "int64", + "required": false, + "type": "integer", + "x-ms-parameter-location": "method" + }, + "RetainUncommittedData": { + "name": "retainUncommittedData", + "in": "query", + "description": "Valid only for flush operations. If \"true\", uncommitted data is retained after the flush operation completes; otherwise, the uncommitted data is deleted after the flush operation. The default is false. Data at offsets less than the specified position are written to the file when flush succeeds, but this optional parameter allows data after the flush position to be retained for a future flush operation.", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "Close": { + "name": "close", + "in": "query", + "description": "Azure Storage Events allow applications to receive notifications when files change. When Azure Storage Events are enabled, a file changed event is raised. This event has a property indicating whether this is the final change to distinguish the difference between an intermediate flush to a file stream and the final close of a file stream. The close query parameter is valid only when the action is \"flush\" and change notifications are enabled. If the value of close is \"true\" and the flush operation completes successfully, the service raises a file change notification with a property indicating that this is the final update (the file stream has been closed). If \"false\" a change notification is raised indicating the file has changed. The default is false. This query parameter is set to true by the Hadoop ABFS driver to indicate that the file stream has been closed.\"", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "ContentLength": { + "name": "Content-Length", + "in": "header", + "description": "Required for \"Append Data\" and \"Flush Data\". Must be 0 for \"Flush Data\". Must be the length of the request content in bytes for \"Append Data\".", + "minimum": 0, + "required": false, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method" + }, + "PathExpiryOptions": { + "name": "x-ms-expiry-option", + "x-ms-client-name": "ExpiryOptions", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "NeverExpire", + "RelativeToCreation", + "RelativeToNow", + "Absolute" + ], + "x-ms-enum": { + "name": "PathExpiryOptions", + "modelAsString": true + }, + "x-ms-parameter-location": "method", + "description": "Required. Indicates mode of the expiry time" + }, + "PathExpiryOptionsOptional": { + "name": "x-ms-expiry-option", + "x-ms-client-name": "ExpiryOptions", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "NeverExpire", + "RelativeToCreation", + "RelativeToNow", + "Absolute" + ], + "x-ms-enum": { + "name": "PathExpiryOptions", + "modelAsString": true + }, + "x-ms-parameter-location": "method", + "description": "Required. Indicates mode of the expiry time" + }, + "PathExpiryTime": { + "name": "x-ms-expiry-time", + "x-ms-client-name": "ExpiresOn", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The time to set the blob to expiry" + }, + "UndeleteSource": { + "name": "x-ms-undelete-source", + "x-ms-client-name": "UndeleteSource", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Only for hierarchical namespace enabled accounts. Optional. The path of the soft deleted blob to undelete." + }, + "Marker": { + "name": "marker", + "in": "query", + "required": false, + "type": "string", + "description": "A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client.", + "x-ms-parameter-location": "method" + }, + "ListBlobsInclude": { + "name": "include", + "in": "query", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string", + "enum": [ + "copy", + "deleted", + "metadata", + "snapshots", + "uncommittedblobs", + "versions", + "tags" + ], + "x-ms-enum": { + "name": "ListBlobsIncludeItem", + "modelAsString": false + } + }, + "x-ms-parameter-location": "method", + "description": "Include this parameter to specify one or more datasets to include in the response." + }, + "ListBlobsShowOnly": { + "name": "showonly", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "deleted" + ], + "x-ms-enum": { + "name": "ListBlobsShowOnly", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Include this parameter to specify one or more datasets to include in the response." + }, + "Delimiter": { + "name": "delimiter", + "description": "When the request includes this parameter, the operation returns a BlobPrefix element in the response body that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string.", + "type": "string", + "x-ms-parameter-location": "method", + "in": "query", + "required": false + }, + "EncryptionKey": { + "name": "x-ms-encryption-key", + "x-ms-client-name": "encryptionKey", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "cpk-info" + }, + "description": "Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services." + }, + "EncryptionKeySha256": { + "name": "x-ms-encryption-key-sha256", + "x-ms-client-name": "encryptionKeySha256", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "cpk-info" + }, + "description": "The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided." + }, + "EncryptionAlgorithm": { + "name": "x-ms-encryption-algorithm", + "x-ms-client-name": "encryptionAlgorithm", + "type": "string", + "in": "header", + "required": false, + "enum": [ + "AES256" + ], + "x-ms-enum": { + "name": "EncryptionAlgorithmType", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "cpk-info" + }, + "description": "The algorithm used to produce the encryption key hash. Currently, the only accepted value is \"AES256\". Must be provided if the x-ms-encryption-key header is provided." + }, + "Flush": { + "name": "flush", + "type": "boolean", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "description": "If file should be flushed after the append" + }, + "EncryptionContext": { + "name": "x-ms-encryption-context", + "x-ms-client-name": "encryptionContext", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Specifies the encryption context to set on the file." + }, + "Paginated": { + "name": "paginated", + "in": "query", + "description": "If true, paginated behavior will be seen. Pagination is for the recursive ACL checks as a POSIX requirement in the server and Delete in an atomic operation once the ACL checks are completed. If false or missing, normal default behavior will kick in, which may timeout in case of very large directories due to recursive ACL checks. This new parameter is introduced for backward compatibility. ", + "x-ms-parameter-location": "method", + "required": false, + "type": "boolean" + } + }, + "definitions": { + "AclFailedEntry": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "errorMessage": { + "type": "string" + } + } + }, + "SetAccessControlRecursiveResponse": { + "type": "object", + "properties": { + "directoriesSuccessful": { + "type": "integer", + "format": "int32" + }, + "filesSuccessful": { + "type": "integer", + "format": "int32" + }, + "failureCount": { + "type": "integer", + "format": "int32" + }, + "failedEntries": { + "type": "array", + "items": { + "$ref": "#/definitions/AclFailedEntry" + } + } + } + }, + "Path": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "isDirectory": { + "default": false, + "type": "boolean" + }, + "lastModified": { + "type": "string" + }, + "eTag": { + "type": "string" + }, + "contentLength": { + "type": "integer", + "format": "int64" + }, + "owner": { + "type": "string" + }, + "group": { + "type": "string" + }, + "permissions": { + "type": "string" + }, + "EncryptionScope": { + "type": "string", + "description": "The name of the encryption scope under which the blob is encrypted." + }, + "creationTime": { + "type": "string" + }, + "expiryTime": { + "type": "string" + }, + "EncryptionContext": { + "type": "string" + } + } + }, + "PathList": { + "type": "object", + "properties": { + "paths": { + "type": "array", + "items": { + "$ref": "#/definitions/Path" + } + } + } + }, + "FileSystem": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "lastModified": { + "type": "string" + }, + "eTag": { + "type": "string" + } + } + }, + "ListBlobsHierarchySegmentResponse": { + "xml": { + "name": "EnumerationResults" + }, + "description": "An enumeration of blobs", + "type": "object", + "required": [ + "ServiceEndpoint", + "ContainerName", + "Segment" + ], + "properties": { + "ServiceEndpoint": { + "type": "string", + "xml": { + "attribute": true + } + }, + "ContainerName": { + "type": "string", + "xml": { + "attribute": true + } + }, + "Prefix": { + "type": "string" + }, + "Marker": { + "type": "string" + }, + "MaxResults": { + "type": "integer" + }, + "Delimiter": { + "type": "string" + }, + "Segment": { + "$ref": "#/definitions/BlobHierarchyListSegment" + }, + "NextMarker": { + "type": "string" + } + } + }, + "BlobHierarchyListSegment": { + "xml": { + "name": "Blobs" + }, + "type": "object", + "required": [ + "BlobItems" + ], + "properties": { + "BlobPrefixes": { + "type": "array", + "items": { + "$ref": "#/definitions/BlobPrefix" + } + }, + "BlobItems": { + "type": "array", + "items": { + "$ref": "#/definitions/BlobItemInternal" + } + } + } + }, + "BlobPrefix": { + "type": "object", + "required": [ + "Name" + ], + "properties": { + "Name": { + "type": "string" + } + } + }, + "BlobItemInternal": { + "xml": { + "name": "Blob" + }, + "description": "An Azure Storage blob", + "type": "object", + "required": [ + "Name", + "Deleted", + "Snapshot", + "Properties" + ], + "properties": { + "Name": { + "type": "string" + }, + "Deleted": { + "type": "boolean" + }, + "Snapshot": { + "type": "string" + }, + "VersionId": { + "type": "string" + }, + "IsCurrentVersion": { + "type": "boolean" + }, + "Properties": { + "$ref": "#/definitions/BlobPropertiesInternal" + }, + "DeletionId": { + "type": "string" + } + } + }, + "BlobPropertiesInternal": { + "xml": { + "name": "Properties" + }, + "description": "Properties of a blob", + "type": "object", + "required": [ + "Etag", + "Last-Modified" + ], + "properties": { + "Creation-Time": { + "type": "string", + "format": "date-time-rfc1123" + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123" + }, + "Etag": { + "type": "string" + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "Size in bytes" + }, + "Content-Type": { + "type": "string" + }, + "Content-Encoding": { + "type": "string" + }, + "Content-Language": { + "type": "string" + }, + "Content-MD5": { + "type": "string", + "format": "byte" + }, + "Content-Disposition": { + "type": "string" + }, + "Cache-Control": { + "type": "string" + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "blobSequenceNumber", + "type": "integer", + "format": "int64" + }, + "CopyId": { + "type": "string" + }, + "CopySource": { + "type": "string" + }, + "CopyProgress": { + "type": "string" + }, + "CopyCompletionTime": { + "type": "string", + "format": "date-time-rfc1123" + }, + "CopyStatusDescription": { + "type": "string" + }, + "ServerEncrypted": { + "type": "boolean" + }, + "IncrementalCopy": { + "type": "boolean" + }, + "DestinationSnapshot": { + "type": "string" + }, + "DeletedTime": { + "type": "string", + "format": "date-time-rfc1123" + }, + "RemainingRetentionDays": { + "type": "integer" + }, + "AccessTierInferred": { + "type": "boolean" + }, + "CustomerProvidedKeySha256": { + "type": "string" + }, + "EncryptionScope": { + "type": "string", + "description": "The name of the encryption scope under which the blob is encrypted." + }, + "AccessTierChangeTime": { + "type": "string", + "format": "date-time-rfc1123" + }, + "TagCount": { + "type": "integer" + }, + "Expiry-Time": { + "x-ms-client-name": "ExpiresOn", + "type": "string", + "format": "date-time-rfc1123" + }, + "Sealed": { + "x-ms-client-name": "IsSealed", + "type": "boolean" + }, + "LastAccessTime": { + "x-ms-client-name": "LastAccessedOn", + "type": "string", + "format": "date-time-rfc1123" + }, + "DeleteTime": { + "type": "string", + "format": "date-time-rfc1123" + } + } + }, + "FileSystemList": { + "type": "object", + "properties": { + "filesystems": { + "type": "array", + "items": { + "$ref": "#/definitions/FileSystem" + } + } + } + }, + "StorageError": { + "type": "object", + "properties": { + "error": { + "type": "object", + "description": "The service error response object.", + "properties": { + "Code": { + "description": "The service error code.", + "type": "string" + }, + "Message": { + "description": "The service error message.", + "type": "string" + } + } + } + } + } + } +} diff --git a/specification/storage/data-plane/Microsoft.BlobStorage/readme.md b/specification/storage/data-plane/Microsoft.BlobStorage/readme.md index 7595ea088ec1..1ea989887762 100644 --- a/specification/storage/data-plane/Microsoft.BlobStorage/readme.md +++ b/specification/storage/data-plane/Microsoft.BlobStorage/readme.md @@ -25,7 +25,7 @@ These are the global settings for the BlobStorage API. ``` yaml openapi-type: data-plane -tag: package-2024-08 +tag: package-2025-01 use-internal-constructors: true add-credentials: true ``` @@ -102,6 +102,15 @@ input-file: - stable/2024-08-04/blob.json ``` +### Tag: package-2025-01 + +These settings apply only when `--tag=package-2025-01` is specified on the command line. + +``` yaml $(tag) == 'package-2025-01' +input-file: +- stable/2025-01-05/blob.json +``` + ### Suppression ``` yaml directive: diff --git a/specification/storage/data-plane/Microsoft.BlobStorage/stable/2025-01-05/blob.json b/specification/storage/data-plane/Microsoft.BlobStorage/stable/2025-01-05/blob.json new file mode 100644 index 000000000000..b7c484e46775 --- /dev/null +++ b/specification/storage/data-plane/Microsoft.BlobStorage/stable/2025-01-05/blob.json @@ -0,0 +1,12443 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Blob Storage", + "version": "2025-01-05", + "x-ms-code-generation-settings": { + "header": "MIT", + "strictSpecAdherence": false + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{url}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "$ref": "#/parameters/Url" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "paths": {}, + "x-ms-paths": { + "/?restype=service&comp=properties": { + "put": { + "tags": [ + "service" + ], + "operationId": "Service_SetProperties", + "description": "Sets properties for a storage account's Blob service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules", + "parameters": [ + { + "$ref": "#/parameters/StorageServiceProperties" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "202": { + "description": "Success (Accepted)", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "service" + ], + "operationId": "Service_GetProperties", + "description": "gets the properties of a storage account's Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + } + }, + "schema": { + "$ref": "#/definitions/StorageServiceProperties" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "service" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/?restype=service&comp=stats": { + "get": { + "tags": [ + "service" + ], + "operationId": "Service_GetStatistics", + "description": "Retrieves statistics related to replication for the Blob service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/StorageServiceStats" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "service" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "stats" + ] + } + ] + }, + "/?comp=list": { + "get": { + "tags": [ + "service" + ], + "operationId": "Service_ListContainersSegment", + "description": "The List Containers Segment operation returns a list of the containers under the specified account", + "parameters": [ + { + "$ref": "#/parameters/Prefix" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/ListContainersInclude" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + } + }, + "schema": { + "$ref": "#/definitions/ListContainersSegmentResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "NextMarker" + } + }, + "parameters": [ + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "list" + ] + } + ] + }, + "/?restype=service&comp=userdelegationkey": { + "post": { + "tags": [ + "service" + ], + "operationId": "Service_GetUserDelegationKey", + "description": "Retrieves a user delegation key for the Blob service. This is only a valid operation when using bearer token authentication.", + "parameters": [ + { + "$ref": "#/parameters/KeyInfo" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/UserDelegationKey" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "service" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "userdelegationkey" + ] + } + ] + }, + "/?restype=account&comp=properties": { + "get": { + "tags": [ + "service" + ], + "operationId": "Service_GetAccountInfo", + "description": "Returns the sku name and account kind ", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success (OK)", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-sku-name": { + "x-ms-client-name": "SkuName", + "type": "string", + "enum": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS", + "Standard_ZRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": false + }, + "description": "Identifies the sku name of the account" + }, + "x-ms-account-kind": { + "x-ms-client-name": "AccountKind", + "type": "string", + "enum": [ + "Storage", + "BlobStorage", + "StorageV2", + "FileStorage", + "BlockBlobStorage" + ], + "x-ms-enum": { + "name": "AccountKind", + "modelAsString": false + }, + "description": "Identifies the account kind" + }, + "x-ms-is-hns-enabled": { + "x-ms-client-name": "IsHierarchicalNamespaceEnabled", + "type": "boolean", + "description": "Version 2019-07-07 and newer. Indicates if the account has a hierarchical namespace enabled." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "account" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/?comp=batch": { + "post": { + "tags": [ + "service" + ], + "operationId": "Service_SubmitBatch", + "description": "The Batch operation allows multiple API calls to be embedded into a single HTTP request.", + "parameters": [ + { + "$ref": "#/parameters/Body" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/MultipartContentType" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Content-Type": { + "type": "string", + "description": "The media type of the body of the response. For batch requests, this is multipart/mixed; boundary=batchresponse_GUID" + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + } + }, + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "batch" + ] + } + ] + }, + "/?comp=blobs": { + "get": { + "tags": [ + "service" + ], + "operationId": "Service_FilterBlobs", + "description": "The Filter Blobs operation enables callers to list blobs across all containers whose tags match a given search expression. Filter blobs searches across all containers within a storage account but can be scoped within the expression to a single container.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/FilterBlobsWhere" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/FilterBlobsInclude" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/FilterBlobSegment" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "blobs" + ] + } + ] + }, + "/{containerName}?restype=container": { + "put": { + "tags": [ + "container" + ], + "operationId": "Container_Create", + "description": "creates a new container under the specified account. If the container with the same name already exists, the operation fails", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/BlobPublicAccess" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DefaultEncryptionScope" + }, + { + "$ref": "#/parameters/DenyEncryptionScopeOverride" + } + ], + "responses": { + "201": { + "description": "Success, Container created.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "container" + ], + "operationId": "Container_GetProperties", + "description": "returns all user-defined metadata and system properties for the specified container. The data returned does not include the container's list of blobs", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "x-ms-meta": { + "type": "string", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a blob is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the blob.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the blob.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-blob-public-access": { + "x-ms-client-name": "BlobPublicAccess", + "description": "Indicated whether data in the container may be accessed publicly and the level of access", + "type": "string", + "enum": [ + "container", + "blob" + ], + "x-ms-enum": { + "name": "PublicAccessType", + "modelAsString": true + } + }, + "x-ms-has-immutability-policy": { + "x-ms-client-name": "HasImmutabilityPolicy", + "description": "Indicates whether the container has an immutability policy set on it.", + "type": "boolean" + }, + "x-ms-has-legal-hold": { + "x-ms-client-name": "HasLegalHold", + "description": "Indicates whether the container has a legal hold.", + "type": "boolean" + }, + "x-ms-default-encryption-scope": { + "x-ms-client-name": "DefaultEncryptionScope", + "description": "The default encryption scope for the container.", + "type": "string" + }, + "x-ms-deny-encryption-scope-override": { + "x-ms-client-name": "DenyEncryptionScopeOverride", + "description": "Indicates whether the container's default encryption scope can be overriden.", + "type": "boolean" + }, + "x-ms-immutable-storage-with-versioning-enabled": { + "x-ms-client-name": "IsImmutableStorageWithVersioningEnabled", + "description": "Indicates whether version level worm is enabled on a container.", + "type": "boolean" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "delete": { + "tags": [ + "container" + ], + "operationId": "Container_Delete", + "description": "operation marks the specified container for deletion. The container and any blobs contained within it are later deleted during garbage collection", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + } + ] + }, + "/{containerName}?restype=container&comp=metadata": { + "put": { + "tags": [ + "container" + ], + "operationId": "Container_SetMetadata", + "description": "operation sets one or more user-defined name-value pairs for the specified container.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "metadata" + ] + } + ] + }, + "/{containerName}?restype=container&comp=acl": { + "get": { + "tags": [ + "container" + ], + "operationId": "Container_GetAccessPolicy", + "description": "gets the permissions for the specified container. The permissions indicate whether container data may be accessed publicly.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "x-ms-blob-public-access": { + "x-ms-client-name": "BlobPublicAccess", + "description": "Indicated whether data in the container may be accessed publicly and the level of access", + "type": "string", + "enum": [ + "container", + "blob" + ], + "x-ms-enum": { + "name": "PublicAccessType", + "modelAsString": true + } + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/SignedIdentifiers" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "put": { + "tags": [ + "container" + ], + "operationId": "Container_SetAccessPolicy", + "description": "sets the permissions for the specified container. The permissions indicate whether blobs in a container may be accessed publicly.", + "parameters": [ + { + "$ref": "#/parameters/ContainerAcl" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/BlobPublicAccess" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "acl" + ] + } + ] + }, + "/{containerName}?restype=container&comp=undelete": { + "put": { + "tags": [ + "container" + ], + "operationId": "Container_Restore", + "description": "Restores a previously-deleted container.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DeletedContainerName" + }, + { + "$ref": "#/parameters/DeletedContainerVersion" + } + ], + "responses": { + "201": { + "description": "Created.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "undelete" + ] + } + ] + }, + "/{containerName}?restype=container&comp=rename": { + "put": { + "tags": [ + "container" + ], + "operationId": "Container_Rename", + "description": "Renames an existing container.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/SourceContainerName" + }, + { + "$ref": "#/parameters/SourceLeaseId" + } + ], + "responses": { + "200": { + "description": "Created.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "rename" + ] + } + ] + }, + "/{containerName}?restype=container&comp=batch": { + "post": { + "tags": [ + "container" + ], + "operationId": "Container_SubmitBatch", + "description": "The Batch operation allows multiple API calls to be embedded into a single HTTP request.", + "parameters": [ + { + "$ref": "#/parameters/Body" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/MultipartContentType" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "202": { + "description": "Success.", + "headers": { + "Content-Type": { + "type": "string", + "description": "The media type of the body of the response. For batch requests, this is multipart/mixed; boundary=batchresponse_GUID" + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + } + }, + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "batch" + ] + } + ] + }, + "/{containerName}?restype=container&comp=blobs": { + "get": { + "tags": [ + "container" + ], + "operationId": "Container_FilterBlobs", + "description": "The Filter Blobs operation enables callers to list blobs in a container whose tags match a given search expression. Filter blobs searches within the given container.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/FilterBlobsWhere" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/FilterBlobsInclude" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/FilterBlobSegment" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "blobs" + ] + } + ] + }, + "/{containerName}?comp=lease&restype=container&acquire": { + "put": { + "tags": [ + "container" + ], + "operationId": "Container_AcquireLease", + "description": "[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseDuration" + }, + { + "$ref": "#/parameters/ProposedLeaseIdOptional" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "201": { + "description": "The Acquire operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a container's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "acquire" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{containerName}?comp=lease&restype=container&release": { + "put": { + "tags": [ + "container" + ], + "operationId": "Container_ReleaseLease", + "description": "[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Release operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "release" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{containerName}?comp=lease&restype=container&renew": { + "put": { + "tags": [ + "container" + ], + "operationId": "Container_RenewLease", + "description": "[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Renew operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a container's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "renew" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{containerName}?comp=lease&restype=container&break": { + "put": { + "tags": [ + "container" + ], + "operationId": "Container_BreakLease", + "description": "[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseBreakPeriod" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "202": { + "description": "The Break operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-lease-time": { + "x-ms-client-name": "LeaseTime", + "type": "integer", + "description": "Approximate time remaining in the lease period, in seconds." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "break" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{containerName}?comp=lease&restype=container&change": { + "put": { + "tags": [ + "container" + ], + "operationId": "Container_ChangeLease", + "description": "[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/ProposedLeaseIdRequired" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Change operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a container's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "change" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{containerName}?restype=container&comp=list&flat": { + "get": { + "tags": [ + "containers" + ], + "operationId": "Container_ListBlobFlatSegment", + "description": "[Update] The List Blobs operation returns a list of the blobs under the specified container", + "parameters": [ + { + "$ref": "#/parameters/Prefix" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/ListBlobsInclude" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Content-Type": { + "type": "string", + "description": "The media type of the body of the response. For List Blobs this is 'application/xml'" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/ListBlobsFlatSegmentResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "NextMarker" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "list" + ] + } + ] + }, + "/{containerName}?restype=container&comp=list&hierarchy": { + "get": { + "tags": [ + "containers" + ], + "operationId": "Container_ListBlobHierarchySegment", + "description": "[Update] The List Blobs operation returns a list of the blobs under the specified container", + "parameters": [ + { + "$ref": "#/parameters/Prefix" + }, + { + "$ref": "#/parameters/Delimiter" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/ListBlobsInclude" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Content-Type": { + "type": "string", + "description": "The media type of the body of the response. For List Blobs this is 'application/xml'" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/ListBlobsHierarchySegmentResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "NextMarker" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "list" + ] + } + ] + }, + "/{containerName}?restype=account&comp=properties": { + "get": { + "tags": [ + "container" + ], + "operationId": "Container_GetAccountInfo", + "description": "Returns the sku name and account kind ", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success (OK)", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-sku-name": { + "x-ms-client-name": "SkuName", + "type": "string", + "enum": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS", + "Standard_ZRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": false + }, + "description": "Identifies the sku name of the account" + }, + "x-ms-account-kind": { + "x-ms-client-name": "AccountKind", + "type": "string", + "enum": [ + "Storage", + "BlobStorage", + "StorageV2", + "FileStorage", + "BlockBlobStorage" + ], + "x-ms-enum": { + "name": "AccountKind", + "modelAsString": false + }, + "description": "Identifies the account kind" + }, + "x-ms-is-hns-enabled": { + "x-ms-client-name": "IsHierarchicalNamespaceEnabled", + "type": "boolean", + "description": "Version 2019-07-07 and newer. Indicates if the account has a hierarchical namespace enabled." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "account" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/{containerName}/{blob}": { + "get": { + "tags": [ + "blob" + ], + "operationId": "Blob_Download", + "description": "The Download operation reads or downloads a blob from the system, including its metadata and properties. You can also call Download to read a snapshot.", + "parameters": [ + { + "$ref": "#/parameters/Snapshot" + }, + { + "$ref": "#/parameters/VersionId" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Range" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/GetRangeContentMD5" + }, + { + "$ref": "#/parameters/GetRangeContentCRC64" + }, + { + "$ref": "#/parameters/StructuredBodyGet" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Returns the content of the entire blob.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-creation-time": { + "x-ms-client-name": "CreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the blob was created." + }, + "x-ms-meta": { + "type": "string", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "x-ms-or-policy-id": { + "x-ms-client-name": "ObjectReplicationPolicyId", + "type": "string", + "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication." + }, + "x-ms-or": { + "type": "string", + "x-ms-client-name": "ObjectReplicationRules", + "x-ms-header-collection-prefix": "x-ms-or-", + "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed)." + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The number of bytes present in the response body." + }, + "Content-Type": { + "type": "string", + "description": "The media type of the body of the response. For Download Blob this is 'application/octet-stream'" + }, + "Content-Range": { + "type": "string", + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "Content-Encoding": { + "type": "string", + "description": "This header returns the value that was specified for the Content-Encoding request header" + }, + "Cache-Control": { + "type": "string", + "description": "This header is returned if it was previously specified for the blob." + }, + "Content-Disposition": { + "type": "string", + "description": "This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified." + }, + "Content-Language": { + "type": "string", + "description": "This header returns the value that was specified for the Content-Language request header." + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", + "type": "integer", + "format": "int64", + "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs" + }, + "x-ms-blob-type": { + "x-ms-client-name": "BlobType", + "description": "The blob's type.", + "type": "string", + "enum": [ + "BlockBlob", + "PageBlob", + "AppendBlob" + ], + "x-ms-enum": { + "name": "BlobType", + "modelAsString": false + } + }, + "x-ms-copy-completion-time": { + "x-ms-client-name": "CopyCompletionTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." + }, + "x-ms-copy-status-description": { + "x-ms-client-name": "CopyStatusDescription", + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy." + }, + "x-ms-copy-progress": { + "x-ms-client-name": "CopyProgress", + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" + }, + "x-ms-copy-source": { + "x-ms-client-name": "CopySource", + "type": "string", + "description": "URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by x-ms-copy-id.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a blob is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the blob.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the blob.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "x-ms-version-id": { + "x-ms-client-name": "VersionId", + "type": "string", + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "x-ms-is-current-version": { + "x-ms-client-name": "IsCurrentVersion", + "type": "boolean", + "description": "The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header." + }, + "Accept-Ranges": { + "type": "string", + "description": "Indicates that the service supports requests for partial blob content." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-blob-committed-block-count": { + "x-ms-client-name": "BlobCommittedBlockCount", + "type": "integer", + "description": "The number of committed blocks present in the blob. This header is returned only for append blobs." + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted)." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + }, + "x-ms-blob-content-md5": { + "x-ms-client-name": "BlobContentMD5", + "type": "string", + "format": "byte", + "description": "If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range" + }, + "x-ms-tag-count": { + "x-ms-client-name": "TagCount", + "type": "integer", + "format": "int64", + "description": "The number of tags associated with the blob" + }, + "x-ms-blob-sealed": { + "x-ms-client-name": "IsSealed", + "type": "boolean", + "description": "If this blob has been sealed" + }, + "x-ms-last-access-time": { + "x-ms-client-name": "LastAccessed", + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the blob was last read or written to" + }, + "x-ms-immutability-policy-until-date": { + "x-ms-client-name": "ImmutabilityPolicyExpiresOn", + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire." + }, + "x-ms-immutability-policy-mode": { + "x-ms-client-name": "ImmutabilityPolicyMode", + "type": "string", + "enum": [ + "Mutable", + "Unlocked", + "Locked" + ], + "x-ms-enum": { + "name": "BlobImmutabilityPolicyMode", + "modelAsString": false + }, + "description": "Indicates immutability policy mode." + }, + "x-ms-legal-hold": { + "x-ms-client-name": "LegalHold", + "type": "boolean", + "description": "Indicates if a legal hold is present on the blob." + }, + "x-ms-structured-body": { + "x-ms-client-name": "StructuredBodyType", + "type": "string", + "description": "Indicates the response body contains a structured message and specifies the message schema version and properties." + }, + "x-ms-structured-content-length": { + "x-ms-client-name": "StructuredContentLength", + "type": "integer", + "format": "int64", + "description": "The length of the blob/file content inside the message body when the response body is returned as a structured message. Will always be smaller than Content-Length." + } + }, + "schema": { + "type": "object", + "format": "file" + } + }, + "206": { + "description": "Returns the content of a specified range of the blob.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-creation-time": { + "x-ms-client-name": "CreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the blob was created." + }, + "x-ms-meta": { + "type": "string", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "x-ms-or-policy-id": { + "x-ms-client-name": "ObjectReplicationPolicyId", + "type": "string", + "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication." + }, + "x-ms-or": { + "type": "string", + "x-ms-client-name": "ObjectReplicationRules", + "x-ms-header-collection-prefix": "x-ms-or-", + "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed)." + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The number of bytes present in the response body." + }, + "Content-Type": { + "type": "string", + "description": "The media type of the body of the response. For Download Blob this is 'application/octet-stream'" + }, + "Content-Range": { + "type": "string", + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "Content-Encoding": { + "type": "string", + "description": "This header returns the value that was specified for the Content-Encoding request header" + }, + "Cache-Control": { + "type": "string", + "description": "This header is returned if it was previously specified for the blob." + }, + "Content-Disposition": { + "type": "string", + "description": "This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified." + }, + "Content-Language": { + "type": "string", + "description": "This header returns the value that was specified for the Content-Language request header." + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", + "type": "integer", + "format": "int64", + "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs" + }, + "x-ms-blob-type": { + "x-ms-client-name": "BlobType", + "description": "The blob's type.", + "type": "string", + "enum": [ + "BlockBlob", + "PageBlob", + "AppendBlob" + ], + "x-ms-enum": { + "name": "BlobType", + "modelAsString": false + } + }, + "x-ms-content-crc64": { + "x-ms-client-name": "ContentCrc64", + "type": "string", + "format": "byte", + "description": "If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad Request)" + }, + "x-ms-copy-completion-time": { + "x-ms-client-name": "CopyCompletionTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." + }, + "x-ms-copy-status-description": { + "x-ms-client-name": "CopyStatusDescription", + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy." + }, + "x-ms-copy-progress": { + "x-ms-client-name": "CopyProgress", + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" + }, + "x-ms-copy-source": { + "x-ms-client-name": "CopySource", + "type": "string", + "description": "URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by x-ms-copy-id.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a blob is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the blob.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the blob.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "x-ms-version-id": { + "x-ms-client-name": "VersionId", + "type": "string", + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "x-ms-is-current-version": { + "x-ms-client-name": "IsCurrentVersion", + "type": "boolean", + "description": "The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header." + }, + "Accept-Ranges": { + "type": "string", + "description": "Indicates that the service supports requests for partial blob content." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-blob-committed-block-count": { + "x-ms-client-name": "BlobCommittedBlockCount", + "type": "integer", + "description": "The number of committed blocks present in the blob. This header is returned only for append blobs." + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted)." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + }, + "x-ms-blob-content-md5": { + "x-ms-client-name": "BlobContentMD5", + "type": "string", + "format": "byte", + "description": "If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range" + }, + "x-ms-tag-count": { + "x-ms-client-name": "TagCount", + "type": "integer", + "format": "int64", + "description": "The number of tags associated with the blob" + }, + "x-ms-blob-sealed": { + "x-ms-client-name": "IsSealed", + "type": "boolean", + "description": "If this blob has been sealed" + }, + "x-ms-last-access-time": { + "x-ms-client-name": "LastAccessed", + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the blob was last read or written to" + }, + "x-ms-immutability-policy-until-date": { + "x-ms-client-name": "ImmutabilityPolicyExpiresOn", + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire." + }, + "x-ms-immutability-policy-mode": { + "x-ms-client-name": "ImmutabilityPolicyMode", + "type": "string", + "description": "Indicates immutability policy mode." + }, + "x-ms-legal-hold": { + "x-ms-client-name": "LegalHold", + "type": "boolean", + "description": "Indicates if a legal hold is present on the blob." + }, + "x-ms-structured-body": { + "x-ms-client-name": "StructuredBodyType", + "type": "string", + "description": "Indicates the response body contains a structured message and specifies the message schema version and properties." + }, + "x-ms-structured-content-length": { + "x-ms-client-name": "StructuredContentLength", + "type": "integer", + "format": "int64", + "description": "The length of the blob/file content inside the message body when the response body is returned as a structured message. Will always be smaller than Content-Length." + } + }, + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "head": { + "tags": [ + "blob" + ], + "operationId": "Blob_GetProperties", + "description": "The Get Properties operation returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob.", + "parameters": [ + { + "$ref": "#/parameters/Snapshot" + }, + { + "$ref": "#/parameters/VersionId" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Returns the properties of the blob.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-creation-time": { + "x-ms-client-name": "CreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the blob was created." + }, + "x-ms-meta": { + "type": "string", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "x-ms-or-policy-id": { + "x-ms-client-name": "ObjectReplicationPolicyId", + "type": "string", + "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication." + }, + "x-ms-or": { + "type": "string", + "x-ms-client-name": "ObjectReplicationRules", + "x-ms-header-collection-prefix": "x-ms-or-", + "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed)." + }, + "x-ms-blob-type": { + "x-ms-client-name": "BlobType", + "description": "The blob's type.", + "type": "string", + "enum": [ + "BlockBlob", + "PageBlob", + "AppendBlob" + ], + "x-ms-enum": { + "name": "BlobType", + "modelAsString": false + } + }, + "x-ms-copy-completion-time": { + "x-ms-client-name": "CopyCompletionTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." + }, + "x-ms-copy-status-description": { + "x-ms-client-name": "CopyStatusDescription", + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy." + }, + "x-ms-copy-progress": { + "x-ms-client-name": "CopyProgress", + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" + }, + "x-ms-copy-source": { + "x-ms-client-name": "CopySource", + "type": "string", + "description": "URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by x-ms-copy-id.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + }, + "x-ms-incremental-copy": { + "x-ms-client-name": "IsIncrementalCopy", + "type": "boolean", + "description": "Included if the blob is incremental copy blob." + }, + "x-ms-copy-destination-snapshot": { + "x-ms-client-name": "DestinationSnapshot", + "type": "string", + "description": "Included if the blob is incremental copy blob or incremental copy snapshot, if x-ms-copy-status is success. Snapshot time of the last successful incremental copy snapshot for this blob." + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a blob is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the blob.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the blob.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The number of bytes present in the response body." + }, + "Content-Type": { + "type": "string", + "description": "The content type specified for the blob. The default content type is 'application/octet-stream'" + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "Content-Encoding": { + "type": "string", + "description": "This header returns the value that was specified for the Content-Encoding request header" + }, + "Content-Disposition": { + "type": "string", + "description": "This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified." + }, + "Content-Language": { + "type": "string", + "description": "This header returns the value that was specified for the Content-Language request header." + }, + "Cache-Control": { + "type": "string", + "description": "This header is returned if it was previously specified for the blob." + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", + "type": "integer", + "format": "int64", + "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "Accept-Ranges": { + "type": "string", + "description": "Indicates that the service supports requests for partial blob content." + }, + "x-ms-blob-committed-block-count": { + "x-ms-client-name": "BlobCommittedBlockCount", + "type": "integer", + "description": "The number of committed blocks present in the blob. This header is returned only for append blobs." + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted)." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the metadata. This header is only returned when the metadata was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + }, + "x-ms-access-tier": { + "x-ms-client-name": "AccessTier", + "type": "string", + "description": "The tier of page blob on a premium storage account or tier of block blob on blob storage LRS accounts. For a list of allowed premium page blob tiers, see https://docs.microsoft.com/en-us/azure/virtual-machines/windows/premium-storage#features. For blob storage LRS accounts, valid values are Hot/Cool/Archive." + }, + "x-ms-access-tier-inferred": { + "x-ms-client-name": "AccessTierInferred", + "type": "boolean", + "description": "For page blobs on a premium storage account only. If the access tier is not explicitly set on the blob, the tier is inferred based on its content length and this header will be returned with true value." + }, + "x-ms-archive-status": { + "x-ms-client-name": "ArchiveStatus", + "type": "string", + "description": "For blob storage LRS accounts, valid values are rehydrate-pending-to-hot/rehydrate-pending-to-cool. If the blob is being rehydrated and is not complete then this header is returned indicating that rehydrate is pending and also tells the destination tier." + }, + "x-ms-access-tier-change-time": { + "x-ms-client-name": "AccessTierChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the tier was changed on the object. This is only returned if the tier on the block blob was ever set." + }, + "x-ms-version-id": { + "x-ms-client-name": "VersionId", + "type": "string", + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "x-ms-is-current-version": { + "x-ms-client-name": "IsCurrentVersion", + "type": "boolean", + "description": "The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header." + }, + "x-ms-tag-count": { + "x-ms-client-name": "TagCount", + "type": "integer", + "format": "int64", + "description": "The number of tags associated with the blob" + }, + "x-ms-expiry-time": { + "x-ms-client-name": "ExpiresOn", + "type": "string", + "format": "date-time-rfc1123", + "description": "The time this blob will expire." + }, + "x-ms-blob-sealed": { + "x-ms-client-name": "IsSealed", + "type": "boolean", + "description": "If this blob has been sealed" + }, + "x-ms-rehydrate-priority": { + "x-ms-client-name": "RehydratePriority", + "description": "If an object is in rehydrate pending state then this header is returned with priority of rehydrate. Valid values are High and Standard.", + "type": "string" + }, + "x-ms-last-access-time": { + "x-ms-client-name": "LastAccessed", + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the blob was last read or written to" + }, + "x-ms-immutability-policy-until-date": { + "x-ms-client-name": "ImmutabilityPolicyExpiresOn", + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire." + }, + "x-ms-immutability-policy-mode": { + "x-ms-client-name": "ImmutabilityPolicyMode", + "type": "string", + "enum": [ + "Mutable", + "Unlocked", + "Locked" + ], + "x-ms-enum": { + "name": "BlobImmutabilityPolicyMode", + "modelAsString": false + }, + "description": "Indicates immutability policy mode." + }, + "x-ms-legal-hold": { + "x-ms-client-name": "LegalHold", + "type": "boolean", + "description": "Indicates if a legal hold is present on the blob." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "delete": { + "tags": [ + "blob" + ], + "operationId": "Blob_Delete", + "description": "If the storage account's soft delete feature is disabled then, when a blob is deleted, it is permanently removed from the storage account. If the storage account's soft delete feature is enabled, then, when a blob is deleted, it is marked for deletion and becomes inaccessible immediately. However, the blob service retains the blob or snapshot for the number of days specified by the DeleteRetentionPolicy section of [Storage service properties] (Set-Blob-Service-Properties.md). After the specified number of days has passed, the blob's data is permanently removed from the storage account. Note that you continue to be charged for the soft-deleted blob's storage until it is permanently removed. Use the List Blobs API and specify the \"include=deleted\" query parameter to discover which blobs and snapshots have been soft deleted. You can then use the Undelete Blob API to restore a soft-deleted blob. All other operations on a soft-deleted blob or snapshot causes the service to return an HTTP status code of 404 (ResourceNotFound).", + "parameters": [ + { + "$ref": "#/parameters/Snapshot" + }, + { + "$ref": "#/parameters/VersionId" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/DeleteSnapshots" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/BlobDeleteType" + } + ], + "responses": { + "202": { + "description": "The delete request was accepted and the blob will be deleted.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + } + ] + }, + "/{containerName}/{blob}?PageBlob": { + "put": { + "tags": [ + "blob" + ], + "operationId": "PageBlob_Create", + "description": "The Create operation creates a new page blob.", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/PremiumPageBlobAccessTierOptional" + }, + { + "$ref": "#/parameters/BlobContentType" + }, + { + "$ref": "#/parameters/BlobContentEncoding" + }, + { + "$ref": "#/parameters/BlobContentLanguage" + }, + { + "$ref": "#/parameters/BlobContentMD5" + }, + { + "$ref": "#/parameters/BlobCacheControl" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/BlobContentDisposition" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/BlobContentLengthRequired" + }, + { + "$ref": "#/parameters/BlobSequenceNumber" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/BlobTagsHeader" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyExpiry" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyMode" + }, + { + "$ref": "#/parameters/LegalHoldOptional" + } + ], + "responses": { + "201": { + "description": "The blob was created.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "x-ms-version-id": { + "x-ms-client-name": "VersionId", + "type": "string", + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "x-ms-blob-type", + "x-ms-client-name": "blobType", + "in": "header", + "required": true, + "x-ms-parameter-location": "method", + "description": "Specifies the type of blob to create: block blob, page blob, or append blob.", + "type": "string", + "enum": [ + "PageBlob" + ], + "x-ms-enum": { + "name": "BlobType", + "modelAsString": false + } + } + ] + }, + "/{containerName}/{blob}?AppendBlob": { + "put": { + "tags": [ + "blob" + ], + "operationId": "AppendBlob_Create", + "description": "The Create Append Blob operation creates a new append blob.", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/BlobContentType" + }, + { + "$ref": "#/parameters/BlobContentEncoding" + }, + { + "$ref": "#/parameters/BlobContentLanguage" + }, + { + "$ref": "#/parameters/BlobContentMD5" + }, + { + "$ref": "#/parameters/BlobCacheControl" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/BlobContentDisposition" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/BlobTagsHeader" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyExpiry" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyMode" + }, + { + "$ref": "#/parameters/LegalHoldOptional" + } + ], + "responses": { + "201": { + "description": "The blob was created.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "x-ms-version-id": { + "x-ms-client-name": "VersionId", + "type": "string", + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "x-ms-blob-type", + "x-ms-client-name": "blobType", + "in": "header", + "required": true, + "x-ms-parameter-location": "method", + "description": "Specifies the type of blob to create: block blob, page blob, or append blob.", + "type": "string", + "enum": [ + "AppendBlob" + ], + "x-ms-enum": { + "name": "BlobType", + "modelAsString": false + } + } + ] + }, + "/{containerName}/{blob}?BlockBlob": { + "put": { + "tags": [ + "blob" + ], + "operationId": "BlockBlob_Upload", + "description": "The Upload Block Blob operation updates the content of an existing block blob. Updating an existing block blob overwrites any existing metadata on the blob. Partial updates are not supported with Put Blob; the content of the existing blob is overwritten with the content of the new blob. To perform a partial update of the content of a block blob, use the Put Block List operation.", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/Body" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ContentMD5" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/BlobContentType" + }, + { + "$ref": "#/parameters/BlobContentEncoding" + }, + { + "$ref": "#/parameters/BlobContentLanguage" + }, + { + "$ref": "#/parameters/BlobContentMD5" + }, + { + "$ref": "#/parameters/BlobCacheControl" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/BlobContentDisposition" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/AccessTierOptional" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/BlobTagsHeader" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyExpiry" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyMode" + }, + { + "$ref": "#/parameters/LegalHoldOptional" + }, + { + "$ref": "#/parameters/ContentCrc64" + }, + { + "$ref": "#/parameters/StructuredBodyPut" + }, + { + "$ref": "#/parameters/StructuredContentLength" + } + ], + "responses": { + "201": { + "description": "The blob was updated.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "x-ms-version-id": { + "x-ms-client-name": "VersionId", + "type": "string", + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + }, + "x-ms-structured-body": { + "x-ms-client-name": "StructuredBodyType", + "type": "string", + "description": "Indicates the structured message body was accepted and mirrors back the message schema version and properties." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "x-ms-blob-type", + "x-ms-client-name": "blobType", + "in": "header", + "required": true, + "x-ms-parameter-location": "method", + "description": "Specifies the type of blob to create: block blob, page blob, or append blob.", + "type": "string", + "enum": [ + "BlockBlob" + ], + "x-ms-enum": { + "name": "BlobType", + "modelAsString": false + } + } + ] + }, + "/{containerName}/{blob}?BlockBlob&fromUrl": { + "put": { + "tags": [ + "blob" + ], + "operationId": "BlockBlob_PutBlobFromUrl", + "description": "The Put Blob from URL operation creates a new Block Blob where the contents of the blob are read from a given URL. This API is supported beginning with the 2020-04-08 version. Partial updates are not supported with Put Blob from URL; the content of an existing blob is overwritten with the content of the new blob. To perform partial updates to a block blob’s contents using a source URL, use the Put Block from URL API in conjunction with Put Block List.", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ContentMD5" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/BlobContentType" + }, + { + "$ref": "#/parameters/BlobContentEncoding" + }, + { + "$ref": "#/parameters/BlobContentLanguage" + }, + { + "$ref": "#/parameters/BlobContentMD5" + }, + { + "$ref": "#/parameters/BlobCacheControl" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/BlobContentDisposition" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/AccessTierOptional" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/SourceIfModifiedSince" + }, + { + "$ref": "#/parameters/SourceIfUnmodifiedSince" + }, + { + "$ref": "#/parameters/SourceIfMatch" + }, + { + "$ref": "#/parameters/SourceIfNoneMatch" + }, + { + "$ref": "#/parameters/SourceIfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/SourceContentMD5" + }, + { + "$ref": "#/parameters/BlobTagsHeader" + }, + { + "$ref": "#/parameters/CopySource" + }, + { + "$ref": "#/parameters/CopySourceBlobProperties" + }, + { + "$ref": "#/parameters/CopySourceAuthorization" + }, + { + "$ref": "#/parameters/CopySourceTags" + } + ], + "responses": { + "201": { + "description": "The blob was updated.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "x-ms-version-id": { + "x-ms-client-name": "VersionId", + "type": "string", + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "x-ms-blob-type", + "x-ms-client-name": "blobType", + "in": "header", + "required": true, + "x-ms-parameter-location": "method", + "description": "Specifies the type of blob to create: block blob, page blob, or append blob.", + "type": "string", + "enum": [ + "BlockBlob" + ], + "x-ms-enum": { + "name": "BlobType", + "modelAsString": false + } + } + ] + }, + "/{containerName}/{blob}?comp=undelete": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_Undelete", + "description": "Undelete a blob that was previously soft deleted", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The blob was undeleted successfully.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "undelete" + ] + } + ] + }, + "/{containerName}/{blob}?comp=expiry": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_SetExpiry", + "description": "Sets the time a blob will expire and be deleted.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/BlobExpiryOptions" + }, + { + "$ref": "#/parameters/BlobExpiryTime" + } + ], + "responses": { + "200": { + "description": "The blob expiry was set successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "expiry" + ] + } + ] + }, + "/{containerName}/{blob}?comp=properties&SetHTTPHeaders": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_SetHTTPHeaders", + "description": "The Set HTTP Headers operation sets system properties on the blob", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/BlobCacheControl" + }, + { + "$ref": "#/parameters/BlobContentType" + }, + { + "$ref": "#/parameters/BlobContentMD5" + }, + { + "$ref": "#/parameters/BlobContentEncoding" + }, + { + "$ref": "#/parameters/BlobContentLanguage" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/BlobContentDisposition" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The properties were set successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", + "type": "integer", + "format": "int64", + "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/{containerName}/{blob}?comp=immutabilityPolicies": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_SetImmutabilityPolicy", + "description": "The Set Immutability Policy operation sets the immutability policy on the blob", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyExpiry" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyMode" + }, + { + "$ref": "#/parameters/Snapshot" + }, + { + "$ref": "#/parameters/VersionId" + } + ], + "responses": { + "200": { + "description": "The immutability policy was successfully set.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-immutability-policy-until-date": { + "x-ms-client-name": "ImmutabilityPolicyExpiry", + "type": "string", + "format": "date-time-rfc1123", + "description": "Indicates the time the immutability policy will expire." + }, + "x-ms-immutability-policy-mode": { + "x-ms-client-name": "ImmutabilityPolicyMode", + "type": "string", + "enum": [ + "Mutable", + "Unlocked", + "Locked" + ], + "x-ms-enum": { + "name": "BlobImmutabilityPolicyMode", + "modelAsString": false + }, + "description": "Indicates immutability policy mode." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "delete": { + "tags": [ + "blob" + ], + "operationId": "Blob_DeleteImmutabilityPolicy", + "description": "The Delete Immutability Policy operation deletes the immutability policy on the blob", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/Snapshot" + }, + { + "$ref": "#/parameters/VersionId" + } + ], + "responses": { + "200": { + "description": "The delete immutability policy request was accepted and the immutability policy will be deleted.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "immutabilityPolicies" + ] + } + ] + }, + "/{containerName}/{blob}?comp=legalhold": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_SetLegalHold", + "description": "The Set Legal Hold operation sets a legal hold on the blob.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/LegalHoldRequired" + }, + { + "$ref": "#/parameters/Snapshot" + }, + { + "$ref": "#/parameters/VersionId" + } + ], + "responses": { + "200": { + "description": "The legal hold was successfully set on the blob.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-legal-hold": { + "x-ms-client-name": "LegalHold", + "type": "boolean", + "description": "Indicates if the blob has a legal hold." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "legalhold" + ] + } + ] + }, + "/{containerName}/{blob}?comp=metadata": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_SetMetadata", + "description": "The Set Blob Metadata operation sets user-defined metadata for the specified blob as one or more name-value pairs", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The metadata was set successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "x-ms-version-id": { + "x-ms-client-name": "VersionId", + "type": "string", + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the metadata. This header is only returned when the metadata was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "metadata" + ] + } + ] + }, + "/{containerName}/{blob}?comp=lease&acquire": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_AcquireLease", + "description": "[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseDuration" + }, + { + "$ref": "#/parameters/ProposedLeaseIdOptional" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "201": { + "description": "The Acquire operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a blobs' lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "acquire" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{containerName}/{blob}?comp=lease&release": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_ReleaseLease", + "description": "[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Release operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "release" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{containerName}/{blob}?comp=lease&renew": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_RenewLease", + "description": "[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Renew operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a blobs' lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "renew" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{containerName}/{blob}?comp=lease&change": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_ChangeLease", + "description": "[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/ProposedLeaseIdRequired" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Change operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a blobs' lease" + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "change" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{containerName}/{blob}?comp=lease&break": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_BreakLease", + "description": "[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseBreakPeriod" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "202": { + "description": "The Break operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-lease-time": { + "x-ms-client-name": "LeaseTime", + "type": "integer", + "description": "Approximate time remaining in the lease period, in seconds." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "break" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{containerName}/{blob}?comp=snapshot": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_CreateSnapshot", + "description": "The Create Snapshot operation creates a read-only snapshot of a blob", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "201": { + "description": "The snaptshot was taken successfully.", + "headers": { + "x-ms-snapshot": { + "x-ms-client-name": "Snapshot", + "type": "string", + "description": "Uniquely identifies the snapshot and indicates the snapshot version. It may be used in subsequent requests to access the snapshot" + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "x-ms-version-id": { + "x-ms-client-name": "VersionId", + "type": "string", + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "True if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. For a snapshot request, this header is set to true when metadata was provided in the request and encrypted with a customer-provided key." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "snapshot" + ] + } + ] + }, + "/{containerName}/{blob}?comp=copy": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_StartCopyFromURL", + "description": "The Start Copy From URL operation copies a blob or an internet resource to a new blob.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/AccessTierOptional" + }, + { + "$ref": "#/parameters/RehydratePriority" + }, + { + "$ref": "#/parameters/SourceIfModifiedSince" + }, + { + "$ref": "#/parameters/SourceIfUnmodifiedSince" + }, + { + "$ref": "#/parameters/SourceIfMatch" + }, + { + "$ref": "#/parameters/SourceIfNoneMatch" + }, + { + "$ref": "#/parameters/SourceIfTags" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/CopySource" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/BlobTagsHeader" + }, + { + "$ref": "#/parameters/SealBlob" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyExpiry" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyMode" + }, + { + "$ref": "#/parameters/LegalHoldOptional" + } + ], + "responses": { + "202": { + "description": "The copy blob has been accepted with the specified copy status.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "x-ms-version-id": { + "x-ms-client-name": "VersionId", + "type": "string", + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by x-ms-copy-id.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + } + ] + }, + "/{containerName}/{blob}?comp=copy&sync": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_CopyFromURL", + "description": "The Copy From URL operation copies a blob or an internet resource to a new blob. It will not return a response until the copy is complete.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/AccessTierOptional" + }, + { + "$ref": "#/parameters/SourceIfModifiedSince" + }, + { + "$ref": "#/parameters/SourceIfUnmodifiedSince" + }, + { + "$ref": "#/parameters/SourceIfMatch" + }, + { + "$ref": "#/parameters/SourceIfNoneMatch" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/CopySource" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/SourceContentMD5" + }, + { + "$ref": "#/parameters/BlobTagsHeader" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyExpiry" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyMode" + }, + { + "$ref": "#/parameters/LegalHoldOptional" + }, + { + "$ref": "#/parameters/CopySourceAuthorization" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/CopySourceTags" + } + ], + "responses": { + "202": { + "description": "The copy has completed.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "x-ms-version-id": { + "x-ms-client-name": "VersionId", + "type": "string", + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for this copy operation." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by x-ms-copy-id.", + "type": "string", + "enum": [ + "success" + ], + "x-ms-enum": { + "name": "SyncCopyStatusType", + "modelAsString": false + } + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "This response header is returned so that the client can check for the integrity of the copied content. This header is only returned if the source content MD5 was specified." + }, + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "This response header is returned so that the client can check for the integrity of the copied content." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "x-ms-requires-sync", + "description": "This header indicates that this is a synchronous Copy Blob From URL instead of a Asynchronous Copy Blob.", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "true" + ] + } + ] + }, + "/{containerName}/{blob}?comp=copy©id": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_AbortCopyFromURL", + "description": "The Abort Copy From URL operation aborts a pending Copy From URL operation, and leaves a destination blob with zero length and full metadata.", + "parameters": [ + { + "$ref": "#/parameters/CopyId" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "204": { + "description": "The delete request was accepted and the blob will be deleted.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "copy" + ] + }, + { + "name": "x-ms-copy-action", + "description": "Copy action.", + "x-ms-client-name": "copyActionAbortConstant", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "abort" + ], + "x-ms-parameter-location": "method" + } + ] + }, + "/{containerName}/{blob}?comp=tier": { + "put": { + "tags": [ + "blobs" + ], + "operationId": "Blob_SetTier", + "description": "The Set Tier operation sets the tier on a blob. The operation is allowed on a page blob in a premium storage account and on a block blob in a blob storage account (locally redundant storage only). A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag.", + "parameters": [ + { + "$ref": "#/parameters/Snapshot" + }, + { + "$ref": "#/parameters/VersionId" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/AccessTierRequired" + }, + { + "$ref": "#/parameters/RehydratePriority" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/IfTags" + } + ], + "responses": { + "200": { + "description": "The new tier will take effect immediately.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and newer." + } + } + }, + "202": { + "description": "The transition to the new tier is pending.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and newer." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "tier" + ] + } + ] + }, + "/{containerName}/{blob}?restype=account&comp=properties&blob": { + "get": { + "tags": [ + "blob" + ], + "operationId": "Blob_GetAccountInfo", + "description": "Returns the sku name and account kind ", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success (OK)", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-sku-name": { + "x-ms-client-name": "SkuName", + "type": "string", + "enum": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS", + "Standard_ZRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": false + }, + "description": "Identifies the sku name of the account" + }, + "x-ms-account-kind": { + "x-ms-client-name": "AccountKind", + "type": "string", + "enum": [ + "Storage", + "BlobStorage", + "StorageV2", + "FileStorage", + "BlockBlobStorage" + ], + "x-ms-enum": { + "name": "AccountKind", + "modelAsString": false + }, + "description": "Identifies the account kind" + }, + "x-ms-is-hns-enabled": { + "x-ms-client-name": "IsHierarchicalNamespaceEnabled", + "type": "boolean", + "description": "Version 2019-07-07 and newer. Indicates if the account has a hierarchical namespace enabled." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "account" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/{containerName}/{blob}?comp=block": { + "put": { + "tags": [ + "blockblob" + ], + "operationId": "BlockBlob_StageBlock", + "description": "The Stage Block operation creates a new block to be committed as part of a blob", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/BlockId" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/ContentMD5" + }, + { + "$ref": "#/parameters/ContentCrc64" + }, + { + "$ref": "#/parameters/Body" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/StructuredBodyPut" + }, + { + "$ref": "#/parameters/StructuredContentLength" + } + ], + "responses": { + "201": { + "description": "The block was created.", + "headers": { + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the block. This header is only returned when the block was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + }, + "x-ms-structured-body": { + "x-ms-client-name": "StructuredBodyType", + "type": "string", + "description": "Indicates the structured message body was accepted and mirrors back the message schema version and properties." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "block" + ] + } + ] + }, + "/{containerName}/{blob}?comp=block&fromURL": { + "put": { + "tags": [ + "blockblob" + ], + "operationId": "BlockBlob_StageBlockFromURL", + "description": "The Stage Block operation creates a new block to be committed as part of a blob where the contents are read from a URL.", + "parameters": [ + { + "$ref": "#/parameters/BlockId" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/SourceUrl" + }, + { + "$ref": "#/parameters/SourceRange" + }, + { + "$ref": "#/parameters/SourceContentMD5" + }, + { + "$ref": "#/parameters/SourceContentCRC64" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/SourceIfModifiedSince" + }, + { + "$ref": "#/parameters/SourceIfUnmodifiedSince" + }, + { + "$ref": "#/parameters/SourceIfMatch" + }, + { + "$ref": "#/parameters/SourceIfNoneMatch" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/CopySourceAuthorization" + } + ], + "responses": { + "201": { + "description": "The block was created.", + "headers": { + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers." + }, + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the block. This header is only returned when the block was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "block" + ] + } + ] + }, + "/{containerName}/{blob}?comp=blocklist": { + "put": { + "tags": [ + "blockblob" + ], + "operationId": "BlockBlob_CommitBlockList", + "description": "The Commit Block List operation writes a blob by specifying the list of block IDs that make up the blob. In order to be written as part of a blob, a block must have been successfully written to the server in a prior Put Block operation. You can call Put Block List to update a blob by uploading only those blocks that have changed, then committing the new and existing blocks together. You can do this by specifying whether to commit a block from the committed block list or from the uncommitted block list, or to commit the most recently uploaded version of the block, whichever list it may belong to.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/BlobCacheControl" + }, + { + "$ref": "#/parameters/BlobContentType" + }, + { + "$ref": "#/parameters/BlobContentEncoding" + }, + { + "$ref": "#/parameters/BlobContentLanguage" + }, + { + "$ref": "#/parameters/BlobContentMD5" + }, + { + "$ref": "#/parameters/ContentMD5" + }, + { + "$ref": "#/parameters/ContentCrc64" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/BlobContentDisposition" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/AccessTierOptional" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "name": "blocks", + "description": "Blob Blocks.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BlockLookupList" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/BlobTagsHeader" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyExpiry" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyMode" + }, + { + "$ref": "#/parameters/LegalHoldOptional" + } + ], + "responses": { + "201": { + "description": "The block list was recorded.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. This header refers to the content of the request, meaning, in this case, the list of blocks, and not the content of the blob itself." + }, + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. This header refers to the content of the request, meaning, in this case, the list of blocks, and not the content of the blob itself." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "x-ms-version-id": { + "x-ms-client-name": "VersionId", + "type": "string", + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "blockblob" + ], + "operationId": "BlockBlob_GetBlockList", + "description": "The Get Block List operation retrieves the list of blocks that have been uploaded as part of a block blob", + "parameters": [ + { + "$ref": "#/parameters/Snapshot" + }, + { + "$ref": "#/parameters/BlockListType" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The page range was written.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Content-Type": { + "type": "string", + "description": "The media type of the body of the response. For Get Block List this is 'application/xml'" + }, + "x-ms-blob-content-length": { + "x-ms-client-name": "BlobContentLength", + "type": "integer", + "format": "int64", + "description": "The size of the blob in bytes." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/BlockList" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "blocklist" + ] + } + ] + }, + "/{containerName}/{blob}?comp=page&update": { + "put": { + "tags": [ + "pageblob" + ], + "operationId": "PageBlob_UploadPages", + "description": "The Upload Pages operation writes a range of pages to a page blob", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/Body" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/ContentMD5" + }, + { + "$ref": "#/parameters/ContentCrc64" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Range" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/IfSequenceNumberLessThanOrEqualTo" + }, + { + "$ref": "#/parameters/IfSequenceNumberLessThan" + }, + { + "$ref": "#/parameters/IfSequenceNumberEqualTo" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/StructuredBodyPut" + }, + { + "$ref": "#/parameters/StructuredContentLength" + } + ], + "responses": { + "201": { + "description": "The page range was written.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers." + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", + "type": "integer", + "format": "int64", + "description": "The current sequence number for the page blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the pages. This header is only returned when the pages were encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + }, + "x-ms-structured-body": { + "x-ms-client-name": "StructuredBodyType", + "type": "string", + "description": "Indicates the structured message body was accepted and mirrors back the message schema version and properties." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "page" + ] + }, + { + "name": "x-ms-page-write", + "x-ms-client-name": "pageWrite", + "in": "header", + "required": true, + "x-ms-parameter-location": "method", + "description": "Required. You may specify one of the following options:\n - Update: Writes the bytes specified by the request body into the specified range. The Range and Content-Length headers must match to perform the update.\n - Clear: Clears the specified range and releases the space used in storage for that range. To clear a range, set the Content-Length header to zero, and the Range header to a value that indicates the range to clear, up to maximum blob size.", + "type": "string", + "enum": [ + "update" + ], + "x-ms-enum": { + "name": "PageWriteType", + "modelAsString": false + } + } + ] + }, + "/{containerName}/{blob}?comp=page&clear": { + "put": { + "tags": [ + "pageblob" + ], + "operationId": "PageBlob_ClearPages", + "description": "The Clear Pages operation clears a set of pages from a page blob", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Range" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/IfSequenceNumberLessThanOrEqualTo" + }, + { + "$ref": "#/parameters/IfSequenceNumberLessThan" + }, + { + "$ref": "#/parameters/IfSequenceNumberEqualTo" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "201": { + "description": "The page range was cleared.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers." + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", + "type": "integer", + "format": "int64", + "description": "The current sequence number for the page blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "page" + ] + }, + { + "name": "x-ms-page-write", + "x-ms-client-name": "pageWrite", + "in": "header", + "required": true, + "x-ms-parameter-location": "method", + "description": "Required. You may specify one of the following options:\n - Update: Writes the bytes specified by the request body into the specified range. The Range and Content-Length headers must match to perform the update.\n - Clear: Clears the specified range and releases the space used in storage for that range. To clear a range, set the Content-Length header to zero, and the Range header to a value that indicates the range to clear, up to maximum blob size.", + "type": "string", + "enum": [ + "clear" + ], + "x-ms-enum": { + "name": "PageWriteType", + "modelAsString": false + } + } + ] + }, + "/{containerName}/{blob}?comp=page&update&fromUrl": { + "put": { + "tags": [ + "pageblob" + ], + "operationId": "PageBlob_UploadPagesFromURL", + "description": "The Upload Pages operation writes a range of pages to a page blob where the contents are read from a URL", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/SourceUrl" + }, + { + "$ref": "#/parameters/SourceRangeRequiredPutPageFromUrl" + }, + { + "$ref": "#/parameters/SourceContentMD5" + }, + { + "$ref": "#/parameters/SourceContentCRC64" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/RangeRequiredPutPageFromUrl" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/IfSequenceNumberLessThanOrEqualTo" + }, + { + "$ref": "#/parameters/IfSequenceNumberLessThan" + }, + { + "$ref": "#/parameters/IfSequenceNumberEqualTo" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/SourceIfModifiedSince" + }, + { + "$ref": "#/parameters/SourceIfUnmodifiedSince" + }, + { + "$ref": "#/parameters/SourceIfMatch" + }, + { + "$ref": "#/parameters/SourceIfNoneMatch" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/CopySourceAuthorization" + } + ], + "responses": { + "201": { + "description": "The page range was written.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers." + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", + "type": "integer", + "format": "int64", + "description": "The current sequence number for the page blob." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "page" + ] + }, + { + "name": "x-ms-page-write", + "x-ms-client-name": "pageWrite", + "in": "header", + "required": true, + "x-ms-parameter-location": "method", + "description": "Required. You may specify one of the following options:\n - Update: Writes the bytes specified by the request body into the specified range. The Range and Content-Length headers must match to perform the update.\n - Clear: Clears the specified range and releases the space used in storage for that range. To clear a range, set the Content-Length header to zero, and the Range header to a value that indicates the range to clear, up to maximum blob size.", + "type": "string", + "enum": [ + "update" + ], + "x-ms-enum": { + "name": "PageWriteType", + "modelAsString": false + } + } + ] + }, + "/{containerName}/{blob}?comp=pagelist": { + "get": { + "tags": [ + "pageblob" + ], + "operationId": "PageBlob_GetPageRanges", + "description": "The Get Page Ranges operation returns the list of valid page ranges for a page blob or snapshot of a page blob", + "parameters": [ + { + "$ref": "#/parameters/Snapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Range" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + } + ], + "responses": { + "200": { + "description": "Information on the page blob was found.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "x-ms-blob-content-length": { + "x-ms-client-name": "BlobContentLength", + "type": "integer", + "format": "int64", + "description": "The size of the blob in bytes." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/PageList" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "NextMarker" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "pagelist" + ] + } + ] + }, + "/{containerName}/{blob}?comp=pagelist&diff": { + "get": { + "tags": [ + "pageblob" + ], + "operationId": "PageBlob_GetPageRangesDiff", + "description": "The Get Page Ranges Diff operation returns the list of valid page ranges for a page blob that were changed between target blob and previous snapshot.", + "parameters": [ + { + "$ref": "#/parameters/Snapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/PrevSnapshot" + }, + { + "$ref": "#/parameters/PrevSnapshotUrl" + }, + { + "$ref": "#/parameters/Range" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + } + ], + "responses": { + "200": { + "description": "Information on the page blob was found.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "x-ms-blob-content-length": { + "x-ms-client-name": "BlobContentLength", + "type": "integer", + "format": "int64", + "description": "The size of the blob in bytes." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/PageList" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "NextMarker" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "pagelist" + ] + } + ] + }, + "/{containerName}/{blob}?comp=properties&Resize": { + "put": { + "tags": [ + "pageblob" + ], + "operationId": "PageBlob_Resize", + "description": "Resize the Blob", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/BlobContentLengthRequired" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Blob was resized successfully", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", + "type": "integer", + "format": "int64", + "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/{containerName}/{blob}?comp=properties&UpdateSequenceNumber": { + "put": { + "tags": [ + "pageblob" + ], + "operationId": "PageBlob_UpdateSequenceNumber", + "description": "Update the sequence number of the blob", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/SequenceNumberAction" + }, + { + "$ref": "#/parameters/BlobSequenceNumber" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The sequence numbers were updated successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", + "type": "integer", + "format": "int64", + "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/{containerName}/{blob}?comp=incrementalcopy": { + "put": { + "tags": [ + "pageblob" + ], + "operationId": "PageBlob_CopyIncremental", + "description": "The Copy Incremental operation copies a snapshot of the source page blob to a destination page blob. The snapshot is copied such that only the differential changes between the previously copied snapshot are transferred to the destination. The copied snapshots are complete copies of the original snapshot and can be read or copied from as usual. This API is supported since REST version 2016-05-31.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/CopySource" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "202": { + "description": "The blob was copied.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by x-ms-copy-id.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "incrementalcopy" + ] + } + ] + }, + "/{containerName}/{blob}?comp=appendblock": { + "put": { + "tags": [ + "appendblob" + ], + "consumes": [ + "application/octet-stream" + ], + "operationId": "AppendBlob_AppendBlock", + "description": "The Append Block operation commits a new block of data to the end of an existing append blob. The Append Block operation is permitted only if the blob was created with x-ms-blob-type set to AppendBlob. Append Block is supported only on version 2015-02-21 version or later.", + "parameters": [ + { + "$ref": "#/parameters/Body" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/ContentMD5" + }, + { + "$ref": "#/parameters/ContentCrc64" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/BlobConditionMaxSize" + }, + { + "$ref": "#/parameters/BlobConditionAppendPos" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/StructuredBodyPut" + }, + { + "$ref": "#/parameters/StructuredContentLength" + } + ], + "responses": { + "201": { + "description": "The block was created.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-blob-append-offset": { + "x-ms-client-name": "BlobAppendOffset", + "type": "string", + "description": "This response header is returned only for append operations. It returns the offset at which the block was committed, in bytes." + }, + "x-ms-blob-committed-block-count": { + "x-ms-client-name": "BlobCommittedBlockCount", + "type": "integer", + "description": "The number of committed blocks present in the blob. This header is returned only for append blobs." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the block. This header is only returned when the block was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + }, + "x-ms-structured-body": { + "x-ms-client-name": "StructuredBodyType", + "type": "string", + "description": "Indicates the structured message body was accepted and mirrors back the message schema version and properties." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "appendblock" + ] + } + ] + }, + "/{containerName}/{blob}?comp=appendblock&fromUrl": { + "put": { + "tags": [ + "appendblob" + ], + "operationId": "AppendBlob_AppendBlockFromUrl", + "description": "The Append Block operation commits a new block of data to the end of an existing append blob where the contents are read from a source url. The Append Block operation is permitted only if the blob was created with x-ms-blob-type set to AppendBlob. Append Block is supported only on version 2015-02-21 version or later.", + "parameters": [ + { + "$ref": "#/parameters/SourceUrl" + }, + { + "$ref": "#/parameters/SourceRange" + }, + { + "$ref": "#/parameters/SourceContentMD5" + }, + { + "$ref": "#/parameters/SourceContentCRC64" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/ContentMD5" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/BlobConditionMaxSize" + }, + { + "$ref": "#/parameters/BlobConditionAppendPos" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/SourceIfModifiedSince" + }, + { + "$ref": "#/parameters/SourceIfUnmodifiedSince" + }, + { + "$ref": "#/parameters/SourceIfMatch" + }, + { + "$ref": "#/parameters/SourceIfNoneMatch" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/CopySourceAuthorization" + } + ], + "responses": { + "201": { + "description": "The block was created.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-blob-append-offset": { + "x-ms-client-name": "BlobAppendOffset", + "type": "string", + "description": "This response header is returned only for append operations. It returns the offset at which the block was committed, in bytes." + }, + "x-ms-blob-committed-block-count": { + "x-ms-client-name": "BlobCommittedBlockCount", + "type": "integer", + "description": "The number of committed blocks present in the blob. This header is returned only for append blobs." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the block. This header is only returned when the block was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "appendblock" + ] + } + ] + }, + "/{containerName}/{blob}?comp=seal": { + "put": { + "tags": [ + "appendblob" + ], + "operationId": "AppendBlob_Seal", + "description": "The Seal operation seals the Append Blob to make it read-only. Seal is supported only on version 2019-12-12 version or later.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/BlobConditionAppendPos" + } + ], + "responses": { + "200": { + "description": "The blob was sealed.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-blob-sealed": { + "x-ms-client-name": "IsSealed", + "type": "boolean", + "description": "If this blob has been sealed" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "seal" + ] + } + ] + }, + "/{containerName}/{blob}?comp=query": { + "post": { + "tags": [ + "blob" + ], + "operationId": "Blob_Query", + "description": "The Query operation enables users to select/project on blob data by providing simple query expressions.", + "parameters": [ + { + "$ref": "#/parameters/QueryRequest" + }, + { + "$ref": "#/parameters/Snapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Returns the content of the entire blob.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-meta": { + "type": "string", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The number of bytes present in the response body." + }, + "Content-Type": { + "type": "string", + "description": "The media type of the body of the response. For Download Blob this is 'application/octet-stream'" + }, + "Content-Range": { + "type": "string", + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "Content-Encoding": { + "type": "string", + "description": "This header returns the value that was specified for the Content-Encoding request header" + }, + "Cache-Control": { + "type": "string", + "description": "This header is returned if it was previously specified for the blob." + }, + "Content-Disposition": { + "type": "string", + "description": "This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified." + }, + "Content-Language": { + "type": "string", + "description": "This header returns the value that was specified for the Content-Language request header." + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", + "type": "integer", + "format": "int64", + "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs" + }, + "x-ms-blob-type": { + "x-ms-client-name": "BlobType", + "description": "The blob's type.", + "type": "string", + "enum": [ + "BlockBlob", + "PageBlob", + "AppendBlob" + ], + "x-ms-enum": { + "name": "BlobType", + "modelAsString": false + } + }, + "x-ms-copy-completion-time": { + "x-ms-client-name": "CopyCompletionTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." + }, + "x-ms-copy-status-description": { + "x-ms-client-name": "CopyStatusDescription", + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy." + }, + "x-ms-copy-progress": { + "x-ms-client-name": "CopyProgress", + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" + }, + "x-ms-copy-source": { + "x-ms-client-name": "CopySource", + "type": "string", + "description": "URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by x-ms-copy-id.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a blob is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the blob.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the blob.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Accept-Ranges": { + "type": "string", + "description": "Indicates that the service supports requests for partial blob content." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-blob-committed-block-count": { + "x-ms-client-name": "BlobCommittedBlockCount", + "type": "integer", + "description": "The number of committed blocks present in the blob. This header is returned only for append blobs." + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted)." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + }, + "x-ms-blob-content-md5": { + "x-ms-client-name": "BlobContentMD5", + "type": "string", + "format": "byte", + "description": "If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range" + } + }, + "schema": { + "type": "object", + "format": "file" + } + }, + "206": { + "description": "Returns the content of a specified range of the blob.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-meta": { + "type": "string", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The number of bytes present in the response body." + }, + "Content-Type": { + "type": "string", + "description": "The media type of the body of the response. For Download Blob this is 'application/octet-stream'" + }, + "Content-Range": { + "type": "string", + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "Content-Encoding": { + "type": "string", + "description": "This header returns the value that was specified for the Content-Encoding request header" + }, + "Cache-Control": { + "type": "string", + "description": "This header is returned if it was previously specified for the blob." + }, + "Content-Disposition": { + "type": "string", + "description": "This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified." + }, + "Content-Language": { + "type": "string", + "description": "This header returns the value that was specified for the Content-Language request header." + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", + "type": "integer", + "format": "int64", + "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs" + }, + "x-ms-blob-type": { + "x-ms-client-name": "BlobType", + "description": "The blob's type.", + "type": "string", + "enum": [ + "BlockBlob", + "PageBlob", + "AppendBlob" + ], + "x-ms-enum": { + "name": "BlobType", + "modelAsString": false + } + }, + "x-ms-content-crc64": { + "x-ms-client-name": "ContentCrc64", + "type": "string", + "format": "byte", + "description": "If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 and x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad Request)" + }, + "x-ms-copy-completion-time": { + "x-ms-client-name": "CopyCompletionTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." + }, + "x-ms-copy-status-description": { + "x-ms-client-name": "CopyStatusDescription", + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy." + }, + "x-ms-copy-progress": { + "x-ms-client-name": "CopyProgress", + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" + }, + "x-ms-copy-source": { + "x-ms-client-name": "CopySource", + "type": "string", + "description": "URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by x-ms-copy-id.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a blob is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the blob.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the blob.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Accept-Ranges": { + "type": "string", + "description": "Indicates that the service supports requests for partial blob content." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-blob-committed-block-count": { + "x-ms-client-name": "BlobCommittedBlockCount", + "type": "integer", + "description": "The number of committed blocks present in the blob. This header is returned only for append blobs." + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted)." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + }, + "x-ms-blob-content-md5": { + "x-ms-client-name": "BlobContentMD5", + "type": "string", + "format": "byte", + "description": "If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range" + } + }, + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "query" + ] + } + ] + }, + "/{containerName}/{blob}?comp=tags": { + "get": { + "tags": [ + "blob" + ], + "operationId": "Blob_GetTags", + "description": "The Get Tags operation enables users to get the tags associated with a blob.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/Snapshot" + }, + { + "$ref": "#/parameters/VersionId" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "200": { + "description": "Retrieved blob tags", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/BlobTags" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_SetTags", + "description": "The Set Tags operation enables users to set tags on a blob.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/VersionId" + }, + { + "$ref": "#/parameters/ContentMD5" + }, + { + "$ref": "#/parameters/ContentCrc64" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/BlobTagsBody" + } + ], + "responses": { + "204": { + "description": "The tags were applied to the blob", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "tags" + ] + } + ] + } + }, + "definitions": { + "KeyInfo": { + "type": "object", + "required": [ + "Start", + "Expiry" + ], + "description": "Key information", + "properties": { + "Start": { + "description": "The date-time the key is active in ISO 8601 UTC time", + "type": "string" + }, + "Expiry": { + "description": "The date-time the key expires in ISO 8601 UTC time", + "type": "string" + } + } + }, + "UserDelegationKey": { + "type": "object", + "required": [ + "SignedOid", + "SignedTid", + "SignedStart", + "SignedExpiry", + "SignedService", + "SignedVersion", + "Value" + ], + "description": "A user delegation key", + "properties": { + "SignedOid": { + "description": "The Azure Active Directory object ID in GUID format.", + "type": "string" + }, + "SignedTid": { + "description": "The Azure Active Directory tenant ID in GUID format", + "type": "string" + }, + "SignedStart": { + "description": "The date-time the key is active", + "type": "string", + "format": "date-time" + }, + "SignedExpiry": { + "description": "The date-time the key expires", + "type": "string", + "format": "date-time" + }, + "SignedService": { + "description": "Abbreviation of the Azure Storage service that accepts the key", + "type": "string" + }, + "SignedVersion": { + "description": "The service version that created the key", + "type": "string" + }, + "Value": { + "description": "The key as a base64 string", + "type": "string" + } + } + }, + "PublicAccessType": { + "type": "string", + "enum": [ + "container", + "blob" + ], + "x-ms-enum": { + "name": "PublicAccessType", + "modelAsString": true + } + }, + "CopyStatus": { + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + }, + "LeaseDuration": { + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "LeaseState": { + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "LeaseStatus": { + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + }, + "StorageError": { + "type": "object", + "properties": { + "Message": { + "type": "string" + } + } + }, + "AccessPolicy": { + "type": "object", + "description": "An Access policy", + "properties": { + "Start": { + "description": "the date-time the policy is active", + "type": "string", + "format": "date-time" + }, + "Expiry": { + "description": "the date-time the policy expires", + "type": "string", + "format": "date-time" + }, + "Permission": { + "description": "the permissions for the acl policy", + "type": "string" + } + } + }, + "AccessTier": { + "type": "string", + "enum": [ + "P4", + "P6", + "P10", + "P15", + "P20", + "P30", + "P40", + "P50", + "P60", + "P70", + "P80", + "Hot", + "Cool", + "Archive", + "Premium", + "Cold" + ], + "x-ms-enum": { + "name": "AccessTier", + "modelAsString": true + } + }, + "ArchiveStatus": { + "type": "string", + "enum": [ + "rehydrate-pending-to-hot", + "rehydrate-pending-to-cool", + "rehydrate-pending-to-cold" + ], + "x-ms-enum": { + "name": "ArchiveStatus", + "modelAsString": true + } + }, + "BlobItemInternal": { + "xml": { + "name": "Blob" + }, + "description": "An Azure Storage blob", + "type": "object", + "required": [ + "Name", + "Deleted", + "Snapshot", + "Properties" + ], + "properties": { + "Name": { + "$ref": "#/definitions/BlobName" + }, + "Deleted": { + "type": "boolean" + }, + "Snapshot": { + "type": "string" + }, + "VersionId": { + "type": "string" + }, + "IsCurrentVersion": { + "type": "boolean" + }, + "Properties": { + "$ref": "#/definitions/BlobPropertiesInternal" + }, + "Metadata": { + "$ref": "#/definitions/BlobMetadata" + }, + "BlobTags": { + "$ref": "#/definitions/BlobTags" + }, + "ObjectReplicationMetadata": { + "$ref": "#/definitions/ObjectReplicationMetadata" + }, + "HasVersionsOnly": { + "type": "boolean" + } + } + }, + "BlobPropertiesInternal": { + "xml": { + "name": "Properties" + }, + "description": "Properties of a blob", + "type": "object", + "required": [ + "Etag", + "Last-Modified" + ], + "properties": { + "Creation-Time": { + "type": "string", + "format": "date-time-rfc1123" + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123" + }, + "Etag": { + "type": "string" + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "Size in bytes" + }, + "Content-Type": { + "type": "string" + }, + "Content-Encoding": { + "type": "string" + }, + "Content-Language": { + "type": "string" + }, + "Content-MD5": { + "type": "string", + "format": "byte" + }, + "Content-Disposition": { + "type": "string" + }, + "Cache-Control": { + "type": "string" + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "blobSequenceNumber", + "type": "integer", + "format": "int64" + }, + "BlobType": { + "type": "string", + "enum": [ + "BlockBlob", + "PageBlob", + "AppendBlob" + ], + "x-ms-enum": { + "name": "BlobType", + "modelAsString": false + } + }, + "LeaseStatus": { + "$ref": "#/definitions/LeaseStatus" + }, + "LeaseState": { + "$ref": "#/definitions/LeaseState" + }, + "LeaseDuration": { + "$ref": "#/definitions/LeaseDuration" + }, + "CopyId": { + "type": "string" + }, + "CopyStatus": { + "$ref": "#/definitions/CopyStatus" + }, + "CopySource": { + "type": "string" + }, + "CopyProgress": { + "type": "string" + }, + "CopyCompletionTime": { + "type": "string", + "format": "date-time-rfc1123" + }, + "CopyStatusDescription": { + "type": "string" + }, + "ServerEncrypted": { + "type": "boolean" + }, + "IncrementalCopy": { + "type": "boolean" + }, + "DestinationSnapshot": { + "type": "string" + }, + "DeletedTime": { + "type": "string", + "format": "date-time-rfc1123" + }, + "RemainingRetentionDays": { + "type": "integer" + }, + "AccessTier": { + "$ref": "#/definitions/AccessTier" + }, + "AccessTierInferred": { + "type": "boolean" + }, + "ArchiveStatus": { + "$ref": "#/definitions/ArchiveStatus" + }, + "CustomerProvidedKeySha256": { + "type": "string" + }, + "EncryptionScope": { + "type": "string", + "description": "The name of the encryption scope under which the blob is encrypted." + }, + "AccessTierChangeTime": { + "type": "string", + "format": "date-time-rfc1123" + }, + "TagCount": { + "type": "integer" + }, + "Expiry-Time": { + "x-ms-client-name": "ExpiresOn", + "type": "string", + "format": "date-time-rfc1123" + }, + "Sealed": { + "x-ms-client-name": "IsSealed", + "type": "boolean" + }, + "RehydratePriority": { + "$ref": "#/definitions/RehydratePriority" + }, + "LastAccessTime": { + "x-ms-client-name": "LastAccessedOn", + "type": "string", + "format": "date-time-rfc1123" + }, + "ImmutabilityPolicyUntilDate": { + "x-ms-client-name": "ImmutabilityPolicyExpiresOn", + "type": "string", + "format": "date-time-rfc1123" + }, + "ImmutabilityPolicyMode": { + "type": "string", + "enum": [ + "Mutable", + "Unlocked", + "Locked" + ], + "x-ms-enum": { + "name": "BlobImmutabilityPolicyMode", + "modelAsString": false + } + }, + "LegalHold": { + "type": "boolean" + } + } + }, + "ListBlobsFlatSegmentResponse": { + "xml": { + "name": "EnumerationResults" + }, + "description": "An enumeration of blobs", + "type": "object", + "required": [ + "ServiceEndpoint", + "ContainerName", + "Segment" + ], + "properties": { + "ServiceEndpoint": { + "type": "string", + "xml": { + "attribute": true + } + }, + "ContainerName": { + "type": "string", + "xml": { + "attribute": true + } + }, + "Prefix": { + "type": "string" + }, + "Marker": { + "type": "string" + }, + "MaxResults": { + "type": "integer" + }, + "Segment": { + "$ref": "#/definitions/BlobFlatListSegment" + }, + "NextMarker": { + "type": "string" + } + } + }, + "ListBlobsHierarchySegmentResponse": { + "xml": { + "name": "EnumerationResults" + }, + "description": "An enumeration of blobs", + "type": "object", + "required": [ + "ServiceEndpoint", + "ContainerName", + "Segment" + ], + "properties": { + "ServiceEndpoint": { + "type": "string", + "xml": { + "attribute": true + } + }, + "ContainerName": { + "type": "string", + "xml": { + "attribute": true + } + }, + "Prefix": { + "type": "string" + }, + "Marker": { + "type": "string" + }, + "MaxResults": { + "type": "integer" + }, + "Delimiter": { + "type": "string" + }, + "Segment": { + "$ref": "#/definitions/BlobHierarchyListSegment" + }, + "NextMarker": { + "type": "string" + } + } + }, + "BlobFlatListSegment": { + "xml": { + "name": "Blobs" + }, + "required": [ + "BlobItems" + ], + "type": "object", + "properties": { + "BlobItems": { + "type": "array", + "items": { + "$ref": "#/definitions/BlobItemInternal" + } + } + } + }, + "BlobHierarchyListSegment": { + "xml": { + "name": "Blobs" + }, + "type": "object", + "required": [ + "BlobItems" + ], + "properties": { + "BlobPrefixes": { + "type": "array", + "items": { + "$ref": "#/definitions/BlobPrefix" + } + }, + "BlobItems": { + "type": "array", + "items": { + "$ref": "#/definitions/BlobItemInternal" + } + } + } + }, + "BlobPrefix": { + "type": "object", + "required": [ + "Name" + ], + "properties": { + "Name": { + "$ref": "#/definitions/BlobName" + } + } + }, + "BlobName": { + "type": "object", + "properties": { + "Encoded": { + "xml": { + "attribute": true, + "name": "Encoded" + }, + "type": "boolean", + "description": "Indicates if the blob name is encoded." + }, + "content": { + "xml": { + "x-ms-text": true + }, + "type": "string", + "description": "The name of the blob." + } + } + }, + "BlobTag": { + "xml": { + "name": "Tag" + }, + "type": "object", + "required": [ + "Key", + "Value" + ], + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + } + }, + "BlobTags": { + "type": "object", + "xml": { + "name": "Tags" + }, + "description": "Blob tags", + "required": [ + "BlobTagSet" + ], + "properties": { + "BlobTagSet": { + "xml": { + "wrapped": true, + "name": "TagSet" + }, + "type": "array", + "items": { + "$ref": "#/definitions/BlobTag" + } + } + } + }, + "Block": { + "type": "object", + "required": [ + "Name", + "Size" + ], + "description": "Represents a single block in a block blob. It describes the block's ID and size.", + "properties": { + "Name": { + "description": "The base64 encoded block ID.", + "type": "string" + }, + "Size": { + "description": "The block size in bytes.", + "type": "integer", + "format": "int64" + } + } + }, + "BlockList": { + "type": "object", + "properties": { + "CommittedBlocks": { + "xml": { + "wrapped": true + }, + "type": "array", + "items": { + "$ref": "#/definitions/Block" + } + }, + "UncommittedBlocks": { + "xml": { + "wrapped": true + }, + "type": "array", + "items": { + "$ref": "#/definitions/Block" + } + } + } + }, + "BlockLookupList": { + "type": "object", + "properties": { + "Committed": { + "type": "array", + "items": { + "type": "string", + "xml": { + "name": "Committed" + } + } + }, + "Uncommitted": { + "type": "array", + "items": { + "type": "string", + "xml": { + "name": "Uncommitted" + } + } + }, + "Latest": { + "type": "array", + "items": { + "type": "string", + "xml": { + "name": "Latest" + } + } + } + }, + "xml": { + "name": "BlockList" + } + }, + "ContainerItem": { + "xml": { + "name": "Container" + }, + "type": "object", + "required": [ + "Name", + "Properties" + ], + "description": "An Azure Storage container", + "properties": { + "Name": { + "type": "string" + }, + "Deleted": { + "type": "boolean" + }, + "Version": { + "type": "string" + }, + "Properties": { + "$ref": "#/definitions/ContainerProperties" + }, + "Metadata": { + "$ref": "#/definitions/ContainerMetadata" + } + } + }, + "ContainerProperties": { + "type": "object", + "required": [ + "Last-Modified", + "Etag" + ], + "description": "Properties of a container", + "properties": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123" + }, + "Etag": { + "type": "string" + }, + "LeaseStatus": { + "$ref": "#/definitions/LeaseStatus" + }, + "LeaseState": { + "$ref": "#/definitions/LeaseState" + }, + "LeaseDuration": { + "$ref": "#/definitions/LeaseDuration" + }, + "PublicAccess": { + "$ref": "#/definitions/PublicAccessType" + }, + "HasImmutabilityPolicy": { + "type": "boolean" + }, + "HasLegalHold": { + "type": "boolean" + }, + "DefaultEncryptionScope": { + "type": "string" + }, + "DenyEncryptionScopeOverride": { + "type": "boolean", + "x-ms-client-name": "PreventEncryptionScopeOverride" + }, + "DeletedTime": { + "type": "string", + "format": "date-time-rfc1123" + }, + "RemainingRetentionDays": { + "type": "integer" + }, + "ImmutableStorageWithVersioningEnabled": { + "x-ms-client-name": "IsImmutableStorageWithVersioningEnabled", + "type": "boolean", + "description": "Indicates if version level worm is enabled on this container." + } + } + }, + "DelimitedTextConfiguration": { + "xml": { + "name": "DelimitedTextConfiguration" + }, + "description": "Groups the settings used for interpreting the blob data if the blob is delimited text formatted.", + "type": "object", + "properties": { + "ColumnSeparator": { + "type": "string", + "description": "The string used to separate columns.", + "xml": { + "name": "ColumnSeparator" + } + }, + "FieldQuote": { + "type": "string", + "description": "The string used to quote a specific field.", + "xml": { + "name": "FieldQuote" + } + }, + "RecordSeparator": { + "type": "string", + "description": "The string used to separate records.", + "xml": { + "name": "RecordSeparator" + } + }, + "EscapeChar": { + "type": "string", + "description": "The string used as an escape character.", + "xml": { + "name": "EscapeChar" + } + }, + "HeadersPresent": { + "type": "boolean", + "description": "Represents whether the data has headers.", + "xml": { + "name": "HasHeaders" + } + } + } + }, + "JsonTextConfiguration": { + "xml": { + "name": "JsonTextConfiguration" + }, + "description": "json text configuration", + "type": "object", + "properties": { + "RecordSeparator": { + "type": "string", + "description": "The string used to separate records.", + "xml": { + "name": "RecordSeparator" + } + } + } + }, + "ArrowConfiguration": { + "xml": { + "name": "ArrowConfiguration" + }, + "description": "Groups the settings used for formatting the response if the response should be Arrow formatted.", + "type": "object", + "required": [ + "Schema" + ], + "properties": { + "Schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ArrowField" + }, + "xml": { + "wrapped": true, + "name": "Schema" + } + } + } + }, + "ParquetConfiguration": { + "xml": { + "name": "ParquetTextConfiguration" + }, + "description": "parquet configuration", + "type": "object" + }, + "ArrowField": { + "xml": { + "name": "Field" + }, + "description": "Groups settings regarding specific field of an arrow schema", + "type": "object", + "required": [ + "Type" + ], + "properties": { + "Type": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Precision": { + "type": "integer" + }, + "Scale": { + "type": "integer" + } + } + }, + "ListContainersSegmentResponse": { + "xml": { + "name": "EnumerationResults" + }, + "description": "An enumeration of containers", + "type": "object", + "required": [ + "ServiceEndpoint", + "ContainerItems" + ], + "properties": { + "ServiceEndpoint": { + "type": "string", + "xml": { + "attribute": true + } + }, + "Prefix": { + "type": "string" + }, + "Marker": { + "type": "string" + }, + "MaxResults": { + "type": "integer" + }, + "ContainerItems": { + "xml": { + "wrapped": true, + "name": "Containers" + }, + "type": "array", + "items": { + "$ref": "#/definitions/ContainerItem" + } + }, + "NextMarker": { + "type": "string" + } + } + }, + "CorsRule": { + "description": "CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain", + "type": "object", + "required": [ + "AllowedOrigins", + "AllowedMethods", + "AllowedHeaders", + "ExposedHeaders", + "MaxAgeInSeconds" + ], + "properties": { + "AllowedOrigins": { + "description": "The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.", + "type": "string" + }, + "AllowedMethods": { + "description": "The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)", + "type": "string" + }, + "AllowedHeaders": { + "description": "the request headers that the origin domain may specify on the CORS request.", + "type": "string" + }, + "ExposedHeaders": { + "description": "The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer", + "type": "string" + }, + "MaxAgeInSeconds": { + "description": "The maximum amount time that a browser should cache the preflight OPTIONS request.", + "type": "integer", + "minimum": 0 + } + } + }, + "ErrorCode": { + "description": "Error codes returned by the service", + "type": "string", + "enum": [ + "AccountAlreadyExists", + "AccountBeingCreated", + "AccountIsDisabled", + "AuthenticationFailed", + "AuthorizationFailure", + "ConditionHeadersNotSupported", + "ConditionNotMet", + "EmptyMetadataKey", + "InsufficientAccountPermissions", + "InternalError", + "InvalidAuthenticationInfo", + "InvalidHeaderValue", + "InvalidHttpVerb", + "InvalidInput", + "InvalidMd5", + "InvalidMetadata", + "InvalidQueryParameterValue", + "InvalidRange", + "InvalidResourceName", + "InvalidUri", + "InvalidXmlDocument", + "InvalidXmlNodeValue", + "Md5Mismatch", + "MetadataTooLarge", + "MissingContentLengthHeader", + "MissingRequiredQueryParameter", + "MissingRequiredHeader", + "MissingRequiredXmlNode", + "MultipleConditionHeadersNotSupported", + "OperationTimedOut", + "OutOfRangeInput", + "OutOfRangeQueryParameterValue", + "RequestBodyTooLarge", + "ResourceTypeMismatch", + "RequestUrlFailedToParse", + "ResourceAlreadyExists", + "ResourceNotFound", + "ServerBusy", + "UnsupportedHeader", + "UnsupportedXmlNode", + "UnsupportedQueryParameter", + "UnsupportedHttpVerb", + "AppendPositionConditionNotMet", + "BlobAlreadyExists", + "BlobImmutableDueToPolicy", + "BlobNotFound", + "BlobOverwritten", + "BlobTierInadequateForContentLength", + "BlobUsesCustomerSpecifiedEncryption", + "BlockCountExceedsLimit", + "BlockListTooLong", + "CannotChangeToLowerTier", + "CannotVerifyCopySource", + "ContainerAlreadyExists", + "ContainerBeingDeleted", + "ContainerDisabled", + "ContainerNotFound", + "ContentLengthLargerThanTierLimit", + "CopyAcrossAccountsNotSupported", + "CopyIdMismatch", + "FeatureVersionMismatch", + "IncrementalCopyBlobMismatch", + "IncrementalCopyOfEarlierVersionSnapshotNotAllowed", + "IncrementalCopySourceMustBeSnapshot", + "InfiniteLeaseDurationRequired", + "InvalidBlobOrBlock", + "InvalidBlobTier", + "InvalidBlobType", + "InvalidBlockId", + "InvalidBlockList", + "InvalidOperation", + "InvalidPageRange", + "InvalidSourceBlobType", + "InvalidSourceBlobUrl", + "InvalidVersionForPageBlobOperation", + "LeaseAlreadyPresent", + "LeaseAlreadyBroken", + "LeaseIdMismatchWithBlobOperation", + "LeaseIdMismatchWithContainerOperation", + "LeaseIdMismatchWithLeaseOperation", + "LeaseIdMissing", + "LeaseIsBreakingAndCannotBeAcquired", + "LeaseIsBreakingAndCannotBeChanged", + "LeaseIsBrokenAndCannotBeRenewed", + "LeaseLost", + "LeaseNotPresentWithBlobOperation", + "LeaseNotPresentWithContainerOperation", + "LeaseNotPresentWithLeaseOperation", + "MaxBlobSizeConditionNotMet", + "NoAuthenticationInformation", + "NoPendingCopyOperation", + "OperationNotAllowedOnIncrementalCopyBlob", + "PendingCopyOperation", + "PreviousSnapshotCannotBeNewer", + "PreviousSnapshotNotFound", + "PreviousSnapshotOperationNotSupported", + "SequenceNumberConditionNotMet", + "SequenceNumberIncrementTooLarge", + "SnapshotCountExceeded", + "SnapshotOperationRateExceeded", + "SnapshotsPresent", + "SourceConditionNotMet", + "SystemInUse", + "TargetConditionNotMet", + "UnauthorizedBlobOverwrite", + "BlobBeingRehydrated", + "BlobArchived", + "BlobNotArchived", + "AuthorizationSourceIPMismatch", + "AuthorizationProtocolMismatch", + "AuthorizationPermissionMismatch", + "AuthorizationServiceMismatch", + "AuthorizationResourceTypeMismatch", + "BlobAccessTierNotSupportedForAccountType" + ], + "x-ms-enum": { + "name": "StorageErrorCode", + "modelAsString": true + } + }, + "FilterBlobItem": { + "xml": { + "name": "Blob" + }, + "description": "Blob info from a Filter Blobs API call", + "type": "object", + "required": [ + "Name", + "ContainerName" + ], + "properties": { + "Name": { + "type": "string" + }, + "ContainerName": { + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/BlobTags" + }, + "VersionId": { + "type": "string" + }, + "IsCurrentVersion": { + "type": "boolean" + } + } + }, + "FilterBlobSegment": { + "description": "The result of a Filter Blobs API call", + "xml": { + "name": "EnumerationResults" + }, + "type": "object", + "required": [ + "ServiceEndpoint", + "Where", + "Blobs" + ], + "properties": { + "ServiceEndpoint": { + "type": "string", + "xml": { + "attribute": true + } + }, + "Where": { + "type": "string" + }, + "Blobs": { + "xml": { + "name": "Blobs", + "wrapped": true + }, + "type": "array", + "items": { + "$ref": "#/definitions/FilterBlobItem" + } + }, + "NextMarker": { + "type": "string" + } + } + }, + "GeoReplication": { + "description": "Geo-Replication information for the Secondary Storage Service", + "type": "object", + "required": [ + "Status", + "LastSyncTime" + ], + "properties": { + "Status": { + "description": "The status of the secondary location", + "type": "string", + "enum": [ + "live", + "bootstrap", + "unavailable" + ], + "x-ms-enum": { + "name": "GeoReplicationStatusType", + "modelAsString": true + } + }, + "LastSyncTime": { + "description": "A GMT date/time value, to the second. All primary writes preceding this value are guaranteed to be available for read operations at the secondary. Primary writes after this point in time may or may not be available for reads.", + "type": "string", + "format": "date-time-rfc1123" + } + } + }, + "Logging": { + "description": "Azure Analytics Logging settings.", + "type": "object", + "required": [ + "Version", + "Delete", + "Read", + "Write", + "RetentionPolicy" + ], + "properties": { + "Version": { + "description": "The version of Storage Analytics to configure.", + "type": "string" + }, + "Delete": { + "description": "Indicates whether all delete requests should be logged.", + "type": "boolean" + }, + "Read": { + "description": "Indicates whether all read requests should be logged.", + "type": "boolean" + }, + "Write": { + "description": "Indicates whether all write requests should be logged.", + "type": "boolean" + }, + "RetentionPolicy": { + "$ref": "#/definitions/RetentionPolicy" + } + } + }, + "ContainerMetadata": { + "type": "object", + "xml": { + "name": "Metadata" + }, + "additionalProperties": { + "type": "string" + } + }, + "BlobMetadata": { + "type": "object", + "xml": { + "name": "Metadata" + }, + "properties": { + "Encrypted": { + "type": "string", + "xml": { + "attribute": true + } + } + }, + "additionalProperties": { + "type": "string" + } + }, + "ObjectReplicationMetadata": { + "type": "object", + "xml": { + "name": "OrMetadata" + }, + "additionalProperties": { + "type": "string" + } + }, + "Metrics": { + "description": "a summary of request statistics grouped by API in hour or minute aggregates for blobs", + "required": [ + "Enabled" + ], + "properties": { + "Version": { + "description": "The version of Storage Analytics to configure.", + "type": "string" + }, + "Enabled": { + "description": "Indicates whether metrics are enabled for the Blob service.", + "type": "boolean" + }, + "IncludeAPIs": { + "description": "Indicates whether metrics should generate summary statistics for called API operations.", + "type": "boolean" + }, + "RetentionPolicy": { + "$ref": "#/definitions/RetentionPolicy" + } + } + }, + "PageList": { + "description": "the list of pages", + "type": "object", + "properties": { + "PageRange": { + "type": "array", + "items": { + "$ref": "#/definitions/PageRange" + } + }, + "ClearRange": { + "type": "array", + "items": { + "$ref": "#/definitions/ClearRange" + } + }, + "NextMarker": { + "type": "string" + } + } + }, + "PageRange": { + "type": "object", + "required": [ + "Start", + "End" + ], + "properties": { + "Start": { + "type": "integer", + "format": "int64", + "xml": { + "name": "Start" + } + }, + "End": { + "type": "integer", + "format": "int64", + "xml": { + "name": "End" + } + } + }, + "xml": { + "name": "PageRange" + } + }, + "ClearRange": { + "type": "object", + "required": [ + "Start", + "End" + ], + "properties": { + "Start": { + "type": "integer", + "format": "int64", + "xml": { + "name": "Start" + } + }, + "End": { + "type": "integer", + "format": "int64", + "xml": { + "name": "End" + } + } + }, + "xml": { + "name": "ClearRange" + } + }, + "QueryRequest": { + "description": "Groups the set of query request settings.", + "type": "object", + "required": [ + "QueryType", + "Expression" + ], + "properties": { + "QueryType": { + "type": "string", + "description": "Required. The type of the provided query expression.", + "xml": { + "name": "QueryType" + }, + "enum": [ + "SQL" + ] + }, + "Expression": { + "type": "string", + "description": "The query expression in SQL. The maximum size of the query expression is 256KiB.", + "xml": { + "name": "Expression" + } + }, + "InputSerialization": { + "$ref": "#/definitions/QuerySerialization", + "xml": { + "name": "InputSerialization" + } + }, + "OutputSerialization": { + "$ref": "#/definitions/QuerySerialization", + "xml": { + "name": "OutputSerialization" + } + } + }, + "xml": { + "name": "QueryRequest" + } + }, + "QueryFormat": { + "type": "object", + "required": [ + "Type" + ], + "properties": { + "Type": { + "$ref": "#/definitions/QueryType" + }, + "DelimitedTextConfiguration": { + "$ref": "#/definitions/DelimitedTextConfiguration" + }, + "JsonTextConfiguration": { + "$ref": "#/definitions/JsonTextConfiguration" + }, + "ArrowConfiguration": { + "$ref": "#/definitions/ArrowConfiguration" + }, + "ParquetTextConfiguration": { + "$ref": "#/definitions/ParquetConfiguration" + } + } + }, + "QuerySerialization": { + "type": "object", + "required": [ + "Format" + ], + "properties": { + "Format": { + "$ref": "#/definitions/QueryFormat", + "xml": { + "name": "Format" + } + } + } + }, + "QueryType": { + "type": "string", + "description": "The quick query format type.", + "enum": [ + "delimited", + "json", + "arrow", + "parquet" + ], + "x-ms-enum": { + "name": "QueryFormatType", + "modelAsString": false + }, + "xml": { + "name": "Type" + } + }, + "RehydratePriority": { + "description": "If an object is in rehydrate pending state then this header is returned with priority of rehydrate. Valid values are High and Standard.", + "type": "string", + "enum": [ + "High", + "Standard" + ], + "x-ms-enum": { + "name": "RehydratePriority", + "modelAsString": true + }, + "xml": { + "name": "RehydratePriority" + } + }, + "RetentionPolicy": { + "description": "the retention policy which determines how long the associated data should persist", + "type": "object", + "required": [ + "Enabled" + ], + "properties": { + "Enabled": { + "description": "Indicates whether a retention policy is enabled for the storage service", + "type": "boolean" + }, + "Days": { + "description": "Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted", + "type": "integer", + "minimum": 1 + }, + "AllowPermanentDelete": { + "description": "Indicates whether permanent delete is allowed on this storage account.", + "type": "boolean" + } + } + }, + "SignedIdentifier": { + "xml": { + "name": "SignedIdentifier" + }, + "description": "signed identifier", + "type": "object", + "required": [ + "Id", + "AccessPolicy" + ], + "properties": { + "Id": { + "type": "string", + "description": "a unique id" + }, + "AccessPolicy": { + "$ref": "#/definitions/AccessPolicy" + } + } + }, + "SignedIdentifiers": { + "description": "a collection of signed identifiers", + "type": "array", + "items": { + "$ref": "#/definitions/SignedIdentifier" + }, + "xml": { + "wrapped": true, + "name": "SignedIdentifiers" + } + }, + "StaticWebsite": { + "description": "The properties that enable an account to host a static website", + "type": "object", + "required": [ + "Enabled" + ], + "properties": { + "Enabled": { + "description": "Indicates whether this account is hosting a static website", + "type": "boolean" + }, + "IndexDocument": { + "description": "The default name of the index page under each directory", + "type": "string" + }, + "ErrorDocument404Path": { + "description": "The absolute path of the custom 404 page", + "type": "string" + }, + "DefaultIndexDocumentPath": { + "description": "Absolute path of the default index page", + "type": "string" + } + } + }, + "StorageServiceProperties": { + "description": "Storage Service Properties.", + "type": "object", + "properties": { + "Logging": { + "$ref": "#/definitions/Logging" + }, + "HourMetrics": { + "$ref": "#/definitions/Metrics" + }, + "MinuteMetrics": { + "$ref": "#/definitions/Metrics" + }, + "Cors": { + "description": "The set of CORS rules.", + "type": "array", + "items": { + "$ref": "#/definitions/CorsRule" + }, + "xml": { + "wrapped": true + } + }, + "DefaultServiceVersion": { + "description": "The default version to use for requests to the Blob service if an incoming request's version is not specified. Possible values include version 2008-10-27 and all more recent versions", + "type": "string" + }, + "DeleteRetentionPolicy": { + "$ref": "#/definitions/RetentionPolicy" + }, + "StaticWebsite": { + "$ref": "#/definitions/StaticWebsite" + } + } + }, + "StorageServiceStats": { + "description": "Stats for the storage service.", + "type": "object", + "properties": { + "GeoReplication": { + "$ref": "#/definitions/GeoReplication" + } + } + } + }, + "parameters": { + "Url": { + "name": "url", + "description": "The URL of the service account, container, or blob that is the target of the desired operation.", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "ApiVersionParameter": { + "name": "x-ms-version", + "x-ms-parameter-location": "client", + "x-ms-client-name": "version", + "in": "header", + "required": true, + "type": "string", + "description": "Specifies the version of the operation to use for this request.", + "enum": [ + "2025-01-05" + ] + }, + "Blob": { + "name": "blob", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(?:/[a-zA-Z0-9]+)*(?:\\.[a-zA-Z0-9]+){0,1}$", + "minLength": 1, + "maxLength": 1024, + "x-ms-parameter-location": "method", + "description": "The blob name." + }, + "BlobCacheControl": { + "name": "x-ms-blob-cache-control", + "x-ms-client-name": "blobCacheControl", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "blob-HTTP-headers" + }, + "description": "Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request." + }, + "BlobConditionAppendPos": { + "name": "x-ms-blob-condition-appendpos", + "x-ms-client-name": "appendPosition", + "in": "header", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "append-position-access-conditions" + }, + "description": "Optional conditional header, used only for the Append Block operation. A number indicating the byte offset to compare. Append Block will succeed only if the append position is equal to this number. If it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP status code 412 - Precondition Failed)." + }, + "BlobConditionMaxSize": { + "name": "x-ms-blob-condition-maxsize", + "x-ms-client-name": "maxSize", + "in": "header", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "append-position-access-conditions" + }, + "description": "Optional conditional header. The max length in bytes permitted for the append blob. If the Append Block operation would cause the blob to exceed that limit or if the blob size is already greater than the value specified in this header, the request will fail with MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed)." + }, + "BlobPublicAccess": { + "name": "x-ms-blob-public-access", + "x-ms-client-name": "access", + "in": "header", + "required": false, + "x-ms-parameter-location": "method", + "description": "Specifies whether data in the container may be accessed publicly and the level of access", + "type": "string", + "enum": [ + "container", + "blob" + ], + "x-ms-enum": { + "name": "PublicAccessType", + "modelAsString": true + } + }, + "BlobTagsBody": { + "name": "Tags", + "in": "body", + "schema": { + "$ref": "#/definitions/BlobTags" + }, + "x-ms-parameter-location": "method", + "description": "Blob tags" + }, + "BlobTagsHeader": { + "name": "x-ms-tags", + "x-ms-client-name": "BlobTagsString", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Optional. Used to set blob tags in various blob operations." + }, + "AccessTierRequired": { + "name": "x-ms-access-tier", + "x-ms-client-name": "tier", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "P4", + "P6", + "P10", + "P15", + "P20", + "P30", + "P40", + "P50", + "P60", + "P70", + "P80", + "Hot", + "Cool", + "Archive", + "Cold" + ], + "x-ms-enum": { + "name": "AccessTier", + "modelAsString": true + }, + "x-ms-parameter-location": "method", + "description": "Indicates the tier to be set on the blob." + }, + "AccessTierOptional": { + "name": "x-ms-access-tier", + "x-ms-client-name": "tier", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "P4", + "P6", + "P10", + "P15", + "P20", + "P30", + "P40", + "P50", + "P60", + "P70", + "P80", + "Hot", + "Cool", + "Archive", + "Cold" + ], + "x-ms-enum": { + "name": "AccessTier", + "modelAsString": true + }, + "x-ms-parameter-location": "method", + "description": "Optional. Indicates the tier to be set on the blob." + }, + "PremiumPageBlobAccessTierOptional": { + "name": "x-ms-access-tier", + "x-ms-client-name": "tier", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "P4", + "P6", + "P10", + "P15", + "P20", + "P30", + "P40", + "P50", + "P60", + "P70", + "P80" + ], + "x-ms-enum": { + "name": "PremiumPageBlobAccessTier", + "modelAsString": true + }, + "x-ms-parameter-location": "method", + "description": "Optional. Indicates the tier to be set on the page blob." + }, + "RehydratePriority": { + "name": "x-ms-rehydrate-priority", + "x-ms-client-name": "rehydratePriority", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "High", + "Standard" + ], + "x-ms-enum": { + "name": "RehydratePriority", + "modelAsString": true + }, + "x-ms-parameter-location": "method", + "description": "Optional: Indicates the priority with which to rehydrate an archived blob." + }, + "BlobContentDisposition": { + "name": "x-ms-blob-content-disposition", + "x-ms-client-name": "blobContentDisposition", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "blob-HTTP-headers" + }, + "description": "Optional. Sets the blob's Content-Disposition header." + }, + "BlobContentEncoding": { + "name": "x-ms-blob-content-encoding", + "x-ms-client-name": "blobContentEncoding", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "blob-HTTP-headers" + }, + "description": "Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request." + }, + "BlobContentLanguage": { + "name": "x-ms-blob-content-language", + "x-ms-client-name": "blobContentLanguage", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "blob-HTTP-headers" + }, + "description": "Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request." + }, + "BlobContentLengthOptional": { + "name": "x-ms-blob-content-length", + "x-ms-client-name": "blobContentLength", + "in": "header", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method", + "description": "This header specifies the maximum size for the page blob, up to 1 TB. The page blob size must be aligned to a 512-byte boundary." + }, + "BlobContentLengthRequired": { + "name": "x-ms-blob-content-length", + "x-ms-client-name": "blobContentLength", + "in": "header", + "required": true, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method", + "description": "This header specifies the maximum size for the page blob, up to 1 TB. The page blob size must be aligned to a 512-byte boundary." + }, + "BlobContentMD5": { + "name": "x-ms-blob-content-md5", + "x-ms-client-name": "blobContentMD5", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "blob-HTTP-headers" + }, + "description": "Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks were validated when each was uploaded." + }, + "BlobContentType": { + "name": "x-ms-blob-content-type", + "x-ms-client-name": "blobContentType", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "blob-HTTP-headers" + }, + "description": "Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request." + }, + "BlobDeleteType": { + "name": "deletetype", + "x-ms-client-name": "blobDeleteType", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "Permanent" + ], + "x-ms-enum": { + "name": "BlobDeleteType", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Optional. Only possible value is 'permanent', which specifies to permanently delete a blob if blob soft delete is enabled." + }, + "BlobExpiryOptions": { + "name": "x-ms-expiry-option", + "x-ms-client-name": "ExpiryOptions", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "NeverExpire", + "RelativeToCreation", + "RelativeToNow", + "Absolute" + ], + "x-ms-enum": { + "name": "BlobExpiryOptions", + "modelAsString": true + }, + "x-ms-parameter-location": "method", + "description": "Required. Indicates mode of the expiry time" + }, + "BlobExpiryTime": { + "name": "x-ms-expiry-time", + "x-ms-client-name": "ExpiresOn", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The time to set the blob to expiry" + }, + "BlobSequenceNumber": { + "name": "x-ms-blob-sequence-number", + "x-ms-client-name": "blobSequenceNumber", + "in": "header", + "required": false, + "type": "integer", + "format": "int64", + "default": 0, + "x-ms-parameter-location": "method", + "description": "Set for page blobs only. The sequence number is a user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 2^63 - 1." + }, + "BlockId": { + "name": "blockid", + "x-ms-client-name": "blockId", + "in": "query", + "type": "string", + "required": true, + "x-ms-parameter-location": "method", + "description": "A valid Base64 string value that identifies the block. Prior to encoding, the string must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified for the blockid parameter must be the same size for each block." + }, + "BlockListType": { + "name": "blocklisttype", + "x-ms-client-name": "listType", + "in": "query", + "required": true, + "default": "committed", + "x-ms-parameter-location": "method", + "description": "Specifies whether to return the list of committed blocks, the list of uncommitted blocks, or both lists together.", + "type": "string", + "enum": [ + "committed", + "uncommitted", + "all" + ], + "x-ms-enum": { + "name": "BlockListType", + "modelAsString": false + } + }, + "Body": { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "format": "file" + }, + "x-ms-parameter-location": "method", + "description": "Initial data" + }, + "ContainerAcl": { + "name": "containerAcl", + "in": "body", + "schema": { + "$ref": "#/definitions/SignedIdentifiers" + }, + "x-ms-parameter-location": "method", + "description": "the acls for the container" + }, + "CopyId": { + "name": "copyid", + "x-ms-client-name": "copyId", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The copy identifier provided in the x-ms-copy-id header of the original Copy Blob operation." + }, + "ClientRequestId": { + "name": "x-ms-client-request-id", + "x-ms-client-name": "requestId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." + }, + "ContainerName": { + "name": "containerName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The container name." + }, + "ContentCrc64": { + "name": "x-ms-content-crc64", + "x-ms-client-name": "transactionalContentCrc64", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "description": "Specify the transactional crc64 for the body, to be validated by the service." + }, + "ContentLength": { + "name": "Content-Length", + "in": "header", + "required": true, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method", + "description": "The length of the request." + }, + "ContentMD5": { + "name": "Content-MD5", + "x-ms-client-name": "transactionalContentMD5", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "description": "Specify the transactional md5 for the body, to be validated by the service." + }, + "CopySource": { + "name": "x-ms-copy-source", + "x-ms-client-name": "copySource", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Specifies the name of the source page blob snapshot. This value is a URL of up to 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would appear in a request URI. The source blob must either be public or must be authenticated via a shared access signature." + }, + "CopySourceAuthorization": { + "name": "x-ms-copy-source-authorization", + "x-ms-client-name": "copySourceAuthorization", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source." + }, + "CopySourceBlobProperties": { + "name": "x-ms-copy-source-blob-properties", + "x-ms-client-name": "copySourceBlobProperties", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "Optional, default is true. Indicates if properties from the source blob should be copied." + }, + "CopySourceTags": { + "name": "x-ms-copy-source-tag-option", + "x-ms-client-name": "copySourceTags", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "REPLACE", + "COPY" + ], + "x-ms-enum": { + "name": "BlobCopySourceTags", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Optional, default 'replace'. Indicates if source tags should be copied or replaced with the tags specified by x-ms-tags." + }, + "DeleteSnapshots": { + "name": "x-ms-delete-snapshots", + "x-ms-client-name": "deleteSnapshots", + "description": "Required if the blob has associated snapshots. Specify one of the following two options: include: Delete the base blob and all of its snapshots. only: Delete only the blob's snapshots and not the blob itself", + "x-ms-parameter-location": "method", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "include", + "only" + ], + "x-ms-enum": { + "name": "DeleteSnapshotsOptionType", + "modelAsString": false + } + }, + "Delimiter": { + "name": "delimiter", + "description": "When the request includes this parameter, the operation returns a BlobPrefix element in the response body that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string.", + "type": "string", + "x-ms-parameter-location": "method", + "in": "query", + "required": true + }, + "EncryptionKey": { + "name": "x-ms-encryption-key", + "x-ms-client-name": "encryptionKey", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "cpk-info" + }, + "description": "Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services." + }, + "EncryptionKeySha256": { + "name": "x-ms-encryption-key-sha256", + "x-ms-client-name": "encryptionKeySha256", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "cpk-info" + }, + "description": "The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided." + }, + "EncryptionAlgorithm": { + "name": "x-ms-encryption-algorithm", + "x-ms-client-name": "encryptionAlgorithm", + "type": "string", + "in": "header", + "required": false, + "enum": [ + "AES256" + ], + "x-ms-enum": { + "name": "EncryptionAlgorithmType", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "cpk-info" + }, + "description": "The algorithm used to produce the encryption key hash. Currently, the only accepted value is \"AES256\". Must be provided if the x-ms-encryption-key header is provided." + }, + "EncryptionScope": { + "name": "x-ms-encryption-scope", + "x-ms-client-name": "encryptionScope", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "cpk-scope-info" + }, + "description": "Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services." + }, + "DefaultEncryptionScope": { + "name": "x-ms-default-encryption-scope", + "x-ms-client-name": "DefaultEncryptionScope", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "container-cpk-scope-info" + }, + "description": "Optional. Version 2019-07-07 and later. Specifies the default encryption scope to set on the container and use for all future writes." + }, + "DeletedContainerName": { + "name": "x-ms-deleted-container-name", + "x-ms-client-name": "DeletedContainerName", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "method", + "description": "Optional. Version 2019-12-12 and later. Specifies the name of the deleted container to restore." + }, + "DeletedContainerVersion": { + "name": "x-ms-deleted-container-version", + "x-ms-client-name": "DeletedContainerVersion", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "method", + "description": "Optional. Version 2019-12-12 and later. Specifies the version of the deleted container to restore." + }, + "DenyEncryptionScopeOverride": { + "name": "x-ms-deny-encryption-scope-override", + "x-ms-client-name": "PreventEncryptionScopeOverride", + "type": "boolean", + "in": "header", + "required": false, + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "container-cpk-scope-info" + }, + "description": "Optional. Version 2019-07-07 and newer. If true, prevents any request from specifying a different encryption scope than the scope set on the container." + }, + "FilterBlobsInclude": { + "name": "include", + "in": "query", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string", + "enum": [ + "none", + "versions" + ], + "x-ms-enum": { + "name": "FilterBlobsIncludeItem", + "modelAsString": false + } + }, + "x-ms-parameter-location": "method", + "description": "Include this parameter to specify one or more datasets to include in the response." + }, + "FilterBlobsWhere": { + "name": "where", + "in": "query", + "required": false, + "type": "string", + "description": "Filters the results to return only to return only blobs whose tags match the specified expression.", + "x-ms-parameter-location": "method" + }, + "GetRangeContentMD5": { + "name": "x-ms-range-get-content-md5", + "x-ms-client-name": "rangeGetContentMD5", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "When set to true and specified together with the Range, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size." + }, + "GetRangeContentCRC64": { + "name": "x-ms-range-get-content-crc64", + "x-ms-client-name": "rangeGetContentCRC64", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "When set to true and specified together with the Range, the service returns the CRC64 hash for the range, as long as the range is less than or equal to 4 MB in size." + }, + "StructuredBodyGet": { + "name": "x-ms-structured-body", + "x-ms-client-name": "StructuredBodyType", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Specifies the response content should be returned as a structured message and specifies the message schema version and properties." + }, + "StructuredBodyPut": { + "name": "x-ms-structured-body", + "x-ms-client-name": "StructuredBodyType", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Required if the request body is a structured message. Specifies the message schema version and properties." + }, + "StructuredContentLength": { + "name": "x-ms-structured-content-length", + "x-ms-client-name": "StructuredContentLength", + "in": "header", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method", + "description": "Required if the request body is a structured message. Specifies the length of the blob/file content inside the message body. Will always be smaller than Content-Length." + }, + "IfMatch": { + "name": "If-Match", + "x-ms-client-name": "ifMatch", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "modified-access-conditions" + }, + "description": "Specify an ETag value to operate only on blobs with a matching value." + }, + "IfModifiedSince": { + "name": "If-Modified-Since", + "x-ms-client-name": "ifModifiedSince", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "modified-access-conditions" + }, + "description": "Specify this header value to operate only on a blob if it has been modified since the specified date/time." + }, + "IfNoneMatch": { + "name": "If-None-Match", + "x-ms-client-name": "ifNoneMatch", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "modified-access-conditions" + }, + "description": "Specify an ETag value to operate only on blobs without a matching value." + }, + "IfUnmodifiedSince": { + "name": "If-Unmodified-Since", + "x-ms-client-name": "ifUnmodifiedSince", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "modified-access-conditions" + }, + "description": "Specify this header value to operate only on a blob if it has not been modified since the specified date/time." + }, + "IfSequenceNumberEqualTo": { + "name": "x-ms-if-sequence-number-eq", + "x-ms-client-name": "ifSequenceNumberEqualTo", + "in": "header", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "sequence-number-access-conditions" + }, + "description": "Specify this header value to operate only on a blob if it has the specified sequence number." + }, + "IfSequenceNumberLessThan": { + "name": "x-ms-if-sequence-number-lt", + "x-ms-client-name": "ifSequenceNumberLessThan", + "in": "header", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "sequence-number-access-conditions" + }, + "description": "Specify this header value to operate only on a blob if it has a sequence number less than the specified." + }, + "IfSequenceNumberLessThanOrEqualTo": { + "name": "x-ms-if-sequence-number-le", + "x-ms-client-name": "ifSequenceNumberLessThanOrEqualTo", + "in": "header", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "sequence-number-access-conditions" + }, + "description": "Specify this header value to operate only on a blob if it has a sequence number less than or equal to the specified." + }, + "IfTags": { + "name": "x-ms-if-tags", + "x-ms-client-name": "ifTags", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "modified-access-conditions" + }, + "description": "Specify a SQL where clause on blob tags to operate only on blobs with a matching value." + }, + "ImmutabilityPolicyExpiry": { + "name": "x-ms-immutability-policy-until-date", + "x-ms-client-name": "immutabilityPolicyExpiry", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method", + "description": "Specifies the date time when the blobs immutability policy is set to expire." + }, + "ImmutabilityPolicyMode": { + "name": "x-ms-immutability-policy-mode", + "x-ms-client-name": "immutabilityPolicyMode", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "Unlocked", + "Locked" + ], + "x-ms-enum": { + "name": "BlobImmutabilityPolicyMode", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Specifies the immutability policy mode to set on the blob." + }, + "KeyInfo": { + "description": "Key information", + "name": "KeyInfo", + "in": "body", + "x-ms-parameter-location": "method", + "required": true, + "schema": { + "$ref": "#/definitions/KeyInfo" + } + }, + "ListBlobsInclude": { + "name": "include", + "in": "query", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string", + "enum": [ + "copy", + "deleted", + "metadata", + "snapshots", + "uncommittedblobs", + "versions", + "tags", + "immutabilitypolicy", + "legalhold", + "deletedwithversions" + ], + "x-ms-enum": { + "name": "ListBlobsIncludeItem", + "modelAsString": false + } + }, + "x-ms-parameter-location": "method", + "description": "Include this parameter to specify one or more datasets to include in the response." + }, + "ListContainersInclude": { + "name": "include", + "in": "query", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string", + "enum": [ + "metadata", + "deleted", + "system" + ], + "x-ms-enum": { + "name": "ListContainersIncludeType", + "modelAsString": false + } + }, + "x-ms-parameter-location": "method", + "description": "Include this parameter to specify that the container's metadata be returned as part of the response body." + }, + "LeaseBreakPeriod": { + "name": "x-ms-lease-break-period", + "x-ms-client-name": "breakPeriod", + "in": "header", + "required": false, + "type": "integer", + "x-ms-parameter-location": "method", + "description": "For a break operation, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period. If this header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses, and an infinite lease breaks immediately." + }, + "LeaseDuration": { + "name": "x-ms-lease-duration", + "x-ms-client-name": "duration", + "in": "header", + "required": false, + "type": "integer", + "x-ms-parameter-location": "method", + "description": "Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change." + }, + "LeaseIdOptional": { + "name": "x-ms-lease-id", + "x-ms-client-name": "leaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "lease-access-conditions" + }, + "description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID." + }, + "LeaseIdRequired": { + "name": "x-ms-lease-id", + "x-ms-client-name": "leaseId", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Specifies the current lease ID on the resource." + }, + "LegalHoldOptional": { + "name": "x-ms-legal-hold", + "x-ms-client-name": "legalHold", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "Specified if a legal hold should be set on the blob." + }, + "LegalHoldRequired": { + "name": "x-ms-legal-hold", + "x-ms-client-name": "legalHold", + "in": "header", + "required": true, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "Specified if a legal hold should be set on the blob." + }, + "Marker": { + "name": "marker", + "in": "query", + "required": false, + "type": "string", + "description": "A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client.", + "x-ms-parameter-location": "method" + }, + "MaxResults": { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "x-ms-parameter-location": "method", + "description": "Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000." + }, + "Metadata": { + "name": "x-ms-meta", + "x-ms-client-name": "metadata", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information.", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "MultipartContentType": { + "name": "Content-Type", + "x-ms-client-name": "multipartContentType", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Required. The value of this header must be multipart/mixed with a batch boundary. Example header value: multipart/mixed; boundary=batch_" + }, + "ObjectReplicationPolicyId": { + "name": "x-ms-or-policy-id", + "x-ms-client-name": "objectReplicationPolicyId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication." + }, + "ObjectReplicationRules": { + "name": "x-ms-or", + "x-ms-client-name": "ObjectReplicationRules", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed).", + "x-ms-header-collection-prefix": "x-ms-or-" + }, + "Prefix": { + "name": "prefix", + "in": "query", + "required": false, + "type": "string", + "description": "Filters the results to return only containers whose name begins with the specified prefix.", + "x-ms-parameter-location": "method" + }, + "PrevSnapshot": { + "name": "prevsnapshot", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Optional in version 2015-07-08 and newer. The prevsnapshot parameter is a DateTime value that specifies that the response will contain only pages that were changed between target blob and previous snapshot. Changed pages include both updated and cleared pages. The target blob may be a snapshot, as long as the snapshot specified by prevsnapshot is the older of the two. Note that incremental snapshots are currently supported only for blobs created on or after January 1, 2016." + }, + "PrevSnapshotUrl": { + "name": "x-ms-previous-snapshot-url", + "x-ms-client-name": "prevSnapshotUrl", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Optional. This header is only supported in service versions 2019-04-19 and after and specifies the URL of a previous snapshot of the target blob. The response will only contain pages that were changed between the target blob and its previous snapshot." + }, + "ProposedLeaseIdOptional": { + "name": "x-ms-proposed-lease-id", + "x-ms-client-name": "proposedLeaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats." + }, + "ProposedLeaseIdRequired": { + "name": "x-ms-proposed-lease-id", + "x-ms-client-name": "proposedLeaseId", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats." + }, + "QueryRequest": { + "name": "queryRequest", + "in": "body", + "x-ms-parameter-location": "client", + "schema": { + "$ref": "#/definitions/QueryRequest" + }, + "description": "the query request" + }, + "Range": { + "name": "x-ms-range", + "x-ms-client-name": "range", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Return only the bytes of the blob in the specified range." + }, + "RangeRequiredPutPageFromUrl": { + "name": "x-ms-range", + "x-ms-client-name": "range", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The range of bytes to which the source range would be written. The range should be 512 aligned and range-end is required." + }, + "SequenceNumberAction": { + "name": "x-ms-sequence-number-action", + "x-ms-client-name": "sequenceNumberAction", + "in": "header", + "required": true, + "x-ms-parameter-location": "method", + "description": "Required if the x-ms-blob-sequence-number header is set for the request. This property applies to page blobs only. This property indicates how the service should modify the blob's sequence number", + "type": "string", + "enum": [ + "max", + "update", + "increment" + ], + "x-ms-enum": { + "name": "SequenceNumberActionType", + "modelAsString": false + } + }, + "Snapshot": { + "name": "snapshot", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob." + }, + "VersionId": { + "name": "versionid", + "x-ms-client-name": "versionId", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer." + }, + "SealBlob": { + "name": "x-ms-seal-blob", + "x-ms-client-name": "SealBlob", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "Overrides the sealed state of the destination blob. Service version 2019-12-12 and newer." + }, + "SourceContainerName": { + "name": "x-ms-source-container-name", + "x-ms-client-name": "SourceContainerName", + "type": "string", + "in": "header", + "required": true, + "x-ms-parameter-location": "method", + "description": "Required. Specifies the name of the container to rename." + }, + "SourceContentMD5": { + "name": "x-ms-source-content-md5", + "x-ms-client-name": "sourceContentMD5", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "description": "Specify the md5 calculated for the range of bytes that must be read from the copy source." + }, + "SourceContentCRC64": { + "name": "x-ms-source-content-crc64", + "x-ms-client-name": "sourceContentcrc64", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "description": "Specify the crc64 calculated for the range of bytes that must be read from the copy source." + }, + "SourceRange": { + "name": "x-ms-source-range", + "x-ms-client-name": "sourceRange", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Bytes of source data in the specified range." + }, + "SourceRangeRequiredPutPageFromUrl": { + "name": "x-ms-source-range", + "x-ms-client-name": "sourceRange", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Bytes of source data in the specified range. The length of this range should match the ContentLength header and x-ms-range/Range destination range header." + }, + "SourceIfMatch": { + "name": "x-ms-source-if-match", + "x-ms-client-name": "sourceIfMatch", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify an ETag value to operate only on blobs with a matching value." + }, + "SourceIfModifiedSince": { + "name": "x-ms-source-if-modified-since", + "x-ms-client-name": "sourceIfModifiedSince", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify this header value to operate only on a blob if it has been modified since the specified date/time." + }, + "SourceIfNoneMatch": { + "name": "x-ms-source-if-none-match", + "x-ms-client-name": "sourceIfNoneMatch", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify an ETag value to operate only on blobs without a matching value." + }, + "SourceIfUnmodifiedSince": { + "name": "x-ms-source-if-unmodified-since", + "x-ms-client-name": "sourceIfUnmodifiedSince", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify this header value to operate only on a blob if it has not been modified since the specified date/time." + }, + "SourceLeaseId": { + "name": "x-ms-source-lease-id", + "x-ms-client-name": "sourceLeaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "A lease ID for the source path. If specified, the source path must have an active lease and the lease ID must match." + }, + "SourceIfTags": { + "name": "x-ms-source-if-tags", + "x-ms-client-name": "sourceIfTags", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify a SQL where clause on blob tags to operate only on blobs with a matching value." + }, + "SourceUrl": { + "name": "x-ms-copy-source", + "x-ms-client-name": "sourceUrl", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Specify a URL to the copy source." + }, + "StorageServiceProperties": { + "name": "StorageServiceProperties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageServiceProperties" + }, + "x-ms-parameter-location": "method", + "description": "The StorageService properties." + }, + "Timeout": { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "minimum": 0, + "x-ms-parameter-location": "method", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations." + } + } +} diff --git a/specification/storage/data-plane/Microsoft.FileStorage/readme.md b/specification/storage/data-plane/Microsoft.FileStorage/readme.md index ee36cadbc1e0..f036ab5c454c 100644 --- a/specification/storage/data-plane/Microsoft.FileStorage/readme.md +++ b/specification/storage/data-plane/Microsoft.FileStorage/readme.md @@ -25,7 +25,7 @@ These are the global settings for the FileStorage API. ``` yaml openapi-type: data-plane -tag: package-2024-11 +tag: package-2025-01 use-internal-constructors: true add-credentials: true ``` @@ -147,6 +147,15 @@ input-file: - stable/2024-11-04/file.json ``` +### Tag: package-2025-01 + +These settings apply only when `--tag=package-2025-01` is specified on the command line. + +``` yaml $(tag) == 'package-2025-01' +input-file: +- stable/2025-01-05/file.json +``` + ### Suppression ``` yaml directive: diff --git a/specification/storage/data-plane/Microsoft.FileStorage/stable/2025-01-05/file.json b/specification/storage/data-plane/Microsoft.FileStorage/stable/2025-01-05/file.json new file mode 100644 index 000000000000..fddbcfb61b94 --- /dev/null +++ b/specification/storage/data-plane/Microsoft.FileStorage/stable/2025-01-05/file.json @@ -0,0 +1,7879 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure File Storage", + "version": "2025-01-05", + "x-ms-code-generation-settings": { + "header": "MIT", + "strictSpecAdherence": false + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{url}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "$ref": "#/parameters/Url" + } + ] + }, + "securityDefinitions": { + "File_shared_key": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "paths": {}, + "x-ms-paths": { + "/?restype=service&comp=properties": { + "put": { + "tags": [ + "service" + ], + "operationId": "Service_SetProperties", + "description": "Sets properties for a storage account's File service endpoint, including properties for Storage Analytics metrics and CORS (Cross-Origin Resource Sharing) rules.", + "parameters": [ + { + "$ref": "#/parameters/StorageServiceProperties" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "202": { + "description": "Success (Accepted)", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "service" + ], + "operationId": "Service_GetProperties", + "description": "Gets the properties of a storage account's File service, including properties for Storage Analytics metrics and CORS (Cross-Origin Resource Sharing) rules.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + } + }, + "schema": { + "$ref": "#/definitions/StorageServiceProperties" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "service" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/?comp=list": { + "get": { + "tags": [ + "service" + ], + "operationId": "Service_ListSharesSegment", + "description": "The List Shares Segment operation returns a list of the shares and share snapshots under the specified account.", + "parameters": [ + { + "$ref": "#/parameters/Prefix" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/ListSharesInclude" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + } + }, + "schema": { + "$ref": "#/definitions/ListSharesResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "NextMarker" + } + }, + "parameters": [ + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "list" + ] + } + ] + }, + "/{shareName}?restype=share": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_Create", + "description": "Creates a new share under the specified account. If the share with the same name already exists, the operation fails.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/ShareQuota" + }, + { + "$ref": "#/parameters/AccessTierOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShareEnabledProtocols" + }, + { + "$ref": "#/parameters/ShareRootSquash" + }, + { + "$ref": "#/parameters/EnableSnapshotVirtualDirectoryAccess" + }, + { + "$ref": "#/parameters/PaidBurstingEnabled" + }, + { + "$ref": "#/parameters/PaidBurstingMaxBandwidthMibps" + }, + { + "$ref": "#/parameters/PaidBurstingMaxIops" + }, + { + "$ref": "#/parameters/FileRequestIntent" + }, + { + "$ref": "#/parameters/ShareProvisionedIops" + }, + { + "$ref": "#/parameters/ShareProvisionedBandwidthMibps" + } + ], + "responses": { + "201": { + "description": "Success, Share created.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the share, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties or metadata updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-share-quota": { + "x-ms-client-name": "Quota", + "type": "integer", + "format": "int64", + "description": "Returns the current share quota in GB." + }, + "x-ms-share-provisioned-iops": { + "x-ms-client-name": "ShareProvisionedIops", + "type": "integer", + "format": "int64", + "description": "The provisioned IOPS of the share. If this is not specified, compute the recommended IOPS of the share using the formula for a share in this media tier (SSD/HDD as appropriate)." + }, + "x-ms-share-provisioned-bandwidth-mibps": { + "x-ms-client-name": "ShareProvisionedBandwidthMibps", + "type": "integer", + "format": "int64", + "description": "The provisioned throughput of the share. If this is not specified, compute the recommended throughput of the share using the formula for a share in this media tier (SSD/HDD as appropriate)." + }, + "x-ms-share-included-burst-iops": { + "x-ms-client-name": "ShareIncludedBurstIops", + "type": "integer", + "format": "int64", + "description": "ShareIncludedBurstIops" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "share" + ], + "operationId": "Share_GetProperties", + "description": "Returns all user-defined metadata and system properties for the specified share or share snapshot. The data returned does not include the share's list of files.", + "parameters": [ + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "x-ms-meta": { + "type": "string", + "description": "A set of name-value pairs that contain the user-defined metadata of the share.", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-share-quota": { + "x-ms-client-name": "Quota", + "type": "integer", + "description": "Returns the current share quota in GB." + }, + "x-ms-share-provisioned-iops": { + "x-ms-client-name": "ProvisionedIops", + "type": "integer", + "description": "Returns the current share provisioned ipos." + }, + "x-ms-share-provisioned-ingress-mbps": { + "x-ms-client-name": "ProvisionedIngressMBps", + "type": "integer", + "description": "Returns the current share provisioned ingress in megabytes per second." + }, + "x-ms-share-provisioned-egress-mbps": { + "x-ms-client-name": "ProvisionedEgressMBps", + "type": "integer", + "description": "Returns the current share provisioned egress in megabytes per second." + }, + "x-ms-share-next-allowed-quota-downgrade-time": { + "x-ms-client-name": "NextAllowedQuotaDowngradeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the current share next allowed quota downgrade time." + }, + "x-ms-share-provisioned-bandwidth-mibps": { + "x-ms-client-name": "ProvisionedBandwidthMibps", + "type": "integer", + "description": "Returns the current share provisioned bandwidth in megabits per second." + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a share is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the share.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the share.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + }, + "x-ms-access-tier": { + "x-ms-client-name": "AccessTier", + "type": "string", + "description": "Returns the access tier set on the share." + }, + "x-ms-access-tier-change-time": { + "x-ms-client-name": "AccessTierChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the last modified time (in UTC) of the access tier of the share." + }, + "x-ms-access-tier-transition-state": { + "x-ms-client-name": "AccessTierTransitionState", + "type": "string", + "description": "Returns the transition state between access tiers, when present." + }, + "x-ms-enabled-protocols": { + "x-ms-client-name": "EnabledProtocols", + "description": "The protocols that have been enabled on the share.", + "type": "string" + }, + "x-ms-root-squash": { + "x-ms-client-name": "RootSquash", + "description": "Valid for NFS shares only.", + "type": "string", + "enum": [ + "NoRootSquash", + "RootSquash", + "AllSquash" + ], + "x-ms-enum": { + "name": "ShareRootSquash", + "modelAsString": false + } + }, + "x-ms-enable-snapshot-virtual-directory-access": { + "x-ms-client-name": "EnableSnapshotVirtualDirectoryAccess", + "description": "Version 2023-08-03 and newer. Specifies whether the snapshot virtual directory should be accessible at the root of share mount point when NFS is enabled. This header is only returned for shares, not for snapshots.", + "type": "boolean" + }, + "x-ms-share-paid-bursting-enabled": { + "x-ms-client-name": "PaidBurstingEnabled", + "description": "Optional. Boolean. Default if not specified is false. This property enables paid bursting.", + "type": "boolean" + }, + "x-ms-share-paid-bursting-max-iops": { + "x-ms-client-name": "PaidBurstingMaxIops", + "description": "Optional. Integer. Default if not specified is the maximum IOPS the file share can support. Current maximum for a file share is 102,400 IOPS.", + "type": "integer", + "format": "int64" + }, + "x-ms-share-paid-bursting-max-bandwidth-mibps": { + "x-ms-client-name": "PaidBurstingMaxBandwidthMibps", + "description": "Optional. Integer. Default if not specified is the maximum throughput the file share can support. Current maximum for a file share is 10,340 MiB/sec.", + "type": "integer", + "format": "int64" + }, + "x-ms-share-included-burst-iops": { + "x-ms-client-name": "IncludedBurstIops", + "description": "Return the calculated burst IOPS of the share.", + "type": "integer", + "format": "int64" + }, + "x-ms-share-max-burst-credits-for-iops": { + "x-ms-client-name": "MaxBurstCreditsForIops", + "description": "Returned the calculated maximum burst credits. This is not the current burst credit level, but the maximum burst credits the share can have.", + "type": "integer", + "format": "int64" + }, + "x-ms-share-next-allowed-provisioned-iops-downgrade-time": { + "x-ms-client-name": "NextAllowedProvisionedIopsDowngradeTime", + "description": "Return timestamp for provisioned IOPS following existing rules for provisioned storage GiB.", + "type": "string", + "format": "date-time-rfc1123" + }, + "x-ms-share-next-allowed-provisioned-bandwidth-downgrade-time": { + "x-ms-client-name": "NextAllowedProvisionedBandwidthDowngradeTime", + "description": "Return timestamp for provisioned throughput following existing rules for provisioned storage GiB.", + "type": "string", + "format": "date-time-rfc1123" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "delete": { + "tags": [ + "share" + ], + "operationId": "Share_Delete", + "description": "Operation marks the specified share or share snapshot for deletion. The share or share snapshot and any files contained within it are later deleted during garbage collection.", + "parameters": [ + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/DeleteSnapshots" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-share-usage-bytes": { + "type": "integer", + "format": "int64", + "description": "The \"live share\" portion of the data that the customer will be billed for in the soft-deleted capacity (logical storage size)." + }, + "x-ms-share-snapshot-usage-bytes": { + "type": "integer", + "format": "int64", + "description": "The snapshot share portion of the data that the customer will be billed for in the soft-deleted capacity (this is the delta, or \"physical storage size\")." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + } + ] + }, + "/{shareName}?restype=share&comp=lease&acquire": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_AcquireLease", + "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseDuration" + }, + { + "$ref": "#/parameters/ProposedLeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "201": { + "description": "The Acquire operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a share's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "acquire" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + } + ] + }, + "/{shareName}?restype=share&comp=lease&release": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_ReleaseLease", + "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The Release operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "release" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + } + ] + }, + "/{shareName}?restype=share&comp=lease&change": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_ChangeLease", + "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/ProposedLeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The Change operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a share's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "change" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + } + ] + }, + "/{shareName}?restype=share&comp=lease&renew": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_RenewLease", + "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The Renew operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a share's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the current share next allowed quota downgrade time." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "renew" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + } + ] + }, + "/{shareName}?restype=share&comp=lease&break": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_BreakLease", + "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseBreakPeriod" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "202": { + "description": "The Break operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-lease-time": { + "x-ms-client-name": "LeaseTime", + "type": "integer", + "description": "Approximate time remaining in the lease period, in seconds." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a share's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "break" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + } + ] + }, + "/{shareName}?restype=share&comp=snapshot": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_CreateSnapshot", + "description": "Creates a read-only snapshot of a share.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "201": { + "description": "Success, Share snapshot created.", + "headers": { + "x-ms-snapshot": { + "x-ms-client-name": "Snapshot", + "type": "string", + "description": "This header is a DateTime value that uniquely identifies the share snapshot. The value of this header may be used in subsequent requests to access the share snapshot. This value is opaque." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the share snapshot, in quotes. A share snapshot cannot be modified, so the ETag of a given share snapshot never changes. However, if new metadata was supplied with the Snapshot Share request then the ETag of the share snapshot differs from that of the base share. If no metadata was specified with the request, the ETag of the share snapshot is identical to that of the base share at the time the share snapshot was taken." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. A share snapshot cannot be modified, so the last modified time of a given share snapshot never changes. However, if new metadata was supplied with the Snapshot Share request then the last modified time of the share snapshot differs from that of the base share. If no metadata was specified with the request, the last modified time of the share snapshot is identical to that of the base share at the time the share snapshot was taken." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "snapshot" + ] + } + ] + }, + "/{shareName}?restype=share&comp=filepermission": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_CreatePermission", + "description": "Create a permission (a security descriptor).", + "consumes": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SharePermission" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "201": { + "description": "Success, Share level permission created.", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the directory/file." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "share" + ], + "operationId": "Share_GetPermission", + "description": "Returns the permission (security descriptor) for a given key", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/FilePermissionKeyRequired" + }, + { + "$ref": "#/parameters/FilePermissionFormat" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + }, + "schema": { + "$ref": "#/definitions/SharePermission" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "filepermission" + ] + } + ] + }, + "/{shareName}?restype=share&comp=properties": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_SetProperties", + "description": "Sets properties for the specified share.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShareQuota" + }, + { + "$ref": "#/parameters/AccessTierOptional" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ShareRootSquash" + }, + { + "$ref": "#/parameters/EnableSnapshotVirtualDirectoryAccess" + }, + { + "$ref": "#/parameters/PaidBurstingEnabled" + }, + { + "$ref": "#/parameters/PaidBurstingMaxBandwidthMibps" + }, + { + "$ref": "#/parameters/PaidBurstingMaxIops" + }, + { + "$ref": "#/parameters/FileRequestIntent" + }, + { + "$ref": "#/parameters/ShareProvisionedIops" + }, + { + "$ref": "#/parameters/ShareProvisionedBandwidthMibps" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-share-quota": { + "x-ms-client-name": "Quota", + "type": "integer", + "format": "int64", + "description": "Returns the current share quota in GB." + }, + "x-ms-share-provisioned-iops": { + "x-ms-client-name": "ProvisionedIops", + "type": "integer", + "format": "int64", + "description": "Returns the current share provisioned ipos." + }, + "x-ms-share-provisioned-bandwidth-mibps": { + "x-ms-client-name": "ProvisionedBandwidthMibps", + "type": "integer", + "format": "int64", + "description": "Returns the current share provisioned bandwidth in megabits per second." + }, + "x-ms-share-included-burst-iops": { + "x-ms-client-name": "IncludedBurstIops", + "description": "Return the calculated burst IOPS of the share.", + "type": "integer", + "format": "int64" + }, + "x-ms-share-max-burst-credits-for-iops": { + "x-ms-client-name": "MaxBurstCreditsForIops", + "description": "Returned the calculated maximum burst credits. This is not the current burst credit level, but the maximum burst credits the share can have.", + "type": "integer", + "format": "int64" + }, + "x-ms-share-next-allowed-quota-downgrade-time": { + "x-ms-client-name": "NextAllowedQuotaDowngradeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the current share next allowed quota downgrade time." + }, + "x-ms-share-next-allowed-provisioned-iops-downgrade-time": { + "x-ms-client-name": "NextAllowedProvisionedIopsDowngradeTime", + "description": "Return timestamp for provisioned IOPS following existing rules for provisioned storage GiB.", + "type": "string", + "format": "date-time-rfc1123" + }, + "x-ms-share-next-allowed-provisioned-bandwidth-downgrade-time": { + "x-ms-client-name": "NextAllowedProvisionedBandwidthDowngradeTime", + "description": "Return timestamp for provisioned throughput following existing rules for provisioned storage GiB.", + "type": "string", + "format": "date-time-rfc1123" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/{shareName}?restype=share&comp=metadata": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_SetMetadata", + "description": "Sets one or more user-defined name-value pairs for the specified share.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "metadata" + ] + } + ] + }, + "/{shareName}?restype=share&comp=acl": { + "get": { + "tags": [ + "share" + ], + "operationId": "Share_GetAccessPolicy", + "description": "Returns information about stored access policies specified on the share.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + }, + "schema": { + "$ref": "#/definitions/SignedIdentifiers" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "put": { + "tags": [ + "share" + ], + "operationId": "Share_SetAccessPolicy", + "description": "Sets a stored access policy for use with shared access signatures.", + "parameters": [ + { + "$ref": "#/parameters/ShareAcl" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "acl" + ] + } + ] + }, + "/{shareName}?restype=share&comp=stats": { + "get": { + "tags": [ + "share" + ], + "operationId": "Share_GetStatistics", + "description": "Retrieves statistics related to the share.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + }, + "schema": { + "$ref": "#/definitions/ShareStats" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "stats" + ] + } + ] + }, + "/{shareName}?restype=share&comp=undelete": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_Restore", + "description": "Restores a previously deleted Share.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DeletedShareName" + }, + { + "$ref": "#/parameters/DeletedShareVersion" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "201": { + "description": "Created", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-share-quota": { + "x-ms-client-name": "Quota", + "type": "integer", + "format": "int64", + "description": "Returns the current share quota in GB." + }, + "x-ms-share-provisioned-iops": { + "x-ms-client-name": "ProvisionedIops", + "type": "integer", + "format": "int64", + "description": "Returns the current share provisioned ipos." + }, + "x-ms-share-provisioned-bandwidth-mibps": { + "x-ms-client-name": "ProvisionedBandwidthMibps", + "type": "integer", + "format": "int64", + "description": "Returns the current share provisioned bandwidth in megabits per second." + }, + "x-ms-share-included-burst-iops": { + "x-ms-client-name": "IncludedBurstIops", + "description": "Return the calculated burst IOPS of the share.", + "type": "integer", + "format": "int64" + }, + "x-ms-share-max-burst-credits-for-iops": { + "x-ms-client-name": "MaxBurstCreditsForIops", + "description": "Returned the calculated maximum burst credits. This is not the current burst credit level, but the maximum burst credits the share can have.", + "type": "integer", + "format": "int64" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "undelete" + ] + } + ] + }, + "/{shareName}/{directory}?restype=directory": { + "put": { + "tags": [ + "directory" + ], + "operationId": "Directory_Create", + "description": "Creates a new directory under the specified share or parent directory.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionFormat" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/FileAttributes" + }, + { + "$ref": "#/parameters/FileCreationTime" + }, + { + "$ref": "#/parameters/FileLastWriteTime" + }, + { + "$ref": "#/parameters/FileChangeTime" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "201": { + "description": "Success, Directory created.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the directory, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the directory." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the directory." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the directory." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the directory." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the directory." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the directory." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the directory." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "directory" + ], + "operationId": "Directory_GetProperties", + "description": "Returns all system properties for the specified directory, and can also be used to check the existence of a directory. The data returned does not include the files in the directory or any subdirectories.", + "parameters": [ + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-meta": { + "type": "string", + "description": "A set of name-value pairs that contain metadata for the directory.", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the Directory was last modified. Operations on files within the directory do not affect the last modified time of the directory." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the directory metadata is completely encrypted using the specified algorithm. Otherwise, the value is set to false." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the directory." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the directory." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the directory." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the directory." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the directory." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the directory." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the directory." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "delete": { + "tags": [ + "directory" + ], + "operationId": "Directory_Delete", + "description": "Removes the specified empty directory. Note that the directory must be empty before it can be deleted.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "202": { + "description": "Success (Accepted).", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "directory" + ] + }, + { + "$ref": "#/parameters/AllowTrailingDot" + } + ] + }, + "/{shareName}/{directory}?restype=directory&comp=properties": { + "put": { + "tags": [ + "directory" + ], + "operationId": "Directory_SetProperties", + "description": "Sets properties on the directory.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionFormat" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/FileAttributes" + }, + { + "$ref": "#/parameters/FileCreationTime" + }, + { + "$ref": "#/parameters/FileLastWriteTime" + }, + { + "$ref": "#/parameters/FileChangeTime" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the directory was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the directory." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the directory." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the directory." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the directory." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the directory." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the directory." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the directory." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "directory" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/{shareName}/{directory}?restype=directory&comp=metadata": { + "put": { + "tags": [ + "directory" + ], + "operationId": "Directory_SetMetadata", + "description": "Updates user defined metadata for the specified directory.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success (OK).", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the directory, in quotes." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "directory" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "metadata" + ] + } + ] + }, + "/{shareName}/{directory}?restype=directory&comp=list": { + "get": { + "tags": [ + "directory" + ], + "operationId": "Directory_ListFilesAndDirectoriesSegment", + "description": "Returns a list of files or directories under the specified share or directory. It lists the contents only for a single level of the directory hierarchy.", + "parameters": [ + { + "$ref": "#/parameters/Prefix" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListFilesInclude" + }, + { + "$ref": "#/parameters/ListFilesExtendedInfo" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Content-Type": { + "type": "string", + "description": "Specifies the format in which the results are returned. Currently this value is 'application/xml'." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + }, + "schema": { + "$ref": "#/definitions/ListFilesAndDirectoriesSegmentResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "NextMarker" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "directory" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "list" + ] + } + ] + }, + "/{shareName}/{directory}?comp=listhandles": { + "get": { + "tags": [ + "directory" + ], + "operationId": "Directory_ListHandles", + "description": "Lists handles for directory.", + "parameters": [ + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/Recursive" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Content-Type": { + "type": "string", + "description": "Specifies the format in which the results are returned. Currently this value is 'application/xml'." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + }, + "schema": { + "$ref": "#/definitions/ListHandlesResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "listhandles" + ] + } + ] + }, + "/{shareName}/{directory}?comp=forceclosehandles": { + "put": { + "tags": [ + "directory" + ], + "operationId": "Directory_ForceCloseHandles", + "description": "Closes all handles open for given directory.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/HandleId" + }, + { + "$ref": "#/parameters/Recursive" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-marker": { + "x-ms-client-name": "marker", + "type": "string", + "description": "A string describing next handle to be closed. It is returned when more handles need to be closed to complete the request." + }, + "x-ms-number-of-handles-closed": { + "x-ms-client-name": "numberOfHandlesClosed", + "type": "integer", + "description": "Contains count of number of handles closed." + }, + "x-ms-number-of-handles-failed": { + "x-ms-client-name": "numberOfHandlesFailedToClose", + "type": "integer", + "description": "Contains count of number of handles that failed to close." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "forceclosehandles" + ] + } + ] + }, + "/{shareName}/{directory}?restype=directory&comp=rename": { + "put": { + "tags": [ + "directory" + ], + "operationId": "Directory_Rename", + "description": "Renames a directory", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/RenameSource" + }, + { + "$ref": "#/parameters/RenameReplaceIfExists" + }, + { + "$ref": "#/parameters/RenameIgnoreReadOnly" + }, + { + "$ref": "#/parameters/SourceLeaseId" + }, + { + "$ref": "#/parameters/DestinationLeaseId" + }, + { + "$ref": "#/parameters/FileCopyFileAttributes" + }, + { + "$ref": "#/parameters/FileCopyFileCreationTime" + }, + { + "$ref": "#/parameters/FileCopyFileLastWriteTime" + }, + { + "$ref": "#/parameters/FileCopyFileChangeTime" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionFormat" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/SourceAllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the file." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the directory." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "directory" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "rename" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_Create", + "description": "Creates a new file or replaces a file. Note it only initializes the file with no content.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "x-ms-content-length", + "x-ms-client-name": "fileContentLength", + "in": "header", + "description": "Specifies the maximum size for the file, up to 4 TB.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "$ref": "#/parameters/FileType" + }, + { + "$ref": "#/parameters/FileContentType" + }, + { + "$ref": "#/parameters/FileContentEncoding" + }, + { + "$ref": "#/parameters/FileContentLanguage" + }, + { + "$ref": "#/parameters/FileCacheControl" + }, + { + "$ref": "#/parameters/FileContentMD5" + }, + { + "$ref": "#/parameters/FileContentDisposition" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionFormat" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/FileAttributes" + }, + { + "$ref": "#/parameters/FileCreationTime" + }, + { + "$ref": "#/parameters/FileLastWriteTime" + }, + { + "$ref": "#/parameters/FileChangeTime" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "201": { + "description": "Success, File created.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the file." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the file." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "file" + ], + "operationId": "File_Download", + "description": "Reads or downloads a file from the system, including its metadata and properties.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Range" + }, + { + "$ref": "#/parameters/GetRangeContentMD5" + }, + { + "$ref": "#/parameters/StructuredBodyGet" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Succeeded to read the entire file.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. Any operation that modifies the file or its properties updates the last modified time." + }, + "x-ms-meta": { + "type": "string", + "description": "A set of name-value pairs associated with this file as user-defined metadata.", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The number of bytes present in the response body." + }, + "Content-Type": { + "type": "string", + "description": "The content type specified for the file. The default content type is 'application/octet-stream'" + }, + "Content-Range": { + "type": "string", + "description": "Indicates the range of bytes returned if the client requested a subset of the file by setting the Range request header." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the file has an MD5 hash and the request is to read the full file, this response header is returned so that the client can check for message content integrity. If the request is to read a specified range and the 'x-ms-range-get-content-md5' is set to true, then the request returns an MD5 hash for the range, as long as the range size is less than or equal to 4 MB. If neither of these sets of conditions is true, then no value is returned for the 'Content-MD5' header." + }, + "Content-Encoding": { + "type": "string", + "description": "Returns the value that was specified for the Content-Encoding request header." + }, + "Cache-Control": { + "type": "string", + "description": "Returned if it was previously specified for the file." + }, + "Content-Disposition": { + "type": "string", + "description": "Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response." + }, + "Content-Language": { + "type": "string", + "description": "Returns the value that was specified for the Content-Language request header." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Accept-Ranges": { + "type": "string", + "description": "Indicates that the service supports requests for partial file content." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-copy-completion-time": { + "x-ms-client-name": "CopyCompletionTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt." + }, + "x-ms-copy-status-description": { + "x-ms-client-name": "CopyStatusDescription", + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure." + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for the last attempted Copy File operation where this file was the destination file." + }, + "x-ms-copy-progress": { + "x-ms-client-name": "CopyProgress", + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied." + }, + "x-ms-copy-source": { + "x-ms-client-name": "CopySource", + "type": "string", + "description": "URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by 'x-ms-copy-id'.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + }, + "x-ms-content-md5": { + "x-ms-client-name": "FileContentMD5", + "type": "string", + "format": "byte", + "description": "If the file has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole file's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range." + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted)." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the file." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the file." + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a file is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the file.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the file.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + }, + "x-ms-structured-body": { + "x-ms-client-name": "StructuredBodyType", + "type": "string", + "description": "Indicates the response body contains a structured message and specifies the message schema version and properties." + }, + "x-ms-structured-content-length": { + "x-ms-client-name": "StructuredContentLength", + "type": "integer", + "format": "int64", + "description": "The length of the blob/file content inside the message body when the response body is returned as a structured message. Will always be smaller than Content-Length." + } + }, + "schema": { + "type": "object", + "format": "file" + } + }, + "206": { + "description": "Succeeded to read a specified range of the file.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. Any operation that modifies the file or its properties updates the last modified time." + }, + "x-ms-meta": { + "type": "string", + "description": "A set of name-value pairs associated with this file as user-defined metadata.", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The number of bytes present in the response body." + }, + "Content-Type": { + "type": "string", + "description": "The content type specified for the file. The default content type is 'application/octet-stream'" + }, + "Content-Range": { + "type": "string", + "description": "Indicates the range of bytes returned if the client requested a subset of the file by setting the Range request header." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the file has an MD5 hash and the request is to read the full file, this response header is returned so that the client can check for message content integrity. If the request is to read a specified range and the 'x-ms-range-get-content-md5' is set to true, then the request returns an MD5 hash for the range, as long as the range size is less than or equal to 4 MB. If neither of these sets of conditions is true, then no value is returned for the 'Content-MD5' header." + }, + "Content-Encoding": { + "type": "string", + "description": "Returns the value that was specified for the Content-Encoding request header." + }, + "Cache-Control": { + "type": "string", + "description": "Returned if it was previously specified for the file." + }, + "Content-Disposition": { + "type": "string", + "description": "Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response." + }, + "Content-Language": { + "type": "string", + "description": "Returns the value that was specified for the Content-Language request header." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Accept-Ranges": { + "type": "string", + "description": "Indicates that the service supports requests for partial file content." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-copy-completion-time": { + "x-ms-client-name": "CopyCompletionTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt." + }, + "x-ms-copy-status-description": { + "x-ms-client-name": "CopyStatusDescription", + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure." + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for the last attempted Copy File operation where this file was the destination file." + }, + "x-ms-copy-progress": { + "x-ms-client-name": "CopyProgress", + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied." + }, + "x-ms-copy-source": { + "x-ms-client-name": "CopySource", + "type": "string", + "description": "URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by 'x-ms-copy-id'.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + }, + "x-ms-content-md5": { + "x-ms-client-name": "FileContentMD5", + "type": "string", + "format": "byte", + "description": "If the file has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole file's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range." + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted)." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the file." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the file." + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a file is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the file.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the file.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + }, + "x-ms-structured-body": { + "x-ms-client-name": "StructuredBodyType", + "type": "string", + "description": "Indicates the response body contains a structured message and specifies the message schema version and properties." + }, + "x-ms-structured-content-length": { + "x-ms-client-name": "StructuredContentLength", + "type": "integer", + "format": "int64", + "description": "The length of the blob/file content inside the message body when the response body is returned as a structured message. Will always be smaller than Content-Length." + } + }, + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "head": { + "tags": [ + "file" + ], + "operationId": "File_GetProperties", + "description": "Returns all user-defined metadata, standard HTTP properties, and system properties for the file. It does not return the content of the file.", + "parameters": [ + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. The date format follows RFC 1123. Any operation that modifies the file or its properties updates the last modified time." + }, + "x-ms-meta": { + "type": "string", + "description": "A set of name-value pairs associated with this file as user-defined metadata.", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "x-ms-type": { + "x-ms-client-name": "FileType", + "description": "Returns the type File. Reserved for future use.", + "type": "string", + "enum": [ + "File" + ] + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The size of the file in bytes. This header returns the value of the 'x-ms-content-length' header that is stored with the file." + }, + "Content-Type": { + "type": "string", + "description": "The content type specified for the file. The default content type is 'application/octet-stream'" + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the Content-MD5 header has been set for the file, the Content-MD5 response header is returned so that the client can check for message content integrity." + }, + "Content-Encoding": { + "type": "string", + "description": "If the Content-Encoding request header has previously been set for the file, the Content-Encoding value is returned in this header." + }, + "Cache-Control": { + "type": "string", + "description": "If the Cache-Control request header has previously been set for the file, the Cache-Control value is returned in this header." + }, + "Content-Disposition": { + "type": "string", + "description": "Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response." + }, + "Content-Language": { + "type": "string", + "description": "Returns the value that was specified for the Content-Language request header." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-copy-completion-time": { + "x-ms-client-name": "CopyCompletionTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt." + }, + "x-ms-copy-status-description": { + "x-ms-client-name": "CopyStatusDescription", + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure." + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for the last attempted Copy File operation where this file was the destination file." + }, + "x-ms-copy-progress": { + "x-ms-client-name": "CopyProgress", + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied." + }, + "x-ms-copy-source": { + "x-ms-client-name": "CopySource", + "type": "string", + "description": "URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by 'x-ms-copy-id'.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted)." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the file." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the file." + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a file is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the file.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the file.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "delete": { + "tags": [ + "file" + ], + "operationId": "File_Delete", + "description": "removes the file from the storage account.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "202": { + "description": "Success (Accepted).", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=properties": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_SetHTTPHeaders", + "description": "Sets HTTP headers on the file.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "x-ms-content-length", + "x-ms-client-name": "fileContentLength", + "in": "header", + "description": "Resizes a file to the specified size. If the specified byte value is less than the current size of the file, then all ranges above the specified byte value are cleared.", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "$ref": "#/parameters/FileContentType" + }, + { + "$ref": "#/parameters/FileContentEncoding" + }, + { + "$ref": "#/parameters/FileContentLanguage" + }, + { + "$ref": "#/parameters/FileCacheControl" + }, + { + "$ref": "#/parameters/FileContentMD5" + }, + { + "$ref": "#/parameters/FileContentDisposition" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionFormat" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/FileAttributes" + }, + { + "$ref": "#/parameters/FileCreationTime" + }, + { + "$ref": "#/parameters/FileLastWriteTime" + }, + { + "$ref": "#/parameters/FileChangeTime" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the directory was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the directory." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the directory." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=metadata": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_SetMetadata", + "description": "Updates user-defined metadata for the specified file.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success (OK).", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "metadata" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=lease&acquire": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_AcquireLease", + "description": "[Update] The Lease File operation establishes and manages a lock on a file for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseDuration" + }, + { + "$ref": "#/parameters/ProposedLeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "201": { + "description": "The Acquire operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a file's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "acquire" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=lease&release": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_ReleaseLease", + "description": "[Update] The Lease File operation establishes and manages a lock on a file for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The Release operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "release" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=lease&change": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_ChangeLease", + "description": "[Update] The Lease File operation establishes and manages a lock on a file for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/ProposedLeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The Change operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a file's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "change" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=lease&break": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_BreakLease", + "description": "[Update] The Lease File operation establishes and manages a lock on a file for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "202": { + "description": "The Break operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a file's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "break" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=range": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_UploadRange", + "description": "Upload a range of bytes to a file.", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/OptionalBody" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "name": "x-ms-range", + "x-ms-client-name": "range", + "in": "header", + "description": "Specifies the range of bytes to be written. Both the start and end of the range must be specified. For an update operation, the range can be up to 4 MB in size. For a clear operation, the range can be up to the value of the file's full size. The File service accepts only a single byte range for the Range and 'x-ms-range' headers, and the byte range must be specified in the following format: bytes=startByte-endByte.", + "required": true, + "type": "string" + }, + { + "name": "x-ms-write", + "x-ms-client-name": "FileRangeWrite", + "in": "header", + "description": "Specify one of the following options: - Update: Writes the bytes specified by the request body into the specified range. The Range and Content-Length headers must match to perform the update. - Clear: Clears the specified range and releases the space used in storage for that range. To clear a range, set the Content-Length header to zero, and set the Range header to a value that indicates the range to clear, up to maximum file size.", + "required": true, + "type": "string", + "enum": [ + "update", + "clear" + ], + "default": "update", + "x-ms-enum": { + "name": "FileRangeWriteType", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/ContentMD5" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/FileLastWriteTimeMode" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + }, + { + "$ref": "#/parameters/StructuredBodyPut" + }, + { + "$ref": "#/parameters/StructuredContentLength" + } + ], + "responses": { + "201": { + "description": "Success (Created).", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the directory was last modified. Any operation that modifies the share or its properties or metadata updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the File service; it is not necessarily the same value as may have been specified in the request headers." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-structured-body": { + "x-ms-client-name": "StructuredBodyType", + "type": "string", + "description": "Indicates the structured message body was accepted and mirrors back the message schema version and properties." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "range" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=range&fromURL": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_UploadRangeFromURL", + "description": "Upload a range of bytes to a file where the contents are read from a URL.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/TargetRange" + }, + { + "$ref": "#/parameters/CopySource" + }, + { + "$ref": "#/parameters/SourceRange" + }, + { + "$ref": "#/parameters/FileRangeWriteFromUrl" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/SourceContentCrc64" + }, + { + "$ref": "#/parameters/SourceIfMatchCrc64" + }, + { + "$ref": "#/parameters/SourceIfNoneMatchCrc64" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/CopySourceAuthorization" + }, + { + "$ref": "#/parameters/FileLastWriteTimeMode" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/SourceAllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "201": { + "description": "Success (Created).", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the directory was last modified. Any operation that modifies the share or its properties or metadata updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the File service; it is not necessarily the same value as may have been specified in the request headers." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "range" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=rangelist": { + "get": { + "tags": [ + "file" + ], + "operationId": "File_GetRangeList", + "description": "Returns the list of valid ranges for a file.", + "parameters": [ + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/PrevShareSnapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "x-ms-range", + "x-ms-client-name": "range", + "in": "header", + "description": "Specifies the range of bytes over which to list ranges, inclusively.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + }, + { + "$ref": "#/parameters/SupportRename" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "The date/time that the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the file's last modified time." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "x-ms-content-length": { + "x-ms-client-name": "FileContentLength", + "type": "integer", + "format": "int64", + "description": "The size of the file in bytes." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + }, + "schema": { + "$ref": "#/definitions/ShareFileRangeList" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "rangelist" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=copy": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_StartCopy", + "description": "Copies a blob or file to a destination file within the storage account.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/CopySource" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionFormat" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/FileCopyPermissionCopyMode" + }, + { + "$ref": "#/parameters/FileCopyIgnoreReadOnly" + }, + { + "$ref": "#/parameters/FileCopyFileAttributes" + }, + { + "$ref": "#/parameters/FileCopyFileCreationTime" + }, + { + "$ref": "#/parameters/FileCopyFileLastWriteTime" + }, + { + "$ref": "#/parameters/FileCopyFileChangeTime" + }, + { + "$ref": "#/parameters/FileCopySetArchiveAttribute" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/SourceAllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "202": { + "description": "The copy file has been accepted with the specified copy status.", + "headers": { + "ETag": { + "type": "string", + "description": "If the copy is completed, contains the ETag of the destination file. If the copy is not complete, contains the ETag of the empty file created at the start of the copy." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date/time that the copy operation to the destination file completed." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for this copy operation. Use with Get File or Get File Properties to check the status of this copy operation, or pass to Abort Copy File to abort a pending copy." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by x-ms-copy-id.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=copy©id": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_AbortCopy", + "description": "Aborts a pending Copy File operation, and leaves a destination file with zero length and full metadata.", + "parameters": [ + { + "$ref": "#/parameters/CopyId" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/CopyActionAbort" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "204": { + "description": "The delete request was accepted and the file will be deleted.", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "copy" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=listhandles": { + "get": { + "tags": [ + "file" + ], + "operationId": "File_ListHandles", + "description": "Lists handles for file", + "parameters": [ + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Content-Type": { + "type": "string", + "description": "Specifies the format in which the results are returned. Currently this value is 'application/xml'." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + }, + "schema": { + "$ref": "#/definitions/ListHandlesResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "listhandles" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=forceclosehandles": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_ForceCloseHandles", + "description": "Closes all handles open for given file", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/HandleId" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-marker": { + "x-ms-client-name": "marker", + "type": "string", + "description": "A string describing next handle to be closed. It is returned when more handles need to be closed to complete the request." + }, + "x-ms-number-of-handles-closed": { + "x-ms-client-name": "numberOfHandlesClosed", + "type": "integer", + "description": "Contains count of number of handles closed." + }, + "x-ms-number-of-handles-failed": { + "x-ms-client-name": "numberOfHandlesFailedToClose", + "type": "integer", + "description": "Contains count of number of handles that failed to close." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "forceclosehandles" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=rename": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_Rename", + "description": "Renames a file", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/RenameSource" + }, + { + "$ref": "#/parameters/RenameReplaceIfExists" + }, + { + "$ref": "#/parameters/RenameIgnoreReadOnly" + }, + { + "$ref": "#/parameters/SourceLeaseId" + }, + { + "$ref": "#/parameters/DestinationLeaseId" + }, + { + "$ref": "#/parameters/FileCopyFileAttributes" + }, + { + "$ref": "#/parameters/FileCopyFileCreationTime" + }, + { + "$ref": "#/parameters/FileCopyFileLastWriteTime" + }, + { + "$ref": "#/parameters/FileCopyFileChangeTime" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionFormat" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/FileContentType" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/SourceAllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the file." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the directory." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "rename" + ] + } + ] + } + }, + "definitions": { + "AccessRight": { + "description": "Access rights of the access policy.", + "type": "string", + "enum": [ + "Read", + "Write", + "Delete" + ], + "x-ms-enum": { + "name": "AccessRight", + "modelAsString": false + } + }, + "AccessPolicy": { + "description": "An Access policy.", + "type": "object", + "properties": { + "Start": { + "description": "The date-time the policy is active.", + "type": "string", + "format": "date-time" + }, + "Expiry": { + "description": "The date-time the policy expires.", + "type": "string", + "format": "date-time" + }, + "Permission": { + "description": "The permissions for the ACL policy.", + "type": "string" + } + } + }, + "CorsRule": { + "description": "CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain.", + "type": "object", + "required": [ + "AllowedOrigins", + "AllowedMethods", + "AllowedHeaders", + "ExposedHeaders", + "MaxAgeInSeconds" + ], + "properties": { + "AllowedOrigins": { + "description": "The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.", + "type": "string" + }, + "AllowedMethods": { + "description": "The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)", + "type": "string" + }, + "AllowedHeaders": { + "description": "The request headers that the origin domain may specify on the CORS request.", + "type": "string" + }, + "ExposedHeaders": { + "description": "The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.", + "type": "string" + }, + "MaxAgeInSeconds": { + "description": "The maximum amount time that a browser should cache the preflight OPTIONS request.", + "type": "integer", + "minimum": 0 + } + } + }, + "ErrorCode": { + "description": "Error codes returned by the service", + "type": "string", + "enum": [ + "AccountAlreadyExists", + "AccountBeingCreated", + "AccountIsDisabled", + "AuthenticationFailed", + "AuthorizationFailure", + "ConditionHeadersNotSupported", + "ConditionNotMet", + "EmptyMetadataKey", + "FileShareProvisionedBandwidthDowngradeNotAllowed", + "FileShareProvisionedIopsDowngradeNotAllowed", + "InsufficientAccountPermissions", + "InternalError", + "InvalidAuthenticationInfo", + "InvalidHeaderValue", + "InvalidHttpVerb", + "InvalidInput", + "InvalidMd5", + "InvalidMetadata", + "InvalidQueryParameterValue", + "InvalidRange", + "InvalidResourceName", + "InvalidUri", + "InvalidXmlDocument", + "InvalidXmlNodeValue", + "Md5Mismatch", + "MetadataTooLarge", + "MissingContentLengthHeader", + "MissingRequiredQueryParameter", + "MissingRequiredHeader", + "MissingRequiredXmlNode", + "MultipleConditionHeadersNotSupported", + "OperationTimedOut", + "OutOfRangeInput", + "OutOfRangeQueryParameterValue", + "RequestBodyTooLarge", + "ResourceTypeMismatch", + "RequestUrlFailedToParse", + "ResourceAlreadyExists", + "ResourceNotFound", + "ServerBusy", + "UnsupportedHeader", + "UnsupportedXmlNode", + "UnsupportedQueryParameter", + "UnsupportedHttpVerb", + "CannotDeleteFileOrDirectory", + "ClientCacheFlushDelay", + "DeletePending", + "DirectoryNotEmpty", + "FileLockConflict", + "InvalidFileOrDirectoryPathName", + "ParentNotFound", + "ReadOnlyAttribute", + "ShareAlreadyExists", + "ShareBeingDeleted", + "ShareDisabled", + "ShareNotFound", + "SharingViolation", + "ShareSnapshotInProgress", + "ShareSnapshotCountExceeded", + "ShareSnapshotOperationNotSupported", + "ShareHasSnapshots", + "PreviousSnapshotNotFound", + "ContainerQuotaDowngradeNotAllowed", + "AuthorizationSourceIPMismatch", + "AuthorizationProtocolMismatch", + "AuthorizationPermissionMismatch", + "AuthorizationServiceMismatch", + "AuthorizationResourceTypeMismatch", + "FeatureVersionMismatch" + ], + "x-ms-enum": { + "name": "StorageErrorCode", + "modelAsString": true + } + }, + "FilesAndDirectoriesListSegment": { + "description": "Abstract for entries that can be listed from Directory.", + "type": "object", + "required": [ + "DirectoryItems", + "FileItems" + ], + "properties": { + "DirectoryItems": { + "type": "array", + "items": { + "$ref": "#/definitions/DirectoryItem" + } + }, + "FileItems": { + "type": "array", + "items": { + "$ref": "#/definitions/FileItem" + } + } + }, + "xml": { + "name": "Entries" + } + }, + "DirectoryItem": { + "xml": { + "name": "Directory" + }, + "description": "A listed directory item.", + "type": "object", + "required": [ + "Name" + ], + "properties": { + "Name": { + "$ref": "#/definitions/StringEncoded" + }, + "FileId": { + "type": "string" + }, + "Properties": { + "$ref": "#/definitions/FileProperty" + }, + "Attributes": { + "type": "string" + }, + "PermissionKey": { + "type": "string" + } + } + }, + "FileItem": { + "xml": { + "name": "File" + }, + "description": "A listed file item.", + "type": "object", + "required": [ + "Name", + "Properties" + ], + "properties": { + "Name": { + "$ref": "#/definitions/StringEncoded" + }, + "FileId": { + "type": "string" + }, + "Properties": { + "$ref": "#/definitions/FileProperty" + }, + "Attributes": { + "type": "string" + }, + "PermissionKey": { + "type": "string" + } + } + }, + "StringEncoded": { + "type": "object", + "properties": { + "Encoded": { + "xml": { + "name": "Encoded", + "attribute": true + }, + "type": "boolean" + }, + "content": { + "xml": { + "x-ms-text": true + }, + "type": "string" + } + } + }, + "FileProperty": { + "description": "File properties.", + "type": "object", + "required": [ + "Content-Length" + ], + "properties": { + "Content-Length": { + "description": "Content length of the file. This value may not be up-to-date since an SMB client may have modified the file locally. The value of Content-Length may not reflect that fact until the handle is closed or the op-lock is broken. To retrieve current property values, call Get File Properties.", + "type": "integer", + "format": "int64" + }, + "CreationTime": { + "type": "string", + "format": "date-time" + }, + "LastAccessTime": { + "type": "string", + "format": "date-time" + }, + "LastWriteTime": { + "type": "string", + "format": "date-time" + }, + "ChangeTime": { + "type": "string", + "format": "date-time" + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123" + }, + "Etag": { + "type": "string" + } + } + }, + "HandleItem": { + "xml": { + "name": "Handle" + }, + "description": "A listed Azure Storage handle item.", + "type": "object", + "required": [ + "HandleId", + "Path", + "FileId", + "SessionId", + "ClientIp", + "ClientName", + "OpenTime" + ], + "properties": { + "HandleId": { + "type": "string", + "description": "XSMB service handle ID" + }, + "Path": { + "$ref": "#/definitions/StringEncoded" + }, + "FileId": { + "type": "string", + "description": "FileId uniquely identifies the file or directory." + }, + "ParentId": { + "type": "string", + "description": "ParentId uniquely identifies the parent directory of the object." + }, + "SessionId": { + "type": "string", + "description": "SMB session ID in context of which the file handle was opened" + }, + "ClientIp": { + "type": "string", + "description": "Client IP that opened the handle" + }, + "ClientName": { + "type": "string", + "description": "Name of the client machine where the share is being mounted" + }, + "OpenTime": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Time when the session that previously opened the handle has last been reconnected. (UTC)" + }, + "LastReconnectTime": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Time handle was last connected to (UTC)" + }, + "AccessRightList": { + "type": "array", + "items": { + "$ref": "#/definitions/AccessRight" + }, + "xml": { + "wrapped": true + } + } + } + }, + "LeaseDuration": { + "xml": { + "name": "LeaseDuration" + }, + "description": "When a share is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "LeaseState": { + "xml": { + "name": "LeaseState" + }, + "description": "Lease state of the share.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "LeaseStatus": { + "xml": { + "name": "LeaseStatus" + }, + "description": "The current lease status of the share.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + }, + "ListFilesAndDirectoriesSegmentResponse": { + "xml": { + "name": "EnumerationResults" + }, + "description": "An enumeration of directories and files.", + "type": "object", + "required": [ + "ServiceEndpoint", + "ShareName", + "DirectoryPath", + "Prefix", + "NextMarker", + "Segment" + ], + "properties": { + "ServiceEndpoint": { + "type": "string", + "xml": { + "attribute": true + } + }, + "ShareName": { + "type": "string", + "xml": { + "attribute": true + } + }, + "ShareSnapshot": { + "type": "string", + "xml": { + "attribute": true + } + }, + "Encoded": { + "type": "boolean", + "xml": { + "attribute": true + } + }, + "DirectoryPath": { + "type": "string", + "xml": { + "attribute": true + } + }, + "Prefix": { + "$ref": "#/definitions/StringEncoded" + }, + "Marker": { + "type": "string" + }, + "MaxResults": { + "type": "integer" + }, + "Segment": { + "$ref": "#/definitions/FilesAndDirectoriesListSegment" + }, + "NextMarker": { + "type": "string" + }, + "DirectoryId": { + "type": "string" + } + } + }, + "ListHandlesResponse": { + "xml": { + "name": "EnumerationResults" + }, + "description": "An enumeration of handles.", + "type": "object", + "required": [ + "NextMarker" + ], + "properties": { + "HandleList": { + "type": "array", + "items": { + "$ref": "#/definitions/HandleItem" + }, + "xml": { + "name": "Entries", + "wrapped": true + } + }, + "NextMarker": { + "type": "string" + } + } + }, + "ListSharesResponse": { + "xml": { + "name": "EnumerationResults" + }, + "description": "An enumeration of shares.", + "type": "object", + "required": [ + "ServiceEndpoint", + "NextMarker" + ], + "properties": { + "ServiceEndpoint": { + "type": "string", + "xml": { + "attribute": true + } + }, + "Prefix": { + "type": "string" + }, + "Marker": { + "type": "string" + }, + "MaxResults": { + "type": "integer" + }, + "ShareItems": { + "type": "array", + "items": { + "$ref": "#/definitions/ShareItemInternal" + }, + "xml": { + "name": "Shares", + "wrapped": true + } + }, + "NextMarker": { + "type": "string" + } + } + }, + "Metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "Metrics": { + "description": "Storage Analytics metrics for file service.", + "required": [ + "Version", + "Enabled" + ], + "properties": { + "Version": { + "description": "The version of Storage Analytics to configure.", + "type": "string" + }, + "Enabled": { + "description": "Indicates whether metrics are enabled for the File service.", + "type": "boolean" + }, + "IncludeAPIs": { + "description": "Indicates whether metrics should generate summary statistics for called API operations.", + "type": "boolean" + }, + "RetentionPolicy": { + "$ref": "#/definitions/RetentionPolicy" + } + } + }, + "SmbMultichannel": { + "description": "Settings for SMB multichannel", + "type": "object", + "properties": { + "Enabled": { + "type": "boolean", + "description": "If SMB multichannel is enabled." + } + }, + "xml": { + "name": "Multichannel" + } + }, + "FileRange": { + "description": "An Azure Storage file range.", + "type": "object", + "required": [ + "Start", + "End" + ], + "properties": { + "Start": { + "type": "integer", + "format": "int64", + "description": "Start of the range." + }, + "End": { + "type": "integer", + "format": "int64", + "description": "End of the range." + } + }, + "xml": { + "name": "Range" + } + }, + "ClearRange": { + "type": "object", + "required": [ + "Start", + "End" + ], + "properties": { + "Start": { + "type": "integer", + "format": "int64", + "xml": { + "name": "Start" + } + }, + "End": { + "type": "integer", + "format": "int64", + "xml": { + "name": "End" + } + } + }, + "xml": { + "name": "ClearRange" + } + }, + "ShareProtocolSettings": { + "description": "Protocol settings", + "type": "object", + "xml": { + "name": "ProtocolSettings" + }, + "properties": { + "Smb": { + "description": "Settings for SMB protocol.", + "$ref": "#/definitions/ShareSmbSettings" + } + } + }, + "ShareFileRangeList": { + "description": "The list of file ranges", + "type": "object", + "properties": { + "Ranges": { + "type": "array", + "items": { + "$ref": "#/definitions/FileRange" + } + }, + "ClearRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/ClearRange" + } + } + } + }, + "StorageError": { + "type": "object", + "properties": { + "Message": { + "type": "string" + }, + "AuthenticationErrorDetail": { + "type": "string" + } + } + }, + "RetentionPolicy": { + "description": "The retention policy.", + "type": "object", + "required": [ + "Enabled" + ], + "properties": { + "Enabled": { + "description": "Indicates whether a retention policy is enabled for the File service. If false, metrics data is retained, and the user is responsible for deleting it.", + "type": "boolean" + }, + "Days": { + "description": "Indicates the number of days that metrics data should be retained. All data older than this value will be deleted. Metrics data is deleted on a best-effort basis after the retention period expires.", + "type": "integer", + "minimum": 1, + "maximum": 365 + } + } + }, + "ShareItemInternal": { + "xml": { + "name": "Share" + }, + "description": "A listed Azure Storage share item.", + "type": "object", + "required": [ + "Name", + "Properties" + ], + "properties": { + "Name": { + "type": "string" + }, + "Snapshot": { + "type": "string" + }, + "Deleted": { + "type": "boolean" + }, + "Version": { + "type": "string" + }, + "Properties": { + "$ref": "#/definitions/SharePropertiesInternal" + }, + "Metadata": { + "$ref": "#/definitions/Metadata" + } + } + }, + "SharePropertiesInternal": { + "description": "Properties of a share.", + "type": "object", + "required": [ + "Last-Modified", + "Etag", + "Quota" + ], + "properties": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123" + }, + "Etag": { + "type": "string" + }, + "Quota": { + "type": "integer" + }, + "ProvisionedIops": { + "type": "integer" + }, + "ProvisionedIngressMBps": { + "type": "integer" + }, + "ProvisionedEgressMBps": { + "type": "integer" + }, + "ProvisionedBandwidthMiBps": { + "type": "integer" + }, + "NextAllowedQuotaDowngradeTime": { + "type": "string", + "format": "date-time-rfc1123" + }, + "DeletedTime": { + "type": "string", + "format": "date-time-rfc1123" + }, + "RemainingRetentionDays": { + "type": "integer" + }, + "AccessTier": { + "type": "string" + }, + "AccessTierChangeTime": { + "type": "string", + "format": "date-time-rfc1123" + }, + "AccessTierTransitionState": { + "type": "string" + }, + "LeaseStatus": { + "$ref": "#/definitions/LeaseStatus" + }, + "LeaseState": { + "$ref": "#/definitions/LeaseState" + }, + "LeaseDuration": { + "$ref": "#/definitions/LeaseDuration" + }, + "EnabledProtocols": { + "$ref": "#/definitions/ShareEnabledProtocols" + }, + "RootSquash": { + "$ref": "#/definitions/ShareRootSquash" + }, + "EnableSnapshotVirtualDirectoryAccess": { + "type": "boolean" + }, + "PaidBurstingEnabled": { + "type": "boolean" + }, + "PaidBurstingMaxIops": { + "type": "integer", + "format": "int64" + }, + "PaidBurstingMaxBandwidthMibps": { + "type": "integer", + "format": "int64" + }, + "IncludedBurstIops": { + "type": "integer", + "format": "int64" + }, + "MaxBurstCreditsForIops": { + "type": "integer", + "format": "int64" + }, + "NextAllowedProvisionedIopsDowngradeTime": { + "type": "string", + "format": "date-time-rfc1123" + }, + "NextAllowedProvisionedBandwidthDowngradeTime": { + "type": "string", + "format": "date-time-rfc1123" + } + } + }, + "ShareStats": { + "description": "Stats for the share.", + "type": "object", + "required": [ + "ShareUsageBytes" + ], + "properties": { + "ShareUsageBytes": { + "description": "The approximate size of the data stored in bytes. Note that this value may not include all recently created or recently resized files.", + "type": "integer" + } + } + }, + "SignedIdentifier": { + "description": "Signed identifier.", + "type": "object", + "required": [ + "Id" + ], + "properties": { + "Id": { + "type": "string", + "description": "A unique id." + }, + "AccessPolicy": { + "description": "The access policy.", + "$ref": "#/definitions/AccessPolicy" + } + } + }, + "SignedIdentifiers": { + "description": "A collection of signed identifiers.", + "type": "array", + "items": { + "$ref": "#/definitions/SignedIdentifier", + "xml": { + "name": "SignedIdentifier" + } + }, + "xml": { + "wrapped": true, + "name": "SignedIdentifiers" + } + }, + "ShareSmbSettings": { + "description": "Settings for SMB protocol.", + "type": "object", + "xml": { + "name": "SMB" + }, + "properties": { + "Multichannel": { + "description": "Settings for SMB Multichannel.", + "$ref": "#/definitions/SmbMultichannel" + } + } + }, + "StorageServiceProperties": { + "description": "Storage service properties.", + "type": "object", + "properties": { + "HourMetrics": { + "description": "A summary of request statistics grouped by API in hourly aggregates for files.", + "$ref": "#/definitions/Metrics" + }, + "MinuteMetrics": { + "description": "A summary of request statistics grouped by API in minute aggregates for files.", + "$ref": "#/definitions/Metrics" + }, + "Cors": { + "description": "The set of CORS rules.", + "type": "array", + "items": { + "$ref": "#/definitions/CorsRule" + }, + "xml": { + "wrapped": true + } + }, + "Protocol": { + "description": "Protocol settings", + "$ref": "#/definitions/ShareProtocolSettings" + } + } + }, + "SharePermission": { + "description": "A permission (a security descriptor) at the share level.", + "type": "object", + "required": [ + "permission" + ], + "properties": { + "permission": { + "type": "string", + "description": "The permission in the Security Descriptor Definition Language (SDDL)." + }, + "format": { + "type": "string", + "enum": [ + "Sddl", + "Binary" + ], + "x-ms-enum": { + "name": "FilePermissionFormat", + "modelAsString": false + } + } + } + }, + "ShareEnabledProtocols": { + "type": "string" + }, + "ShareRootSquash": { + "type": "string", + "enum": [ + "NoRootSquash", + "RootSquash", + "AllSquash" + ], + "x-ms-enum": { + "name": "ShareRootSquash", + "modelAsString": false + } + } + }, + "parameters": { + "AccessTierOptional": { + "name": "x-ms-access-tier", + "x-ms-client-name": "accessTier", + "in": "header", + "description": "Specifies the access tier of the share.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "enum": [ + "TransactionOptimized", + "Hot", + "Cool", + "Premium" + ], + "x-ms-enum": { + "name": "ShareAccessTier", + "modelAsString": true + } + }, + "ApiVersionParameter": { + "name": "x-ms-version", + "x-ms-client-name": "version", + "x-ms-parameter-location": "client", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "enum": [ + "2025-01-05" + ] + }, + "ClientRequestId": { + "name": "x-ms-client-request-id", + "x-ms-client-name": "requestId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." + }, + "ContentLength": { + "name": "Content-Length", + "x-ms-client-name": "contentLength", + "in": "header", + "description": "Specifies the number of bytes being transmitted in the request body. When the x-ms-write header is set to clear, the value of this header must be set to zero.", + "required": true, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method" + }, + "ContentMD5": { + "name": "Content-MD5", + "x-ms-client-name": "contentMD5", + "in": "header", + "description": "An MD5 hash of the content. This hash is used to verify the integrity of the data during transport. When the Content-MD5 header is specified, the File service compares the hash of the content that has arrived with the header value that was sent. If the two hashes do not match, the operation will fail with error code 400 (Bad Request).", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method" + }, + "CopyActionAbort": { + "name": "x-ms-copy-action", + "x-ms-client-name": "copyActionAbortConstant", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "abort" + ], + "x-ms-parameter-location": "method", + "description": "Abort." + }, + "CopyId": { + "name": "copyid", + "x-ms-client-name": "copyId", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The copy identifier provided in the x-ms-copy-id header of the original Copy File operation." + }, + "CopySource": { + "name": "x-ms-copy-source", + "x-ms-client-name": "copySource", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Specifies the URL of the source file or blob, up to 2 KB in length. To copy a file to another file within the same storage account, you may use Shared Key to authenticate the source file. If you are copying a file from another storage account, or if you are copying a blob from the same storage account or another storage account, then you must authenticate the source file or blob using a shared access signature. If the source is a public blob, no authentication is required to perform the copy operation. A file in a share snapshot can also be specified as a copy source." + }, + "CopySourceAuthorization": { + "name": "x-ms-copy-source-authorization", + "x-ms-client-name": "copySourceAuthorization", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source." + }, + "FileCopyPermissionCopyMode": { + "name": "x-ms-file-permission-copy-mode", + "x-ms-client-name": "filePermissionCopyMode", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "source", + "override" + ], + "x-ms-enum": { + "name": "PermissionCopyModeType", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies the option to copy file security descriptor from source file or to set it using the value which is defined by the header value of x-ms-file-permission or x-ms-file-permission-key." + }, + "FileCopyIgnoreReadOnly": { + "name": "x-ms-file-copy-ignore-readonly", + "x-ms-client-name": "ignoreReadOnly", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies the option to overwrite the target file if it already exists and has read-only attribute set." + }, + "FileCopyFileAttributes": { + "name": "x-ms-file-attributes", + "x-ms-client-name": "fileAttributes", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies either the option to copy file attributes from a source file(source) to a target file or a list of attributes to set on a target file." + }, + "FileCopyFileCreationTime": { + "name": "x-ms-file-creation-time", + "x-ms-client-name": "fileCreationTime", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies either the option to copy file creation time from a source file(source) to a target file or a time value in ISO 8601 format to set as creation time on a target file." + }, + "FileCopyFileLastWriteTime": { + "name": "x-ms-file-last-write-time", + "x-ms-client-name": "fileLastWriteTime", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies either the option to copy file last write time from a source file(source) to a target file or a time value in ISO 8601 format to set as last write time on a target file." + }, + "FileCopyFileChangeTime": { + "name": "x-ms-file-change-time", + "x-ms-client-name": "fileChangeTime", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies either the option to copy file last write time from a source file(source) to a target file or a time value in ISO 8601 format to set as last write time on a target file." + }, + "FileCopySetArchiveAttribute": { + "name": "x-ms-file-copy-set-archive", + "x-ms-client-name": "setArchiveAttribute", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies the option to set archive attribute on a target file. True means archive attribute will be set on a target file despite attribute overrides or a source file state." + }, + "DeletedShareName": { + "name": "x-ms-deleted-share-name", + "x-ms-client-name": "DeletedShareName", + "description": "Specifies the name of the previously-deleted share.", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DirectoryPath": { + "name": "directory", + "in": "path", + "description": "The path of the target directory.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": false + }, + "FilePath": { + "name": "fileName", + "in": "path", + "description": "The path of the target file.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": false + }, + "ShareName": { + "name": "shareName", + "in": "path", + "description": "The name of the target share.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DeletedShareVersion": { + "name": "x-ms-deleted-share-version", + "x-ms-client-name": "DeletedShareVersion", + "description": "Specifies the version of the previously-deleted share.", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DeleteSnapshots": { + "name": "x-ms-delete-snapshots", + "x-ms-client-name": "deleteSnapshots", + "description": "Specifies the option include to delete the base share and all of its snapshots.", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "include", + "include-leased" + ], + "x-ms-enum": { + "name": "DeleteSnapshotsOptionType", + "modelAsString": false + }, + "x-ms-parameter-location": "method" + }, + "DestinationLeaseId": { + "name": "x-ms-destination-lease-id", + "x-ms-client-name": "destinationLeaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "destination-lease-access-conditions" + }, + "description": "Required if the destination file has an active infinite lease. The lease ID specified for this header must match the lease ID of the destination file. If the request does not include the lease ID or it is not valid, the operation fails with status code 412 (Precondition Failed). If this header is specified and the destination file does not currently have an active lease, the operation will also fail with status code 412 (Precondition Failed)." + }, + "EnableSnapshotVirtualDirectoryAccess": { + "name": "x-ms-enable-snapshot-virtual-directory-access", + "x-ms-client-name": "enableSnapshotVirtualDirectoryAccess", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "FileAttributes": { + "name": "x-ms-file-attributes", + "x-ms-client-name": "FileAttributes", + "in": "header", + "description": "If specified, the provided file attributes shall be set. Default value: ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "FileCacheControl": { + "name": "x-ms-cache-control", + "x-ms-client-name": "fileCacheControl", + "description": "Sets the file's cache control. The File service stores this value but does not use or modify it.", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "file-HTTP-headers" + } + }, + "FileContentDisposition": { + "name": "x-ms-content-disposition", + "x-ms-client-name": "fileContentDisposition", + "description": "Sets the file's Content-Disposition header.", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "file-HTTP-headers" + } + }, + "FileContentEncoding": { + "name": "x-ms-content-encoding", + "x-ms-client-name": "fileContentEncoding", + "in": "header", + "description": "Specifies which content encodings have been applied to the file.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "file-HTTP-headers" + } + }, + "FileContentLanguage": { + "name": "x-ms-content-language", + "x-ms-client-name": "fileContentLanguage", + "in": "header", + "description": "Specifies the natural languages used by this resource.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "file-HTTP-headers" + } + }, + "FileContentMD5": { + "name": "x-ms-content-md5", + "x-ms-client-name": "fileContentMD5", + "in": "header", + "description": "Sets the file's MD5 hash.", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "file-HTTP-headers" + } + }, + "FileContentType": { + "name": "x-ms-content-type", + "x-ms-client-name": "fileContentType", + "in": "header", + "description": "Sets the MIME content type of the file. The default type is 'application/octet-stream'.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "file-HTTP-headers" + } + }, + "FileCreationTime": { + "name": "x-ms-file-creation-time", + "x-ms-client-name": "FileCreationTime", + "in": "header", + "description": "Creation time for the file/directory. Default value: Now.", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method" + }, + "FileLastWriteTime": { + "name": "x-ms-file-last-write-time", + "x-ms-client-name": "FileLastWriteTime", + "in": "header", + "description": "Last write time for the file/directory. Default value: Now.", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method" + }, + "FileChangeTime": { + "name": "x-ms-file-change-time", + "x-ms-client-name": "FileChangeTime", + "in": "header", + "description": "Change time for the file/directory. Default value: Now.", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method" + }, + "FileLastWriteTimeMode": { + "name": "x-ms-file-last-write-time", + "x-ms-client-name": "FileLastWrittenMode", + "in": "header", + "description": "If the file last write time should be preserved or overwritten", + "required": false, + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "Now", + "Preserve" + ], + "x-ms-enum": { + "name": "FileLastWrittenMode", + "modelAsString": false + } + }, + "FilePermission": { + "name": "x-ms-file-permission", + "x-ms-client-name": "FilePermission", + "in": "header", + "description": "If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "FilePermissionKey": { + "name": "x-ms-file-permission-key", + "x-ms-client-name": "FilePermissionKey", + "in": "header", + "description": "Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "FilePermissionFormat": { + "name": "x-ms-file-permission-format", + "x-ms-client-name": "FilePermissionFormat", + "description": "Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission", + "in": "header", + "x-ms-parameter-location": "method", + "required": false, + "type": "string", + "enum": [ + "Sddl", + "Binary" + ], + "x-ms-enum": { + "name": "FilePermissionFormat", + "modelAsString": false + } + }, + "FilePermissionKeyRequired": { + "name": "x-ms-file-permission-key", + "x-ms-client-name": "FilePermissionKey", + "in": "header", + "description": "Key of the permission to be set for the directory/file.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "FileRangeWriteFromUrl": { + "name": "x-ms-write", + "x-ms-parameter-location": "client", + "x-ms-client-name": "fileRangeWriteFromUrl", + "in": "header", + "description": "Only update is supported: - Update: Writes the bytes downloaded from the source url into the specified range.", + "required": true, + "type": "string", + "enum": [ + "update" + ], + "default": "update", + "x-ms-enum": { + "name": "FileRangeWriteFromUrlType", + "modelAsString": false + } + }, + "FileRequestIntent": { + "name": "x-ms-file-request-intent", + "x-ms-client-name": "fileRequestIntent", + "in": "header", + "description": "Valid value is backup", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true + } + }, + "SupportRename": { + "name": "x-ms-file-support-rename", + "x-ms-client-name": "SupportRename", + "in": "header", + "required": false, + "type": "boolean", + "description": "This header is allowed only when PrevShareSnapshot query parameter is set. Determines whether the changed ranges for a file that has been renamed or moved between the target snapshot (or the live file) and the previous snapshot should be listed. If the value is true, the valid changed ranges for the file will be returned. If the value is false, the operation will result in a failure with 409 (Conflict) response. The default value is false.", + "x-ms-parameter-location": "method" + }, + "FileType": { + "name": "x-ms-type", + "x-ms-client-name": "fileTypeConstant", + "in": "header", + "required": true, + "description": "Dummy constant parameter, file type can only be file.", + "type": "string", + "enum": [ + "file" + ], + "x-ms-parameter-location": "method" + }, + "GetRangeContentMD5": { + "name": "x-ms-range-get-content-md5", + "x-ms-client-name": "rangeGetContentMD5", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "When this header is set to true and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size." + }, + "StructuredBodyGet": { + "name": "x-ms-structured-body", + "x-ms-client-name": "StructuredBodyType", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Specifies the response content should be returned as a structured message and specifies the message schema version and properties." + }, + "StructuredBodyPut": { + "name": "x-ms-structured-body", + "x-ms-client-name": "StructuredBodyType", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Required if the request body is a structured message. Specifies the message schema version and properties." + }, + "StructuredContentLength": { + "name": "x-ms-structured-content-length", + "x-ms-client-name": "StructuredContentLength", + "in": "header", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method", + "description": "Required if the request body is a structured message. Specifies the length of the blob/file content inside the message body. Will always be smaller than Content-Length." + }, + "HandleId": { + "name": "x-ms-handle-id", + "x-ms-client-name": "handleId", + "in": "header", + "description": "Specifies handle ID opened on the file or directory to be closed. Asterisk (‘*’) is a wildcard that specifies all handles.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "LeaseBreakPeriod": { + "name": "x-ms-lease-break-period", + "x-ms-client-name": "breakPeriod", + "in": "header", + "required": false, + "type": "integer", + "x-ms-parameter-location": "method", + "description": "For a break operation, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period. If this header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses, and an infinite lease breaks immediately." + }, + "LeaseDuration": { + "name": "x-ms-lease-duration", + "x-ms-client-name": "duration", + "in": "header", + "required": false, + "type": "integer", + "x-ms-parameter-location": "method", + "description": "Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change." + }, + "LeaseIdOptional": { + "name": "x-ms-lease-id", + "x-ms-client-name": "leaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "lease-access-conditions" + }, + "description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID." + }, + "LeaseIdRequired": { + "name": "x-ms-lease-id", + "x-ms-client-name": "leaseId", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Specifies the current lease ID on the resource." + }, + "ListFilesInclude": { + "name": "include", + "in": "query", + "description": "Include this parameter to specify one or more datasets to include in the response.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string", + "enum": [ + "Timestamps", + "Etag", + "Attributes", + "PermissionKey" + ], + "x-ms-enum": { + "name": "ListFilesIncludeType", + "modelAsString": false + } + }, + "x-ms-parameter-location": "method" + }, + "ListFilesExtendedInfo": { + "name": "x-ms-file-extended-info", + "x-ms-client-name": "includeExtendedInfo", + "x-ms-parameter-location": "method", + "in": "header", + "type": "boolean", + "required": false, + "description": "Include extended information." + }, + "ListSharesInclude": { + "name": "include", + "in": "query", + "description": "Include this parameter to specify one or more datasets to include in the response.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string", + "enum": [ + "snapshots", + "metadata", + "deleted" + ], + "x-ms-enum": { + "name": "ListSharesIncludeType", + "modelAsString": false + } + }, + "x-ms-parameter-location": "method" + }, + "Marker": { + "name": "marker", + "in": "query", + "description": "A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "MaxResults": { + "name": "maxresults", + "in": "query", + "description": "Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater than 5,000, the server will return up to 5,000 items.", + "required": false, + "type": "integer", + "minimum": 1, + "x-ms-parameter-location": "method" + }, + "Metadata": { + "name": "x-ms-meta", + "x-ms-client-name": "metadata", + "in": "header", + "description": "A name-value pair to associate with a file storage object.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "OptionalBody": { + "name": "optionalbody", + "in": "body", + "description": "Initial data.", + "required": false, + "schema": { + "type": "object", + "format": "file" + }, + "x-ms-parameter-location": "method" + }, + "PaidBurstingEnabled": { + "name": "x-ms-share-paid-bursting-enabled", + "x-ms-client-name": "paidBurstingEnabled", + "description": "Optional. Boolean. Default if not specified is false. This property enables paid bursting.", + "in": "header", + "x-ms-parameter-location": "method", + "required": false, + "type": "boolean" + }, + "PaidBurstingMaxBandwidthMibps": { + "name": "x-ms-share-paid-bursting-max-bandwidth-mibps", + "x-ms-client-name": "PaidBurstingMaxBandwidthMibps", + "description": "Optional. Integer. Default if not specified is the maximum throughput the file share can support. Current maximum for a file share is 10,340 MiB/sec.", + "in": "header", + "x-ms-parameter-location": "method", + "required": false, + "type": "integer", + "format": "int64" + }, + "PaidBurstingMaxIops": { + "name": "x-ms-share-paid-bursting-max-iops", + "x-ms-client-name": "paidBurstingMaxIops", + "description": "Optional. Integer. Default if not specified is the maximum IOPS the file share can support. Current maximum for a file share is 102,400 IOPS.", + "in": "header", + "x-ms-parameter-location": "method", + "required": false, + "type": "integer", + "format": "int64" + }, + "Prefix": { + "name": "prefix", + "in": "query", + "description": "Filters the results to return only entries whose name begins with the specified prefix.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "PrevShareSnapshot": { + "name": "prevsharesnapshot", + "in": "query", + "description": "The previous snapshot parameter is an opaque DateTime value that, when present, specifies the previous snapshot.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ProposedLeaseIdOptional": { + "name": "x-ms-proposed-lease-id", + "x-ms-client-name": "proposedLeaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Proposed lease ID, in a GUID string format. The File service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats." + }, + "ProposedLeaseIdRequired": { + "name": "x-ms-proposed-lease-id", + "x-ms-client-name": "proposedLeaseId", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Proposed lease ID, in a GUID string format. The File service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats." + }, + "Range": { + "name": "x-ms-range", + "x-ms-client-name": "range", + "in": "header", + "description": "Return file data only from the specified byte range.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Recursive": { + "name": "x-ms-recursive", + "x-ms-client-name": "recursive", + "in": "header", + "description": "Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files.", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "RenameIgnoreReadOnly": { + "name": "x-ms-file-rename-ignore-readonly", + "x-ms-client-name": "ignoreReadOnly", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "Optional. A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected. If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly attribute set will cause the rename to fail." + }, + "RenameReplaceIfExists": { + "name": "x-ms-file-rename-replace-if-exists", + "x-ms-client-name": "replaceIfExists", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "Optional. A boolean value for if the destination file already exists, whether this request will overwrite the file or not. If true, the rename will succeed and will overwrite the destination file. If not provided or if false and the destination file does exist, the request will not overwrite the destination file. If provided and the destination file doesn’t exist, the rename will succeed. Note: This value does not override the x-ms-file-copy-ignore-read-only header value." + }, + "RenameSource": { + "name": "x-ms-file-rename-source", + "x-ms-client-name": "renameSource", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Required. Specifies the URI-style path of the source file, up to 2 KB in length." + }, + "Url": { + "name": "url", + "x-ms-parameter-location": "client", + "in": "path", + "description": "The URL of the service account, share, directory or file that is the target of the desired operation.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true + }, + "ShareAcl": { + "name": "shareAcl", + "in": "body", + "description": "The ACL for the share.", + "schema": { + "$ref": "#/definitions/SignedIdentifiers" + }, + "x-ms-parameter-location": "method" + }, + "ShareProvisionedIops": { + "name": "x-ms-share-provisioned-iops", + "x-ms-client-name": "shareProvisionedIops", + "in": "header", + "description": "Optional. The provisioned IOPS of the share. If this is not specified, compute the recommended IOPS of the share using the formula for a share in this media tier (SSD/HDD as appropriate). The provisioned IOPS of the share is always explicitly stored on the share object, even if the recommendation formula is used.", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method" + }, + "ShareProvisionedBandwidthMibps": { + "name": "x-ms-share-provisioned-bandwidth-mibps", + "x-ms-client-name": "shareProvisionedBandwidthMibps", + "in": "header", + "description": "Optional. The provisioned throughput of the share. If this is not specified, compute the recommended throughput of the share using the formula for a share in this media tier (SSD/HDD as appropriate).", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method" + }, + "ShareQuota": { + "name": "x-ms-share-quota", + "x-ms-client-name": "quota", + "in": "header", + "description": "Specifies the maximum size of the share, in gigabytes.", + "required": false, + "type": "integer", + "minimum": 1, + "x-ms-parameter-location": "method" + }, + "ShareSnapshot": { + "name": "sharesnapshot", + "in": "query", + "description": "The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SourceContentCrc64": { + "name": "x-ms-source-content-crc64", + "x-ms-client-name": "sourceContentCrc64", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "description": "Specify the crc64 calculated for the range of bytes that must be read from the copy source." + }, + "SourceIfMatchCrc64": { + "name": "x-ms-source-if-match-crc64", + "x-ms-client-name": "sourceIfMatchCrc64", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify the crc64 value to operate only on range with a matching crc64 checksum." + }, + "SourceIfNoneMatchCrc64": { + "name": "x-ms-source-if-none-match-crc64", + "x-ms-client-name": "sourceIfNoneMatchCrc64", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify the crc64 value to operate only on range without a matching crc64 checksum." + }, + "SourceLeaseId": { + "name": "x-ms-source-lease-id", + "x-ms-client-name": "sourceLeaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-lease-access-conditions" + }, + "description": "Required if the source file has an active infinite lease." + }, + "SourceRange": { + "name": "x-ms-source-range", + "x-ms-client-name": "sourceRange", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Bytes of source data in the specified range." + }, + "StorageServiceProperties": { + "name": "StorageServiceProperties", + "in": "body", + "description": "The StorageService properties.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageServiceProperties" + }, + "x-ms-parameter-location": "method" + }, + "TargetRange": { + "name": "x-ms-range", + "x-ms-client-name": "Range", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Writes data to the specified byte range in the file." + }, + "Timeout": { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.", + "required": false, + "type": "integer", + "minimum": 0, + "x-ms-parameter-location": "method" + }, + "SharePermission": { + "name": "sharePermission", + "in": "body", + "description": "A permission (a security descriptor) at the share level.", + "required": true, + "schema": { + "$ref": "#/definitions/SharePermission" + }, + "x-ms-parameter-location": "method" + }, + "ShareEnabledProtocols": { + "name": "x-ms-enabled-protocols", + "description": "Protocols to enable on the share.", + "x-ms-client-name": "enabledProtocols", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ShareRootSquash": { + "name": "x-ms-root-squash", + "description": "Root squash to set on the share. Only valid for NFS shares.", + "x-ms-client-name": "rootSquash", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "NoRootSquash", + "RootSquash", + "AllSquash" + ], + "x-ms-enum": { + "name": "ShareRootSquash", + "modelAsString": false + }, + "x-ms-parameter-location": "method" + }, + "AllowTrailingDot": { + "name": "x-ms-allow-trailing-dot", + "description": "If true, the trailing dot will not be trimmed from the target URI.", + "x-ms-client-name": "allowTrailingDot", + "in": "header", + "required": false, + "type": "boolean" + }, + "SourceAllowTrailingDot": { + "name": "x-ms-source-allow-trailing-dot", + "description": "If true, the trailing dot will not be trimmed from the source URI.", + "x-ms-client-name": "allowSourceTrailingDot", + "in": "header", + "required": false, + "type": "boolean" + } + } +} From cef1712ba5ec146dbc53ad480217325d2374a7b1 Mon Sep 17 00:00:00 2001 From: xuhumsft <116764429+xuhumsft@users.noreply.github.com> Date: Wed, 25 Sep 2024 21:39:46 -0700 Subject: [PATCH 21/48] Dev sentinel securityinsights microsoft.security insights 2024 04 01 preview (#28437) * Adds base for updating Microsoft.SecurityInsights from version preview/2024-01-01-preview to version 2024-04-01-preview * Updates readme * Updates API version in new specs and examples * Release sentinel 2024 04 01 preview business applications agents (#28504) * businessApplicationAgents * prettier * businessApplicationAgents * add displayName to be required (#28720) * Add breaking changes from last stable version (#28904) * remove 4 values from enum (#28931) * [Enrichment API] Remove deprecated api (#29059) * remove deprecated api * delete examples * remove old enrichment.json reference --------- Co-authored-by: Camilo Gonzalez Tabares * update the pattern for bookmark (#29100) * update bizapps (#29122) * update bizapps * Update BusinessApplicationAgents.json * update name for SDK * update resource name for SDK * update agentsystem * Sentinel-2024-04-01-preview-AdvancedAutomationRulesConditionsForIncidentLabels (#29246) Support automation rules with conditions on incident labels as a collection * Add suppressions for AvoidAdditionalProperties (#29278) * Update readme.md Add suppressions for data connector * Add suppressions * add suppressions (#29432) Co-authored-by: Offir Shvartz * Update dataConnectors.json (#29394) * update suffix to port (#29372) * Added x-ms-pageable and NextList to GetRecommendations (#29465) * Fix readonly and additionalProperties in OnDemand (#29595) * fix readonly and additionalProperties in OnDemand * update reason for suppressing AvoidAdditionalProperties * fix prettier * Fix Lro in OnDemand (#29603) * Fix Lro Error in OnDemand * fix prettier * updated settings file (#29658) * updated settings file * fix model issues * ran prettier * Update Entities Controllers Lint Exceptions (#29462) * Update EntityQueryTemplates.json * Update EntityQueries.json * Update Entities.json * Fix File Import Failures (#29515) * fix failures * add 200 response option * update from PR comments * Fileimports fix (#29733) * fix failures * add 200 response option * update from PR comments * update cloud error * Fileimports fix (#29786) * fix failures * add 200 response option * update from PR comments * update cloud error * update error response * update --------- Co-authored-by: xuhumsft <116764429+xuhumsft@users.noreply.github.com> * Remove EnvironmentVariable from Enum (#29949) * Watchlist fix lint failures (#30191) * Watchlist fix lint failures * fix lint * lint * provisioning states * lint again * model validation * update suppression format (#30252) * Dev sentinel securityinsights microsoft.security insights 2024 04 01 preview (#30302) * update suppression format * update ThreatIntelligenceQuery in the readme to suppress AvoidAdditionalProperties * Update readme.md (#30313) * adding comments to the readme file (#30316) * Update BusinessApplicationAgents.json * update readme to fix Lint Diff Error (#30340) * update readme to fix Lint Diff Error * fix format * remove ---- * fix line break * Revert "remove ----" This reverts commit d6842b580cd3fc1a7179ebea8a6070a3ae0c0690. * suppress the correct file (#30375) * update common-types/resource-management/v3/types.json to common-types/resource-management/v5/types.json to resolve Go-SDK issue (#30556) * TI Query small fixes (#30567) * Add blockchain to latest profile * Add additional types * Adds base for updating Microsoft.SecurityInsights from version preview/2022-04-01-preview to version 2022-05-01-preview * Updates readme * Updates API version in new specs and examples * . * changes * . * . --------- Co-authored-by: Mark Cowlishaw Co-authored-by: Anat Gilenson <53407600+anat-gilenson@users.noreply.github.com> * update resource in common to v5 (#30570) * fix ModelValidationError (#30571) * fix go-sdk error (#30699) * fix go-sdk error * remove odata parameters in post --------- Co-authored-by: Dvir Naim <106969883+dvir-ms@users.noreply.github.com> Co-authored-by: ityankel <47292630+ityankel@users.noreply.github.com> Co-authored-by: Camilo Gonzalez Co-authored-by: Camilo Gonzalez Tabares Co-authored-by: loriatarms <105870291+loriatarms@users.noreply.github.com> Co-authored-by: sagamzu <52034287+sagamzu@users.noreply.github.com> Co-authored-by: Offir Shvartz Co-authored-by: Offir Shvartz Co-authored-by: Itiel Maimon Co-authored-by: Laith Hisham <49263932+laithhisham@users.noreply.github.com> Co-authored-by: Vaspate <103540155+Vaspate@users.noreply.github.com> Co-authored-by: NoaGoren-Microsoft <160013798+NoaGoren-Microsoft@users.noreply.github.com> Co-authored-by: rheabansal <93624991+rheabansal@users.noreply.github.com> Co-authored-by: nbatyrbb <115049492+nbatyrbb@users.noreply.github.com> Co-authored-by: Rotem2dvir Co-authored-by: moranraz <59017169+moranraz@users.noreply.github.com> Co-authored-by: Mark Cowlishaw Co-authored-by: Anat Gilenson <53407600+anat-gilenson@users.noreply.github.com> --- .../2024-04-01-preview/AlertRules.json | 2600 +++++++++++ .../2024-04-01-preview/AutomationRules.json | 1549 +++++++ .../2024-04-01-preview/BillingStatistics.json | 226 + .../preview/2024-04-01-preview/Bookmarks.json | 751 +++ .../BusinessApplicationAgents.json | 1691 +++++++ .../2024-04-01-preview/ContentPackages.json | 319 ++ .../ContentProductPackages.json | 232 + .../ContentProductTemplates.json | 226 + .../2024-04-01-preview/ContentTemplates.json | 353 ++ .../EnrichmentWithWorkspace.json | 443 ++ .../preview/2024-04-01-preview/Entities.json | 1559 +++++++ .../2024-04-01-preview/EntityQueries.json | 534 +++ .../EntityQueryTemplates.json | 331 ++ .../2024-04-01-preview/FileImports.json | 575 +++ .../preview/2024-04-01-preview/Hunts.json | 994 ++++ .../preview/2024-04-01-preview/Incidents.json | 1669 +++++++ .../preview/2024-04-01-preview/Metadata.json | 774 ++++ .../2024-04-01-preview/OfficeConsents.json | 234 + .../2024-04-01-preview/OnboardingStates.json | 284 ++ .../2024-04-01-preview/Recommendations.json | 452 ++ .../SecurityMLAnalyticsSettings.json | 444 ++ .../preview/2024-04-01-preview/Settings.json | 438 ++ .../2024-04-01-preview/SourceControls.json | 1005 ++++ .../ThreatIntelligence.json | 1097 +++++ .../ThreatIntelligenceCount.json | 348 ++ .../ThreatIntelligenceQuery.json | 583 +++ .../TriggeredAnalyticsRuleRuns.json | 354 ++ .../2024-04-01-preview/Watchlists.json | 745 +++ .../WorkspaceManagerAssignments.json | 737 +++ .../WorkspaceManagerConfigurations.json | 323 ++ .../WorkspaceManagerGroups.json | 318 ++ .../WorkspaceManagerMembers.json | 310 ++ .../2024-04-01-preview/common/AlertTypes.json | 81 + .../common/ContentCommonTypes.json | 646 +++ .../common/EntityTypes.json | 2550 +++++++++++ .../common/IncidentTypes.json | 246 + .../common/RelationTypes.json | 98 + .../common/ThreatIntelligenceTypes.json | 48 + .../dataConnectorDefinitions.json | 706 +++ .../2024-04-01-preview/dataConnectors.json | 4060 +++++++++++++++++ .../actions/CreateActionOfAlertRule.json | 43 + .../actions/DeleteActionOfAlertRule.json | 14 + .../actions/GetActionOfAlertRuleById.json | 24 + .../actions/GetAllActionsByAlertRule.json | 27 + .../GetAlertRuleTemplateById.json | 53 + .../GetAlertRuleTemplates.json | 238 + .../alertRules/CreateFusionAlertRule.json | 845 ++++ ...nAlertRuleWithFusionScenarioExclusion.json | 851 ++++ ...softSecurityIncidentCreationAlertRule.json | 58 + .../alertRules/CreateNrtAlertRule.json | 136 + .../alertRules/CreateScheduledAlertRule.json | 270 ++ .../examples/alertRules/DeleteAlertRule.json | 13 + .../examples/alertRules/GetAllAlertRules.json | 412 ++ .../alertRules/GetFusionAlertRule.json | 310 ++ ...softSecurityIncidentCreationAlertRule.json | 30 + .../examples/alertRules/GetNrtAlertRule.json | 55 + .../alertRules/GetScheduledAlertRule.json | 95 + .../AutomationRules_CreateOrUpdate.json | 195 + .../AutomationRules_Delete.json | 17 + .../automationRules/AutomationRules_Get.json | 73 + .../automationRules/AutomationRules_List.json | 76 + .../GetAllBillingStatistics.json | 26 + .../GetBillingStatistic.json | 23 + .../examples/bookmarks/CreateBookmark.json | 143 + .../examples/bookmarks/DeleteBookmark.json | 13 + .../examples/bookmarks/GetBookmarkById.json | 64 + .../examples/bookmarks/GetBookmarks.json | 67 + .../bookmarks/expand/PostExpandBookmark.json | 43 + .../relations/CreateBookmarkRelation.json | 43 + .../relations/DeleteBookmarkRelation.json | 14 + .../relations/GetAllBookmarkRelations.json | 28 + .../relations/GetBookmarkRelationByName.json | 25 + .../BusinessApplicationAgent_Get.json | 38 + ...inessApplicationAgents_CreateOrUpdate.json | 68 + .../BusinessApplicationAgents_Delete.json | 13 + .../BusinessApplicationAgents_List.json | 42 + .../actions/ListActions.json | 40 + .../actions/ReportActionStatus.json | 18 + .../actions/UndoAction.json | 16 + .../systems/Systems_CreateOrUpdate.json | 153 + .../systems/Systems_Delete.json | 14 + .../systems/Systems_Get.json | 61 + .../systems/Systems_List.json | 64 + .../contentPackages/GetPackageById.json | 34 + .../examples/contentPackages/GetPackages.json | 39 + .../GetProductPackageById.json | 76 + .../contentPackages/GetProductPackages.json | 78 + .../contentPackages/InstallPackage.json | 151 + .../contentPackages/UninstallPackage.json | 13 + .../contentTemplates/DeleteTemplate.json | 13 + .../GetProductTemplateById.json | 43 + .../contentTemplates/GetProductTemplates.json | 45 + .../contentTemplates/GetTemplateById.json | 41 + .../contentTemplates/GetTemplates.json | 43 + .../contentTemplates/InstallTemplate.json | 228 + ...teCustomizableDataConnectorDefinition.json | 258 ++ .../DeleteDataConnectorDefinitionById.json | 13 + ...stomizableDataConnectoeDefinitionById.json | 95 + .../GetDataConnectorDefinitions.json | 94 + ...CheckRequirementsAzureActiveDirectory.json | 22 + ...tsAzureActiveDirectoryNoAuthorization.json | 22 + ...irementsAzureActiveDirectoryNoLicense.json | 22 + .../CheckRequirementsAzureSecurityCenter.json | 22 + .../CheckRequirementsDynamics365.json | 22 + .../dataConnectors/CheckRequirementsIoT.json | 22 + .../CheckRequirementsMdatp.json | 22 + ...RequirementsMicrosoftCloudAppSecurity.json | 22 + ...MicrosoftPurviewInformationProtection.json | 22 + ...quirementsMicrosoftThreatIntelligence.json | 22 + ...RequirementsMicrosoftThreatProtection.json | 22 + .../CheckRequirementsOffice365Project.json | 22 + .../CheckRequirementsOfficeATP.json | 22 + .../CheckRequirementsOfficeIRM.json | 22 + .../CheckRequirementsOfficePowerBI.json | 22 + .../CheckRequirementsThreatIntelligence.json | 22 + ...ckRequirementsThreatIntelligenceTaxii.json | 22 + .../dataConnectors/ConnectAPIPolling.json | 24 + .../ConnectAPIPollingV2Logs.json | 27 + .../dataConnectors/CreateAPIPolling.json | 368 ++ .../CreateDynamics365DataConnetor.json | 57 + .../dataConnectors/CreateGenericUI.json | 437 ++ .../CreateGoogleCloudPlatform.json | 92 + ...viewInformationProtectionDataConnetor.json | 57 + ...rosoftThreatIntelligenceDataConnector.json | 59 + ...MicrosoftThreatProtectionDataConnetor.json | 81 + .../CreateOffice365ProjectDataConnetor.json | 57 + .../CreateOfficeDataConnetor.json | 75 + .../CreateOfficePowerBIDataConnector.json | 57 + ...CreateThreatIntelligenceDataConnector.json | 59 + ...eThreatIntelligenceTaxiiDataConnector.json | 81 + .../dataConnectors/DeleteAPIPolling.json | 13 + .../dataConnectors/DeleteGenericUI.json | 13 + .../DeleteGoogleCloudPlatform.json | 13 + ...viewInformationProtectionDataConnetor.json | 13 + ...rosoftThreatIntelligenceDataConnector.json | 13 + .../DeleteOffice365ProjectDataConnetor.json | 13 + .../DeleteOfficeDataConnetor.json | 13 + .../DeleteOfficePowerBIDataConnetor.json | 13 + .../dataConnectors/DisconnectAPIPolling.json | 13 + .../dataConnectors/GetAPIPolling.json | 133 + .../GetAmazonWebServicesCloudTrailById.json | 28 + .../GetAmazonWebServicesS3ById.json | 32 + .../GetAzureActiveDirectoryById.json | 28 + .../GetAzureAdvancedThreatProtectionById.json | 28 + .../GetAzureSecurityCenterById.json | 28 + .../dataConnectors/GetDataConnectors.json | 508 +++ .../GetDynamics365DataConnectorById.json | 28 + .../examples/dataConnectors/GetGenericUI.json | 156 + .../GetGoogleCloudPlatformById.json | 35 + .../examples/dataConnectors/GetIoTById.json | 28 + .../GetMicrosoftCloudAppSecurityById.json | 31 + ...tDefenderAdvancedThreatProtectionById.json | 28 + ...GetMicrosoftInsiderRiskManagementById.json | 28 + ...InformationProtectionDataConnetorById.json | 28 + .../GetMicrosoftThreatIntelligenceById.json | 29 + .../GetMicrosoftThreatProtectionById.json | 36 + ...Office365AdvancedThreatProtectionById.json | 28 + .../GetOffice365ProjectDataConnetorById.json | 28 + .../GetOfficeDataConnetorById.json | 34 + .../GetOfficePowerBIDataConnetorById.json | 28 + .../dataConnectors/GetRestApiPollerById.json | 59 + .../GetThreatIntelligenceById.json | 29 + .../GetThreatIntelligenceTaxiiById.json | 36 + .../GetGeodataWithWorkspaceByIp.json | 35 + .../GetWhoisWithWorkspaceByDomainName.json | 91 + .../entities/GetAccountEntityById.json | 32 + .../entities/GetAzureResourceEntityById.json | 24 + .../GetCloudApplicationEntityById.json | 25 + .../examples/entities/GetDnsEntityById.json | 26 + .../examples/entities/GetEntities.json | 63 + .../examples/entities/GetFileEntityById.json | 24 + .../entities/GetFileHashEntityById.json | 24 + .../examples/entities/GetHostEntityById.json | 31 + .../entities/GetIoTDeviceEntityById.json | 45 + .../examples/entities/GetIpEntityById.json | 23 + .../entities/GetMailClusterEntityById.json | 44 + .../entities/GetMailMessageEntityById.json | 48 + .../entities/GetMailboxEntityById.json | 26 + .../entities/GetMalwareEntityById.json | 24 + .../entities/GetProcessEntityById.json | 25 + .../examples/entities/GetQueries.json | 456 ++ .../entities/GetRegistryKeyEntityById.json | 24 + .../entities/GetRegistryValueEntityById.json | 26 + .../entities/GetSecurityAlertEntityById.json | 51 + .../entities/GetSecurityGroupEntityById.json | 25 + .../entities/GetSubmissionMailEntityById.json | 29 + .../examples/entities/GetUrlEntityById.json | 23 + .../entities/expand/PostExpandEntity.json | 52 + .../entities/insights/PostGetInsights.json | 100 + .../relations/GetAllEntityRelations.json | 28 + .../relations/GetEntityRelationByName.json | 25 + .../entities/timeline/PostTimelineEntity.json | 92 + .../CreateEntityQueryActivity.json | 133 + .../entityQueries/DeleteEntityQuery.json | 13 + .../GetActivityEntityQueryById.json | 54 + .../entityQueries/GetEntityQueries.json | 59 + .../GetExpansionEntityQueryById.json | 34 + .../GetActivityEntityQueryTemplateById.json | 57 + .../GetEntityQueryTemplates.json | 105 + .../fileImports/CreateFileImport.json | 75 + .../fileImports/DeleteFileImport.json | 41 + .../fileImports/GetFileImportById.json | 37 + .../examples/fileImports/GetFileImports.json | 42 + .../examples/hunts/CreateHunt.json | 100 + .../examples/hunts/CreateHuntComment.json | 56 + .../examples/hunts/CreateHuntRelation.json | 53 + .../examples/hunts/DeleteHunt.json | 14 + .../examples/hunts/DeleteHuntComment.json | 15 + .../examples/hunts/DeleteHuntRelation.json | 15 + .../examples/hunts/GetHuntById.json | 43 + .../examples/hunts/GetHuntCommentById.json | 32 + .../examples/hunts/GetHuntComments.json | 27 + .../examples/hunts/GetHuntRelationById.json | 29 + .../examples/hunts/GetHuntRelations.json | 32 + .../examples/hunts/GetHunts.json | 46 + .../IncidentAlerts/Incidents_ListAlerts.json | 50 + .../Incidents_ListBookmarks.json | 47 + .../IncidentComments_CreateOrUpdate.json | 55 + .../IncidentComments_Delete.json | 14 + .../IncidentComments_Get.json | 31 + .../IncidentComments_List.json | 34 + .../Incidents_ListEntities.json | 34 + .../IncidentTasks_CreateOrUpdate.json | 73 + .../IncidentTasks/IncidentTasks_Delete.json | 14 + .../IncidentTasks/IncidentTasks_Get.json | 39 + .../IncidentTasks/IncidentTasks_List.json | 42 + .../IncidentTeam/Incidents_CreateTeam.json | 26 + .../incidents/Incidents_CreateOrUpdate.json | 136 + .../examples/incidents/Incidents_Delete.json | 13 + .../examples/incidents/Incidents_Get.json | 63 + .../examples/incidents/Incidents_List.json | 68 + .../relations/CreateIncidentRelation.json | 43 + .../relations/DeleteIncidentRelation.json | 14 + .../relations/GetAllIncidentRelations.json | 40 + .../relations/GetIncidentRelationByName.json | 25 + .../manualTrigger/Entities_RunPlaybook.json | 17 + .../manualTrigger/Incidents_RunPlaybook.json | 18 + .../examples/metadata/DeleteMetadata.json | 13 + .../examples/metadata/GetAllMetadata.json | 64 + .../metadata/GetAllMetadataOData.json | 52 + .../examples/metadata/GetMetadata.json | 104 + .../examples/metadata/PatchMetadata.json | 35 + .../examples/metadata/PutMetadata.json | 286 ++ .../examples/metadata/PutMetadataMinimal.json | 40 + .../officeConsents/DeleteOfficeConsents.json | 13 + .../officeConsents/GetOfficeConsents.json | 25 + .../officeConsents/GetOfficeConsentsById.json | 22 + .../CreateSentinelOnboardingState.json | 36 + .../DeleteSentinelOnboardingState.json | 13 + .../GetAllSentinelOnboardingStates.json | 24 + .../GetSentinelOnboardingState.json | 21 + .../examples/operations/ListOperations.json | 563 +++ .../recommendations/GetRecommendation.json | 42 + .../recommendations/GetRecommendations.json | 45 + .../recommendations/PatchRecommendation.json | 47 + .../ReevaluateRecommendation.json | 21 + .../repositories/GetRepositories.json | 37 + ...eateAnomalySecurityMLAnalyticsSetting.json | 245 + .../DeleteSecurityMLAnalyticsSetting.json | 13 + .../GetAllSecurityMLAnalyticsSettings.json | 94 + .../GetAnomalySecurityMLAnalyticsSetting.json | 91 + .../settings/DeleteEyesOnSetting.json | 13 + .../examples/settings/GetAllSettings.json | 25 + .../examples/settings/GetEyesOnSetting.json | 22 + .../settings/UpdateEyesOnSetting.json | 40 + .../sourcecontrols/CreateSourceControl.json | 162 + .../sourcecontrols/DeleteSourceControl.json | 29 + .../sourcecontrols/GetSourceControlById.json | 75 + .../sourcecontrols/GetSourceControls.json | 78 + .../AppendTagsThreatIntelligence.json | 18 + .../CollectThreatIntelligenceMetrics.json | 43 + .../CreateThreatIntelligence.json | 100 + .../DeleteThreatIntelligence.json | 13 + .../GetThreatIntelligence.json | 76 + .../GetThreatIntelligenceById.json | 43 + .../PostThreatIntelligenceCount.json | 30 + .../PostThreatIntelligenceQuery.json | 122 + .../QueryThreatIntelligence.json | 107 + .../ReplaceTagsThreatIntelligence.json | 52 + .../UpdateThreatIntelligence.json | 101 + .../triggerRuleRun_Post.json | 23 + .../triggeredAnalyticsRuleRun_Get.json | 29 + .../triggeredAnalyticsRuleRuns_Get.json | 48 + .../examples/watchlists/CreateWatchlist.json | 88 + .../CreateWatchlistAndWatchlistItems.json | 92 + .../watchlists/CreateWatchlistItem.json | 92 + .../examples/watchlists/DeleteWatchlist.json | 18 + .../watchlists/DeleteWatchlistItem.json | 15 + .../watchlists/GetWatchlistByAlias.json | 50 + .../watchlists/GetWatchlistItemById.json | 47 + .../watchlists/GetWatchlistItems.json | 50 + .../examples/watchlists/GetWatchlists.json | 53 + .../CreateJob.json | 24 + ...ateOrUpdateWorkspaceManagerAssignment.json | 62 + .../DeleteJob.json | 14 + .../DeleteWorkspaceManagerAssignment.json | 13 + .../GetAllJobs.json | 46 + .../GetAllWorkspaceManagerAssignments.json | 35 + .../workspaceManagerAssignments/GetJob.json | 43 + .../GetWorkspaceManagerAssignment.json | 32 + ...OrUpdateWorkspaceManagerConfiguration.json | 38 + .../DeleteWorkspaceManagerConfiguration.json | 13 + .../GetAllWorkspaceManagerConfigurations.json | 25 + .../GetWorkspaceManagerConfiguration.json | 22 + .../CreateOrUpdateWorkspaceManagerGroup.json | 53 + .../DeleteWorkspaceManagerGroup.json | 13 + .../GetAllWorkspaceManagerGroups.json | 30 + .../GetWorkspaceManagerGroup.json | 27 + .../CreateOrUpdateWorkspaceManagerMember.json | 41 + .../DeleteWorkspaceManagerMember.json | 13 + .../GetAllWorkspaceManagerMembers.json | 26 + .../GetWorkspaceManagerMember.json | 23 + .../2024-04-01-preview/operations.json | 138 + .../resource-manager/common/2.0/types.json | 2 +- .../resource-manager/readme.md | 91 +- 315 files changed, 48591 insertions(+), 6 deletions(-) create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/AlertRules.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/AutomationRules.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/BillingStatistics.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Bookmarks.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/BusinessApplicationAgents.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ContentPackages.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ContentProductPackages.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ContentProductTemplates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ContentTemplates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/EnrichmentWithWorkspace.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Entities.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/EntityQueries.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/EntityQueryTemplates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/FileImports.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Hunts.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Incidents.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Metadata.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/OfficeConsents.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/OnboardingStates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Recommendations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/SecurityMLAnalyticsSettings.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Settings.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/SourceControls.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ThreatIntelligenceCount.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ThreatIntelligenceQuery.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/TriggeredAnalyticsRuleRuns.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Watchlists.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/WorkspaceManagerAssignments.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/WorkspaceManagerConfigurations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/WorkspaceManagerGroups.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/WorkspaceManagerMembers.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/common/AlertTypes.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/common/ContentCommonTypes.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/common/EntityTypes.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/common/IncidentTypes.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/common/RelationTypes.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/common/ThreatIntelligenceTypes.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/dataConnectorDefinitions.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/dataConnectors.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/actions/CreateActionOfAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/actions/DeleteActionOfAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/actions/GetActionOfAlertRuleById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/actions/GetAllActionsByAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplateById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/CreateFusionAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/CreateFusionAlertRuleWithFusionScenarioExclusion.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/CreateMicrosoftSecurityIncidentCreationAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/CreateNrtAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/CreateScheduledAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/DeleteAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/GetAllAlertRules.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/GetFusionAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/GetMicrosoftSecurityIncidentCreationAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/GetNrtAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/GetScheduledAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/automationRules/AutomationRules_CreateOrUpdate.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/automationRules/AutomationRules_Delete.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/automationRules/AutomationRules_Get.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/automationRules/AutomationRules_List.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/billingStatistics/GetAllBillingStatistics.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/billingStatistics/GetBillingStatistic.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/CreateBookmark.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/DeleteBookmark.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/GetBookmarkById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/GetBookmarks.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/expand/PostExpandBookmark.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/relations/CreateBookmarkRelation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/relations/DeleteBookmarkRelation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/relations/GetAllBookmarkRelations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/relations/GetBookmarkRelationByName.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/BusinessApplicationAgent_Get.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/BusinessApplicationAgents_CreateOrUpdate.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/BusinessApplicationAgents_Delete.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/BusinessApplicationAgents_List.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/actions/ListActions.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/actions/ReportActionStatus.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/actions/UndoAction.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/systems/Systems_CreateOrUpdate.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/systems/Systems_Delete.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/systems/Systems_Get.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/systems/Systems_List.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentPackages/GetPackageById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentPackages/GetPackages.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentPackages/GetProductPackageById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentPackages/GetProductPackages.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentPackages/InstallPackage.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentPackages/UninstallPackage.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentTemplates/DeleteTemplate.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentTemplates/GetProductTemplateById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentTemplates/GetProductTemplates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentTemplates/GetTemplateById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentTemplates/GetTemplates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentTemplates/InstallTemplate.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectorDefinitions/CreateCustomizableDataConnectorDefinition.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectorDefinitions/DeleteDataConnectorDefinitionById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectorDefinitions/GetCustomizableDataConnectoeDefinitionById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectorDefinitions/GetDataConnectorDefinitions.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectory.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoAuthorization.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoLicense.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsAzureSecurityCenter.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsDynamics365.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsIoT.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsMdatp.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftCloudAppSecurity.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftPurviewInformationProtection.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftThreatProtection.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsOffice365Project.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsOfficeATP.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsOfficeIRM.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsOfficePowerBI.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsThreatIntelligenceTaxii.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/ConnectAPIPolling.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/ConnectAPIPollingV2Logs.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateAPIPolling.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateDynamics365DataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateGenericUI.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateGoogleCloudPlatform.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateMicrosoftPurviewInformationProtectionDataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateMicrosoftThreatIntelligenceDataConnector.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateMicrosoftThreatProtectionDataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateOffice365ProjectDataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateOfficeDataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateOfficePowerBIDataConnector.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateThreatIntelligenceDataConnector.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateThreatIntelligenceTaxiiDataConnector.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteAPIPolling.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteGenericUI.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteGoogleCloudPlatform.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteMicrosoftPurviewInformationProtectionDataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteMicrosoftThreatIntelligenceDataConnector.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteOffice365ProjectDataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteOfficeDataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteOfficePowerBIDataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DisconnectAPIPolling.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetAPIPolling.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetAmazonWebServicesCloudTrailById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetAmazonWebServicesS3ById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetAzureActiveDirectoryById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetAzureAdvancedThreatProtectionById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetAzureSecurityCenterById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetDataConnectors.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetDynamics365DataConnectorById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetGenericUI.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetGoogleCloudPlatformById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetIoTById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetMicrosoftCloudAppSecurityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetMicrosoftDefenderAdvancedThreatProtectionById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetMicrosoftInsiderRiskManagementById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetMicrosoftPurviewInformationProtectionDataConnetorById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetMicrosoftThreatIntelligenceById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetMicrosoftThreatProtectionById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetOffice365AdvancedThreatProtectionById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetOffice365ProjectDataConnetorById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetOfficeDataConnetorById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetOfficePowerBIDataConnetorById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetRestApiPollerById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetThreatIntelligenceById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetThreatIntelligenceTaxiiById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/enrichment/GetGeodataWithWorkspaceByIp.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/enrichment/GetWhoisWithWorkspaceByDomainName.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetAccountEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetAzureResourceEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetCloudApplicationEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetDnsEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetEntities.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetFileEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetFileHashEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetHostEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetIoTDeviceEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetIpEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetMailClusterEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetMailMessageEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetMailboxEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetMalwareEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetProcessEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetQueries.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetRegistryKeyEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetRegistryValueEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetSecurityAlertEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetSecurityGroupEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetSubmissionMailEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetUrlEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/expand/PostExpandEntity.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/insights/PostGetInsights.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/relations/GetAllEntityRelations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/relations/GetEntityRelationByName.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/timeline/PostTimelineEntity.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueries/CreateEntityQueryActivity.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueries/DeleteEntityQuery.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueries/GetActivityEntityQueryById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueries/GetEntityQueries.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueries/GetExpansionEntityQueryById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueryTemplates/GetActivityEntityQueryTemplateById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueryTemplates/GetEntityQueryTemplates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/fileImports/CreateFileImport.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/fileImports/DeleteFileImport.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/fileImports/GetFileImportById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/fileImports/GetFileImports.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/CreateHunt.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/CreateHuntComment.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/CreateHuntRelation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/DeleteHunt.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/DeleteHuntComment.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/DeleteHuntRelation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/GetHuntById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/GetHuntCommentById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/GetHuntComments.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/GetHuntRelationById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/GetHuntRelations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/GetHunts.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentAlerts/Incidents_ListAlerts.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentBookmarks/Incidents_ListBookmarks.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentComments/IncidentComments_CreateOrUpdate.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentComments/IncidentComments_Delete.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentComments/IncidentComments_Get.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentComments/IncidentComments_List.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentEntities/Incidents_ListEntities.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentTasks/IncidentTasks_CreateOrUpdate.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentTasks/IncidentTasks_Delete.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentTasks/IncidentTasks_Get.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentTasks/IncidentTasks_List.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentTeam/Incidents_CreateTeam.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/Incidents_CreateOrUpdate.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/Incidents_Delete.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/Incidents_Get.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/Incidents_List.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/relations/CreateIncidentRelation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/relations/DeleteIncidentRelation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/relations/GetAllIncidentRelations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/relations/GetIncidentRelationByName.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/manualTrigger/Entities_RunPlaybook.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/manualTrigger/Incidents_RunPlaybook.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/DeleteMetadata.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/GetAllMetadata.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/GetAllMetadataOData.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/GetMetadata.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/PatchMetadata.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/PutMetadata.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/PutMetadataMinimal.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/officeConsents/DeleteOfficeConsents.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/officeConsents/GetOfficeConsents.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/officeConsents/GetOfficeConsentsById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/onboardingStates/CreateSentinelOnboardingState.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/onboardingStates/DeleteSentinelOnboardingState.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/onboardingStates/GetAllSentinelOnboardingStates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/onboardingStates/GetSentinelOnboardingState.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/operations/ListOperations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/recommendations/GetRecommendation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/recommendations/GetRecommendations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/recommendations/PatchRecommendation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/recommendations/ReevaluateRecommendation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/repositories/GetRepositories.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/securityMLAnalyticsSettings/CreateAnomalySecurityMLAnalyticsSetting.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/securityMLAnalyticsSettings/DeleteSecurityMLAnalyticsSetting.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/securityMLAnalyticsSettings/GetAllSecurityMLAnalyticsSettings.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/securityMLAnalyticsSettings/GetAnomalySecurityMLAnalyticsSetting.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/settings/DeleteEyesOnSetting.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/settings/GetAllSettings.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/settings/GetEyesOnSetting.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/settings/UpdateEyesOnSetting.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/sourcecontrols/CreateSourceControl.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/sourcecontrols/DeleteSourceControl.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/sourcecontrols/GetSourceControlById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/sourcecontrols/GetSourceControls.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/AppendTagsThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/CollectThreatIntelligenceMetrics.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/CreateThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/DeleteThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/GetThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/GetThreatIntelligenceById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/PostThreatIntelligenceCount.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/PostThreatIntelligenceQuery.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/QueryThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/ReplaceTagsThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/UpdateThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/triggeredAnalyticsRuleRuns/triggerRuleRun_Post.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRun_Get.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRuns_Get.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/CreateWatchlist.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/CreateWatchlistAndWatchlistItems.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/CreateWatchlistItem.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/DeleteWatchlist.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/DeleteWatchlistItem.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/GetWatchlistByAlias.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/GetWatchlistItemById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/GetWatchlistItems.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/GetWatchlists.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/CreateJob.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/CreateOrUpdateWorkspaceManagerAssignment.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/DeleteJob.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/DeleteWorkspaceManagerAssignment.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/GetAllJobs.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/GetAllWorkspaceManagerAssignments.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/GetJob.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/GetWorkspaceManagerAssignment.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerConfigurations/CreateOrUpdateWorkspaceManagerConfiguration.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerConfigurations/DeleteWorkspaceManagerConfiguration.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerConfigurations/GetAllWorkspaceManagerConfigurations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerConfigurations/GetWorkspaceManagerConfiguration.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerGroups/CreateOrUpdateWorkspaceManagerGroup.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerGroups/DeleteWorkspaceManagerGroup.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerGroups/GetAllWorkspaceManagerGroups.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerGroups/GetWorkspaceManagerGroup.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerMembers/CreateOrUpdateWorkspaceManagerMember.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerMembers/DeleteWorkspaceManagerMember.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerMembers/GetAllWorkspaceManagerMembers.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerMembers/GetWorkspaceManagerMember.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/operations.json diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/AlertRules.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/AlertRules.json new file mode 100644 index 000000000000..7f0cf5f88aed --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/AlertRules.json @@ -0,0 +1,2600 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules": { + "get": { + "x-ms-examples": { + "Get all alert rules.": { + "$ref": "./examples/alertRules/GetAllAlertRules.json" + } + }, + "tags": [ + "Alert Rules" + ], + "description": "Gets all alert rules.", + "operationId": "AlertRules_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertRulesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}": { + "get": { + "x-ms-examples": { + "Get a Scheduled alert rule.": { + "$ref": "./examples/alertRules/GetScheduledAlertRule.json" + }, + "Get an Nrt alert rule.": { + "$ref": "./examples/alertRules/GetNrtAlertRule.json" + }, + "Get a Fusion alert rule.": { + "$ref": "./examples/alertRules/GetFusionAlertRule.json" + }, + "Get a MicrosoftSecurityIncidentCreation rule.": { + "$ref": "./examples/alertRules/GetMicrosoftSecurityIncidentCreationAlertRule.json" + } + }, + "tags": [ + "Alert Rules" + ], + "description": "Gets the alert rule.", + "operationId": "AlertRules_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a Scheduled alert rule.": { + "$ref": "./examples/alertRules/CreateScheduledAlertRule.json" + }, + "Creates or updates a Nrt alert rule.": { + "$ref": "./examples/alertRules/CreateNrtAlertRule.json" + }, + "Creates or updates a Fusion alert rule.": { + "$ref": "./examples/alertRules/CreateFusionAlertRule.json" + }, + "Creates or updates a Fusion alert rule with scenario exclusion pattern.": { + "$ref": "./examples/alertRules/CreateFusionAlertRuleWithFusionScenarioExclusion.json" + }, + "Creates or updates a MicrosoftSecurityIncidentCreation rule.": { + "$ref": "./examples/alertRules/CreateMicrosoftSecurityIncidentCreationAlertRule.json" + } + }, + "tags": [ + "Alert Rules" + ], + "description": "Creates or updates the alert rule.", + "operationId": "AlertRules_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + }, + { + "$ref": "#/parameters/AlertRule" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertRule" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/AlertRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an alert rule.": { + "$ref": "./examples/alertRules/DeleteAlertRule.json" + } + }, + "tags": [ + "Alert Rules" + ], + "description": "Delete the alert rule.", + "operationId": "AlertRules_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}/actions": { + "get": { + "x-ms-examples": { + "Get all actions of alert rule.": { + "$ref": "./examples/actions/GetAllActionsByAlertRule.json" + } + }, + "tags": [ + "Actions" + ], + "description": "Gets all actions of alert rule.", + "operationId": "Actions_ListByAlertRule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ActionsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}/actions/{actionId}": { + "get": { + "x-ms-examples": { + "Get an action of alert rule.": { + "$ref": "./examples/actions/GetActionOfAlertRuleById.json" + } + }, + "tags": [ + "Actions" + ], + "description": "Gets the action of alert rule.", + "operationId": "Actions_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + }, + { + "$ref": "#/parameters/ActionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ActionResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates an action of alert rule.": { + "$ref": "./examples/actions/CreateActionOfAlertRule.json" + } + }, + "tags": [ + "Actions" + ], + "description": "Creates or updates the action of alert rule.", + "operationId": "Actions_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + }, + { + "$ref": "#/parameters/ActionId" + }, + { + "$ref": "#/parameters/Action" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ActionResponse" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ActionResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an action of alert rule.": { + "$ref": "./examples/actions/DeleteActionOfAlertRule.json" + } + }, + "tags": [ + "Actions" + ], + "description": "Delete the action of alert rule.", + "operationId": "Actions_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + }, + { + "$ref": "#/parameters/ActionId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/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": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertRuleTemplatesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/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": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/AlertRuleTemplateId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertRuleTemplate" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "Action": { + "description": "The action", + "in": "body", + "name": "action", + "required": true, + "schema": { + "$ref": "#/definitions/ActionRequest" + }, + "x-ms-parameter-location": "method" + }, + "ActionId": { + "description": "Action ID", + "in": "path", + "name": "actionId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AlertRule": { + "description": "The alert rule", + "in": "body", + "name": "alertRule", + "required": true, + "schema": { + "$ref": "#/definitions/AlertRule" + }, + "x-ms-parameter-location": "method" + }, + "AlertRuleTemplateId": { + "description": "Alert rule template ID", + "in": "path", + "name": "alertRuleTemplateId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "RuleId": { + "description": "Alert rule ID", + "in": "path", + "name": "ruleId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "AlertRule": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Alert rule.", + "properties": { + "kind": { + "$ref": "#/definitions/AlertRuleKindEnum", + "description": "The kind of the alert rule" + } + }, + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] + }, + "AlertRuleKindEnum": { + "description": "The kind of the alert rule", + "enum": [ + "Scheduled", + "MicrosoftSecurityIncidentCreation", + "Fusion", + "MLBehaviorAnalytics", + "ThreatIntelligence", + "NRT" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AlertRuleKind", + "values": [ + { + "value": "Scheduled" + }, + { + "value": "MicrosoftSecurityIncidentCreation" + }, + { + "value": "Fusion" + }, + { + "value": "MLBehaviorAnalytics" + }, + { + "value": "ThreatIntelligence" + }, + { + "value": "NRT" + } + ] + } + }, + "AlertRuleTemplate": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "description": "Alert rule template.", + "discriminator": "kind", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/AlertRuleKindEnum", + "description": "The kind of the alert rule" + } + }, + "required": [ + "kind" + ] + }, + "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" + }, + "AlertRuleTemplatePropertiesBase": { + "description": "Base alert rule template property bag.", + "properties": { + "alertRulesCreatedByTemplateCount": { + "description": "the number of alert rules that were created by this template", + "type": "integer", + "format": "int32" + }, + "lastUpdatedDateUTC": { + "description": "The last time that this alert rule template has been updated.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "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 sources for this template", + "items": { + "$ref": "#/definitions/AlertRuleTemplateDataSource" + }, + "x-ms-identifiers": [ + "connectorId" + ], + "type": "array" + }, + "status": { + "$ref": "#/definitions/AlertRuleTemplateStatus", + "description": "The alert rule template status." + } + }, + "type": "object" + }, + "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" + } + ] + } + }, + "AlertRuleTemplateWithMitreProperties": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" + } + ], + "description": "Alert rule template with MITRE property bag.", + "properties": { + "tactics": { + "description": "The tactics of the alert rule", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" + }, + "type": "array" + }, + "techniques": { + "description": "The techniques of the alert rule", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "QueryBasedAlertRuleTemplateProperties": { + "description": "Query based alert rule template base property bag.", + "properties": { + "query": { + "description": "The query that creates alerts for this rule.", + "type": "string" + }, + "severity": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The severity for alerts created by this alert rule." + }, + "version": { + "description": "The version of this template - in format , where all are numbers. For example <1.0.2>.", + "type": "string" + }, + "customDetails": { + "description": "Dictionary of string key-value pairs of columns to be attached to the alert", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "entityMappings": { + "$ref": "#/definitions/EntityMappings", + "description": "Array of the entity mappings of the alert rule" + }, + "alertDetailsOverride": { + "type": "object", + "$ref": "#/definitions/AlertDetailsOverride", + "description": "The alert details override settings" + }, + "eventGroupingSettings": { + "$ref": "#/definitions/EventGroupingSettings", + "description": "The event grouping settings." + }, + "sentinelEntitiesMappings": { + "$ref": "#/definitions/SentinelEntitiesMappings", + "description": "Array of the sentinel entity mappings of the alert rule" + } + }, + "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" + } + }, + "type": "object", + "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" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "MLBehaviorAnalyticsAlertRule": { + "allOf": [ + { + "$ref": "#/definitions/AlertRule" + } + ], + "description": "Represents MLBehaviorAnalytics alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/MLBehaviorAnalyticsAlertRuleProperties", + "description": "MLBehaviorAnalytics alert rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MLBehaviorAnalytics" + }, + "MLBehaviorAnalyticsAlertRuleProperties": { + "description": "MLBehaviorAnalytics alert rule base property bag.", + "properties": { + "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 rule has been modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "severity": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The severity for alerts created by this alert rule.", + "readOnly": true + }, + "tactics": { + "description": "The tactics of the alert rule", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" + }, + "readOnly": true, + "type": "array" + }, + "techniques": { + "description": "The techniques of the alert rule", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "subTechniques": { + "description": "The sub-techniques of the alert rule", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "required": [ + "alertRuleTemplateName", + "enabled" + ], + "type": "object" + }, + "MLBehaviorAnalyticsAlertRuleTemplate": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplate" + } + ], + "description": "Represents MLBehaviorAnalytics alert rule template.", + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplateWithMitreProperties" + } + ], + "description": "MLBehaviorAnalytics alert rule template properties.", + "properties": { + "severity": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The severity for alerts created by this alert rule." + } + }, + "type": "object", + "required": [ + "displayName", + "description", + "status", + "severity", + "alertRulesCreatedByTemplateCount" + ], + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MLBehaviorAnalytics" + }, + "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.", + "properties": { + "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" + }, + "sourceSettings": { + "description": "Configuration for all supported source signals in fusion detection.", + "items": { + "$ref": "#/definitions/FusionSourceSettings" + }, + "x-ms-identifiers": [], + "type": "array" + }, + "scenarioExclusionPatterns": { + "description": "Configuration to exclude scenarios in fusion detection.", + "items": { + "$ref": "#/definitions/FusionScenarioExclusionPattern" + }, + "x-ms-identifiers": [], + "type": "array" + }, + "lastModifiedUtc": { + "description": "The last time that this alert has been modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "severity": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The severity for alerts created by this alert rule.", + "readOnly": true + }, + "tactics": { + "description": "The tactics of the alert rule", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" + }, + "readOnly": true, + "type": "array" + }, + "techniques": { + "description": "The techniques of the alert rule", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "subTechniques": { + "description": "The sub-techniques of the alert rule", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "required": [ + "alertRuleTemplateName", + "enabled" + ], + "type": "object" + }, + "FusionSourceSettings": { + "description": "Represents a supported source signal configuration in Fusion detection.", + "properties": { + "enabled": { + "description": "Determines whether this source signal is enabled or disabled in Fusion detection.", + "type": "boolean" + }, + "sourceName": { + "description": "Name of the Fusion source signal. Refer to Fusion alert rule template for supported values.", + "type": "string" + }, + "sourceSubTypes": { + "description": "Configuration for all source subtypes under this source signal consumed in fusion detection.", + "items": { + "$ref": "#/definitions/FusionSourceSubTypeSetting" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "required": [ + "enabled", + "sourceName" + ], + "type": "object" + }, + "FusionSourceSubTypeSetting": { + "description": "Represents a supported source subtype configuration under a source signal in Fusion detection.", + "properties": { + "enabled": { + "description": "Determines whether this source subtype under source signal is enabled or disabled in Fusion detection.", + "type": "boolean" + }, + "sourceSubTypeName": { + "description": "The Name of the source subtype under a given source signal in Fusion detection. Refer to Fusion alert rule template for supported values.", + "type": "string" + }, + "sourceSubTypeDisplayName": { + "description": "The display name of source subtype under a source signal consumed in Fusion detection.", + "type": "string", + "readOnly": true + }, + "severityFilters": { + "description": "Severity configuration for a source subtype consumed in fusion detection.", + "$ref": "#/definitions/FusionSubTypeSeverityFilter", + "type": "object" + } + }, + "required": [ + "enabled", + "sourceSubTypeName", + "severityFilters" + ], + "type": "object" + }, + "FusionSubTypeSeverityFilter": { + "description": "Represents severity configuration for a source subtype consumed in Fusion detection.", + "properties": { + "isSupported": { + "description": "Determines whether this source subtype supports severity configuration or not.", + "type": "boolean", + "readOnly": true + }, + "filters": { + "description": "Individual Severity configuration settings for a given source subtype consumed in Fusion detection.", + "items": { + "$ref": "#/definitions/FusionSubTypeSeverityFiltersItem" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "type": "object" + }, + "FusionSubTypeSeverityFiltersItem": { + "description": "Represents a Severity filter setting for a given source subtype consumed in Fusion detection.", + "properties": { + "severity": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The Severity for a given source subtype consumed in Fusion detection." + }, + "enabled": { + "description": "Determines whether this severity is enabled or disabled for this source subtype consumed in Fusion detection.", + "type": "boolean" + } + }, + "required": [ + "severity", + "enabled" + ], + "type": "object" + }, + "FusionScenarioExclusionPattern": { + "description": "Represents a Fusion scenario exclusion patterns in Fusion detection.", + "properties": { + "exclusionPattern": { + "description": "Scenario exclusion pattern.", + "type": "string" + }, + "dateAddedInUTC": { + "description": "DateTime when scenario exclusion pattern is added in UTC.", + "type": "string" + } + }, + "required": [ + "exclusionPattern", + "dateAddedInUTC" + ], + "type": "object" + }, + "FusionAlertRuleTemplate": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplate" + } + ], + "description": "Represents Fusion alert rule template.", + "properties": { + "properties": { + "$ref": "#/definitions/FusionAlertRuleTemplateProperties", + "description": "Fusion alert rule template properties", + "required": [ + "displayName", + "description", + "status", + "severity", + "alertRulesCreatedByTemplateCount" + ], + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Fusion" + }, + "FusionAlertRuleTemplateProperties": { + "description": "Fusion 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" + }, + "lastUpdatedDateUTC": { + "description": "The time that this alert rule template was last updated.", + "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", + "x-ms-identifiers": [] + }, + "status": { + "$ref": "#/definitions/AlertRuleTemplateStatus", + "description": "The alert rule template status.", + "type": "string" + }, + "severity": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The severity for alerts created by this alert rule." + }, + "tactics": { + "description": "The tactics of the alert rule template", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "techniques": { + "description": "The techniques of the alert rule", + "items": { + "type": "string" + }, + "type": "array" + }, + "subTechniques": { + "description": "The sub-techniques of the alert rule", + "items": { + "type": "string" + }, + "type": "array" + }, + "sourceSettings": { + "description": "All supported source signal configurations consumed in fusion detection.", + "items": { + "$ref": "#/definitions/FusionTemplateSourceSetting" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "type": "object", + "x-ms-client-flatten": true + }, + "FusionTemplateSourceSetting": { + "description": "Represents a source signal consumed in Fusion detection.", + "properties": { + "sourceName": { + "description": "The name of a source signal consumed in Fusion detection.", + "type": "string" + }, + "sourceSubTypes": { + "description": "All supported source subtypes under this source signal consumed in fusion detection.", + "items": { + "$ref": "#/definitions/FusionTemplateSourceSubType" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "required": [ + "sourceName" + ], + "type": "object" + }, + "FusionTemplateSourceSubType": { + "description": "Represents a source subtype under a source signal consumed in Fusion detection.", + "properties": { + "sourceSubTypeName": { + "description": "The name of source subtype under a source signal consumed in Fusion detection.", + "type": "string" + }, + "sourceSubTypeDisplayName": { + "description": "The display name of source subtype under a source signal consumed in Fusion detection.", + "type": "string", + "readOnly": true + }, + "severityFilter": { + "description": "Severity configuration available for a source subtype consumed in fusion detection.", + "$ref": "#/definitions/FusionTemplateSubTypeSeverityFilter", + "type": "object" + } + }, + "required": [ + "sourceSubTypeName", + "severityFilter" + ], + "type": "object" + }, + "FusionTemplateSubTypeSeverityFilter": { + "description": "Represents severity configurations available for a source subtype consumed in Fusion detection.", + "properties": { + "isSupported": { + "description": "Determines whether severity configuration is supported for this source subtype consumed in Fusion detection.", + "type": "boolean" + }, + "severityFilters": { + "description": "List of all supported severities for this source subtype consumed in Fusion detection.", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "required": [ + "isSupported" + ], + "type": "object" + }, + "ThreatIntelligenceAlertRule": { + "allOf": [ + { + "$ref": "#/definitions/AlertRule" + } + ], + "description": "Represents Threat Intelligence alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/ThreatIntelligenceAlertRuleProperties", + "description": "Threat Intelligence alert rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "ThreatIntelligence" + }, + "ThreatIntelligenceAlertRuleProperties": { + "description": "Threat Intelligence alert rule base property bag.", + "properties": { + "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": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The severity for alerts created by this alert rule.", + "readOnly": true + }, + "tactics": { + "description": "The tactics of the alert rule", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" + }, + "readOnly": true, + "type": "array" + }, + "techniques": { + "description": "The techniques of the alert rule", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "subTechniques": { + "description": "The sub-techniques of the alert rule", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "required": [ + "alertRuleTemplateName", + "enabled" + ], + "type": "object" + }, + "ThreatIntelligenceAlertRuleTemplate": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplate" + } + ], + "description": "Represents Threat Intelligence alert rule template.", + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplateWithMitreProperties" + } + ], + "description": "Threat Intelligence alert rule template properties", + "properties": { + "severity": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The severity for alerts created by this alert rule." + } + }, + "required": [ + "displayName", + "description", + "status", + "severity", + "alertRulesCreatedByTemplateCount" + ], + "type": "object", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "ThreatIntelligence" + }, + "MicrosoftSecurityIncidentCreationAlertRule": { + "allOf": [ + { + "$ref": "#/definitions/AlertRule" + } + ], + "description": "Represents MicrosoftSecurityIncidentCreation rule.", + "properties": { + "properties": { + "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleProperties", + "description": "MicrosoftSecurityIncidentCreation rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftSecurityIncidentCreation" + }, + "MicrosoftSecurityIncidentCreationAlertRuleCommonProperties": { + "description": "MicrosoftSecurityIncidentCreation rule common property bag.", + "properties": { + "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": "./common/AlertTypes.json#/definitions/AlertSeverityEnum" + }, + "type": "array" + } + }, + "required": [ + "productFilter" + ], + "type": "object" + }, + "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", + "Office 365 Advanced Threat Protection", + "Microsoft Defender Advanced Threat Protection" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "MicrosoftSecurityProductName" + } + }, + "MicrosoftSecurityIncidentCreationAlertRuleProperties": { + "allOf": [ + { + "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleCommonProperties" + } + ], + "description": "MicrosoftSecurityIncidentCreation rule property bag.", + "properties": { + "alertRuleTemplateName": { + "description": "The Name of the alert rule template used to create this rule.", + "type": "string" + }, + "description": { + "description": "The description of the alert rule.", + "type": "string" + }, + "displayName": { + "description": "The display name for alerts created by this alert rule.", + "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" + } + }, + "required": [ + "displayName", + "enabled", + "productFilter" + ], + "type": "object" + }, + "MicrosoftSecurityIncidentCreationAlertRuleTemplate": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplate" + } + ], + "description": "Represents MicrosoftSecurityIncidentCreation rule template.", + "properties": { + "properties": { + "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleTemplateProperties", + "description": "MicrosoftSecurityIncidentCreation rule template properties", + "required": [ + "displayName", + "description", + "createdDateUTC", + "status", + "alertRulesCreatedByTemplateCount", + "productFilter" + ], + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftSecurityIncidentCreation" + }, + "MicrosoftSecurityIncidentCreationAlertRuleTemplateProperties": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" + } + ], + "description": "MicrosoftSecurityIncidentCreation rule template properties", + "properties": { + "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": "./common/AlertTypes.json#/definitions/AlertSeverityEnum" + }, + "type": "array" + } + }, + "type": "object", + "x-ms-client-flatten": true + }, + "ScheduledAlertRuleProperties": { + "allOf": [ + { + "$ref": "#/definitions/ScheduledAlertRuleCommonProperties" + } + ], + "description": "Scheduled alert rule base property bag.", + "properties": { + "alertRuleTemplateName": { + "description": "The Name of the alert rule template used to create this rule.", + "type": "string" + }, + "templateVersion": { + "description": "The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2>", + "type": "string" + }, + "description": { + "description": "The description of the alert rule.", + "type": "string" + }, + "displayName": { + "description": "The display name for alerts created by this alert rule.", + "type": "string" + }, + "enabled": { + "description": "Determines whether this alert rule is enabled or disabled.", + "type": "boolean" + }, + "lastModifiedUtc": { + "description": "The last time that this alert rule has been modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "suppressionDuration": { + "description": "The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.", + "format": "duration", + "type": "string" + }, + "suppressionEnabled": { + "description": "Determines whether the suppression for this alert rule is enabled or disabled.", + "type": "boolean" + }, + "tactics": { + "description": "The tactics of the alert rule", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" + }, + "type": "array" + }, + "techniques": { + "description": "The techniques of the alert rule", + "items": { + "type": "string" + }, + "type": "array" + }, + "subTechniques": { + "description": "The sub-techniques of the alert rule", + "items": { + "type": "string" + }, + "type": "array" + }, + "incidentConfiguration": { + "$ref": "#/definitions/IncidentConfiguration", + "description": "The settings of the incidents that created from alerts triggered by this analytics rule" + } + }, + "required": [ + "displayName", + "enabled", + "severity", + "query", + "queryFrequency", + "queryPeriod", + "triggerOperator", + "triggerThreshold", + "suppressionEnabled", + "suppressionDuration" + ], + "type": "object", + "x-ms-client-flatten": true + }, + "NrtAlertRuleProperties": { + "description": "Nrt alert rule base property bag.", + "properties": { + "alertRuleTemplateName": { + "description": "The Name of the alert rule template used to create this rule.", + "type": "string" + }, + "templateVersion": { + "description": "The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2>", + "type": "string" + }, + "description": { + "description": "The description of the alert rule.", + "type": "string" + }, + "query": { + "description": "The query that creates alerts for this rule.", + "type": "string" + }, + "tactics": { + "description": "The tactics of the alert rule", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" + }, + "type": "array" + }, + "techniques": { + "description": "The techniques of the alert rule", + "items": { + "type": "string" + }, + "type": "array" + }, + "subTechniques": { + "description": "The sub-techniques of the alert rule", + "items": { + "type": "string" + }, + "type": "array" + }, + "displayName": { + "description": "The display name for alerts created by this alert rule.", + "type": "string" + }, + "enabled": { + "description": "Determines whether this alert rule is enabled or disabled.", + "type": "boolean" + }, + "lastModifiedUtc": { + "description": "The last time that this alert rule has been modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "suppressionDuration": { + "description": "The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.", + "format": "duration", + "type": "string" + }, + "suppressionEnabled": { + "description": "Determines whether the suppression for this alert rule is enabled or disabled.", + "type": "boolean" + }, + "severity": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The severity for alerts created by this alert rule." + }, + "incidentConfiguration": { + "$ref": "#/definitions/IncidentConfiguration", + "description": "The settings of the incidents that created from alerts triggered by this analytics rule" + }, + "customDetails": { + "description": "Dictionary of string key-value pairs of columns to be attached to the alert", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "entityMappings": { + "$ref": "#/definitions/EntityMappings", + "description": "Array of the entity mappings of the alert rule" + }, + "alertDetailsOverride": { + "type": "object", + "$ref": "#/definitions/AlertDetailsOverride", + "description": "The alert details override settings" + }, + "eventGroupingSettings": { + "$ref": "#/definitions/EventGroupingSettings", + "description": "The event grouping settings." + }, + "sentinelEntitiesMappings": { + "$ref": "#/definitions/SentinelEntitiesMappings", + "description": "Array of the sentinel entity mappings of the alert rule" + } + }, + "required": [ + "displayName", + "enabled", + "severity", + "query", + "suppressionEnabled", + "suppressionDuration" + ], + "type": "object", + "x-ms-client-flatten": true + }, + "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" + }, + "lastUpdatedDateUTC": { + "description": "The time that this alert rule template was last updated.", + "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", + "x-ms-identifiers": [] + }, + "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": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "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": "./common/AlertTypes.json#/definitions/AttackTactic" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "techniques": { + "description": "The techniques of the alert rule", + "items": { + "type": "string" + }, + "type": "array" + }, + "subTechniques": { + "description": "The sub-techniques of the alert rule", + "items": { + "type": "string" + }, + "type": "array" + }, + "version": { + "description": "The version of this template - in format , where all are numbers. For example <1.0.2>.", + "type": "string" + }, + "eventGroupingSettings": { + "$ref": "#/definitions/EventGroupingSettings", + "description": "The event grouping settings." + }, + "customDetails": { + "description": "Dictionary of string key-value pairs of columns to be attached to the alert", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "entityMappings": { + "$ref": "#/definitions/EntityMappings", + "description": "Array of the entity mappings of the alert rule" + }, + "alertDetailsOverride": { + "type": "object", + "$ref": "#/definitions/AlertDetailsOverride", + "description": "The alert details override settings" + }, + "sentinelEntitiesMappings": { + "$ref": "#/definitions/SentinelEntitiesMappings", + "description": "Array of the sentinel entity mappings of the alert rule" + } + }, + "type": "object" + }, + "ScheduledAlertRuleTemplate": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplate" + } + ], + "description": "Represents scheduled alert rule template.", + "properties": { + "properties": { + "$ref": "#/definitions/ScheduledAlertRuleTemplateProperties", + "description": "Scheduled alert rule template properties", + "required": [ + "displayName", + "description", + "status", + "alertRulesCreatedByTemplateCount", + "severity", + "query", + "queryFrequency", + "queryPeriod", + "triggerOperator", + "triggerThreshold", + "version" + ], + "type": "object", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Scheduled" + }, + "NrtAlertRuleTemplate": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplate" + } + ], + "description": "Represents NRT alert rule template.", + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplateWithMitreProperties" + }, + { + "$ref": "#/definitions/QueryBasedAlertRuleTemplateProperties" + } + ], + "description": "NRT alert rule template properties", + "required": [ + "displayName", + "description", + "status", + "alertRulesCreatedByTemplateCount", + "severity", + "query", + "version" + ], + "type": "object", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "NRT" + }, + "EventGroupingSettings": { + "description": "Event grouping settings property bag.", + "properties": { + "aggregationKind": { + "$ref": "#/definitions/EventGroupingAggregationKind" + } + }, + "type": "object" + }, + "EventGroupingAggregationKind": { + "description": "The event grouping aggregation kinds", + "enum": [ + "SingleAlert", + "AlertPerResult" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EventGroupingAggregationKind" + } + }, + "ScheduledAlertRule": { + "allOf": [ + { + "$ref": "#/definitions/AlertRule" + } + ], + "description": "Represents scheduled alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/ScheduledAlertRuleProperties", + "description": "Scheduled alert rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Scheduled" + }, + "NrtAlertRule": { + "allOf": [ + { + "$ref": "#/definitions/AlertRule" + } + ], + "description": "Represents NRT alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/NrtAlertRuleProperties", + "description": "NRT alert rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "NRT" + }, + "ScheduledAlertRuleCommonProperties": { + "description": "Scheduled alert rule template property bag.", + "properties": { + "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": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "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.", + "type": "integer", + "format": "int32" + }, + "eventGroupingSettings": { + "$ref": "#/definitions/EventGroupingSettings", + "description": "The event grouping settings." + }, + "customDetails": { + "description": "Dictionary of string key-value pairs of columns to be attached to the alert", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "entityMappings": { + "$ref": "#/definitions/EntityMappings", + "description": "Array of the entity mappings of the alert rule" + }, + "alertDetailsOverride": { + "type": "object", + "$ref": "#/definitions/AlertDetailsOverride", + "description": "The alert details override settings" + }, + "sentinelEntitiesMappings": { + "$ref": "#/definitions/SentinelEntitiesMappings", + "description": "Array of the sentinel entity mappings of the alert rule" + } + }, + "type": "object" + }, + "EntityMappings": { + "description": "List of entity mappings of the alert rule", + "type": "array", + "items": { + "$ref": "#/definitions/EntityMapping" + }, + "x-ms-identifiers": [] + }, + "EntityMapping": { + "description": "Single entity mapping for the alert rule", + "properties": { + "entityType": { + "$ref": "#/definitions/EntityMappingType" + }, + "fieldMappings": { + "description": "array of field mappings for the given entity mapping", + "type": "array", + "items": { + "$ref": "#/definitions/FieldMapping" + }, + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "FieldMapping": { + "description": "A single field mapping of the mapped entity", + "properties": { + "identifier": { + "description": "the V3 identifier of the entity", + "type": "string" + }, + "columnName": { + "description": "the column name to be mapped to the identifier", + "type": "string" + } + }, + "type": "object" + }, + "SentinelEntitiesMappings": { + "description": "List of sentinel entity mappings of the alert rule", + "type": "array", + "items": { + "$ref": "#/definitions/SentinelEntityMapping" + }, + "x-ms-identifiers": [] + }, + "SentinelEntityMapping": { + "description": "A single sentinel entity mapping", + "properties": { + "columnName": { + "description": "the column name to be mapped to the SentinelEntities", + "type": "string" + } + }, + "type": "object" + }, + "AlertDetailsOverride": { + "description": "Settings for how to dynamically override alert static details", + "properties": { + "alertDisplayNameFormat": { + "description": "the format containing columns name(s) to override the alert name", + "type": "string" + }, + "alertDescriptionFormat": { + "description": "the format containing columns name(s) to override the alert description", + "type": "string" + }, + "alertTacticsColumnName": { + "description": "the column name to take the alert tactics from", + "type": "string" + }, + "alertSeverityColumnName": { + "description": "the column name to take the alert severity from", + "type": "string" + }, + "alertDynamicProperties": { + "description": "List of additional dynamic properties to override", + "type": "array", + "items": { + "$ref": "#/definitions/AlertPropertyMapping" + }, + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "AlertPropertyMapping": { + "description": "A single alert property mapping to override", + "properties": { + "alertProperty": { + "$ref": "#/definitions/AlertProperty" + }, + "value": { + "description": "the column name to use to override this property", + "type": "string" + } + }, + "type": "object" + }, + "IncidentConfiguration": { + "description": "Incident Configuration property bag.", + "properties": { + "createIncident": { + "description": "Create incidents from alerts triggered by this analytics rule", + "type": "boolean" + }, + "groupingConfiguration": { + "$ref": "#/definitions/GroupingConfiguration", + "description": "Set how the alerts that are triggered by this analytics rule, are grouped into incidents" + } + }, + "type": "object", + "required": [ + "createIncident" + ] + }, + "GroupingConfiguration": { + "description": "Grouping configuration property bag.", + "properties": { + "enabled": { + "description": "Grouping enabled", + "type": "boolean" + }, + "reopenClosedIncident": { + "description": "Re-open closed matching incidents", + "type": "boolean" + }, + "lookbackDuration": { + "description": "Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)", + "format": "duration", + "type": "string" + }, + "matchingMethod": { + "description": "Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty.", + "enum": [ + "AllEntities", + "AnyAlert", + "Selected" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "MatchingMethod", + "values": [ + { + "description": "Grouping alerts into a single incident if all the entities match", + "value": "AllEntities" + }, + { + "description": "Grouping any alerts triggered by this rule into a single incident", + "value": "AnyAlert" + }, + { + "description": "Grouping alerts into a single incident if the selected entities, custom details and alert details match", + "value": "Selected" + } + ] + } + }, + "groupByEntities": { + "description": "A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used.", + "items": { + "$ref": "#/definitions/EntityMappingType" + }, + "type": "array" + }, + "groupByAlertDetails": { + "description": "A list of alert details to group by (when matchingMethod is Selected)", + "items": { + "description": "Alert detail", + "enum": [ + "DisplayName", + "Severity" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AlertDetail", + "values": [ + { + "description": "Alert display name", + "value": "DisplayName" + }, + { + "description": "Alert severity", + "value": "Severity" + } + ] + } + }, + "type": "array" + }, + "groupByCustomDetails": { + "description": "A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "enabled", + "reopenClosedIncident", + "lookbackDuration", + "matchingMethod" + ] + }, + "ActionRequest": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/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", + "x-ms-secret": true + } + }, + "required": [ + "triggerUri" + ], + "type": "object" + }, + "ActionResponse": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Action for alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/ActionResponseProperties", + "description": "Action properties for get request", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "ActionResponseProperties": { + "allOf": [ + { + "$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" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "EntityMappingType": { + "description": "The V3 type of the mapped entity", + "enum": [ + "Account", + "Host", + "IP", + "Malware", + "File", + "Process", + "CloudApplication", + "DNS", + "AzureResource", + "FileHash", + "RegistryKey", + "RegistryValue", + "SecurityGroup", + "URL", + "Mailbox", + "MailCluster", + "MailMessage", + "SubmissionMail" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EntityMappingType", + "values": [ + { + "description": "User account entity type", + "value": "Account" + }, + { + "description": "Host entity type", + "value": "Host" + }, + { + "description": "IP address entity type", + "value": "IP" + }, + { + "description": "Malware entity type", + "value": "Malware" + }, + { + "description": "System file entity type", + "value": "File" + }, + { + "description": "Process entity type", + "value": "Process" + }, + { + "description": "Cloud app entity type", + "value": "CloudApplication" + }, + { + "description": "DNS entity type", + "value": "DNS" + }, + { + "description": "Azure resource entity type", + "value": "AzureResource" + }, + { + "description": "File-hash entity type", + "value": "FileHash" + }, + { + "description": "Registry key entity type", + "value": "RegistryKey" + }, + { + "description": "Registry value entity type", + "value": "RegistryValue" + }, + { + "description": "Security group entity type", + "value": "SecurityGroup" + }, + { + "description": "URL entity type", + "value": "URL" + }, + { + "description": "Mailbox entity type", + "value": "Mailbox" + }, + { + "description": "Mail cluster entity type", + "value": "MailCluster" + }, + { + "description": "Mail message entity type", + "value": "MailMessage" + }, + { + "description": "Submission mail entity type", + "value": "SubmissionMail" + } + ] + } + }, + "AlertProperty": { + "description": "The V3 alert property", + "enum": [ + "AlertLink", + "ConfidenceLevel", + "ConfidenceScore", + "ExtendedLinks", + "ProductName", + "ProviderName", + "ProductComponentName", + "RemediationSteps", + "Techniques", + "SubTechniques" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AlertProperty", + "values": [ + { + "description": "Alert's link", + "value": "AlertLink" + }, + { + "description": "Confidence level property", + "value": "ConfidenceLevel" + }, + { + "description": "Confidence score", + "value": "ConfidenceScore" + }, + { + "description": "Extended links to the alert", + "value": "ExtendedLinks" + }, + { + "description": "Product name alert property", + "value": "ProductName" + }, + { + "description": "Provider name alert property", + "value": "ProviderName" + }, + { + "description": "Product component name alert property", + "value": "ProductComponentName" + }, + { + "description": "Remediation steps alert property", + "value": "RemediationSteps" + }, + { + "description": "Techniques alert property", + "value": "Techniques" + }, + { + "description": "SubTechniques alert property", + "value": "SubTechniques" + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/AutomationRules.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/AutomationRules.json new file mode 100644 index 000000000000..627edcb7fe8a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/AutomationRules.json @@ -0,0 +1,1549 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/automationRules/{automationRuleId}": { + "get": { + "tags": [ + "automationRules" + ], + "description": "Gets the automation rule.", + "operationId": "AutomationRules_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/AutomationRuleId" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/AutomationRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AutomationRules_Get": { + "$ref": "./examples/automationRules/AutomationRules_Get.json" + } + } + }, + "put": { + "tags": [ + "automationRules" + ], + "description": "Creates or updates the automation rule.", + "operationId": "AutomationRules_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/AutomationRuleId" + }, + { + "in": "body", + "name": "automationRuleToUpsert", + "description": "The automation rule", + "schema": { + "$ref": "#/definitions/AutomationRule" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/AutomationRule" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/AutomationRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AutomationRules_CreateOrUpdate": { + "$ref": "./examples/automationRules/AutomationRules_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "automationRules" + ], + "description": "Delete the automation rule.", + "operationId": "AutomationRules_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/AutomationRuleId" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "type": "object" + } + }, + "204": { + "description": "No Content", + "schema": { + "type": "object" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AutomationRules_Delete": { + "$ref": "./examples/automationRules/AutomationRules_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/automationRules": { + "get": { + "tags": [ + "automationRules" + ], + "description": "Gets all automation rules.", + "operationId": "AutomationRules_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/AutomationRulesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AutomationRules_List": { + "$ref": "./examples/automationRules/AutomationRules_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityIdentifier}/runPlaybook": { + "post": { + "tags": [ + "manualTrigger" + ], + "description": "Triggers playbook on a specific entity.", + "operationId": "Entities_RunPlaybook", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "in": "path", + "name": "entityIdentifier", + "description": "Entity identifier.", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "requestBody", + "description": "Describes the request body for triggering a playbook on an entity.", + "schema": { + "$ref": "#/definitions/EntityManualTriggerRequestBody" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Entities_RunPlaybook": { + "$ref": "./examples/manualTrigger/Entities_RunPlaybook.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentIdentifier}/runPlaybook": { + "post": { + "tags": [ + "manualTrigger" + ], + "description": "Triggers playbook on a specific incident", + "operationId": "Incidents_RunPlaybook", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "in": "path", + "name": "incidentIdentifier", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "requestBody", + "schema": { + "$ref": "#/definitions/ManualTriggerRequestBody" + } + } + ], + "responses": { + "204": { + "description": "Success", + "schema": { + "type": "object" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Incidents_RunPlaybook": { + "$ref": "./examples/manualTrigger/Incidents_RunPlaybook.json" + } + } + } + } + }, + "definitions": { + "ActionType": { + "description": "The type of the automation rule action.", + "enum": [ + "ModifyProperties", + "RunPlaybook", + "AddIncidentTask" + ], + "type": "string", + "example": "ModifyProperties", + "x-ms-enum": { + "name": "ActionType", + "modelAsString": true, + "values": [ + { + "value": "ModifyProperties", + "description": "Modify an object's properties" + }, + { + "value": "RunPlaybook", + "description": "Run a playbook on an object" + }, + { + "value": "AddIncidentTask", + "description": "Add a task to an incident object" + } + ] + } + }, + "AddIncidentTaskActionProperties": { + "required": [ + "title" + ], + "type": "object", + "properties": { + "title": { + "description": "The title of the task.", + "type": "string" + }, + "description": { + "description": "The description of the task.", + "type": "string" + } + } + }, + "AutomationRule": { + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "properties": { + "properties": { + "type": "object", + "$ref": "#/definitions/AutomationRuleProperties", + "x-ms-client-flatten": true + } + } + }, + "AutomationRuleAction": { + "description": "Describes an automation rule action.", + "required": [ + "actionType", + "order" + ], + "type": "object", + "properties": { + "order": { + "format": "int32", + "type": "integer" + }, + "actionType": { + "$ref": "#/definitions/ActionType" + } + }, + "discriminator": "actionType" + }, + "AutomationRuleAddIncidentTaskAction": { + "description": "Describes an automation rule action to add a task to an incident", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AutomationRuleAction" + } + ], + "properties": { + "actionConfiguration": { + "type": "object", + "$ref": "#/definitions/AddIncidentTaskActionProperties" + } + }, + "x-ms-discriminator-value": "AddIncidentTask", + "x-ms-client-flatten": true + }, + "AutomationRuleBooleanCondition": { + "type": "object", + "properties": { + "operator": { + "$ref": "#/definitions/AutomationRuleBooleanConditionSupportedOperator" + }, + "innerConditions": { + "type": "array", + "items": { + "$ref": "#/definitions/AutomationRuleCondition" + }, + "x-ms-identifiers": [], + "minItems": 2, + "maxItems": 10 + } + } + }, + "AutomationRuleBooleanConditionSupportedOperator": { + "enum": [ + "And", + "Or" + ], + "type": "string", + "example": "And", + "x-ms-enum": { + "name": "AutomationRuleBooleanConditionSupportedOperator", + "modelAsString": true, + "values": [ + { + "value": "And", + "description": "Evaluates as true if all the item conditions are evaluated as true" + }, + { + "value": "Or", + "description": "Evaluates as true if at least one of the item conditions are evaluated as true" + } + ] + } + }, + "AutomationRuleCondition": { + "description": "Describes an automation rule condition.", + "required": [ + "conditionType" + ], + "type": "object", + "properties": { + "conditionType": { + "$ref": "#/definitions/ConditionType" + } + }, + "discriminator": "conditionType" + }, + "AutomationRuleModifyPropertiesAction": { + "description": "Describes an automation rule action to modify an object's properties", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AutomationRuleAction" + } + ], + "properties": { + "actionConfiguration": { + "type": "object", + "$ref": "#/definitions/IncidentPropertiesAction" + } + }, + "x-ms-discriminator-value": "ModifyProperties", + "x-ms-client-flatten": true + }, + "AutomationRuleProperties": { + "description": "Automation rule properties", + "required": [ + "actions", + "displayName", + "order", + "triggeringLogic" + ], + "type": "object", + "properties": { + "displayName": { + "description": "The display name of the automation rule.", + "type": "string", + "maxLength": 500 + }, + "order": { + "format": "int32", + "description": "The order of execution of the automation rule.", + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + "triggeringLogic": { + "$ref": "#/definitions/AutomationRuleTriggeringLogic" + }, + "actions": { + "description": "The actions to execute when the automation rule is triggered.", + "type": "array", + "items": { + "$ref": "#/definitions/AutomationRuleAction" + }, + "x-ms-identifiers": [], + "maxItems": 20 + }, + "lastModifiedTimeUtc": { + "format": "date-time", + "description": "The last time the automation rule was updated.", + "type": "string", + "readOnly": true + }, + "createdTimeUtc": { + "format": "date-time", + "description": "The time the automation rule was created.", + "type": "string", + "readOnly": true + }, + "lastModifiedBy": { + "readOnly": true, + "$ref": "../../../common/2.0/types.json#/definitions/ClientInfo" + }, + "createdBy": { + "readOnly": true, + "$ref": "../../../common/2.0/types.json#/definitions/ClientInfo" + } + } + }, + "AutomationRulePropertyArrayChangedConditionSupportedArrayType": { + "enum": [ + "Alerts", + "Labels", + "Tactics", + "Comments" + ], + "type": "string", + "example": "Alerts", + "x-ms-enum": { + "name": "AutomationRulePropertyArrayChangedConditionSupportedArrayType", + "modelAsString": true, + "values": [ + { + "value": "Alerts", + "description": "Evaluate the condition on the alerts" + }, + { + "value": "Labels", + "description": "Evaluate the condition on the labels" + }, + { + "value": "Tactics", + "description": "Evaluate the condition on the tactics" + }, + { + "value": "Comments", + "description": "Evaluate the condition on the comments" + } + ] + } + }, + "AutomationRulePropertyArrayChangedConditionSupportedChangeType": { + "enum": [ + "Added" + ], + "type": "string", + "example": "Added", + "x-ms-enum": { + "name": "AutomationRulePropertyArrayChangedConditionSupportedChangeType", + "modelAsString": true, + "values": [ + { + "value": "Added", + "description": "Evaluate the condition on items added to the array" + } + ] + } + }, + "AutomationRulePropertyArrayChangedValuesCondition": { + "type": "object", + "properties": { + "arrayType": { + "$ref": "#/definitions/AutomationRulePropertyArrayChangedConditionSupportedArrayType" + }, + "changeType": { + "$ref": "#/definitions/AutomationRulePropertyArrayChangedConditionSupportedChangeType" + } + } + }, + "AutomationRulePropertyArrayConditionSupportedArrayConditionType": { + "enum": [ + "AnyItem", + "AllItems" + ], + "type": "string", + "example": "AnyItem", + "x-ms-enum": { + "name": "AutomationRulePropertyArrayConditionSupportedArrayConditionType", + "modelAsString": true, + "values": [ + { + "value": "AnyItem", + "description": "Evaluate the condition as true if any item fulfills it" + }, + { + "value": "AllItems", + "description": "Evaluate the condition as true if all the items fulfill it" + } + ] + } + }, + "AutomationRulePropertyArrayConditionSupportedArrayType": { + "enum": [ + "CustomDetails", + "CustomDetailValues", + "IncidentLabels" + ], + "type": "string", + "example": "CustomDetails", + "x-ms-enum": { + "name": "AutomationRulePropertyArrayConditionSupportedArrayType", + "modelAsString": true, + "values": [ + { + "value": "CustomDetails", + "description": "Evaluate the condition on the custom detail keys" + }, + { + "value": "CustomDetailValues", + "description": "Evaluate the condition on a custom detail's values" + }, + { + "value": "IncidentLabels", + "description": "Evaluate the condition on the incident labels" + } + ] + } + }, + "AutomationRulePropertyArrayValuesCondition": { + "type": "object", + "properties": { + "arrayType": { + "$ref": "#/definitions/AutomationRulePropertyArrayConditionSupportedArrayType" + }, + "arrayConditionType": { + "$ref": "#/definitions/AutomationRulePropertyArrayConditionSupportedArrayConditionType" + }, + "itemConditions": { + "type": "array", + "items": { + "$ref": "#/definitions/AutomationRuleCondition" + }, + "x-ms-identifiers": [], + "maxItems": 10 + } + } + }, + "AutomationRulePropertyChangedConditionSupportedChangedType": { + "enum": [ + "ChangedFrom", + "ChangedTo" + ], + "type": "string", + "example": "ChangedFrom", + "x-ms-enum": { + "name": "AutomationRulePropertyChangedConditionSupportedChangedType", + "modelAsString": true, + "values": [ + { + "value": "ChangedFrom", + "description": "Evaluate the condition on the previous value of the property" + }, + { + "value": "ChangedTo", + "description": "Evaluate the condition on the updated value of the property" + } + ] + } + }, + "AutomationRulePropertyChangedConditionSupportedPropertyType": { + "enum": [ + "IncidentSeverity", + "IncidentStatus", + "IncidentOwner" + ], + "type": "string", + "example": "IncidentSeverity", + "x-ms-enum": { + "name": "AutomationRulePropertyChangedConditionSupportedPropertyType", + "modelAsString": true, + "values": [ + { + "value": "IncidentSeverity", + "description": "Evaluate the condition on the incident severity" + }, + { + "value": "IncidentStatus", + "description": "Evaluate the condition on the incident status" + }, + { + "value": "IncidentOwner", + "description": "Evaluate the condition on the incident owner" + } + ] + } + }, + "AutomationRulePropertyConditionSupportedOperator": { + "enum": [ + "Equals", + "NotEquals", + "Contains", + "NotContains", + "StartsWith", + "NotStartsWith", + "EndsWith", + "NotEndsWith" + ], + "type": "string", + "example": "Equals", + "x-ms-enum": { + "name": "AutomationRulePropertyConditionSupportedOperator", + "modelAsString": true, + "values": [ + { + "value": "Equals", + "description": "Evaluates if the property equals at least one of the condition values" + }, + { + "value": "NotEquals", + "description": "Evaluates if the property does not equal any of the condition values" + }, + { + "value": "Contains", + "description": "Evaluates if the property contains at least one of the condition values" + }, + { + "value": "NotContains", + "description": "Evaluates if the property does not contain any of the condition values" + }, + { + "value": "StartsWith", + "description": "Evaluates if the property starts with any of the condition values" + }, + { + "value": "NotStartsWith", + "description": "Evaluates if the property does not start with any of the condition values" + }, + { + "value": "EndsWith", + "description": "Evaluates if the property ends with any of the condition values" + }, + { + "value": "NotEndsWith", + "description": "Evaluates if the property does not end with any of the condition values" + } + ] + } + }, + "AutomationRulePropertyConditionSupportedProperty": { + "description": "The property to evaluate in an automation rule property condition.", + "enum": [ + "IncidentTitle", + "IncidentDescription", + "IncidentSeverity", + "IncidentStatus", + "IncidentRelatedAnalyticRuleIds", + "IncidentTactics", + "IncidentLabel", + "IncidentProviderName", + "IncidentUpdatedBySource", + "IncidentCustomDetailsKey", + "IncidentCustomDetailsValue", + "AccountAadTenantId", + "AccountAadUserId", + "AccountName", + "AccountNTDomain", + "AccountPUID", + "AccountSid", + "AccountObjectGuid", + "AccountUPNSuffix", + "AlertProductNames", + "AlertAnalyticRuleIds", + "AzureResourceResourceId", + "AzureResourceSubscriptionId", + "CloudApplicationAppId", + "CloudApplicationAppName", + "DNSDomainName", + "FileDirectory", + "FileName", + "FileHashValue", + "HostAzureID", + "HostName", + "HostNetBiosName", + "HostNTDomain", + "HostOSVersion", + "IoTDeviceId", + "IoTDeviceName", + "IoTDeviceType", + "IoTDeviceVendor", + "IoTDeviceModel", + "IoTDeviceOperatingSystem", + "IPAddress", + "MailboxDisplayName", + "MailboxPrimaryAddress", + "MailboxUPN", + "MailMessageDeliveryAction", + "MailMessageDeliveryLocation", + "MailMessageRecipient", + "MailMessageSenderIP", + "MailMessageSubject", + "MailMessageP1Sender", + "MailMessageP2Sender", + "MalwareCategory", + "MalwareName", + "ProcessCommandLine", + "ProcessId", + "RegistryKey", + "RegistryValueData", + "Url" + ], + "type": "string", + "example": "IncidentTitle", + "x-ms-enum": { + "name": "AutomationRulePropertyConditionSupportedProperty", + "modelAsString": true, + "values": [ + { + "value": "IncidentTitle", + "description": "The title of the incident" + }, + { + "value": "IncidentDescription", + "description": "The description of the incident" + }, + { + "value": "IncidentSeverity", + "description": "The severity of the incident" + }, + { + "value": "IncidentStatus", + "description": "The status of the incident" + }, + { + "value": "IncidentRelatedAnalyticRuleIds", + "description": "The related Analytic rule ids of the incident" + }, + { + "value": "IncidentTactics", + "description": "The tactics of the incident" + }, + { + "value": "IncidentLabel", + "description": "The labels of the incident" + }, + { + "value": "IncidentProviderName", + "description": "The provider name of the incident" + }, + { + "value": "IncidentUpdatedBySource", + "description": "The update source of the incident" + }, + { + "value": "IncidentCustomDetailsKey", + "description": "The incident custom detail key" + }, + { + "value": "IncidentCustomDetailsValue", + "description": "The incident custom detail value" + }, + { + "value": "AccountAadTenantId", + "description": "The account Azure Active Directory tenant id" + }, + { + "value": "AccountAadUserId", + "description": "The account Azure Active Directory user id" + }, + { + "value": "AccountName", + "description": "The account name" + }, + { + "value": "AccountNTDomain", + "description": "The account NetBIOS domain name" + }, + { + "value": "AccountPUID", + "description": "The account Azure Active Directory Passport User ID" + }, + { + "value": "AccountSid", + "description": "The account security identifier" + }, + { + "value": "AccountObjectGuid", + "description": "The account unique identifier" + }, + { + "value": "AccountUPNSuffix", + "description": "The account user principal name suffix" + }, + { + "value": "AlertProductNames", + "description": "The name of the product of the alert" + }, + { + "value": "AlertAnalyticRuleIds", + "description": "The analytic rule ids of the alert" + }, + { + "value": "AzureResourceResourceId", + "description": "The Azure resource id" + }, + { + "value": "AzureResourceSubscriptionId", + "description": "The Azure resource subscription id" + }, + { + "value": "CloudApplicationAppId", + "description": "The cloud application identifier" + }, + { + "value": "CloudApplicationAppName", + "description": "The cloud application name" + }, + { + "value": "DNSDomainName", + "description": "The dns record domain name" + }, + { + "value": "FileDirectory", + "description": "The file directory full path" + }, + { + "value": "FileName", + "description": "The file name without path" + }, + { + "value": "FileHashValue", + "description": "The file hash value" + }, + { + "value": "HostAzureID", + "description": "The host Azure resource id" + }, + { + "value": "HostName", + "description": "The host name without domain" + }, + { + "value": "HostNetBiosName", + "description": "The host NetBIOS name" + }, + { + "value": "HostNTDomain", + "description": "The host NT domain" + }, + { + "value": "HostOSVersion", + "description": "The host operating system" + }, + { + "value": "IoTDeviceId", + "description": "\"The IoT device id" + }, + { + "value": "IoTDeviceName", + "description": "The IoT device name" + }, + { + "value": "IoTDeviceType", + "description": "The IoT device type" + }, + { + "value": "IoTDeviceVendor", + "description": "The IoT device vendor" + }, + { + "value": "IoTDeviceModel", + "description": "The IoT device model" + }, + { + "value": "IoTDeviceOperatingSystem", + "description": "The IoT device operating system" + }, + { + "value": "IPAddress", + "description": "The IP address" + }, + { + "value": "MailboxDisplayName", + "description": "The mailbox display name" + }, + { + "value": "MailboxPrimaryAddress", + "description": "The mailbox primary address" + }, + { + "value": "MailboxUPN", + "description": "The mailbox user principal name" + }, + { + "value": "MailMessageDeliveryAction", + "description": "The mail message delivery action" + }, + { + "value": "MailMessageDeliveryLocation", + "description": "The mail message delivery location" + }, + { + "value": "MailMessageRecipient", + "description": "The mail message recipient" + }, + { + "value": "MailMessageSenderIP", + "description": "The mail message sender IP address" + }, + { + "value": "MailMessageSubject", + "description": "The mail message subject" + }, + { + "value": "MailMessageP1Sender", + "description": "The mail message P1 sender" + }, + { + "value": "MailMessageP2Sender", + "description": "The mail message P2 sender" + }, + { + "value": "MalwareCategory", + "description": "The malware category" + }, + { + "value": "MalwareName", + "description": "The malware name" + }, + { + "value": "ProcessCommandLine", + "description": "The process execution command line" + }, + { + "value": "ProcessId", + "description": "The process id" + }, + { + "value": "RegistryKey", + "description": "The registry key path" + }, + { + "value": "RegistryValueData", + "description": "The registry key value in string formatted representation" + }, + { + "value": "Url", + "description": "The url" + } + ] + } + }, + "AutomationRulePropertyValuesChangedCondition": { + "type": "object", + "properties": { + "propertyName": { + "$ref": "#/definitions/AutomationRulePropertyChangedConditionSupportedPropertyType" + }, + "changeType": { + "$ref": "#/definitions/AutomationRulePropertyChangedConditionSupportedChangedType" + }, + "operator": { + "$ref": "#/definitions/AutomationRulePropertyConditionSupportedOperator" + }, + "propertyValues": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AutomationRulePropertyValuesCondition": { + "type": "object", + "properties": { + "propertyName": { + "$ref": "#/definitions/AutomationRulePropertyConditionSupportedProperty" + }, + "operator": { + "$ref": "#/definitions/AutomationRulePropertyConditionSupportedOperator" + }, + "propertyValues": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AutomationRuleRunPlaybookAction": { + "description": "Describes an automation rule action to run a playbook", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AutomationRuleAction" + } + ], + "properties": { + "actionConfiguration": { + "type": "object", + "$ref": "#/definitions/PlaybookActionProperties" + } + }, + "x-ms-discriminator-value": "RunPlaybook", + "x-ms-client-flatten": true + }, + "AutomationRulesList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AutomationRule" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "AutomationRuleTriggeringLogic": { + "description": "Describes automation rule triggering logic.", + "required": [ + "isEnabled", + "triggersOn", + "triggersWhen" + ], + "type": "object", + "properties": { + "isEnabled": { + "description": "Determines whether the automation rule is enabled or disabled.", + "type": "boolean" + }, + "expirationTimeUtc": { + "format": "date-time", + "description": "Determines when the automation rule should automatically expire and be disabled.", + "type": "string" + }, + "triggersOn": { + "$ref": "#/definitions/triggersOn" + }, + "triggersWhen": { + "$ref": "#/definitions/triggersWhen" + }, + "conditions": { + "description": "The conditions to evaluate to determine if the automation rule should be triggered on a given object.", + "type": "array", + "maxItems": 50, + "items": { + "$ref": "#/definitions/AutomationRuleCondition" + }, + "x-ms-identifiers": [ + "conditionType" + ] + } + } + }, + "BooleanConditionProperties": { + "description": "Describes an automation rule condition that applies a boolean operator (e.g AND, OR) to conditions", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AutomationRuleCondition" + } + ], + "properties": { + "conditionProperties": { + "type": "object", + "$ref": "#/definitions/AutomationRuleBooleanCondition" + } + }, + "x-ms-discriminator-value": "Boolean", + "x-ms-client-flatten": true + }, + "ConditionType": { + "enum": [ + "Property", + "PropertyArray", + "PropertyChanged", + "PropertyArrayChanged", + "Boolean" + ], + "type": "string", + "example": "Property", + "x-ms-enum": { + "name": "ConditionType", + "modelAsString": true, + "values": [ + { + "value": "Property", + "description": "Evaluate an object property value" + }, + { + "value": "PropertyArray", + "description": "Evaluate an object array property value" + }, + { + "value": "PropertyChanged", + "description": "Evaluate an object property changed value" + }, + { + "value": "PropertyArrayChanged", + "description": "Evaluate an object array property changed value" + }, + { + "value": "Boolean", + "description": "Apply a boolean operator (e.g AND, OR) to conditions" + } + ] + } + }, + "EntityManualTriggerRequestBody": { + "type": "object", + "description": "Describes the request body for triggering a playbook on an entity.", + "required": [ + "logicAppsResourceId" + ], + "properties": { + "incidentArmId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "scopes": [ + "Extension" + ], + "type": "Microsoft.SecurityInsights/incidents" + } + ] + }, + "description": "Incident ARM id." + }, + "tenantId": { + "format": "uuid", + "type": "string", + "description": "The tenant id of the playbook resource." + }, + "logicAppsResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Logic/workflows" + }, + { + "type": "Microsoft.Web/sites" + } + ] + }, + "description": "The resource id of the playbook resource." + } + } + }, + "IncidentPropertiesAction": { + "type": "object", + "properties": { + "severity": { + "$ref": "./common/IncidentTypes.json#/definitions/IncidentSeverityEnum" + }, + "status": { + "$ref": "./common/IncidentTypes.json#/definitions/IncidentStatusEnum" + }, + "classification": { + "$ref": "./common/IncidentTypes.json#/definitions/IncidentClassificationEnum" + }, + "classificationReason": { + "$ref": "./common/IncidentTypes.json#/definitions/IncidentClassificationReasonEnum" + }, + "classificationComment": { + "description": "Describes the reason the incident was closed.", + "type": "string" + }, + "owner": { + "$ref": "./common/IncidentTypes.json#/definitions/IncidentOwnerInfo" + }, + "labels": { + "description": "List of labels to add to the incident.", + "type": "array", + "x-ms-identifiers": [ + "labelName" + ], + "items": { + "$ref": "./common/IncidentTypes.json#/definitions/IncidentLabel" + } + } + } + }, + "ManualTriggerRequestBody": { + "type": "object", + "required": [ + "logicAppsResourceId" + ], + "properties": { + "tenantId": { + "format": "uuid", + "type": "string" + }, + "logicAppsResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Logic/workflows" + }, + { + "type": "Microsoft.Web/sites" + } + ] + } + } + } + }, + "PlaybookActionProperties": { + "type": "object", + "required": [ + "logicAppResourceId" + ], + "properties": { + "logicAppResourceId": { + "description": "The resource id of the playbook resource.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Logic/workflows" + }, + { + "type": "Microsoft.Web/sites" + } + ] + } + }, + "tenantId": { + "format": "uuid", + "description": "The tenant id of the playbook resource.", + "type": "string" + } + } + }, + "PropertyArrayChangedConditionProperties": { + "description": "Describes an automation rule condition that evaluates an array property's value change", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AutomationRuleCondition" + } + ], + "properties": { + "conditionProperties": { + "type": "object", + "$ref": "#/definitions/AutomationRulePropertyArrayChangedValuesCondition" + } + }, + "x-ms-discriminator-value": "PropertyArrayChanged", + "x-ms-client-flatten": true + }, + "PropertyArrayConditionProperties": { + "description": "Describes an automation rule condition that evaluates an array property's value", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AutomationRuleCondition" + } + ], + "properties": { + "conditionProperties": { + "type": "object", + "$ref": "#/definitions/AutomationRulePropertyArrayValuesCondition" + } + }, + "x-ms-discriminator-value": "PropertyArray", + "x-ms-client-flatten": true + }, + "PropertyChangedConditionProperties": { + "description": "Describes an automation rule condition that evaluates a property's value change", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AutomationRuleCondition" + } + ], + "properties": { + "conditionProperties": { + "type": "object", + "$ref": "#/definitions/AutomationRulePropertyValuesChangedCondition" + } + }, + "x-ms-discriminator-value": "PropertyChanged", + "x-ms-client-flatten": true + }, + "PropertyConditionProperties": { + "description": "Describes an automation rule condition that evaluates a property's value", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AutomationRuleCondition" + } + ], + "properties": { + "conditionProperties": { + "type": "object", + "$ref": "#/definitions/AutomationRulePropertyValuesCondition" + } + }, + "x-ms-discriminator-value": "Property", + "x-ms-client-flatten": true + }, + "triggersOn": { + "enum": [ + "Incidents", + "Alerts" + ], + "type": "string", + "example": "Incidents", + "x-ms-enum": { + "name": "triggersOn", + "modelAsString": true, + "values": [ + { + "value": "Incidents", + "description": "Trigger on Incidents" + }, + { + "value": "Alerts", + "description": "Trigger on Alerts" + } + ] + } + }, + "triggersWhen": { + "enum": [ + "Created", + "Updated" + ], + "type": "string", + "example": "Created", + "x-ms-enum": { + "name": "triggersWhen", + "modelAsString": true, + "values": [ + { + "value": "Created", + "description": "Trigger on created objects" + }, + { + "value": "Updated", + "description": "Trigger on updated objects" + } + ] + } + } + }, + "parameters": { + "AutomationRule": { + "name": "automationRule", + "description": "The automation rule", + "required": true, + "in": "body", + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/AutomationRule" + } + }, + "AutomationRuleId": { + "in": "path", + "name": "automationRuleId", + "description": "Automation rule ID", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/BillingStatistics.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/BillingStatistics.json new file mode 100644 index 000000000000..56177e44eb5a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/BillingStatistics.json @@ -0,0 +1,226 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/billingStatistics": { + "get": { + "x-ms-examples": { + "Get all Microsoft Sentinel billing statistics.": { + "$ref": "./examples/billingStatistics/GetAllBillingStatistics.json" + } + }, + "tags": [ + "billingStatistics" + ], + "description": "Gets all Microsoft Sentinel billing statistics.", + "operationId": "BillingStatistics_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BillingStatisticList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/billingStatistics/{billingStatisticName}": { + "get": { + "x-ms-examples": { + "Get a billing statistic.": { + "$ref": "./examples/billingStatistics/GetBillingStatistic.json" + } + }, + "tags": [ + "billingStatistics" + ], + "description": "Gets a billing statistic", + "operationId": "BillingStatistics_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BillingStatisticName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BillingStatistic" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "BillingStatisticList": { + "description": "List of all Microsoft Sentinel billing statistics.", + "type": "object", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of billing statistics.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of billing statistics.", + "items": { + "$ref": "#/definitions/BillingStatistic" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + }, + "BillingStatistic": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/AzureEntityResource" + } + ], + "description": "Billing statistic", + "properties": { + "kind": { + "$ref": "#/definitions/BillingStatisticKindEnum", + "description": "The kind of the billing statistic" + } + }, + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] + }, + "BillingStatisticKindEnum": { + "description": "The kind of the billing statistic", + "enum": [ + "SapSolutionUsage" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "BillingStatisticKind", + "values": [ + { + "value": "SapSolutionUsage" + } + ] + } + }, + "SapSolutionUsageStatistic": { + "allOf": [ + { + "$ref": "#/definitions/BillingStatistic" + } + ], + "description": "Billing statistic about the Microsoft Sentinel solution for SAP Usage", + "properties": { + "properties": { + "$ref": "#/definitions/SapSolutionUsageStatisticProperties", + "description": "The SAP solution usage object", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "SapSolutionUsage" + }, + "SapSolutionUsageStatisticProperties": { + "description": "Properties of the billing statistic about the Microsoft Sentinel solution for SAP usage", + "properties": { + "activeSystemIdCount": { + "description": "The latest count of active SAP system IDs under the Microsoft Sentinel solution for SAP Usage", + "type": "integer", + "format": "int64", + "readOnly": true + } + }, + "type": "object" + } + }, + "parameters": { + "BillingStatisticName": { + "description": "The name of the billing statistic", + "in": "path", + "name": "billingStatisticName", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Bookmarks.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Bookmarks.json new file mode 100644 index 000000000000..ffbaefbb5d55 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Bookmarks.json @@ -0,0 +1,751 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.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": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BookmarkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/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": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Bookmark" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/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": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + }, + { + "$ref": "#/parameters/Bookmark" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Bookmark" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Bookmark" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/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": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}/relations": { + "get": { + "x-ms-examples": { + "Get all bookmark relations.": { + "$ref": "./examples/bookmarks/relations/GetAllBookmarkRelations.json" + } + }, + "tags": [ + "BookmarkRelations" + ], + "description": "Gets all bookmark relations.", + "operationId": "BookmarkRelations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./common/RelationTypes.json#/definitions/RelationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-odata": "./common/RelationTypes.json#/definitions/Relation", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}/expand": { + "post": { + "x-ms-examples": { + "Expand an bookmark": { + "$ref": "./examples/bookmarks/expand/PostExpandBookmark.json" + } + }, + "description": "Expand an bookmark", + "operationId": "Bookmark_Expand", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + }, + { + "$ref": "#/parameters/BookmarkExpandRequestBody" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BookmarkExpandResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "tags": [ + "Bookmark" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}/relations/{relationName}": { + "get": { + "x-ms-examples": { + "Get a bookmark relation.": { + "$ref": "./examples/bookmarks/relations/GetBookmarkRelationByName.json" + } + }, + "tags": [ + "BookmarkRelations" + ], + "description": "Gets a bookmark relation.", + "operationId": "BookmarkRelations_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + }, + { + "$ref": "./common/RelationTypes.json#/parameters/RelationName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./common/RelationTypes.json#/definitions/Relation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a bookmark relation.": { + "$ref": "./examples/bookmarks/relations/CreateBookmarkRelation.json" + } + }, + "tags": [ + "BookmarkRelations" + ], + "description": "Creates the bookmark relation.", + "operationId": "BookmarkRelations_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + }, + { + "$ref": "./common/RelationTypes.json#/parameters/RelationName" + }, + { + "$ref": "./common/RelationTypes.json#/parameters/Relation" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./common/RelationTypes.json#/definitions/Relation" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./common/RelationTypes.json#/definitions/Relation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete the bookmark relation.": { + "$ref": "./examples/bookmarks/relations/DeleteBookmarkRelation.json" + } + }, + "tags": [ + "BookmarkRelations" + ], + "description": "Delete the bookmark relation.", + "operationId": "BookmarkRelations_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + }, + { + "$ref": "./common/RelationTypes.json#/parameters/RelationName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "Bookmark": { + "description": "The bookmark", + "in": "body", + "name": "bookmark", + "required": true, + "schema": { + "$ref": "#/definitions/Bookmark" + }, + "x-ms-parameter-location": "method" + }, + "BookmarkExpandRequestBody": { + "description": "The parameters required to execute an expand operation on the given bookmark.", + "in": "body", + "name": "parameters", + "required": true, + "schema": { + "$ref": "#/definitions/BookmarkExpandParameters" + }, + "x-ms-parameter-location": "method" + }, + "BookmarkId": { + "description": "Bookmark ID", + "in": "path", + "name": "bookmarkId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "Bookmark": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a bookmark in Azure Security Insights.", + "properties": { + "properties": { + "$ref": "#/definitions/BookmarkProperties", + "description": "Bookmark properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "BookmarkExpandParameters": { + "description": "The parameters required to execute an expand operation on the given bookmark.", + "properties": { + "endTime": { + "description": "The end date filter, so the only expansion results returned are before this date.", + "format": "date-time", + "type": "string" + }, + "expansionId": { + "description": "The Id of the expansion to perform.", + "format": "uuid", + "type": "string" + }, + "startTime": { + "description": "The start date filter, so the only expansion results returned are after this date.", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "BookmarkExpandResponse": { + "description": "The entity expansion result operation response.", + "properties": { + "metaData": { + "$ref": "./common/EntityTypes.json#/definitions/ExpansionResultsMetadata", + "description": "The metadata from the expansion operation results." + }, + "value": { + "description": "The expansion result values.", + "properties": { + "entities": { + "description": "Array of the expansion result entities.", + "items": { + "$ref": "./common/EntityTypes.json#/definitions/Entity" + }, + "type": "array" + }, + "edges": { + "description": "Array of expansion result connected entities", + "items": { + "$ref": "#/definitions/ConnectedEntity" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "BookmarkList": { + "description": "List all the bookmarks.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of bookmarks.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of bookmarks.", + "items": { + "$ref": "#/definitions/Bookmark" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "BookmarkProperties": { + "description": "Describes bookmark properties", + "properties": { + "created": { + "description": "The time the bookmark was created", + "format": "date-time", + "type": "string" + }, + "createdBy": { + "$ref": "../../../common/2.0/types.json#/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": "../../../common/2.0/types.json#/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": "../../../common/2.0/types.json#/definitions/UserInfo", + "description": "Describes a user that updated the bookmark", + "type": "object" + }, + "eventTime": { + "description": "The bookmark event time", + "format": "date-time", + "type": "string" + }, + "queryStartTime": { + "description": "The start time for the query", + "format": "date-time", + "type": "string" + }, + "queryEndTime": { + "description": "The end time for the query", + "format": "date-time", + "type": "string" + }, + "incidentInfo": { + "$ref": "./common/IncidentTypes.json#/definitions/IncidentInfo", + "description": "Describes an incident that relates to bookmark", + "type": "object" + }, + "entityMappings": { + "$ref": "#/definitions/EntityMappingsList", + "description": "Describes the entity mappings of the bookmark", + "type": "object" + }, + "tactics": { + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" + }, + "description": "A list of relevant mitre attacks", + "type": "array" + }, + "techniques": { + "items": { + "$ref": "#/definitions/AttackTechnique" + }, + "description": "A list of relevant mitre techniques", + "type": "array" + } + }, + "required": [ + "displayName", + "query" + ], + "type": "object" + }, + "ConnectedEntity": { + "description": "Expansion result connected entities", + "properties": { + "targetEntityId": { + "description": "Entity Id of the connected entity", + "type": "string" + }, + "additionalData": { + "description": "key-value pairs for a connected entity mapping", + "type": "object" + } + }, + "type": "object" + }, + "EntityMappingsList": { + "description": "Describes the entity mappings of the bookmark", + "items": { + "$ref": "#/definitions/BookmarkEntityMappings" + }, + "x-ms-identifiers": [], + "type": "array" + }, + "BookmarkEntityMappings": { + "description": "Describes the entity mappings of a single entity", + "properties": { + "entityType": { + "description": "The entity type", + "type": "string" + }, + "fieldMappings": { + "description": "Array of fields mapping for that entity type", + "items": { + "$ref": "#/definitions/EntityFieldMapping" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "type": "object" + }, + "EntityFieldMapping": { + "description": "Map identifiers of a single entity", + "properties": { + "identifier": { + "description": "Alert V3 identifier", + "type": "string" + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "type": "object" + }, + "AttackTechnique": { + "description": "Mitre technique (https://attack.mitre.org/matrices/enterprise/)", + "type": "string" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/BusinessApplicationAgents.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/BusinessApplicationAgents.json new file mode 100644 index 000000000000..bc2e4e8e71ff --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/BusinessApplicationAgents.json @@ -0,0 +1,1691 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/businessApplicationAgents/{agentResourceName}": { + "put": { + "tags": [ + "businessApplicationAgents" + ], + "description": "Creates or updates the Business Application Agent.", + "operationId": "BusinessApplicationAgents_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "in": "path", + "name": "agentResourceName", + "description": "Business Application Agent Name", + "required": true, + "type": "string", + "pattern": "^[a-z0-9,-]*$", + "minLength": 3, + "maxLength": 63 + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "agentToUpsert", + "description": "The Business Application Agent", + "schema": { + "$ref": "#/definitions/BusinessApplicationAgentResource" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/BusinessApplicationAgentResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/BusinessApplicationAgentResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BusinessApplicationAgents_CreateOrUpdate": { + "$ref": "./examples/businessApplicationAgents/BusinessApplicationAgents_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "businessApplicationAgents" + ], + "description": "Gets Business Application Agent.", + "operationId": "BusinessApplicationAgent_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "in": "path", + "name": "agentResourceName", + "description": "Business Application Agent Name", + "required": true, + "type": "string", + "pattern": "^[a-z0-9,-]*$", + "minLength": 3, + "maxLength": 63 + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/BusinessApplicationAgentResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BusinessApplicationAgent_Get": { + "$ref": "./examples/businessApplicationAgents/BusinessApplicationAgent_Get.json" + } + } + }, + "delete": { + "tags": [ + "businessApplicationAgents" + ], + "description": "Delete the Business Application Agent.", + "operationId": "BusinessApplicationAgents_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "in": "path", + "name": "agentResourceName", + "description": "Business Application Agent Name", + "required": true, + "type": "string", + "pattern": "^[a-z0-9,-]*$", + "minLength": 3, + "maxLength": 63 + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BusinessApplicationAgents_Delete": { + "$ref": "./examples/businessApplicationAgents/BusinessApplicationAgents_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/businessApplicationAgents": { + "get": { + "tags": [ + "businessApplicationAgents" + ], + "description": "Gets all Business Application Agents under the workspace.", + "operationId": "BusinessApplicationAgents_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/BusinessApplicationAgentsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessApplicationAgents_List": { + "$ref": "./examples/businessApplicationAgents/BusinessApplicationAgents_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/businessApplicationAgents/{agentResourceName}/systems/{systemResourceName}": { + "put": { + "tags": [ + "systems" + ], + "description": "Creates or updates the system.", + "operationId": "Systems_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "in": "path", + "name": "agentResourceName", + "description": "Business Application Agent Name", + "required": true, + "type": "string", + "pattern": "^[a-z0-9,-]*$", + "minLength": 3, + "maxLength": 63 + }, + { + "in": "path", + "name": "systemResourceName", + "description": "The name of the system.", + "required": true, + "type": "string", + "pattern": "^[a-z0-9,-]*$", + "minLength": 3, + "maxLength": 63 + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "systemToUpsert", + "description": "The system to upsert.", + "schema": { + "$ref": "#/definitions/SystemResource" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/SystemResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SystemResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Systems_CreateOrUpdate": { + "$ref": "./examples/businessApplicationAgents/systems/Systems_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "systems" + ], + "description": "Gets the system.", + "operationId": "Systems_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "in": "path", + "name": "agentResourceName", + "description": "Business Application Agent Name", + "required": true, + "type": "string", + "pattern": "^[a-z0-9,-]*$", + "minLength": 3, + "maxLength": 63 + }, + { + "in": "path", + "name": "systemResourceName", + "description": "The name of the system.", + "required": true, + "type": "string", + "pattern": "^[a-z0-9,-]*$", + "minLength": 3, + "maxLength": 63 + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/SystemResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Systems_Get": { + "$ref": "./examples/businessApplicationAgents/systems/Systems_Get.json" + } + } + }, + "delete": { + "tags": [ + "systems" + ], + "description": "Deletes the system.", + "operationId": "Systems_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "in": "path", + "name": "agentResourceName", + "description": "Business Application Agent Name", + "required": true, + "type": "string", + "pattern": "^[a-z0-9,-]*$", + "minLength": 3, + "maxLength": 63 + }, + { + "in": "path", + "name": "systemResourceName", + "description": "The name of the system.", + "required": true, + "type": "string", + "pattern": "^[a-z0-9,-]*$", + "minLength": 3, + "maxLength": 63 + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Systems_Delete": { + "$ref": "./examples/businessApplicationAgents/systems/Systems_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/businessApplicationAgents/{agentResourceName}/systems": { + "get": { + "tags": [ + "systems" + ], + "description": "ListAll the systems.", + "operationId": "Systems_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "in": "path", + "name": "agentResourceName", + "description": "Business Application Agent Name", + "required": true, + "type": "string", + "pattern": "^[a-z0-9,-]*$", + "minLength": 3, + "maxLength": 63 + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/SystemsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Systems_List": { + "$ref": "./examples/businessApplicationAgents/systems/Systems_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/businessApplicationAgents/{agentResourceName}/systems/{systemResourceName}/listActions": { + "post": { + "tags": [ + "SystemsActions" + ], + "operationId": "Systems_ListActions", + "description": "List of actions for a business application system.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "in": "path", + "name": "agentResourceName", + "description": "Business Application Agent Name", + "required": true, + "type": "string", + "pattern": "^[a-z0-9,-]*$", + "minLength": 3, + "maxLength": 63 + }, + { + "in": "path", + "name": "systemResourceName", + "description": "The name of the system.", + "required": true, + "type": "string", + "pattern": "^[a-z0-9,-]*$", + "minLength": 3, + "maxLength": 63 + } + ], + "responses": { + "200": { + "description": "List actions for a business application system", + "schema": { + "$ref": "#/definitions/ListActionsResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListActions": { + "$ref": "./examples/businessApplicationAgents/actions/ListActions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/businessApplicationAgents/{agentResourceName}/systems/{systemResourceName}/undoAction": { + "post": { + "tags": [ + "SystemsActions" + ], + "operationId": "Systems_UndoAction", + "description": "Undo action, based on the actionId.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "in": "path", + "name": "agentResourceName", + "description": "Business Application Agent Name", + "required": true, + "type": "string", + "pattern": "^[a-z0-9,-]*$", + "minLength": 3, + "maxLength": 63 + }, + { + "in": "path", + "name": "systemResourceName", + "description": "The name of the system.", + "required": true, + "type": "string", + "pattern": "^[a-z0-9,-]*$", + "minLength": 3, + "maxLength": 63 + }, + { + "in": "body", + "description": "Undo action, based on the actionId.", + "name": "payload", + "schema": { + "$ref": "#/definitions/UndoActionPayload" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UndoAction": { + "$ref": "./examples/businessApplicationAgents/actions/UndoAction.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/businessApplicationAgents/{agentResourceName}/systems/{systemResourceName}/reportActionStatus": { + "post": { + "tags": [ + "SystemsActions" + ], + "operationId": "Systems_ReportActionStatus", + "description": "Report the status of the action.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "in": "path", + "name": "agentResourceName", + "description": "Business Application Agent Name", + "required": true, + "type": "string", + "pattern": "^[a-z0-9,-]*$", + "minLength": 3, + "maxLength": 63 + }, + { + "in": "path", + "name": "systemResourceName", + "description": "The name of the system.", + "required": true, + "type": "string", + "pattern": "^[a-z0-9,-]*$", + "minLength": 3, + "maxLength": 63 + }, + { + "in": "body", + "name": "payload", + "description": "Report a status of the action that was performed by the agent", + "schema": { + "$ref": "#/definitions/ReportActionStatusPayload" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ReportActionStatus": { + "$ref": "./examples/businessApplicationAgents/actions/ReportActionStatus.json" + } + } + } + } + }, + "definitions": { + "BusinessApplicationAgentResource": { + "description": "Describes the configuration of a Business Application Agent.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "properties": { + "properties": { + "type": "object", + "$ref": "#/definitions/AgentProperties", + "x-ms-client-flatten": true + } + } + }, + "AgentConfiguration": { + "description": "Describes the configuration of a Business Application Agent.", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/AgentType" + } + }, + "discriminator": "type" + }, + "AgentProperties": { + "required": [ + "configuration", + "displayName" + ], + "type": "object", + "properties": { + "configuration": { + "$ref": "#/definitions/AgentConfiguration" + }, + "agentSystems": { + "type": "array", + "items": { + "$ref": "#/definitions/AgentSystem" + }, + "readOnly": true + }, + "displayName": { + "minLength": 1, + "type": "string" + }, + "lastModifiedTimeUtc": { + "format": "date-time", + "type": "string", + "readOnly": true + } + } + }, + "AgentSystem": { + "description": "Describes the configuration of a system inside the agent.", + "type": "object", + "properties": { + "systemResourceName": { + "type": "string" + }, + "systemDisplayName": { + "type": "string" + } + } + }, + "AgentType": { + "description": "Type of the agent", + "enum": [ + "SAP" + ], + "type": "string", + "example": "SAP", + "x-ms-enum": { + "name": "AgentType", + "modelAsString": true, + "values": [ + { + "value": "SAP" + } + ] + } + }, + "BusinessApplicationAgentsList": { + "description": "List of agents.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BusinessApplicationAgentResource" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "KeyVaultAuthenticationMode": { + "description": "Type for authentication identity to key vault", + "enum": [ + "ManagedIdentity", + "ServicePrincipal" + ], + "type": "string", + "example": "ManagedIdentity", + "x-ms-enum": { + "name": "KeyVaultAuthenticationMode", + "modelAsString": true, + "values": [ + { + "value": "ManagedIdentity" + }, + { + "value": "ServicePrincipal" + } + ] + } + }, + "SapAgentConfiguration": { + "description": "Describes the configuration of a SAP Docker agent.", + "required": [ + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AgentConfiguration" + } + ], + "properties": { + "agentContainerName": { + "description": "The name of the docker agent.\r\nonly letters with numbers, underscores and hyphens are allowed\r\nexample: \"my-agent\"", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "type": "string" + }, + "sdkPath": { + "description": "The SDK path (a file not a folder) on the agent machine.\r\nexample: \"/path/to/nwrfc750P_8-70002755.zip\"", + "pattern": "^/(([^/]+/)*nwrfc75.*\\.zip$)|^((?:[a-zA-Z]:)?(?:\\\\|\\\\\\\\)(?:[^\\\\/:*?\"<>|\\r\\n]+\\\\)*nwrfc75.*\\.zip)$", + "type": "string" + }, + "sncPath": { + "description": "The SNC path (a folder not a file) on the agent machine.\r\nexample: \"/path/to/snc\"", + "pattern": "^\\/(?:[^/]+\\/)*[^/]+$|^(?:[a-zA-Z]:)?(?:\\\\|\\\\\\\\)(?:[^\\\\/:*?\"<>|\\r\\n]+\\\\)*[^\\\\/:*?\"<>|\\r\\n]*$", + "type": "string" + }, + "keyVaultResourceId": { + "description": "The key vault resource id to access the key vault.\r\nexample: \"/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.KeyVault/vaults/myVault\"", + "pattern": "^\\/?subscriptions\\/([^\\/]+)\\/resourceGroups\\/([^\\/]+)\\/providers\\/Microsoft\\.KeyVault\\/vaults\\/([^\\/]+)$", + "type": "string" + }, + "keyVaultAuthenticationMode": { + "description": "The key mode of the agent.\r\nManagedIdentity|ApplicationIdentity are the options", + "$ref": "#/definitions/KeyVaultAuthenticationMode" + }, + "secretSource": { + "description": "The secret source of the agent.\r\nAzureKeyVault is the option", + "$ref": "#/definitions/SecretSource" + }, + "type": { + "$ref": "#/definitions/AgentType" + } + }, + "x-ms-discriminator-value": "SAP" + }, + "SecretSource": { + "description": "Type for Secret Source - Azure Key Vault", + "enum": [ + "AzureKeyVault" + ], + "type": "string", + "example": "AzureKeyVault", + "x-ms-enum": { + "name": "SecretSource", + "modelAsString": true, + "values": [ + { + "value": "AzureKeyVault" + } + ] + } + }, + "ListActionsResponse": { + "description": "List all actions for a system to perform.", + "properties": { + "value": { + "description": "Array of actions.", + "items": { + "$ref": "#/definitions/Action" + }, + "x-ms-identifiers": [], + "type": "array" + }, + "nextLink": { + "description": "The link to fetch the next page of actions.", + "type": "string" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "Action": { + "description": "Represents an action to perform on a specific system.", + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/ListActionKind", + "description": "The actions kind" + } + }, + "type": "object" + }, + "ListActionKind": { + "description": "The kind of the action", + "enum": [ + "LockUser", + "UnlockUser" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ListActionKind", + "values": [ + { + "value": "LockUser" + }, + { + "value": "UnlockUser" + } + ] + } + }, + "LockUserAction": { + "allOf": [ + { + "$ref": "#/definitions/Action" + } + ], + "description": "Represents lock user action.", + "properties": { + "user": { + "type": "string", + "description": "The user to lock" + }, + "failureReason": { + "type": "string", + "description": "The reason of the failure of the action. Empty if the action is successful." + } + }, + "type": "object", + "x-ms-discriminator-value": "LockUser" + }, + "UnlockUserAction": { + "allOf": [ + { + "$ref": "#/definitions/Action" + } + ], + "description": "Represents an unlock user action.", + "properties": { + "user": { + "type": "string", + "description": "The user to unlock" + }, + "failureReason": { + "type": "string", + "description": "The reason of the failure of the action. Empty if the action is successful." + } + }, + "type": "object", + "x-ms-discriminator-value": "UnlockUser" + }, + "UndoActionPayload": { + "description": "Represents the undo action.", + "properties": { + "actionId": { + "type": "string", + "description": "The action ID of the original action that was performed and now need to undo" + } + }, + "type": "object" + }, + "ReportActionStatusPayload": { + "description": "Report the status of an action that was performed by the agent", + "type": "object", + "properties": { + "actionId": { + "type": "string", + "description": "The action ID to perform" + }, + "actionStatus": { + "description": "The status of the action that was performed by the agent", + "type": "string" + }, + "failureReason": { + "description": "The reason of the failure of the action. Empty if the action is successful.", + "type": "string" + } + } + }, + "ActionStatus": { + "description": "The status of the action that was performed by the agent", + "enum": [ + "Pending", + "Completed", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ActionStatus", + "values": [ + { + "value": "Pending", + "description": "Actions is pending" + }, + { + "value": "Completed", + "description": "The action is completed successfully." + }, + { + "value": "Failed", + "description": "The action failed." + } + ] + } + }, + "SapAuthenticationType": { + "description": "Types of authentication to SAP.", + "enum": [ + "UsernamePassword", + "Snc", + "SncWithUsernamePassword" + ], + "type": "string", + "example": "UsernamePassword", + "x-ms-enum": { + "name": "SapAuthenticationType", + "modelAsString": true, + "values": [ + { + "value": "UsernamePassword" + }, + { + "value": "Snc" + }, + { + "value": "SncWithUsernamePassword" + } + ] + } + }, + "ConfigurationType": { + "description": "Represents the types of configuration for a system.", + "enum": [ + "SAP" + ], + "type": "string", + "example": "SAP", + "x-ms-enum": { + "name": "ConfigurationType", + "modelAsString": true, + "values": [ + { + "value": "SAP" + } + ] + } + }, + "HttpsConfigurationType": { + "description": "Represents the types of HTTPS configuration to connect to the SapControl service.", + "enum": [ + "HttpOnly", + "HttpsWithSslVerification", + "HttpsWithoutSslVerification" + ], + "type": "string", + "example": "HttpOnly", + "x-ms-enum": { + "name": "HttpsConfigurationType", + "modelAsString": true, + "values": [ + { + "value": "HttpOnly" + }, + { + "value": "HttpsWithSslVerification" + }, + { + "value": "HttpsWithoutSslVerification" + } + ] + } + }, + "IngestionType": { + "description": "Types of ingestion.", + "enum": [ + "Full", + "Incremental" + ], + "type": "string", + "example": "Full", + "x-ms-enum": { + "name": "IngestionType", + "modelAsString": true, + "values": [ + { + "value": "Full" + }, + { + "value": "Incremental" + } + ] + } + }, + "Log": { + "description": "Describes a log.", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/LogType" + }, + "ingestionType": { + "$ref": "#/definitions/IngestionType" + }, + "status": { + "$ref": "#/definitions/LogStatusType" + }, + "scheduleInterval": { + "format": "int32", + "description": "The schedule interval in seconds.", + "type": "integer" + }, + "bulkSize": { + "format": "int32", + "description": "The bulk size for the log.", + "type": "integer" + }, + "filters": { + "description": "The filters for the log.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "LogStatusType": { + "description": "Types of log status.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "example": "Enabled", + "x-ms-enum": { + "name": "LogStatusType", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + } + }, + "LogType": { + "description": "Types of logs and tables.", + "enum": [ + "AbapAuditLog", + "AbapJobLog", + "AbapSpoolLog", + "AbapSpoolOutputLog", + "AbapChangeDocsLog", + "AbapAppLog", + "AbapWorkflowLog", + "AbapCrLog", + "AbapTableDataLog", + "AbapFilesLogs", + "JavaFilesLogs", + "AGRTCODES", + "USR01", + "USR02", + "AGR1251", + "AGRUSERS", + "AGRPROF", + "UST04", + "USR21", + "ADR6", + "ADCP", + "USR05", + "USGRPUSER", + "USERADDR", + "DEVACCESS", + "AGRDEFINE", + "PAHI", + "AGRAGRS", + "USRSTAMP", + "AGRFLAGS", + "SNCSYSACL", + "USRACL" + ], + "type": "string", + "example": "AbapAuditLog", + "x-ms-enum": { + "name": "LogType", + "modelAsString": true, + "values": [ + { + "value": "AbapAuditLog" + }, + { + "value": "AbapJobLog" + }, + { + "value": "AbapSpoolLog" + }, + { + "value": "AbapSpoolOutputLog" + }, + { + "value": "AbapChangeDocsLog" + }, + { + "value": "AbapAppLog" + }, + { + "value": "AbapWorkflowLog" + }, + { + "value": "AbapCrLog" + }, + { + "value": "AbapTableDataLog" + }, + { + "value": "AbapFilesLogs" + }, + { + "value": "JavaFilesLogs" + }, + { + "value": "AGRTCODES" + }, + { + "value": "USR01" + }, + { + "value": "USR02" + }, + { + "value": "AGR1251" + }, + { + "value": "AGRUSERS" + }, + { + "value": "AGRPROF" + }, + { + "value": "UST04" + }, + { + "value": "USR21" + }, + { + "value": "ADR6" + }, + { + "value": "ADCP" + }, + { + "value": "USR05" + }, + { + "value": "USGRPUSER" + }, + { + "value": "USERADDR" + }, + { + "value": "DEVACCESS" + }, + { + "value": "AGRDEFINE" + }, + { + "value": "PAHI" + }, + { + "value": "AGRAGRS" + }, + { + "value": "USRSTAMP" + }, + { + "value": "AGRFLAGS" + }, + { + "value": "SNCSYSACL" + }, + { + "value": "USRACL" + } + ] + } + }, + "RfcConnector": { + "description": "Describes the Rfc connector.", + "required": [ + "client", + "systemId", + "systemNumber", + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemsConfigurationConnector" + } + ], + "properties": { + "abapServerHost": { + "description": "FQDN, hostname, or IP address of the ABAP server.", + "type": "string" + }, + "messageServerHost": { + "description": "FQDN, hostname, or IP address of the Message server.", + "type": "string" + }, + "group": { + "description": "Logon group of the message server.", + "type": "string" + }, + "messageServerService": { + "description": "Port number, or service name (from /etc/services) of the message server.", + "type": "string" + }, + "sncQop": { + "description": "SNC QOP.\r\nOptions are 1, 2, 3, 8, 9.", + "pattern": "^[1,2,3,8,9]$", + "type": "string" + }, + "codePage": { + "description": "The SAP code page used for character encoding.\r\nExample - 1100", + "pattern": "^(?:[a-zA-Z0-9]{4}|UTF-8)$", + "type": "string" + }, + "systemNumber": { + "description": "System number of the ABAP server.", + "minLength": 1, + "pattern": "^\\d{1,3}$", + "type": "string" + }, + "systemId": { + "description": "System ID of the ABAP server.\r\nExample - A4H", + "minLength": 1, + "pattern": "^[a-zA-Z0-9]{3}$", + "type": "string" + }, + "client": { + "description": "Client number of the ABAP server.\r\nExample - 001", + "minLength": 1, + "pattern": "^[0-9]{3}$", + "type": "string" + }, + "authenticationType": { + "description": "The authentication type to SAP.", + "$ref": "#/definitions/SapAuthenticationType" + }, + "type": { + "$ref": "#/definitions/SystemConfigurationConnectorType" + } + }, + "x-ms-discriminator-value": "Rfc" + }, + "SapControlConnector": { + "description": "Describes the SapControl connector configuration.", + "required": [ + "instance", + "server", + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemsConfigurationConnector" + } + ], + "properties": { + "server": { + "description": "The server name.\r\nFQDN or IP address.", + "minLength": 1, + "pattern": "^([a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\\.)+[a-zA-Z]{2,}$|^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}$", + "type": "string" + }, + "instance": { + "description": "The instance number. Only 2 digits are allowed.", + "minLength": 1, + "pattern": "^\\d{2}$", + "type": "string" + }, + "timezone": { + "description": "The timezone.\r\nexample: \"GMT+0\" or \"GMT-8\"\r\ndefault: \"GMT+0\"", + "default": "GMT+0", + "pattern": "^GMT[+-]\\d+$", + "type": "string" + }, + "port": { + "description": "The port of the SOAP connection to SAP Control.", + "pattern": "^\\d{1,5}$", + "type": "string" + }, + "httpsConfiguration": { + "$ref": "#/definitions/HttpsConfigurationType" + }, + "type": { + "$ref": "#/definitions/SystemConfigurationConnectorType" + } + }, + "x-ms-discriminator-value": "SapControl" + }, + "SapSystemsConfiguration": { + "description": "Describes the SAP configuration.", + "required": [ + "connector", + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemsConfiguration" + } + ], + "properties": { + "azureResourceId": { + "description": "azure resource id\r\nexample: \"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM\"", + "pattern": "^\\/?subscriptions\\/([^\\/]+)\\/resourceGroups\\/([^\\/]+)\\/providers\\/([^\\/]+)\\/([^\\/]+)\\/([^\\/]+)$", + "type": "string" + }, + "connector": { + "$ref": "#/definitions/SystemsConfigurationConnector" + }, + "logs": { + "description": "The logs configuration.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/Log" + } + }, + "type": { + "$ref": "#/definitions/ConfigurationType" + } + }, + "x-ms-discriminator-value": "SAP" + }, + "SystemResource": { + "description": "Describes the system within the agent.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "properties": { + "properties": { + "type": "object", + "$ref": "#/definitions/SystemProperties", + "x-ms-client-flatten": true + } + } + }, + "SystemConfigurationConnectorType": { + "description": "Represents the types of SAP systems.", + "enum": [ + "Rfc", + "SapControl" + ], + "type": "string", + "example": "Rfc", + "x-ms-enum": { + "name": "SystemConfigurationConnectorType", + "modelAsString": true, + "values": [ + { + "value": "Rfc" + }, + { + "value": "SapControl" + } + ] + } + }, + "SystemProperties": { + "description": "The properties of the system.", + "required": [ + "configuration", + "displayName" + ], + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/SystemStatusType" + }, + "configuration": { + "$ref": "#/definitions/SystemsConfiguration" + }, + "displayName": { + "minLength": 1, + "type": "string" + }, + "lastModifiedTimeUtc": { + "format": "date-time", + "type": "string", + "readOnly": true + } + } + }, + "SystemStatusType": { + "description": "The status of the system.", + "enum": [ + "Running", + "Stopped" + ], + "type": "string", + "example": "Running", + "x-ms-enum": { + "name": "SystemStatusType", + "modelAsString": true, + "values": [ + { + "value": "Running" + }, + { + "value": "Stopped" + } + ] + } + }, + "SystemsConfiguration": { + "description": "The configuration of the system.", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/ConfigurationType" + } + }, + "discriminator": "type" + }, + "SystemsConfigurationConnector": { + "description": "Base Model for SAP System Connector.", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/SystemConfigurationConnectorType" + } + }, + "discriminator": "type" + }, + "SystemsList": { + "description": "List of Agent's Systems.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SystemResource" + } + }, + "nextLink": { + "type": "string" + } + } + } + }, + "parameters": { + "BusinessApplicationAgentResource": { + "name": "businessApplicationAgentResource", + "description": "The Business Application Agent Resource", + "required": true, + "in": "body", + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/BusinessApplicationAgentResource" + } + }, + "BusinessApplicationAgentId": { + "in": "path", + "name": "businessApplicationAgentId", + "description": "BusinessApplicationAgent ID", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "SystemResource": { + "name": "systemResource", + "description": "The system resource", + "required": true, + "in": "body", + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/SystemResource" + } + }, + "SystemId": { + "in": "path", + "name": "systemId", + "description": "System ID", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "tags": [ + { + "name": "BusinessApplicationAgents", + "description": "Controller that handles requests forwarded from ASI RP for agents resources CRUD ARM APIs." + }, + { + "name": "Systems", + "description": "Controller that handles requests forwarded from ASI RP for systems resources CRUD ARM APIs." + } + ], + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ContentPackages.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ContentPackages.json new file mode 100644 index 000000000000..a65d3d8a1718 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ContentPackages.json @@ -0,0 +1,319 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentPackages": { + "get": { + "x-ms-examples": { + "Get all available packages.": { + "$ref": "./examples/contentPackages/GetPackages.json" + } + }, + "tags": [ + "ContentPackages" + ], + "description": "Gets all installed packages.", + "operationId": "ContentPackages_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSearch" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataCount" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkip" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/packageList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentPackages/{packageId}": { + "get": { + "x-ms-examples": { + "Get installed packages by id.": { + "$ref": "./examples/contentPackages/GetPackageById.json" + } + }, + "tags": [ + "ContentPackages" + ], + "description": "Gets an installed packages by its id.", + "operationId": "ContentPackages_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/PackageIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/packageModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Install a package to the workspace.": { + "$ref": "./examples/contentPackages/InstallPackage.json" + } + }, + "tags": [ + "ContentPackages" + ], + "description": "Install a package to the workspace.", + "operationId": "ContentPackage_Install", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/PackageIdParameter" + }, + { + "$ref": "#/parameters/PackageInstallationProperties" + } + ], + "responses": { + "200": { + "description": "OK, a package is updated.", + "schema": { + "$ref": "#/definitions/packageModel" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/packageModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Uninstall a package from the workspace.": { + "$ref": "./examples/contentPackages/UninstallPackage.json" + } + }, + "tags": [ + "ContentPackages" + ], + "description": "Uninstall a package from the workspace.", + "operationId": "ContentPackage_Uninstall", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/PackageIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "packageList": { + "description": "List available packages.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of packages.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of packages.", + "items": { + "$ref": "#/definitions/packageModel" + }, + "type": "array" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "packageModel": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a Package in Azure Security Insights.", + "properties": { + "properties": { + "description": "package properties", + "$ref": "#/definitions/packageProperties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "packageProperties": { + "description": "Describes package properties", + "allOf": [ + { + "$ref": "./common/ContentCommonTypes.json#/definitions/packageBaseProperties" + } + ], + "required": [ + "contentId", + "contentProductId", + "contentKind", + "version", + "displayName" + ], + "type": "object" + } + }, + "parameters": { + "PackageIdParameter": { + "description": "package Id", + "in": "path", + "name": "packageId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "PackageInstallationProperties": { + "description": "Package installation properties", + "in": "body", + "name": "packageInstallationProperties", + "required": true, + "schema": { + "$ref": "#/definitions/packageModel" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ContentProductPackages.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ContentProductPackages.json new file mode 100644 index 000000000000..e4a55ed1b269 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ContentProductPackages.json @@ -0,0 +1,232 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentProductPackages": { + "get": { + "x-ms-examples": { + "Get all available packages.": { + "$ref": "./examples/contentPackages/GetProductPackages.json" + } + }, + "tags": [ + "ContentProductPackages" + ], + "description": "Gets all packages from the catalog.\nExpandable properties:\n- properties/installed\n- properties/packagedContent", + "operationId": "ProductPackages_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/productPackageList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentProductPackages/{packageId}": { + "get": { + "x-ms-examples": { + "Get a package.": { + "$ref": "./examples/contentPackages/GetProductPackageById.json" + } + }, + "tags": [ + "ContentProductPackages" + ], + "description": "Gets a package by its identifier from the catalog.", + "operationId": "ProductPackage_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/PackageIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/productPackageModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "productPackageList": { + "description": "List available packages.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of packages.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of packages.", + "items": { + "$ref": "#/definitions/productPackageModel" + }, + "type": "array" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "productPackageModel": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a Package in Azure Security Insights.", + "properties": { + "properties": { + "description": "package properties", + "$ref": "#/definitions/productPackageProperties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "productPackageProperties": { + "description": "Describes package properties", + "allOf": [ + { + "$ref": "./common/ContentCommonTypes.json#/definitions/packageBaseProperties", + "description": "The content id of the package" + }, + { + "$ref": "#/definitions/productPackageAdditionalProperties", + "description": "The package kind" + } + ], + "required": [ + "contentId", + "contentKind", + "version", + "displayName" + ], + "type": "object" + }, + "productPackageAdditionalProperties": { + "description": "product package additional properties", + "properties": { + "installedVersion": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataVersion", + "description": "The version of the installed package, null or absent means not installed." + }, + "metadataResourceId": { + "description": "The metadata resource id.", + "type": "string", + "format": "arm-id" + }, + "packagedContent": { + "$ref": "#/definitions/packagedContent", + "description": "The json of the ARM template to deploy. Expandable." + } + }, + "type": "object" + }, + "packagedContent": { + "type": "object", + "description": "The json of the ARM template to deploy" + } + }, + "parameters": { + "PackageIdParameter": { + "description": "package Id", + "in": "path", + "name": "packageId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ContentProductTemplates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ContentProductTemplates.json new file mode 100644 index 000000000000..0d9ff1412b39 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ContentProductTemplates.json @@ -0,0 +1,226 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentProductTemplates": { + "get": { + "x-ms-examples": { + "Get all installed templates.": { + "$ref": "./examples/contentTemplates/GetProductTemplates.json" + } + }, + "tags": [ + "ContentProductTemplates" + ], + "description": "Gets all templates in the catalog.", + "operationId": "ProductTemplates_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSearch" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataCount" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkip" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/productTemplateList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentproducttemplates/{templateId}": { + "get": { + "x-ms-examples": { + "Get a template.": { + "$ref": "./examples/contentTemplates/GetProductTemplateById.json" + } + }, + "tags": [ + "ContentProductTemplates" + ], + "description": "Gets a template by its identifier.", + "operationId": "ProductTemplate_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/templateIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/productTemplateModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "productTemplateList": { + "description": "List of all the template.", + "type": "object", + "properties": { + "value": { + "description": "Array of templates.", + "items": { + "$ref": "#/definitions/productTemplateModel" + }, + "type": "array" + }, + "nextLink": { + "description": "URL to fetch the next page of template.", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "productTemplateModel": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Template resource definition.", + "properties": { + "properties": { + "description": "template properties", + "$ref": "#/definitions/productTemplateProperties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "productTemplateProperties": { + "allOf": [ + { + "$ref": "./common/ContentCommonTypes.json#/definitions/templateBaseProperties" + }, + { + "$ref": "#/definitions/productTemplateAdditionalProperties" + } + ], + "description": "Template property bag.", + "required": [ + "contentId", + "version", + "displayName", + "contentKind", + "source" + ] + }, + "productTemplateAdditionalProperties": { + "description": "additional properties of product template.", + "type": "object", + "properties": { + "packagedContent": { + "type": "object", + "description": "The json of the ARM template to deploy" + } + } + } + }, + "parameters": { + "templateIdParameter": { + "description": "template Id", + "in": "path", + "name": "templateId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ContentTemplates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ContentTemplates.json new file mode 100644 index 000000000000..44289e11e310 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ContentTemplates.json @@ -0,0 +1,353 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentTemplates": { + "get": { + "x-ms-examples": { + "Get all installed templates.": { + "$ref": "./examples/contentTemplates/GetTemplates.json" + } + }, + "tags": [ + "ContentTemplates" + ], + "description": "Gets all installed templates.\nExpandable properties:\n- properties/mainTemplate\n- properties/dependantTemplates", + "operationId": "ContentTemplates_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataExpand" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSearch" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataCount" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkip" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/templateList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentTemplates/{templateId}": { + "put": { + "x-ms-examples": { + "Get a template.": { + "$ref": "./examples/contentTemplates/InstallTemplate.json" + } + }, + "tags": [ + "ContentTemplates" + ], + "description": "Install a template.", + "operationId": "ContentTemplate_Install", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/templateIdParameter" + }, + { + "$ref": "#/parameters/templateInstallationProperties" + } + ], + "responses": { + "200": { + "description": "OK, a template is updated.", + "schema": { + "$ref": "#/definitions/templateModel" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/templateModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "get": { + "x-ms-examples": { + "Get a template.": { + "$ref": "./examples/contentTemplates/GetTemplateById.json" + } + }, + "tags": [ + "ContentTemplates" + ], + "description": "Gets a template byt its identifier.\nExpandable properties:\n- properties/mainTemplate\n- properties/dependantTemplates", + "operationId": "ContentTemplate_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/templateIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/templateModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete metadata.": { + "$ref": "./examples/contentTemplates/DeleteTemplate.json" + } + }, + "tags": [ + "ContentTemplates" + ], + "description": "Delete an installed template.", + "operationId": "ContentTemplate_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/templateIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "templateList": { + "description": "List of all the template.", + "type": "object", + "properties": { + "value": { + "description": "Array of templates.", + "items": { + "$ref": "#/definitions/templateModel" + }, + "type": "array" + }, + "nextLink": { + "description": "URL to fetch the next page of template.", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "templateModel": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Template resource definition.", + "properties": { + "properties": { + "description": "template properties", + "$ref": "#/definitions/templateProperties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "templateProperties": { + "allOf": [ + { + "$ref": "./common/ContentCommonTypes.json#/definitions/templateBaseProperties" + }, + { + "$ref": "#/definitions/templateAdditionalProperties" + } + ], + "description": "Template property bag.", + "required": [ + "contentId", + "version", + "displayName", + "contentKind", + "source", + "packageId", + "packageVersion", + "contentProductId" + ], + "type": "object" + }, + "templateAdditionalProperties": { + "description": "additional properties of product template.", + "type": "object", + "properties": { + "mainTemplate": { + "$ref": "#/definitions/mainTemplate", + "description": "The JSON of the ARM template to deploy active content. Expandable." + }, + "dependantTemplates": { + "type": "array", + "items": { + "$ref": "#/definitions/templateProperties" + }, + "description": "Dependant templates. Expandable.", + "readOnly": true, + "x-ms-identifiers": [ + "contentId" + ] + } + } + }, + "mainTemplate": { + "description": "The JSON of the ARM template to deploy active content", + "type": "object" + } + }, + "parameters": { + "templateIdParameter": { + "description": "template Id", + "in": "path", + "name": "templateId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "templateInstallationProperties": { + "description": "Template installation properties", + "in": "body", + "name": "templateInstallationProperties", + "required": true, + "schema": { + "$ref": "#/definitions/templateModel" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/EnrichmentWithWorkspace.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/EnrichmentWithWorkspace.json new file mode 100644 index 000000000000..ee1f53e794d0 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/EnrichmentWithWorkspace.json @@ -0,0 +1,443 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/enrichment/{enrichmentType}/listGeodataByIp": { + "post": { + "x-ms-examples": { + "Get geodata for a single IP address": { + "$ref": "./examples/enrichment/GetGeodataWithWorkspaceByIp.json" + } + }, + "tags": [ + "Enrichment" + ], + "description": "Get geodata for a single IP address", + "operationId": "ListGeodataByIp", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EnrichmentType" + }, + { + "$ref": "#/parameters/EnrichmentIpAddressBody" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EnrichmentIpGeodata" + } + }, + "default": { + "description": "Error response describing why the operation failed to enrich this ip.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/enrichment/{enrichmentType}/listWhoisByDomain": { + "post": { + "x-ms-examples": { + "Get whois information for a single domain name": { + "$ref": "./examples/enrichment/GetWhoisWithWorkspaceByDomainName.json" + } + }, + "tags": [ + "Enrichment" + ], + "description": "Get whois information for a single domain name", + "operationId": "ListWhoisByDomain", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EnrichmentType" + }, + { + "$ref": "#/parameters/EnrichmentDomainBody" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EnrichmentDomainWhois" + } + }, + "default": { + "description": "Error response describing why the operation failed to enrich this domain.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "EnrichmentIpAddressBody": { + "description": "IP address (v4 or v6) to be enriched", + "in": "body", + "name": "ipAddressBody", + "required": true, + "schema": { + "$ref": "#/definitions/EnrichmentIpAddressBody" + }, + "x-ms-parameter-location": "method" + }, + "EnrichmentDomainBody": { + "description": "Domain name to be enriched. Only domain name is accepted", + "in": "body", + "name": "domainBody", + "required": true, + "schema": { + "$ref": "#/definitions/EnrichmentDomainBody" + }, + "x-ms-parameter-location": "method" + }, + "EnrichmentType": { + "description": "Enrichment type", + "in": "path", + "name": "enrichmentType", + "required": true, + "enum": [ + "main" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EnrichmentType", + "values": [ + { + "value": "main" + } + ] + }, + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "EnrichmentIpAddressBody": { + "description": "IP address (v4 or v6) to be enriched", + "properties": { + "ipAddress": { + "description": "The dotted-decimal or colon-separated string representation of the IP address", + "type": "string" + } + }, + "type": "object" + }, + "EnrichmentDomainBody": { + "description": "Domain name to be enriched", + "properties": { + "domain": { + "description": "The domain name", + "type": "string" + } + }, + "type": "object" + }, + "EnrichmentDomainWhois": { + "description": "Whois information for a given domain and associated metadata", + "properties": { + "domain": { + "description": "The domain for this whois record", + "type": "string" + }, + "server": { + "description": "The hostname of this registrar's whois server", + "type": "string" + }, + "created": { + "description": "The timestamp at which this record was created", + "format": "date-time", + "type": "string" + }, + "updated": { + "description": "The timestamp at which this record was last updated", + "format": "date-time", + "type": "string" + }, + "expires": { + "description": "The timestamp at which this record will expire", + "format": "date-time", + "type": "string" + }, + "parsedWhois": { + "description": "The whois record for a given domain", + "$ref": "#/definitions/EnrichmentDomainWhoisDetails" + } + }, + "type": "object" + }, + "EnrichmentDomainWhoisDetails": { + "description": "The whois record for a given domain", + "properties": { + "registrar": { + "description": "The registrar associated with this domain", + "$ref": "#/definitions/EnrichmentDomainWhoisRegistrarDetails" + }, + "contacts": { + "description": "The set of contacts associated with this domain", + "$ref": "#/definitions/EnrichmentDomainWhoisContacts" + }, + "nameServers": { + "description": "A list of name servers associated with this domain", + "type": "array", + "items": { + "type": "string" + } + }, + "statuses": { + "description": "The set of status flags for this whois record", + "type": "array", + "items": { + "type": "string" + } + } + }, + "type": "object" + }, + "EnrichmentDomainWhoisRegistrarDetails": { + "description": "The registrar associated with this domain", + "properties": { + "name": { + "description": "The name of this registrar", + "type": "string" + }, + "abuseContactEmail": { + "description": "This registrar's abuse contact email", + "type": "string" + }, + "abuseContactPhone": { + "description": "This registrar's abuse contact phone number", + "type": "string" + }, + "ianaId": { + "description": "This registrar's Internet Assigned Numbers Authority id", + "type": "string" + }, + "url": { + "description": "This registrar's URL", + "type": "string" + }, + "whoisServer": { + "description": "The hostname of this registrar's whois server", + "type": "string" + } + }, + "type": "object" + }, + "EnrichmentDomainWhoisContacts": { + "description": "The set of contacts associated with this domain", + "properties": { + "admin": { + "description": "The admin contact for this whois record", + "$ref": "#/definitions/EnrichmentDomainWhoisContact" + }, + "billing": { + "description": "The billing contact for this whois record", + "$ref": "#/definitions/EnrichmentDomainWhoisContact" + }, + "registrant": { + "description": "The registrant contact for this whois record", + "$ref": "#/definitions/EnrichmentDomainWhoisContact" + }, + "tech": { + "description": "The technical contact for this whois record", + "$ref": "#/definitions/EnrichmentDomainWhoisContact" + } + }, + "type": "object" + }, + "EnrichmentDomainWhoisContact": { + "description": "An individual contact associated with this domain", + "properties": { + "name": { + "description": "The name of this contact", + "type": "string" + }, + "org": { + "description": "The organization for this contact", + "type": "string" + }, + "street": { + "description": "A list describing the street address for this contact", + "type": "array", + "items": { + "type": "string" + } + }, + "city": { + "description": "The city for this contact", + "type": "string" + }, + "state": { + "description": "The state for this contact", + "type": "string" + }, + "postal": { + "description": "The postal code for this contact", + "type": "string" + }, + "country": { + "description": "The country for this contact", + "type": "string" + }, + "phone": { + "description": "The phone number for this contact", + "type": "string" + }, + "fax": { + "description": "The fax number for this contact", + "type": "string" + }, + "email": { + "description": "The email address for this contact", + "type": "string" + } + }, + "type": "object" + }, + "EnrichmentIpGeodata": { + "description": "Geodata information for a given IP address", + "properties": { + "asn": { + "description": "The autonomous system number associated with this IP address", + "type": "string" + }, + "carrier": { + "description": "The name of the carrier for this IP address", + "type": "string" + }, + "city": { + "description": "The city this IP address is located in", + "type": "string" + }, + "cityConfidenceFactor": { + "description": "A numeric rating of confidence that the value in the 'city' field is correct, on a scale of 0-100", + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100 + }, + "continent": { + "description": "The continent this IP address is located on", + "type": "string" + }, + "country": { + "description": "The county this IP address is located in", + "type": "string" + }, + "countryConfidenceFactor": { + "description": "A numeric rating of confidence that the value in the 'country' field is correct on a scale of 0-100", + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100 + }, + "ipAddr": { + "description": "The dotted-decimal or colon-separated string representation of the IP address", + "type": "string" + }, + "ipRoutingType": { + "description": "A description of the connection type of this IP address", + "type": "string" + }, + "latitude": { + "description": "The latitude of this IP address", + "type": "string" + }, + "longitude": { + "description": "The longitude of this IP address", + "type": "string" + }, + "organization": { + "description": "The name of the organization for this IP address", + "type": "string" + }, + "organizationType": { + "description": "The type of the organization for this IP address", + "type": "string" + }, + "region": { + "description": "The geographic region this IP address is located in", + "type": "string" + }, + "state": { + "description": "The state this IP address is located in", + "type": "string" + }, + "stateConfidenceFactor": { + "description": "A numeric rating of confidence that the value in the 'state' field is correct on a scale of 0-100", + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100 + }, + "stateCode": { + "description": "The abbreviated name for the state this IP address is located in", + "type": "string" + } + }, + "type": "object" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Entities.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Entities.json new file mode 100644 index 000000000000..8d0362c41c82 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Entities.json @@ -0,0 +1,1559 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities": { + "get": { + "x-ms-examples": { + "Get all entities.": { + "$ref": "./examples/entities/GetEntities.json" + } + }, + "tags": [ + "Entities" + ], + "description": "Gets all entities.", + "operationId": "Entities_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}": { + "get": { + "x-ms-examples": { + "Get an account entity.": { + "$ref": "./examples/entities/GetAccountEntityById.json" + }, + "Get a host entity.": { + "$ref": "./examples/entities/GetHostEntityById.json" + }, + "Get a file entity.": { + "$ref": "./examples/entities/GetFileEntityById.json" + }, + "Get a security alert entity.": { + "$ref": "./examples/entities/GetSecurityAlertEntityById.json" + }, + "Get a file hash entity.": { + "$ref": "./examples/entities/GetFileHashEntityById.json" + }, + "Get a malware entity.": { + "$ref": "./examples/entities/GetMalwareEntityById.json" + }, + "Get a security group entity.": { + "$ref": "./examples/entities/GetSecurityGroupEntityById.json" + }, + "Get an azure resource entity.": { + "$ref": "./examples/entities/GetAzureResourceEntityById.json" + }, + "Get a cloud application entity.": { + "$ref": "./examples/entities/GetCloudApplicationEntityById.json" + }, + "Get a process entity.": { + "$ref": "./examples/entities/GetProcessEntityById.json" + }, + "Get a dns entity.": { + "$ref": "./examples/entities/GetDnsEntityById.json" + }, + "Get an ip entity.": { + "$ref": "./examples/entities/GetIpEntityById.json" + }, + "Get a registry key entity.": { + "$ref": "./examples/entities/GetRegistryKeyEntityById.json" + }, + "Get a registry value entity.": { + "$ref": "./examples/entities/GetRegistryValueEntityById.json" + }, + "Get a url entity.": { + "$ref": "./examples/entities/GetUrlEntityById.json" + }, + "Get an IoT device entity.": { + "$ref": "./examples/entities/GetIoTDeviceEntityById.json" + }, + "Get a mailCluster entity.": { + "$ref": "./examples/entities/GetMailClusterEntityById.json" + }, + "Get a mailbox entity.": { + "$ref": "./examples/entities/GetMailboxEntityById.json" + }, + "Get a mailMessage entity.": { + "$ref": "./examples/entities/GetMailMessageEntityById.json" + }, + "Get a submissionMail entity.": { + "$ref": "./examples/entities/GetSubmissionMailEntityById.json" + } + }, + "tags": [ + "Entities" + ], + "description": "Gets an entity.", + "operationId": "Entities_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./common/EntityTypes.json#/definitions/Entity" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/expand": { + "post": { + "x-ms-examples": { + "Expand an entity": { + "$ref": "./examples/entities/expand/PostExpandEntity.json" + } + }, + "tags": [ + "Entities" + ], + "description": "Expands an entity.", + "operationId": "Entities_Expand", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityId" + }, + { + "$ref": "#/parameters/EntityExpandRequestBody" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityExpandResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/getTimeline": { + "post": { + "x-ms-examples": { + "Entity timeline": { + "$ref": "./examples/entities/timeline/PostTimelineEntity.json" + } + }, + "tags": [ + "Entities" + ], + "description": "Timeline for an entity.", + "operationId": "EntitiesGetTimeline_list", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityId" + }, + { + "$ref": "#/parameters/EntityTimelineRequestBody" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityTimelineResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/queries": { + "get": { + "x-ms-examples": { + "Get Entity Query": { + "$ref": "./examples/entities/GetQueries.json" + } + }, + "tags": [ + "Entities" + ], + "description": "Get Insights and Activities for an entity.", + "operationId": "Entities_Queries", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityId" + }, + { + "$ref": "#/parameters/EntityQueryKindParam" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GetQueriesResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/getInsights": { + "post": { + "x-ms-examples": { + "Entity Insight": { + "$ref": "./examples/entities/insights/PostGetInsights.json" + } + }, + "tags": [ + "Entities" + ], + "description": "Execute Insights for an entity.", + "operationId": "Entities_GetInsights", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityId" + }, + { + "$ref": "#/parameters/GetInsightsEntityQueriesRequestBody" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityGetInsightsResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/relations": { + "get": { + "x-ms-examples": { + "Get all relations of an entity.": { + "$ref": "./examples/entities/relations/GetAllEntityRelations.json" + } + }, + "tags": [ + "EntityRelations" + ], + "description": "Gets all relations of an entity.", + "operationId": "EntitiesRelations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityId" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./common/RelationTypes.json#/definitions/RelationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-odata": "./common/RelationTypes.json#/definitions/Relation", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/relations/{relationName}": { + "get": { + "x-ms-examples": { + "Get an entity relation.": { + "$ref": "./examples/entities/relations/GetEntityRelationByName.json" + } + }, + "tags": [ + "EntityRelations" + ], + "description": "Gets an entity relation.", + "operationId": "EntityRelations_GetRelation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityId" + }, + { + "$ref": "./common/RelationTypes.json#/parameters/RelationName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./common/RelationTypes.json#/definitions/Relation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "EntityExpandRequestBody": { + "description": "The parameters required to execute an expand operation on the given entity.", + "in": "body", + "name": "parameters", + "required": true, + "schema": { + "$ref": "#/definitions/EntityExpandParameters" + }, + "x-ms-parameter-location": "method" + }, + "EntityId": { + "description": "entity ID", + "in": "path", + "name": "entityId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "EntityTimelineRequestBody": { + "description": "The parameters required to execute an timeline operation on the given entity.", + "in": "body", + "name": "parameters", + "required": true, + "schema": { + "$ref": "#/definitions/EntityTimelineParameters" + }, + "x-ms-parameter-location": "method" + }, + "EntityQueryKindParam": { + "description": "The Kind parameter for queries", + "in": "query", + "name": "kind", + "required": true, + "type": "string", + "enum": [ + "Insight" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "EntityItemQueryKind", + "values": [ + { + "description": "insight", + "value": "Insight" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "GetInsightsEntityQueriesRequestBody": { + "description": "The parameters required to execute insights on the given entity.", + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EntityGetInsightsParameters" + }, + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "ActivityTimelineItem": { + "allOf": [ + { + "$ref": "#/definitions/EntityTimelineItem" + } + ], + "description": "Represents Activity timeline item.", + "properties": { + "queryId": { + "type": "string", + "description": "The activity query id." + }, + "bucketStartTimeUTC": { + "format": "date-time", + "type": "string", + "description": "The grouping bucket start time." + }, + "bucketEndTimeUTC": { + "format": "date-time", + "type": "string", + "description": "The grouping bucket end time." + }, + "firstActivityTimeUTC": { + "format": "date-time", + "type": "string", + "description": "The time of the first activity in the grouping bucket." + }, + "lastActivityTimeUTC": { + "format": "date-time", + "type": "string", + "description": "The time of the last activity in the grouping bucket." + }, + "content": { + "type": "string", + "description": "The activity timeline content." + }, + "title": { + "type": "string", + "description": "The activity timeline title." + } + }, + "required": [ + "queryId", + "bucketStartTimeUTC", + "bucketEndTimeUTC", + "firstActivityTimeUTC", + "lastActivityTimeUTC", + "content", + "title" + ], + "type": "object", + "x-ms-discriminator-value": "Activity" + }, + "BookmarkTimelineItem": { + "allOf": [ + { + "$ref": "#/definitions/EntityTimelineItem" + } + ], + "description": "Represents bookmark timeline item.", + "properties": { + "azureResourceId": { + "type": "string", + "description": "The bookmark azure resource id." + }, + "displayName": { + "type": "string", + "description": "The bookmark display name." + }, + "notes": { + "type": "string", + "description": "The notes of the bookmark" + }, + "endTimeUtc": { + "format": "date-time", + "type": "string", + "description": "The bookmark end time." + }, + "startTimeUtc": { + "format": "date-time", + "type": "string", + "description": "The bookmark start time." + }, + "eventTime": { + "format": "date-time", + "type": "string", + "description": "The bookmark event time." + }, + "createdBy": { + "$ref": "../../../common/2.0/types.json#/definitions/UserInfo", + "description": "Describes a user that created the bookmark" + }, + "labels": { + "description": "List of labels relevant to this bookmark", + "items": { + "$ref": "../../../common/2.0/types.json#/definitions/Label" + }, + "type": "array" + } + }, + "required": [ + "azureResourceId" + ], + "type": "object", + "x-ms-discriminator-value": "Bookmark" + }, + "AnomalyTimelineItem": { + "allOf": [ + { + "$ref": "#/definitions/EntityTimelineItem" + } + ], + "description": "Represents anomaly timeline item.", + "properties": { + "azureResourceId": { + "type": "string", + "description": "The anomaly azure resource id." + }, + "productName": { + "type": "string", + "description": "The anomaly product name." + }, + "description": { + "type": "string", + "description": "The anomaly description." + }, + "displayName": { + "type": "string", + "description": "The anomaly name." + }, + "endTimeUtc": { + "format": "date-time", + "type": "string", + "description": "The anomaly end time." + }, + "startTimeUtc": { + "format": "date-time", + "type": "string", + "description": "The anomaly start time." + }, + "timeGenerated": { + "format": "date-time", + "type": "string", + "description": "The anomaly generated time." + }, + "vendor": { + "type": "string", + "description": "The name of the anomaly vendor." + }, + "intent": { + "type": "string", + "description": "The intent of the anomaly." + }, + "techniques": { + "type": "array", + "items": { + "type": "string", + "description": "technique of the anomaly" + }, + "description": "The techniques of the anomaly." + }, + "reasons": { + "type": "array", + "items": { + "type": "string", + "description": "Reason of the anomaly" + }, + "description": "The reasons that cause the anomaly." + } + }, + "required": [ + "azureResourceId", + "displayName", + "endTimeUtc", + "startTimeUtc", + "timeGenerated" + ], + "type": "object", + "x-ms-discriminator-value": "Anomaly" + }, + "EntityGetInsightsParameters": { + "description": "The parameters required to execute insights operation on the given entity.", + "type": "object", + "properties": { + "startTime": { + "description": "The start timeline date, so the results returned are after this date.", + "format": "date-time", + "type": "string" + }, + "endTime": { + "description": "The end timeline date, so the results returned are before this date.", + "format": "date-time", + "type": "string" + }, + "addDefaultExtendedTimeRange": { + "description": "Indicates if query time range should be extended with default time range of the query. Default value is false", + "type": "boolean" + }, + "insightQueryIds": { + "description": "List of Insights Query Id. If empty, default value is all insights of this entity", + "type": "array", + "items": { + "description": "Insight Query Id (GUID)", + "format": "uuid", + "type": "string" + } + } + }, + "required": [ + "startTime", + "endTime" + ] + }, + "EntityGetInsightsResponse": { + "description": "The Get Insights result operation response.", + "properties": { + "metaData": { + "$ref": "#/definitions/GetInsightsResultsMetadata", + "description": "The metadata from the get insights operation results." + }, + "value": { + "description": "The insights result values.", + "items": { + "$ref": "#/definitions/EntityInsightItem" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "EntityEdges": { + "description": "The edge that connects the entity to the other entity.", + "properties": { + "targetEntityId": { + "description": "The target entity Id.", + "type": "string" + }, + "additionalData": { + "additionalProperties": true, + "description": "A bag of custom fields that should be part of the entity and will be presented to the user.", + "type": "object" + } + }, + "type": "object" + }, + "EntityExpandParameters": { + "description": "The parameters required to execute an expand operation on the given entity.", + "properties": { + "endTime": { + "description": "The end date filter, so the only expansion results returned are before this date.", + "format": "date-time", + "type": "string" + }, + "expansionId": { + "description": "The Id of the expansion to perform.", + "format": "uuid", + "type": "string" + }, + "startTime": { + "description": "The start date filter, so the only expansion results returned are after this date.", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "EntityExpandResponse": { + "description": "The entity expansion result operation response.", + "properties": { + "metaData": { + "$ref": "./common/EntityTypes.json#/definitions/ExpansionResultsMetadata", + "description": "The metadata from the expansion operation results." + }, + "value": { + "description": "The expansion result values.", + "properties": { + "entities": { + "description": "Array of the expansion result entities.", + "items": { + "$ref": "./common/EntityTypes.json#/definitions/Entity" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "edges": { + "description": "Array of edges that connects the entity to the list of entities.", + "items": { + "$ref": "#/definitions/EntityEdges" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + } + }, + "type": "object" + }, + "EntityInsightItem": { + "description": "Entity insight Item.", + "type": "object", + "properties": { + "queryId": { + "type": "string", + "description": "The query id of the insight" + }, + "queryTimeInterval": { + "type": "object", + "description": "The Time interval that the query actually executed on.", + "properties": { + "startTime": { + "format": "date-time", + "type": "string", + "description": "Insight query start time" + }, + "endTime": { + "format": "date-time", + "type": "string", + "description": "Insight query end time" + } + } + }, + "tableQueryResults": { + "$ref": "#/definitions/InsightsTableResult", + "description": "Query results for table insights query." + }, + "chartQueryResults": { + "type": "array", + "description": "Query results for table insights query.", + "items": { + "$ref": "#/definitions/InsightsTableResult", + "description": "Query results for table insights query." + }, + "x-ms-identifiers": [] + } + } + }, + "EntityList": { + "description": "List of all the entities.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of entities.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of entities.", + "items": { + "$ref": "./common/EntityTypes.json#/definitions/Entity" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "EntityTimelineItem": { + "description": "Entity timeline Item.", + "discriminator": "kind", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/EntityTimelineKind", + "description": "The entity query kind type." + } + }, + "required": [ + "kind" + ] + }, + "EntityTimelineResponse": { + "description": "The entity timeline result operation response.", + "properties": { + "metaData": { + "$ref": "#/definitions/TimelineResultsMetadata", + "description": "The metadata from the timeline operation results." + }, + "value": { + "description": "The timeline result values.", + "items": { + "$ref": "#/definitions/EntityTimelineItem" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "EntityTimelineKind": { + "description": "The entity query kind", + "enum": [ + "Activity", + "Bookmark", + "SecurityAlert", + "Anomaly" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EntityTimelineKind", + "values": [ + { + "description": "activity", + "value": "Activity" + }, + { + "description": "bookmarks", + "value": "Bookmark" + }, + { + "description": "security alerts", + "value": "SecurityAlert" + }, + { + "description": "anomaly", + "value": "Anomaly" + } + ] + } + }, + "EntityTimelineParameters": { + "description": "The parameters required to execute s timeline operation on the given entity.", + "properties": { + "kinds": { + "description": "Array of timeline Item kinds.", + "items": { + "$ref": "#/definitions/EntityTimelineKind" + }, + "type": "array" + }, + "startTime": { + "description": "The start timeline date, so the results returned are after this date.", + "format": "date-time", + "type": "string" + }, + "endTime": { + "description": "The end timeline date, so the results returned are before this date.", + "format": "date-time", + "type": "string" + }, + "numberOfBucket": { + "description": "The number of bucket for timeline queries aggregation.", + "type": "integer", + "format": "int32" + } + }, + "type": "object", + "required": [ + "startTime", + "endTime" + ] + }, + "EntityQueryItem": { + "description": "An abstract Query item for entity", + "type": "object", + "discriminator": "kind", + "properties": { + "id": { + "description": "Query Template ARM ID", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Query Template ARM Name", + "type": "string" + }, + "type": { + "description": "ARM Type", + "type": "string" + }, + "kind": { + "$ref": "./common/EntityTypes.json#/definitions/EntityQueryKind", + "description": "The kind of the entity query" + } + }, + "required": [ + "kind" + ] + }, + "EntityQueryItemProperties": { + "description": "An properties abstract Query item for entity", + "type": "object", + "properties": { + "dataTypes": { + "description": "Data types for template", + "type": "array", + "items": { + "properties": { + "dataType": { + "description": "Data type name", + "type": "string" + } + }, + "type": "object" + }, + "x-ms-identifiers": [] + }, + "inputEntityType": { + "description": "The type of the entity", + "$ref": "./common/EntityTypes.json#/definitions/EntityInnerType" + }, + "requiredInputFieldsSets": { + "description": "Data types for template", + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "entitiesFilter": { + "description": "The query applied only to entities matching to all filters", + "type": "object" + } + } + }, + "InsightsTableResult": { + "type": "object", + "description": "Query results for table insights query.", + "properties": { + "columns": { + "type": "array", + "description": "Columns Metadata of the table", + "items": { + "properties": { + "type": { + "type": "string", + "description": "the type of the colum" + }, + "name": { + "type": "string", + "description": "the name of the colum" + } + }, + "type": "object" + }, + "x-ms-identifiers": [] + }, + "rows": { + "type": "array", + "description": "Rows data of the table", + "items": { + "type": "array", + "description": "Single row of data", + "items": { + "type": "string", + "description": "Cell in the table" + } + } + } + } + }, + "InsightQueryItem": { + "allOf": [ + { + "$ref": "#/definitions/EntityQueryItem" + } + ], + "description": "Represents Insight Query.", + "properties": { + "properties": { + "description": "Properties bag for InsightQueryItem", + "$ref": "#/definitions/InsightQueryItemProperties" + } + }, + "type": "object", + "x-ms-discriminator-value": "Insight" + }, + "InsightQueryItemProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityQueryItemProperties" + } + ], + "description": "Represents Insight Query.", + "properties": { + "displayName": { + "type": "string", + "description": "The insight display name." + }, + "description": { + "type": "string", + "description": "The insight description." + }, + "baseQuery": { + "type": "string", + "description": "The base query of the insight." + }, + "tableQuery": { + "type": "object", + "description": "The insight table query.", + "properties": { + "columnsDefinitions": { + "type": "array", + "description": "List of insight column definitions.", + "items": { + "properties": { + "header": { + "type": "string", + "description": "Insight column header." + }, + "outputType": { + "type": "string", + "description": "Insights Column type.", + "enum": [ + "Number", + "String", + "Date", + "Entity" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "outputType" + } + }, + "supportDeepLink": { + "type": "boolean", + "description": "Is query supports deep-link." + } + }, + "type": "object" + }, + "x-ms-identifiers": [] + }, + "queriesDefinitions": { + "type": "array", + "description": "List of insight queries definitions.", + "x-ms-identifiers": [], + "items": { + "properties": { + "filter": { + "type": "string", + "description": "Insight column header." + }, + "summarize": { + "type": "string", + "description": "Insight column header." + }, + "project": { + "type": "string", + "description": "Insight column header." + }, + "linkColumnsDefinitions": { + "type": "array", + "description": "Insight column header.", + "x-ms-identifiers": [], + "items": { + "properties": { + "projectedName": { + "type": "string", + "description": "Insight Link Definition Projected Name." + }, + "Query": { + "type": "string", + "description": "Insight Link Definition Query." + } + }, + "type": "object" + } + } + }, + "type": "object" + } + } + } + }, + "chartQuery": { + "type": "object", + "description": "The insight chart query." + }, + "additionalQuery": { + "type": "object", + "description": "The activity query definitions.", + "properties": { + "query": { + "type": "string", + "description": "The insight query." + }, + "text": { + "type": "string", + "description": "The insight text." + } + } + }, + "defaultTimeRange": { + "type": "object", + "description": "The insight chart query.", + "properties": { + "beforeRange": { + "type": "string", + "description": "The padding for the start time of the query." + }, + "afterRange": { + "type": "string", + "description": "The padding for the end time of the query." + } + } + }, + "referenceTimeRange": { + "type": "object", + "description": "The insight chart query.", + "properties": { + "beforeRange": { + "type": "string", + "description": "Additional query time for looking back." + } + } + } + }, + "type": "object" + }, + "GetInsightsResultsMetadata": { + "description": "Get Insights result metadata.", + "properties": { + "totalCount": { + "description": "the total items found for the insights request", + "type": "integer", + "format": "int32" + }, + "errors": { + "description": "information about the failed queries", + "items": { + "$ref": "#/definitions/GetInsightsErrorKind" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "required": [ + "totalCount" + ], + "type": "object" + }, + "GetInsightsErrorKind": { + "description": "GetInsights Query Errors.", + "properties": { + "kind": { + "description": "the query kind", + "type": "string", + "enum": [ + "Insight" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "GetInsightsError", + "values": [ + { + "value": "Insight" + } + ] + } + }, + "queryId": { + "description": "the query id", + "type": "string" + }, + "errorMessage": { + "description": "the error message", + "type": "string" + } + }, + "required": [ + "kind", + "errorMessage" + ], + "type": "object" + }, + "GetQueriesResponse": { + "description": "Retrieve queries for entity result operation response.", + "properties": { + "value": { + "description": "The query result values.", + "items": { + "$ref": "#/definitions/EntityQueryItem" + }, + "type": "array" + } + }, + "type": "object" + }, + "SecurityAlertTimelineItem": { + "allOf": [ + { + "$ref": "#/definitions/EntityTimelineItem" + } + ], + "description": "Represents security alert timeline item.", + "properties": { + "azureResourceId": { + "type": "string", + "description": "The alert azure resource id." + }, + "productName": { + "type": "string", + "description": "The alert product name." + }, + "description": { + "type": "string", + "description": "The alert description." + }, + "displayName": { + "type": "string", + "description": "The alert name." + }, + "severity": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The alert severity." + }, + "endTimeUtc": { + "format": "date-time", + "type": "string", + "description": "The alert end time." + }, + "startTimeUtc": { + "format": "date-time", + "type": "string", + "description": "The alert start time." + }, + "timeGenerated": { + "format": "date-time", + "type": "string", + "description": "The alert generated time." + }, + "alertType": { + "type": "string", + "description": "The name of the alert type." + }, + "intent": { + "type": "string", + "description": "The intent of the alert.", + "enum": [ + "Unknown", + "Probing", + "Exploitation", + "Persistence", + "PrivilegeEscalation", + "DefenseEvasion", + "CredentialAccess", + "Discovery", + "LateralMovement", + "Execution", + "Collection", + "Exfiltration", + "CommandAndControl", + "Impact" + ], + "readOnly": true, + "x-ms-enum": { + "modelAsString": true, + "name": "KillChainIntent", + "values": [ + { + "description": "The default value.", + "value": "Unknown" + }, + { + "description": "Probing could be an attempt to access a certain resource regardless of a malicious intent or a failed attempt to gain access to a target system to gather information prior to exploitation. This step is usually detected as an attempt originating from outside the network in attempt to scan the target system and find a way in.", + "value": "Probing" + }, + { + "description": "Exploitation is the stage where an attacker manage to get foothold on the attacked resource. This stage is applicable not only for compute hosts, but also for resources such as user accounts, certificates etc. Adversaries will often be able to control the resource after this stage.", + "value": "Exploitation" + }, + { + "description": "Persistence is any access, action, or configuration change to a system that gives an adversary a persistent presence on that system. Adversaries will often need to maintain access to systems through interruptions such as system restarts, loss of credentials, or other failures that would require a remote access tool to restart or alternate backdoor for them to regain access.", + "value": "Persistence" + }, + { + "description": "Privilege escalation is the result of actions that allow an adversary to obtain a higher level of permissions on a system or network. Certain tools or actions require a higher level of privilege to work and are likely necessary at many points throughout an operation. User accounts with permissions to access specific systems or perform specific functions necessary for adversaries to achieve their objective may also be considered an escalation of privilege.", + "value": "PrivilegeEscalation" + }, + { + "description": "Defense evasion consists of techniques an adversary may use to evade detection or avoid other defenses. Sometimes these actions are the same as or variations of techniques in other categories that have the added benefit of subverting a particular defense or mitigation. ", + "value": "DefenseEvasion" + }, + { + "description": "Credential access represents techniques resulting in access to or control over system, domain, or service credentials that are used within an enterprise environment. Adversaries will likely attempt to obtain legitimate credentials from users or administrator accounts (local system administrator or domain users with administrator access) to use within the network. With sufficient access within a network, an adversary can create accounts for later use within the environment.", + "value": "CredentialAccess" + }, + { + "description": "Discovery consists of techniques that allow the adversary to gain knowledge about the system and internal network. When adversaries gain access to a new system, they must navigate themselves to what they now have control of and what benefits operating from that system give to their current objective or overall goals during the intrusion. The operating system provides many native tools that aid in this post-compromise information-gathering phase.", + "value": "Discovery" + }, + { + "description": "Lateral movement consists of techniques that enable an adversary to access and control remote systems on a network and could, but does not necessarily, include execution of tools on remote systems. The lateral movement techniques could allow an adversary to gather information from a system without needing additional tools, such as a remote access tool. An adversary can use lateral movement for many purposes, including remote Execution of tools, pivoting to additional systems, access to specific information or files, access to additional credentials, or to cause an effect.", + "value": "LateralMovement" + }, + { + "description": "The execution tactic represents techniques that result in execution of adversary-controlled code on a local or remote system. This tactic is often used in conjunction with lateral movement to expand access to remote systems on a network.", + "value": "Execution" + }, + { + "description": "Collection consists of techniques used to identify and gather information, such as sensitive files, from a target network prior to exfiltration. This category also covers locations on a system or network where the adversary may look for information to exfiltrate.", + "value": "Collection" + }, + { + "description": "Exfiltration refers to techniques and attributes that result or aid in the adversary removing files and information from a target network. This category also covers locations on a system or network where the adversary may look for information to exfiltrate.", + "value": "Exfiltration" + }, + { + "description": "The command and control tactic represents how adversaries communicate with systems under their control within a target network.", + "value": "CommandAndControl" + }, + { + "description": "The impact intent primary objective is to directly reduce the availability or integrity of a system, service, or network; including manipulation of data to impact a business or operational process. This would often refer to techniques such as ransom-ware, defacement, data manipulation and others.", + "value": "Impact" + } + ] + } + }, + "techniques": { + "type": "array", + "items": { + "type": "string", + "description": "technique of the alert" + }, + "description": "The techniques of the alert." + } + }, + "required": [ + "azureResourceId", + "displayName", + "severity", + "endTimeUtc", + "startTimeUtc", + "timeGenerated", + "alertType" + ], + "type": "object", + "x-ms-discriminator-value": "SecurityAlert" + }, + "TimelineError": { + "description": "Timeline Query Errors.", + "properties": { + "kind": { + "description": "the query kind", + "$ref": "#/definitions/EntityTimelineKind" + }, + "queryId": { + "description": "the query id", + "type": "string" + }, + "errorMessage": { + "description": "the error message", + "type": "string" + } + }, + "required": [ + "kind", + "errorMessage" + ], + "type": "object" + }, + "TimelineResultsMetadata": { + "description": "Expansion result metadata.", + "properties": { + "totalCount": { + "description": "the total items found for the timeline request", + "type": "integer", + "format": "int32" + }, + "aggregations": { + "description": "timeline aggregation per kind", + "items": { + "$ref": "#/definitions/TimelineAggregation" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "errors": { + "description": "information about the failure queries", + "items": { + "$ref": "#/definitions/TimelineError" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "required": [ + "totalCount", + "aggregations" + ], + "type": "object" + }, + "TimelineAggregation": { + "description": "timeline aggregation information per kind", + "properties": { + "count": { + "description": "the total items found for a kind", + "type": "integer", + "format": "int32" + }, + "kind": { + "description": "the query kind", + "$ref": "#/definitions/EntityTimelineKind" + } + }, + "required": [ + "kind", + "count" + ], + "type": "object" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/EntityQueries.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/EntityQueries.json new file mode 100644 index 000000000000..c6f2e46b3427 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/EntityQueries.json @@ -0,0 +1,534 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entityQueries": { + "get": { + "x-ms-examples": { + "Get all entity queries.": { + "$ref": "./examples/entityQueries/GetEntityQueries.json" + } + }, + "tags": [ + "EntityQueries" + ], + "description": "Gets all entity queries.", + "operationId": "EntityQueries_List", + "parameters": [ + { + "$ref": "#/parameters/EntityQueryKind" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityQueryList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entityQueries/{entityQueryId}": { + "get": { + "x-ms-examples": { + "Get an Expansion entity query.": { + "$ref": "./examples/entityQueries/GetExpansionEntityQueryById.json" + }, + "Get an Activity entity query.": { + "$ref": "./examples/entityQueries/GetActivityEntityQueryById.json" + } + }, + "tags": [ + "EntityQueries" + ], + "description": "Gets an entity query.", + "operationId": "EntityQueries_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityQueryId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityQuery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates an Activity entity query.": { + "$ref": "./examples/entityQueries/CreateEntityQueryActivity.json" + } + }, + "tags": [ + "EntityQueries" + ], + "description": "Creates or updates the entity query.", + "operationId": "EntityQueries_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityQueryId" + }, + { + "$ref": "#/parameters/CustomEntityQuery" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityQuery" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/EntityQuery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an entity query.": { + "$ref": "./examples/entityQueries/DeleteEntityQuery.json" + } + }, + "tags": [ + "EntityQueries" + ], + "description": "Delete the entity query.", + "operationId": "EntityQueries_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityQueryId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "CustomEntityQueryKind": { + "description": "The kind of the entity query that supports put request.", + "enum": [ + "Activity" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "CustomEntityQueryKind", + "values": [ + { + "value": "Activity" + } + ] + } + }, + "EntityQueryList": { + "description": "List of all the entity queries.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of entity queries.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of entity queries.", + "items": { + "$ref": "#/definitions/EntityQuery" + }, + "type": "array" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "EntityQuery": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Specific entity query.", + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "./common/EntityTypes.json#/definitions/EntityQueryKind", + "description": "the entity query kind" + } + }, + "type": "object", + "required": [ + "kind" + ] + }, + "CustomEntityQuery": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Specific entity query that supports put requests.", + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "#/definitions/CustomEntityQueryKind", + "description": "the entity query kind" + } + }, + "type": "object", + "required": [ + "kind" + ] + }, + "ExpansionEntityQuery": { + "description": "Represents Expansion entity query.", + "allOf": [ + { + "$ref": "#/definitions/EntityQuery" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ExpansionEntityQueriesProperties", + "description": "Expansion entity query properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Expansion" + }, + "ExpansionEntityQueriesProperties": { + "description": "Describes expansion entity query properties", + "properties": { + "dataSources": { + "description": "List of the data sources that are required to run the query", + "items": { + "description": "data source", + "type": "string" + }, + "type": "array" + }, + "displayName": { + "description": "The query display name", + "type": "string" + }, + "inputEntityType": { + "$ref": "./common/EntityTypes.json#/definitions/EntityInnerType", + "description": "The type of the query's source entity" + }, + "inputFields": { + "description": "List of the fields of the source entity that are required to run the query", + "items": { + "description": "input field", + "type": "string" + }, + "type": "array" + }, + "outputEntityTypes": { + "description": "List of the desired output types to be constructed from the result", + "items": { + "$ref": "./common/EntityTypes.json#/definitions/EntityInnerType", + "description": "output entity type" + }, + "type": "array" + }, + "queryTemplate": { + "description": "The template query string to be parsed and formatted", + "type": "string" + } + }, + "type": "object" + }, + "ActivityEntityQuery": { + "description": "Represents Activity entity query.", + "allOf": [ + { + "$ref": "#/definitions/EntityQuery" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ActivityEntityQueriesProperties", + "description": "Activity entity query properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Activity" + }, + "ActivityCustomEntityQuery": { + "description": "Represents Activity entity query.", + "allOf": [ + { + "$ref": "#/definitions/CustomEntityQuery" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ActivityEntityQueriesProperties", + "description": "Activity entity query properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Activity" + }, + "ActivityEntityQueriesProperties": { + "description": "Describes activity entity query properties", + "properties": { + "title": { + "description": "The entity query title", + "type": "string" + }, + "content": { + "description": "The entity query content to display in timeline", + "type": "string" + }, + "description": { + "description": "The entity query description", + "type": "string" + }, + "queryDefinitions": { + "description": "The Activity query definitions", + "properties": { + "query": { + "description": "The Activity query to run on a given entity", + "type": "string" + } + }, + "type": "object" + }, + "inputEntityType": { + "$ref": "./common/EntityTypes.json#/definitions/EntityInnerType", + "description": "The type of the query's source entity" + }, + "requiredInputFieldsSets": { + "description": "List of the fields of the source entity that are required to run the query", + "items": { + "description": "Sub sets of the field of the source entity that are required to run the query", + "items": { + "description": "Required input field name", + "type": "string" + }, + "type": "array" + }, + "type": "array" + }, + "entitiesFilter": { + "description": "The query applied only to entities matching to all filters", + "type": "object", + "additionalProperties": { + "description": "Filter field name", + "items": { + "description": "Filter field values", + "type": "string" + }, + "type": "array" + } + }, + "templateName": { + "description": "The template id this activity was created from", + "type": "string" + }, + "enabled": { + "description": "Determines whether this activity is enabled or disabled.", + "type": "boolean" + }, + "createdTimeUtc": { + "description": "The time the activity was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "lastModifiedTimeUtc": { + "description": "The last time the activity was updated", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + } + }, + "parameters": { + "EntityQueryId": { + "description": "entity query ID", + "in": "path", + "name": "entityQueryId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "EntityQueryKind": { + "description": "The entity query kind we want to fetch", + "in": "query", + "name": "kind", + "required": false, + "enum": [ + "Expansion", + "Activity" + ], + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-enum": { + "name": "EntityQueryTemplateKind", + "modelAsString": true, + "values": [ + { + "value": "Activity" + }, + { + "value": "Insight" + }, + { + "value": "SecurityAlert" + }, + { + "value": "Bookmark" + }, + { + "value": "Expansion" + }, + { + "value": "GuidedInsight" + }, + { + "value": "Anomaly" + } + ] + } + }, + "CustomEntityQuery": { + "description": "The entity query we want to create or update", + "in": "body", + "name": "entityQuery", + "required": true, + "schema": { + "$ref": "#/definitions/CustomEntityQuery" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/EntityQueryTemplates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/EntityQueryTemplates.json new file mode 100644 index 000000000000..ca0f91e97eea --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/EntityQueryTemplates.json @@ -0,0 +1,331 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entityQueryTemplates": { + "get": { + "x-ms-examples": { + "Get all entity query templates.": { + "$ref": "./examples/entityQueryTemplates/GetEntityQueryTemplates.json" + } + }, + "tags": [ + "EntityQueries" + ], + "description": "Gets all entity query templates.", + "operationId": "EntityQueryTemplates_List", + "parameters": [ + { + "$ref": "#/parameters/EntityQueryTemplateKind" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityQueryTemplateList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entityQueryTemplates/{entityQueryTemplateId}": { + "get": { + "x-ms-examples": { + "Get an Activity entity query template.": { + "$ref": "./examples/entityQueryTemplates/GetActivityEntityQueryTemplateById.json" + } + }, + "tags": [ + "EntityQueries" + ], + "description": "Gets an entity query.", + "operationId": "EntityQueryTemplates_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityQueryTemplateId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityQueryTemplate" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "EntityQueryTemplateKind": { + "description": "The kind of the entity query template.", + "enum": [ + "Activity" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EntityQueryTemplateKind", + "values": [ + { + "value": "Activity" + } + ] + } + }, + "EntityQueryTemplateList": { + "description": "List of all the entity query templates.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of entity query templates.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of entity query templates.", + "items": { + "$ref": "#/definitions/EntityQueryTemplate" + }, + "type": "array" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "EntityQueryTemplate": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "description": "Specific entity query template.", + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "#/definitions/EntityQueryTemplateKind", + "description": "the entity query template kind" + } + }, + "type": "object", + "required": [ + "kind" + ] + }, + "ActivityEntityQueryTemplate": { + "description": "Represents Activity entity query.", + "allOf": [ + { + "$ref": "#/definitions/EntityQueryTemplate" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ActivityEntityQueryTemplateProperties", + "description": "Activity entity query properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Activity" + }, + "ActivityEntityQueryTemplateProperties": { + "description": "Describes activity entity query properties", + "properties": { + "title": { + "description": "The entity query title", + "type": "string" + }, + "content": { + "description": "The entity query content to display in timeline", + "type": "string" + }, + "description": { + "description": "The entity query description", + "type": "string" + }, + "queryDefinitions": { + "description": "The Activity query definitions", + "properties": { + "query": { + "description": "The Activity query to run on a given entity", + "type": "string" + }, + "summarizeBy": { + "description": "The dimensions we want to summarize the timeline results on, this is comma separated list", + "type": "string" + } + }, + "type": "object" + }, + "dataTypes": { + "description": "List of required data types for the given entity query template", + "items": { + "$ref": "#/definitions/DataTypeDefinitions" + }, + "type": "array" + }, + "inputEntityType": { + "$ref": "./common/EntityTypes.json#/definitions/EntityInnerType", + "description": "The type of the query's source entity" + }, + "requiredInputFieldsSets": { + "description": "List of the fields of the source entity that are required to run the query", + "items": { + "description": "Sub sets of the field of the source entity that are required to run the query", + "items": { + "description": "Required input field name", + "type": "string" + }, + "type": "array" + }, + "type": "array" + }, + "entitiesFilter": { + "description": "The query applied only to entities matching to all filters", + "type": "object", + "additionalProperties": { + "description": "Filter field name", + "items": { + "description": "Filter field values", + "type": "string" + }, + "type": "array" + } + } + }, + "type": "object" + }, + "DataTypeDefinitions": { + "description": "The data type definition", + "properties": { + "dataType": { + "description": "The data type name", + "type": "string" + } + }, + "type": "object" + } + }, + "parameters": { + "EntityQueryTemplateId": { + "description": "entity query template ID", + "in": "path", + "name": "entityQueryTemplateId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "EntityQueryTemplateKind": { + "description": "The entity template query kind we want to fetch", + "in": "query", + "name": "kind", + "required": false, + "enum": [ + "Activity" + ], + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-enum": { + "name": "EntityQueryTemplateKind", + "modelAsString": true, + "values": [ + { + "value": "Activity" + }, + { + "value": "Insight" + }, + { + "value": "SecurityAlert" + }, + { + "value": "Bookmark" + }, + { + "value": "Expansion" + }, + { + "value": "GuidedInsight" + }, + { + "value": "Anomaly" + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/FileImports.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/FileImports.json new file mode 100644 index 000000000000..cf8275f10c61 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/FileImports.json @@ -0,0 +1,575 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/fileImports": { + "get": { + "x-ms-examples": { + "Get all file imports.": { + "$ref": "./examples/fileImports/GetFileImports.json" + } + }, + "tags": [ + "FileImports" + ], + "description": "Gets all file imports.", + "operationId": "FileImports_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FileImportList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/fileImports/{fileImportId}": { + "get": { + "x-ms-examples": { + "Get a file import.": { + "$ref": "./examples/fileImports/GetFileImportById.json" + } + }, + "tags": [ + "FileImports" + ], + "description": "Gets a file import.", + "operationId": "FileImports_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/FileImportId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FileImport" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create a file import.": { + "$ref": "./examples/fileImports/CreateFileImport.json" + } + }, + "tags": [ + "FileImports" + ], + "description": "Creates the file import.", + "operationId": "FileImports_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/FileImportId" + }, + { + "$ref": "#/parameters/FileImport" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FileImport" + } + }, + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/FileImport" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a file import.": { + "$ref": "./examples/fileImports/DeleteFileImport.json" + } + }, + "tags": [ + "FileImports" + ], + "description": "Delete the file import.", + "operationId": "FileImports_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/FileImportId" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/FileImport" + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "FileMetadata": { + "description": "Represents a file.", + "properties": { + "fileFormat": { + "description": "The format of the file", + "enum": [ + "CSV", + "JSON", + "Unspecified" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "fileFormat", + "values": [ + { + "description": "A CSV file.", + "value": "CSV" + }, + { + "description": "A JSON file.", + "value": "JSON" + }, + { + "description": "A file of other format.", + "value": "Unspecified" + } + ] + } + }, + "fileName": { + "description": "The name of the file.", + "type": "string" + }, + "fileSize": { + "description": "The size of the file.", + "format": "int32", + "type": "integer" + }, + "fileContentUri": { + "description": "A URI with a valid SAS token to allow uploading / downloading the file.", + "type": "string", + "readOnly": true + }, + "deleteStatus": { + "description": "Indicates whether the file was deleted from the storage account.", + "enum": [ + "Deleted", + "NotDeleted", + "Unspecified" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DeleteStatus", + "values": [ + { + "description": "The file was deleted.", + "value": "Deleted" + }, + { + "description": "The file was not deleted.", + "value": "NotDeleted" + }, + { + "description": "Unspecified", + "value": "Unspecified" + } + ] + }, + "readOnly": true + } + }, + "type": "object" + }, + "FileImport": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "description": "Represents a file import in Azure Security Insights.", + "properties": { + "properties": { + "$ref": "#/definitions/FileImportProperties", + "description": "File import properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "FileImportList": { + "description": "List all the file imports.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of file imports.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of file imports.", + "items": { + "$ref": "#/definitions/FileImport" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "FileImportProperties": { + "description": "Describes the FileImport's properties", + "properties": { + "ingestionMode": { + "description": "Describes how to ingest the records in the file.", + "enum": [ + "IngestOnlyIfAllAreValid", + "IngestAnyValidRecords", + "Unspecified" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IngestionMode", + "values": [ + { + "description": "No records should be ingested when invalid records are detected.", + "value": "IngestOnlyIfAllAreValid" + }, + { + "description": "Valid records should still be ingested when invalid records are detected.", + "value": "IngestAnyValidRecords" + }, + { + "description": "Unspecified", + "value": "Unspecified" + } + ] + } + }, + "contentType": { + "description": "The content type of this file.", + "enum": [ + "BasicIndicator", + "StixIndicator", + "Unspecified" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "FileImportContentType", + "values": [ + { + "description": "File containing records with the core fields of an indicator, plus the observables to construct the STIX pattern.", + "value": "BasicIndicator" + }, + { + "description": "File containing STIX indicators.", + "value": "StixIndicator" + }, + { + "description": "File containing other records.", + "value": "Unspecified" + } + ] + } + }, + "createdTimeUTC": { + "description": "The time the file was imported.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "errorFile": { + "description": "Represents the error file (if the import was ingested with errors or failed the validation).", + "$ref": "#/definitions/FileMetadata", + "readOnly": true, + "type": "object" + }, + "errorsPreview": { + "description": "An ordered list of some of the errors that were encountered during validation.", + "items": { + "description": "An error that were encountered during validation.", + "$ref": "#/definitions/ValidationError" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "importFile": { + "description": "Represents the imported file.", + "$ref": "#/definitions/FileMetadata", + "type": "object" + }, + "ingestedRecordCount": { + "description": "The number of records that have been successfully ingested.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "source": { + "description": "The source for the data in the file.", + "type": "string" + }, + "state": { + "description": "The state of the file import.", + "enum": [ + "FatalError", + "Ingested", + "IngestedWithErrors", + "InProgress", + "Invalid", + "WaitingForUpload", + "Unspecified" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "FileImportState", + "values": [ + { + "description": "A fatal error has occurred while ingesting the file.", + "value": "FatalError" + }, + { + "description": "The file has been ingested.", + "value": "Ingested" + }, + { + "description": "The file has been ingested with errors.", + "value": "IngestedWithErrors" + }, + { + "description": "The file ingestion is in progress.", + "value": "InProgress" + }, + { + "description": "The file is invalid.", + "value": "Invalid" + }, + { + "description": "Waiting for the file to be uploaded.", + "value": "WaitingForUpload" + }, + { + "description": "Unspecified state.", + "value": "Unspecified" + } + ] + } + }, + "totalRecordCount": { + "description": "The number of records in the file.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "validRecordCount": { + "description": "The number of records that have passed validation.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "filesValidUntilTimeUTC": { + "description": "The time the files associated with this import are deleted from the storage account.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "importValidUntilTimeUTC": { + "description": "The time the file import record is soft deleted from the database and history.", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "ingestionMode", + "contentType", + "importFile", + "source" + ], + "type": "object" + }, + "ValidationError": { + "description": "Describes an error encountered in the file during validation.", + "properties": { + "recordIndex": { + "description": "The number of the record that has the error.", + "type": "integer", + "format": "int32" + }, + "errorMessages": { + "description": "A list of descriptions of the error.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + } + }, + "parameters": { + "FileImportId": { + "description": "File import ID", + "in": "path", + "name": "fileImportId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "FileImport": { + "description": "The file import", + "in": "body", + "name": "fileImport", + "required": true, + "schema": { + "$ref": "#/definitions/FileImport" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Hunts.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Hunts.json new file mode 100644 index 000000000000..278b55704368 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Hunts.json @@ -0,0 +1,994 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/hunts": { + "get": { + "x-ms-examples": { + "Get all hunts.": { + "$ref": "./examples/hunts/GetHunts.json" + } + }, + "tags": [ + "Hunts" + ], + "description": "Gets all hunts, without relations and comments.", + "operationId": "Hunts_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HuntList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/hunts/{huntId}": { + "get": { + "x-ms-examples": { + "Get a hunt.": { + "$ref": "./examples/hunts/GetHuntById.json" + } + }, + "tags": [ + "Hunts" + ], + "description": "Gets a hunt, without relations and comments.", + "operationId": "Hunts_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/HuntId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Hunt" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a hunt.": { + "$ref": "./examples/hunts/DeleteHunt.json" + } + }, + "tags": [ + "Hunts" + ], + "description": "Delete a hunt.", + "operationId": "Hunts_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/HuntId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a hunt.": { + "$ref": "./examples/hunts/CreateHunt.json" + } + }, + "tags": [ + "Hunts" + ], + "description": "Create or update a hunt", + "operationId": "Hunts_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/HuntId" + }, + { + "$ref": "#/parameters/Hunt" + } + ], + "responses": { + "200": { + "description": "Create or update the Hunt", + "schema": { + "$ref": "#/definitions/Hunt" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Hunt" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/hunts/{huntId}/relations": { + "get": { + "x-ms-examples": { + "Get all hunt relations.": { + "$ref": "./examples/hunts/GetHuntRelations.json" + } + }, + "tags": [ + "HuntRelations" + ], + "description": "Gets all hunt relations", + "operationId": "HuntRelations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/HuntId" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HuntRelationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/hunts/{huntId}/relations/{huntRelationId}": { + "get": { + "x-ms-examples": { + "Get a hunt relation.": { + "$ref": "./examples/hunts/GetHuntRelationById.json" + } + }, + "tags": [ + "HuntRelations" + ], + "description": "Gets a hunt relation", + "operationId": "HuntRelations_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/HuntId" + }, + { + "$ref": "#/parameters/HuntRelationId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HuntRelation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a hunt relation.": { + "$ref": "./examples/hunts/DeleteHuntRelation.json" + } + }, + "tags": [ + "HuntRelations" + ], + "description": "Delete a hunt relation.", + "operationId": "HuntRelations_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/HuntId" + }, + { + "$ref": "#/parameters/HuntRelationId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a hunt relation.": { + "$ref": "./examples/hunts/CreateHuntRelation.json" + } + }, + "tags": [ + "HuntRelations" + ], + "description": "Creates or updates a hunt relation.", + "operationId": "HuntRelations_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/HuntId" + }, + { + "$ref": "#/parameters/HuntRelationId" + }, + { + "$ref": "#/parameters/HuntRelation" + } + ], + "responses": { + "200": { + "description": "Create or update the hunt relation", + "schema": { + "$ref": "#/definitions/HuntRelation" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/HuntRelation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/hunts/{huntId}/comments": { + "get": { + "x-ms-examples": { + "Get all hunt comments.": { + "$ref": "./examples/hunts/GetHuntComments.json" + } + }, + "tags": [ + "HuntComments" + ], + "description": "Gets all hunt comments", + "operationId": "HuntComments_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/HuntId" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HuntCommentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/hunts/{huntId}/comments/{huntCommentId}": { + "get": { + "x-ms-examples": { + "Get a hunt comment.": { + "$ref": "./examples/hunts/GetHuntCommentById.json" + } + }, + "tags": [ + "HuntComments" + ], + "description": "Gets a hunt comment", + "operationId": "HuntComments_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/HuntId" + }, + { + "$ref": "#/parameters/HuntCommentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HuntComment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a hunt comment.": { + "$ref": "./examples/hunts/DeleteHuntComment.json" + } + }, + "tags": [ + "HuntComments" + ], + "description": "Delete a hunt comment.", + "operationId": "HuntComments_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/HuntId" + }, + { + "$ref": "#/parameters/HuntCommentId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a hunt comment.": { + "$ref": "./examples/hunts/CreateHuntComment.json" + } + }, + "tags": [ + "HuntComments" + ], + "description": "Creates or updates a hunt relation.", + "operationId": "HuntComments_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/HuntId" + }, + { + "$ref": "#/parameters/HuntCommentId" + }, + { + "$ref": "#/parameters/HuntComment" + } + ], + "responses": { + "200": { + "description": "Create or update the hunt comment", + "schema": { + "$ref": "#/definitions/HuntComment" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/HuntComment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "HuntList": { + "description": "List all the hunts.", + "type": "object", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of hunts.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of hunts.", + "items": { + "$ref": "#/definitions/Hunt" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + }, + "Hunt": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a Hunt in Azure Security Insights.", + "properties": { + "properties": { + "$ref": "#/definitions/HuntProperties", + "description": "Hunt properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "HuntProperties": { + "description": "Describes hunt properties", + "properties": { + "displayName": { + "description": "The display name of the hunt", + "type": "string" + }, + "description": { + "description": "The description of the hunt", + "type": "string" + }, + "status": { + "description": "The status of the hunt.", + "enum": [ + "New", + "Active", + "Closed", + "Backlog", + "Approved" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "status" + }, + "default": "New" + }, + "hypothesisStatus": { + "description": "The hypothesis status of the hunt.", + "enum": [ + "Unknown", + "Invalidated", + "Validated" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "hypothesisStatus" + }, + "default": "Unknown" + }, + "attackTactics": { + "description": "A list of mitre attack tactics the hunt is associated with", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" + }, + "type": "array" + }, + "attackTechniques": { + "description": "A list of a mitre attack techniques the hunt is associated with", + "items": { + "description": "Attack Technique", + "type": "string" + }, + "type": "array" + }, + "labels": { + "description": "List of labels relevant to this hunt ", + "items": { + "$ref": "../../../common/2.0/types.json#/definitions/Label" + }, + "type": "array" + }, + "owner": { + "$ref": "#/definitions/HuntOwner" + } + }, + "required": [ + "displayName", + "description" + ], + "type": "object" + }, + "HuntRelationList": { + "description": "List of all the hunt relations", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of hunt relations.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of hunt relations", + "items": { + "$ref": "#/definitions/HuntRelation" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "HuntRelation": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a Hunt Relation in Azure Security Insights.", + "properties": { + "properties": { + "$ref": "#/definitions/HuntRelationProperties", + "description": "Hunt Relation properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "HuntRelationProperties": { + "description": "Describes hunt relation properties", + "properties": { + "relatedResourceId": { + "description": "The id of the related resource", + "type": "string" + }, + "relatedResourceName": { + "description": "The name of the related resource", + "type": "string", + "readOnly": true + }, + "relationType": { + "description": "The type of the hunt relation", + "type": "string", + "readOnly": true + }, + "relatedResourceKind": { + "description": "The resource that the relation is related to", + "type": "string", + "readOnly": true + }, + "labels": { + "description": "List of labels relevant to this hunt", + "items": { + "$ref": "../../../common/2.0/types.json#/definitions/Label" + }, + "type": "array" + } + }, + "required": [ + "relatedResourceId" + ], + "type": "object" + }, + "HuntCommentList": { + "description": "List of all hunt comments", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of hunt comments.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of hunt comments", + "items": { + "$ref": "#/definitions/HuntComment" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "HuntComment": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a Hunt Comment in Azure Security Insights", + "properties": { + "properties": { + "$ref": "#/definitions/HuntCommentProperties", + "description": "Hunt Comment properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "HuntCommentProperties": { + "description": "Describes a hunt comment properties", + "properties": { + "message": { + "description": "The message for the comment", + "type": "string" + } + }, + "required": [ + "message" + ], + "type": "object" + }, + "HuntOwner": { + "description": "Describes a user that the hunt is assigned to", + "type": "object", + "properties": { + "email": { + "description": "The email of the user the hunt is assigned to.", + "type": "string" + }, + "assignedTo": { + "description": "The name of the user the hunt is assigned to.", + "type": "string" + }, + "objectId": { + "description": "The object id of the user the hunt is assigned to.", + "format": "uuid", + "type": "string", + "x-nullable": true + }, + "userPrincipalName": { + "description": "The user principal name of the user the hunt is assigned to.", + "type": "string" + }, + "ownerType": { + "description": "The type of the owner the hunt is assigned to.", + "type": "string", + "enum": [ + "Unknown", + "User", + "Group" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "OwnerType", + "values": [ + { + "description": "The hunt owner type is unknown", + "value": "Unknown" + }, + { + "description": "The hunt owner type is an AAD user", + "value": "User" + }, + { + "description": "The hunt owner type is an AAD group", + "value": "Group" + } + ] + } + } + } + } + }, + "parameters": { + "Hunt": { + "description": "The hunt", + "name": "hunt", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Hunt" + }, + "x-ms-parameter-location": "method" + }, + "HuntId": { + "description": "The hunt id (GUID)", + "in": "path", + "name": "huntId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "HuntRelation": { + "description": "The hunt relation", + "in": "body", + "name": "huntRelation", + "required": true, + "schema": { + "$ref": "#/definitions/HuntRelation" + }, + "x-ms-parameter-location": "method" + }, + "HuntRelationId": { + "description": "The hunt relation id (GUID)", + "in": "path", + "name": "huntRelationId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "HuntComment": { + "description": "The hunt comment", + "in": "body", + "name": "huntComment", + "required": true, + "schema": { + "$ref": "#/definitions/HuntComment" + }, + "x-ms-parameter-location": "method" + }, + "HuntCommentId": { + "description": "The hunt comment id (GUID)", + "in": "path", + "name": "huntCommentId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Incidents.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Incidents.json new file mode 100644 index 000000000000..a5f6afc31ff6 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Incidents.json @@ -0,0 +1,1669 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents": { + "get": { + "tags": [ + "Incidents" + ], + "description": "Gets all incidents.", + "operationId": "Incidents_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Incidents_List": { + "$ref": "./examples/incidents/Incidents_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}": { + "get": { + "tags": [ + "Incidents" + ], + "description": "Gets an incident.", + "operationId": "Incidents_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Incident" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Incidents_Get": { + "$ref": "./examples/incidents/Incidents_Get.json" + } + } + }, + "put": { + "tags": [ + "Incidents" + ], + "description": "Creates or updates the incident.", + "operationId": "Incidents_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/Incident" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Incident" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Incident" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Incidents_CreateOrUpdate": { + "$ref": "./examples/incidents/Incidents_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Incidents" + ], + "description": "Delete the incident.", + "operationId": "Incidents_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Incidents_Delete": { + "$ref": "./examples/incidents/Incidents_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/createTeam": { + "post": { + "tags": [ + "IncidentTeam" + ], + "description": "Creates a Microsoft team to investigate the incident by sharing information and insights between participants.", + "operationId": "Incidents_CreateTeam", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/TeamProperties" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TeamInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Incidents_CreateTeam": { + "$ref": "./examples/incidents/IncidentTeam/Incidents_CreateTeam.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/alerts": { + "post": { + "tags": [ + "IncidentAlerts" + ], + "description": "Gets all incident alerts.", + "operationId": "Incidents_ListAlerts", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentAlertList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Incidents_ListAlerts": { + "$ref": "./examples/incidents/IncidentAlerts/Incidents_ListAlerts.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/bookmarks": { + "post": { + "tags": [ + "IncidentBookmarks" + ], + "description": "Gets all incident bookmarks.", + "operationId": "Incidents_ListBookmarks", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentBookmarkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Incidents_ListBookmarks": { + "$ref": "./examples/incidents/IncidentBookmarks/Incidents_ListBookmarks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments": { + "get": { + "tags": [ + "IncidentComments" + ], + "description": "Gets all incident comments.", + "operationId": "IncidentComments_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentCommentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "IncidentComments_List": { + "$ref": "./examples/incidents/IncidentComments/IncidentComments_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments/{incidentCommentId}": { + "get": { + "tags": [ + "IncidentComments" + ], + "description": "Gets an incident comment.", + "operationId": "IncidentComments_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/IncidentCommentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentComment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "IncidentComments_Get": { + "$ref": "./examples/incidents/IncidentComments/IncidentComments_Get.json" + } + } + }, + "put": { + "tags": [ + "IncidentComments" + ], + "description": "Creates or updates the incident comment.", + "operationId": "IncidentComments_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/IncidentCommentId" + }, + { + "$ref": "#/parameters/IncidentComment" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentComment" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/IncidentComment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "IncidentComments_CreateOrUpdate": { + "$ref": "./examples/incidents/IncidentComments/IncidentComments_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "IncidentComments" + ], + "description": "Delete the incident comment.", + "operationId": "IncidentComments_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/IncidentCommentId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "IncidentComments_Delete": { + "$ref": "./examples/incidents/IncidentComments/IncidentComments_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/entities": { + "post": { + "tags": [ + "IncidentEntities" + ], + "description": "Gets all incident related entities.", + "operationId": "Incidents_ListEntities", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentEntitiesResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Incidents_ListEntities": { + "$ref": "./examples/incidents/IncidentEntities/Incidents_ListEntities.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations": { + "get": { + "x-ms-examples": { + "Get all incident relations.": { + "$ref": "./examples/incidents/relations/GetAllIncidentRelations.json" + } + }, + "tags": [ + "IncidentRelations" + ], + "description": "Gets all incident relations.", + "operationId": "IncidentRelations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./common/RelationTypes.json#/definitions/RelationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-odata": "./common/RelationTypes.json#/definitions/Relation", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations/{relationName}": { + "get": { + "x-ms-examples": { + "Get an incident relation.": { + "$ref": "./examples/incidents/relations/GetIncidentRelationByName.json" + } + }, + "tags": [ + "IncidentRelations" + ], + "description": "Gets an incident relation.", + "operationId": "IncidentRelations_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "./common/RelationTypes.json#/parameters/RelationName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./common/RelationTypes.json#/definitions/Relation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates an incident relation.": { + "$ref": "./examples/incidents/relations/CreateIncidentRelation.json" + } + }, + "tags": [ + "IncidentRelations" + ], + "description": "Creates or updates the incident relation.", + "operationId": "IncidentRelations_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "./common/RelationTypes.json#/parameters/RelationName" + }, + { + "$ref": "./common/RelationTypes.json#/parameters/Relation" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./common/RelationTypes.json#/definitions/Relation" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./common/RelationTypes.json#/definitions/Relation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete the incident relation.": { + "$ref": "./examples/incidents/relations/DeleteIncidentRelation.json" + } + }, + "tags": [ + "IncidentRelations" + ], + "description": "Delete the incident relation.", + "operationId": "IncidentRelations_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "./common/RelationTypes.json#/parameters/RelationName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/tasks": { + "get": { + "tags": [ + "IncidentTasks" + ], + "description": "Gets all incident tasks.", + "operationId": "IncidentTasks_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentTaskList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "IncidentTasks_List": { + "$ref": "./examples/incidents/IncidentTasks/IncidentTasks_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/tasks/{incidentTaskId}": { + "get": { + "tags": [ + "IncidentTasks" + ], + "description": "Gets an incident task.", + "operationId": "IncidentTasks_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/IncidentTaskId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentTask" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "IncidentTasks_Get": { + "$ref": "./examples/incidents/IncidentTasks/IncidentTasks_Get.json" + } + } + }, + "put": { + "tags": [ + "IncidentTasks" + ], + "description": "Creates or updates the incident task.", + "operationId": "IncidentTasks_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/IncidentTaskId" + }, + { + "$ref": "#/parameters/IncidentTask" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentTask" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/IncidentTask" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "IncidentTasks_CreateOrUpdate": { + "$ref": "./examples/incidents/IncidentTasks/IncidentTasks_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "IncidentTasks" + ], + "description": "Delete the incident task.", + "operationId": "IncidentTasks_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/IncidentTaskId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "IncidentTasks_Delete": { + "$ref": "./examples/incidents/IncidentTasks/IncidentTasks_Delete.json" + } + } + } + } + }, + "definitions": { + "Incident": { + "type": "object", + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "properties": { + "properties": { + "type": "object", + "$ref": "#/definitions/IncidentProperties", + "x-ms-client-flatten": true + } + } + }, + "IncidentAdditionalData": { + "description": "Incident additional data property bag.", + "type": "object", + "properties": { + "alertsCount": { + "format": "int32", + "description": "The number of alerts in the incident", + "type": "integer", + "readOnly": true + }, + "bookmarksCount": { + "format": "int32", + "description": "The number of bookmarks in the incident", + "type": "integer", + "readOnly": true + }, + "commentsCount": { + "format": "int32", + "description": "The number of comments in the incident", + "type": "integer", + "readOnly": true + }, + "alertProductNames": { + "description": "List of product names of alerts in the incident", + "type": "array", + "items": { + "description": "Alert product name", + "type": "string" + }, + "readOnly": true + }, + "tactics": { + "description": "The tactics associated with incident", + "type": "array", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" + }, + "readOnly": true + }, + "techniques": { + "description": "The techniques associated with incident's tactics", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "providerIncidentUrl": { + "description": "The provider incident url to the incident in Microsoft 365 Defender portal", + "type": "string", + "readOnly": true + } + } + }, + "IncidentAlertList": { + "description": "List of incident alerts.", + "type": "object", + "properties": { + "value": { + "description": "Array of incident alerts.", + "type": "array", + "items": { + "$ref": "./common/EntityTypes.json#/definitions/SecurityAlert" + } + } + }, + "required": [ + "value" + ] + }, + "IncidentBookmarkList": { + "description": "List of incident bookmarks.", + "type": "object", + "properties": { + "value": { + "description": "Array of incident bookmarks.", + "type": "array", + "items": { + "$ref": "./common/EntityTypes.json#/definitions/HuntingBookmark" + } + } + }, + "required": [ + "value" + ] + }, + "IncidentComment": { + "type": "object", + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents an incident comment", + "properties": { + "properties": { + "type": "object", + "$ref": "#/definitions/IncidentCommentProperties", + "description": "Incident comment properties", + "x-ms-client-flatten": true + } + } + }, + "IncidentCommentList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IncidentComment" + } + }, + "nextLink": { + "type": "string", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "IncidentCommentProperties": { + "description": "Incident comment property bag.", + "required": [ + "message" + ], + "type": "object", + "properties": { + "message": { + "description": "The comment message", + "type": "string" + }, + "createdTimeUtc": { + "format": "date-time", + "description": "The time the comment was created", + "type": "string", + "readOnly": true + }, + "lastModifiedTimeUtc": { + "format": "date-time", + "description": "The time the comment was updated", + "type": "string", + "readOnly": true + }, + "author": { + "type": "object", + "$ref": "../../../common/2.0/types.json#/definitions/ClientInfo", + "description": "Describes the client that created the comment", + "readOnly": true + } + } + }, + "IncidentEntitiesResponse": { + "description": "The incident related entities response.", + "type": "object", + "properties": { + "entities": { + "description": "Array of the incident related entities.", + "type": "array", + "items": { + "$ref": "./common/EntityTypes.json#/definitions/Entity" + } + }, + "metaData": { + "description": "The metadata from the incident related entities results.", + "type": "array", + "items": { + "$ref": "#/definitions/IncidentEntitiesResultsMetadata" + } + } + } + }, + "IncidentEntitiesResultsMetadata": { + "description": "Information of a specific aggregation in the incident related entities result.", + "required": [ + "count", + "entityKind" + ], + "type": "object", + "properties": { + "entityKind": { + "description": "The kind of the aggregated entity.", + "$ref": "./common/EntityTypes.json#/definitions/EntityInnerKind" + }, + "count": { + "format": "int32", + "description": "Total number of aggregations of the given kind in the incident related entities result.", + "type": "integer" + } + } + }, + "IncidentList": { + "required": [ + "value" + ], + "description": "List all the incidents.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Incident" + } + }, + "nextLink": { + "description": "URL to fetch the next set of incidents.", + "type": "string", + "readOnly": true + } + } + }, + "IncidentProperties": { + "required": [ + "severity", + "status", + "title" + ], + "type": "object", + "properties": { + "title": { + "description": "The title of the incident", + "type": "string" + }, + "description": { + "description": "The description of the incident", + "type": "string" + }, + "severity": { + "$ref": "./common/IncidentTypes.json#/definitions/IncidentSeverityEnum" + }, + "status": { + "$ref": "./common/IncidentTypes.json#/definitions/IncidentStatusEnum" + }, + "classification": { + "description": "The reason the incident was closed", + "$ref": "./common/IncidentTypes.json#/definitions/IncidentClassificationEnum" + }, + "classificationReason": { + "description": "The classification reason the incident was closed with", + "$ref": "./common/IncidentTypes.json#/definitions/IncidentClassificationReasonEnum" + }, + "classificationComment": { + "description": "Describes the reason the incident was closed", + "type": "string" + }, + "owner": { + "type": "object", + "description": "Describes a user that the incident is assigned to", + "$ref": "./common/IncidentTypes.json#/definitions/IncidentOwnerInfo" + }, + "labels": { + "description": "List of labels relevant to this incident", + "type": "array", + "items": { + "$ref": "./common/IncidentTypes.json#/definitions/IncidentLabel" + } + }, + "firstActivityTimeUtc": { + "format": "date-time", + "description": "The time of the first activity in the incident", + "type": "string" + }, + "lastActivityTimeUtc": { + "format": "date-time", + "description": "The time of the last activity in the incident", + "type": "string" + }, + "lastModifiedTimeUtc": { + "format": "date-time", + "description": "The last time the incident was updated", + "type": "string", + "readOnly": true + }, + "createdTimeUtc": { + "format": "date-time", + "description": "The time the incident was created", + "type": "string", + "readOnly": true + }, + "incidentNumber": { + "format": "int32", + "description": "A sequential number", + "type": "integer", + "readOnly": true + }, + "additionalData": { + "$ref": "#/definitions/IncidentAdditionalData", + "description": "Additional data on the incident", + "readOnly": true, + "type": "object" + }, + "relatedAnalyticRuleIds": { + "description": "List of resource ids of Analytic rules related to the incident", + "type": "array", + "items": { + "description": "Related Analytic rule resource id", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "scopes": [ + "Extension" + ], + "type": "Microsoft.SecurityInsights/alertRules" + } + ] + } + }, + "readOnly": true + }, + "incidentUrl": { + "description": "The deep-link url to the incident in Azure portal", + "type": "string", + "readOnly": true + }, + "providerName": { + "description": "The name of the source provider that generated the incident", + "type": "string", + "readOnly": true + }, + "providerIncidentId": { + "description": "The incident ID assigned by the incident provider", + "type": "string", + "readOnly": true + }, + "teamInformation": { + "$ref": "#/definitions/TeamInformation", + "description": "Describes a team for the incident", + "type": "object" + } + } + }, + "IncidentTask": { + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "properties": { + "properties": { + "type": "object", + "$ref": "#/definitions/IncidentTaskProperties", + "x-ms-client-flatten": true + } + } + }, + "IncidentTaskList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IncidentTask" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "IncidentTaskProperties": { + "required": [ + "status", + "title" + ], + "type": "object", + "properties": { + "title": { + "description": "The title of the task", + "type": "string" + }, + "description": { + "description": "The description of the task", + "type": "string" + }, + "status": { + "$ref": "#/definitions/IncidentTaskStatus" + }, + "createdTimeUtc": { + "format": "date-time", + "description": "The time the task was created", + "type": "string", + "readOnly": true + }, + "lastModifiedTimeUtc": { + "format": "date-time", + "description": "The last time the task was updated", + "type": "string", + "readOnly": true + }, + "createdBy": { + "type": "object", + "$ref": "../../../common/2.0/types.json#/definitions/ClientInfo" + }, + "lastModifiedBy": { + "type": "object", + "$ref": "../../../common/2.0/types.json#/definitions/ClientInfo" + } + } + }, + "IncidentTaskStatus": { + "enum": [ + "New", + "Completed" + ], + "type": "string", + "example": "New", + "x-ms-enum": { + "name": "IncidentTaskStatus", + "modelAsString": true, + "values": [ + { + "value": "New", + "description": "A new task" + }, + { + "value": "Completed", + "description": "A completed task" + } + ] + } + }, + "TeamInformation": { + "description": "Describes team information", + "type": "object", + "properties": { + "teamId": { + "description": "Team ID", + "type": "string", + "readOnly": true + }, + "primaryChannelUrl": { + "description": "The primary channel URL of the team", + "type": "string", + "readOnly": true + }, + "teamCreationTimeUtc": { + "format": "date-time", + "description": "The time the team was created", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the team", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description of the team", + "type": "string", + "readOnly": true + } + } + }, + "TeamProperties": { + "description": "Describes team properties", + "required": [ + "teamName" + ], + "type": "object", + "properties": { + "teamName": { + "description": "The name of the team", + "type": "string" + }, + "teamDescription": { + "description": "The description of the team", + "type": "string" + }, + "groupIds": { + "description": "List of group IDs to add their members to the team", + "type": "array", + "items": { + "format": "uuid", + "type": "string" + } + }, + "memberIds": { + "description": "List of member IDs to add to the team", + "type": "array", + "items": { + "format": "uuid", + "type": "string" + } + } + } + } + }, + "parameters": { + "Incident": { + "name": "incident", + "description": "The incident", + "required": true, + "in": "body", + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/Incident" + } + }, + "IncidentId": { + "in": "path", + "name": "incidentId", + "description": "Incident ID", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "IncidentComment": { + "name": "incidentComment", + "description": "The incident comment", + "required": true, + "in": "body", + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/IncidentComment" + } + }, + "IncidentCommentId": { + "in": "path", + "name": "incidentCommentId", + "description": "Incident comment ID", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "TeamProperties": { + "name": "teamProperties", + "description": "Team properties", + "required": true, + "in": "body", + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/TeamInformation" + } + }, + "IncidentTask": { + "name": "incidentTask", + "description": "The incident task", + "required": true, + "in": "body", + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/IncidentTask" + } + }, + "IncidentTaskId": { + "in": "path", + "name": "incidentTaskId", + "description": "Incident task ID", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Metadata.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Metadata.json new file mode 100644 index 000000000000..240088ed5489 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Metadata.json @@ -0,0 +1,774 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/metadata": { + "get": { + "x-ms-examples": { + "Get all metadata.": { + "$ref": "./examples/metadata/GetAllMetadata.json" + }, + "Get all metadata with OData filter/orderby/skip/top": { + "$ref": "./examples/metadata/GetAllMetadataOData.json" + } + }, + "tags": [ + "Metadata" + ], + "description": "List of all metadata", + "operationId": "Metadata_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkip" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MetadataList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/metadata/{metadataName}": { + "get": { + "x-ms-examples": { + "Get single metadata by name": { + "$ref": "./examples/metadata/GetMetadata.json" + } + }, + "tags": [ + "Metadata" + ], + "description": "Get a Metadata.", + "operationId": "Metadata_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/MetadataName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MetadataModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete metadata.": { + "$ref": "./examples/metadata/DeleteMetadata.json" + } + }, + "tags": [ + "Metadata" + ], + "description": "Delete a Metadata.", + "operationId": "Metadata_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/MetadataName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create/update full metadata.": { + "$ref": "./examples/metadata/PutMetadata.json" + }, + "Create/update minimal metadata.": { + "$ref": "./examples/metadata/PutMetadataMinimal.json" + } + }, + "tags": [ + "Metadata" + ], + "description": "Create a Metadata.", + "operationId": "Metadata_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/MetadataName" + }, + { + "$ref": "#/parameters/Metadata" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/MetadataModel" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/MetadataModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "patch": { + "x-ms-examples": { + "Update metadata.": { + "$ref": "./examples/metadata/PatchMetadata.json" + } + }, + "tags": [ + "Metadata" + ], + "description": "Update an existing Metadata.", + "operationId": "Metadata_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/MetadataName" + }, + { + "$ref": "#/parameters/MetadataPatch" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MetadataModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "MetadataList": { + "description": "List of all the metadata.", + "type": "object", + "properties": { + "value": { + "description": "Array of metadata.", + "items": { + "$ref": "#/definitions/MetadataModel" + }, + "type": "array" + }, + "nextLink": { + "description": "URL to fetch the next page of metadata.", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "MetadataModel": { + "type": "object", + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Metadata resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/metadataProperties", + "description": "Metadata properties", + "x-ms-client-flatten": true + } + } + }, + "metadataPatch": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Metadata patch request body.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/metadataPropertiesPatch", + "description": "Metadata patch request body", + "x-ms-client-flatten": true + } + } + }, + "metadataContentId": { + "description": "Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId.", + "type": "string" + }, + "metadataParentId": { + "description": "Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group)", + "type": "string" + }, + "metadataVersion": { + "description": "Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks", + "type": "string" + }, + "metadataKind": { + "type": "string", + "description": "The kind of content the metadata is for." + }, + "metadataSource": { + "description": "The original source of the content item, where it comes from.", + "type": "object", + "required": [ + "kind" + ], + "properties": { + "kind": { + "description": "Source type of the content", + "type": "string", + "enum": [ + "LocalWorkspace", + "Community", + "Solution", + "SourceRepository" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "sourceKind", + "values": [ + { + "value": "LocalWorkspace" + }, + { + "value": "Community" + }, + { + "value": "Solution" + }, + { + "value": "SourceRepository" + } + ] + } + }, + "name": { + "description": "Name of the content source. The repo name, solution name, LA workspace name etc.", + "type": "string" + }, + "sourceId": { + "description": "ID of the content source. The solution ID, workspace ID, etc", + "type": "string" + } + } + }, + "metadataAuthor": { + "type": "object", + "description": "Publisher or creator of the content item.", + "properties": { + "name": { + "description": "Name of the author. Company or person.", + "type": "string" + }, + "email": { + "description": "Email of author contact", + "type": "string" + }, + "link": { + "description": "Link for author/vendor page", + "type": "string" + } + } + }, + "metadataSupport": { + "type": "object", + "description": "Support information for the content item.", + "required": [ + "tier" + ], + "properties": { + "tier": { + "description": "Type of support for content item", + "type": "string", + "enum": [ + "Microsoft", + "Partner", + "Community" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "supportTier", + "values": [ + { + "value": "Microsoft" + }, + { + "value": "Partner" + }, + { + "value": "Community" + } + ] + } + }, + "name": { + "description": "Name of the support contact. Company or person.", + "type": "string" + }, + "email": { + "description": "Email of support contact", + "type": "string" + }, + "link": { + "description": "Link for support help, like to support page to open a ticket etc.", + "type": "string" + } + } + }, + "metadataCategories": { + "type": "object", + "description": "ies for the solution content item", + "properties": { + "domains": { + "description": "domain for the solution content item", + "type": "array", + "example": [ + "str1", + "str2", + "str3" + ], + "items": { + "type": "string" + } + }, + "verticals": { + "description": "Industry verticals for the solution content item", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "str1", + "str2", + "str3" + ] + } + } + }, + "metadataProviders": { + "description": "Providers for the solution content item", + "type": "array", + "example": [ + "str1", + "str2", + "str3" + ], + "items": { + "type": "string" + } + }, + "firstPublishDate": { + "description": "first publish date of solution content item", + "type": "string", + "format": "date" + }, + "lastPublishDate": { + "description": "last publish date of solution content item", + "type": "string", + "format": "date" + }, + "metadataCustomVersion": { + "description": "The custom version of the content. A optional free text", + "type": "string" + }, + "metadataContentSchemaVersion": { + "description": "Schema version of the content. Can be used to distinguish between different flow based on the schema version", + "type": "string" + }, + "metadataIcon": { + "description": "the icon identifier. this id can later be fetched from the solution template", + "type": "string" + }, + "metadataThreatAnalysisTactics": { + "description": "the tactics the resource covers", + "type": "array", + "example": [ + "reconnaissance", + "exfiltration" + ], + "items": { + "type": "string" + } + }, + "metadataThreatAnalysisTechniques": { + "description": "the techniques the resource covers, these have to be aligned with the tactics being used", + "type": "array", + "example": [ + "T1548", + "T1548.001", + "T1134.003" + ], + "items": { + "type": "string" + } + }, + "metadataPreviewImages": { + "description": "preview image file names. These will be taken from the solution artifacts", + "type": "array", + "example": [ + "example.png", + "example2.jpeg" + ], + "items": { + "type": "string" + } + }, + "metadataPreviewImagesDark": { + "description": "preview image file names. These will be taken from the solution artifacts. used for dark theme support", + "type": "array", + "example": [ + "example.png", + "example2.jpeg" + ], + "items": { + "type": "string" + } + }, + "metadataProperties": { + "description": "Metadata property bag.", + "required": [ + "parentId", + "kind" + ], + "type": "object", + "properties": { + "contentId": { + "$ref": "#/definitions/metadataContentId", + "description": "Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Dynamic for user-created. This is the resource name" + }, + "parentId": { + "$ref": "#/definitions/metadataParentId", + "description": "Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group)" + }, + "version": { + "$ref": "#/definitions/metadataVersion", + "description": "Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks" + }, + "kind": { + "$ref": "#/definitions/metadataKind", + "description": "The kind of content the metadata is for." + }, + "source": { + "$ref": "#/definitions/metadataSource", + "description": "Source of the content. This is where/how it was created." + }, + "author": { + "$ref": "#/definitions/metadataAuthor", + "description": "The creator of the content item." + }, + "support": { + "$ref": "#/definitions/metadataSupport", + "description": "Support information for the metadata - type, name, contact information" + }, + "dependencies": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataDependencies", + "description": "Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex formats." + }, + "categories": { + "$ref": "#/definitions/metadataCategories", + "description": "Categories for the solution content item" + }, + "providers": { + "$ref": "#/definitions/metadataProviders", + "description": "Providers for the solution content item" + }, + "firstPublishDate": { + "$ref": "#/definitions/firstPublishDate", + "description": "first publish date solution content item" + }, + "lastPublishDate": { + "$ref": "#/definitions/lastPublishDate", + "description": "last publish date for the solution content item" + }, + "customVersion": { + "$ref": "#/definitions/metadataCustomVersion", + "description": "The custom version of the content. A optional free text" + }, + "contentSchemaVersion": { + "$ref": "#/definitions/metadataContentSchemaVersion", + "description": "Schema version of the content. Can be used to distinguish between different flow based on the schema version" + }, + "icon": { + "$ref": "#/definitions/metadataIcon", + "description": "the icon identifier. this id can later be fetched from the solution template" + }, + "threatAnalysisTactics": { + "$ref": "#/definitions/metadataThreatAnalysisTactics", + "description": "the tactics the resource covers" + }, + "threatAnalysisTechniques": { + "$ref": "#/definitions/metadataThreatAnalysisTechniques", + "description": "the techniques the resource covers, these have to be aligned with the tactics being used" + }, + "previewImages": { + "$ref": "#/definitions/metadataPreviewImages", + "description": "preview image file names. These will be taken from the solution artifacts" + }, + "previewImagesDark": { + "$ref": "#/definitions/metadataPreviewImagesDark", + "description": "preview image file names. These will be taken from the solution artifacts. used for dark theme support" + } + } + }, + "metadataPropertiesPatch": { + "description": "Metadata property bag for patch requests. This is the same as the MetadataProperties, but with nothing required", + "type": "object", + "properties": { + "contentId": { + "$ref": "#/definitions/metadataContentId", + "description": "Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Dynamic for user-created. This is the resource name" + }, + "parentId": { + "$ref": "#/definitions/metadataParentId", + "description": "Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group)" + }, + "version": { + "$ref": "#/definitions/metadataVersion", + "description": "Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks" + }, + "kind": { + "$ref": "#/definitions/metadataKind", + "description": "The kind of content the metadata is for." + }, + "source": { + "$ref": "#/definitions/metadataSource", + "description": "Source of the content. This is where/how it was created." + }, + "author": { + "$ref": "#/definitions/metadataAuthor", + "description": "The creator of the content item." + }, + "support": { + "$ref": "#/definitions/metadataSupport", + "description": "Support information for the metadata - type, name, contact information" + }, + "dependencies": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataDependencies", + "description": "Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex formats." + }, + "categories": { + "$ref": "#/definitions/metadataCategories", + "description": "Categories for the solution content item" + }, + "providers": { + "$ref": "#/definitions/metadataProviders", + "description": "Providers for the solution content item" + }, + "firstPublishDate": { + "$ref": "#/definitions/firstPublishDate", + "description": "first publish date solution content item" + }, + "lastPublishDate": { + "$ref": "#/definitions/lastPublishDate", + "description": "last publish date for the solution content item" + }, + "customVersion": { + "$ref": "#/definitions/metadataCustomVersion", + "description": "The custom version of the content. A optional free text" + }, + "contentSchemaVersion": { + "$ref": "#/definitions/metadataContentSchemaVersion", + "description": "Schema version of the content. Can be used to distinguish between different flow based on the schema version" + }, + "icon": { + "$ref": "#/definitions/metadataIcon", + "description": "the icon identifier. this id can later be fetched from the solution template" + }, + "threatAnalysisTactics": { + "$ref": "#/definitions/metadataThreatAnalysisTactics", + "description": "the tactics the resource covers" + }, + "threatAnalysisTechniques": { + "$ref": "#/definitions/metadataThreatAnalysisTechniques", + "description": "the techniques the resource covers, these have to be aligned with the tactics being used" + }, + "previewImages": { + "$ref": "#/definitions/metadataPreviewImages", + "description": "preview image file names. These will be taken from the solution artifacts" + }, + "previewImagesDark": { + "$ref": "#/definitions/metadataPreviewImagesDark", + "description": "preview image file names. These will be taken from the solution artifacts. used for dark theme support" + } + } + } + }, + "parameters": { + "Metadata": { + "description": "Metadata resource.", + "in": "body", + "name": "metadata", + "required": true, + "schema": { + "$ref": "#/definitions/MetadataModel" + }, + "x-ms-parameter-location": "method" + }, + "MetadataPatch": { + "description": "Partial metadata request.", + "in": "body", + "name": "metadataPatch", + "required": true, + "schema": { + "$ref": "#/definitions/metadataPatch" + }, + "x-ms-parameter-location": "method" + }, + "MetadataName": { + "description": "The Metadata name.", + "in": "path", + "name": "metadataName", + "required": true, + "pattern": "^\\S+$", + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/OfficeConsents.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/OfficeConsents.json new file mode 100644 index 000000000000..9e5610a9c55b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/OfficeConsents.json @@ -0,0 +1,234 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/officeConsents": { + "get": { + "x-ms-examples": { + "Get all office consents.": { + "$ref": "./examples/officeConsents/GetOfficeConsents.json" + } + }, + "tags": [ + "Office Consents" + ], + "description": "Gets all office365 consents.", + "operationId": "OfficeConsents_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfficeConsentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/officeConsents/{consentId}": { + "get": { + "x-ms-examples": { + "Get an office consent.": { + "$ref": "./examples/officeConsents/GetOfficeConsentsById.json" + } + }, + "tags": [ + "Office Consents" + ], + "description": "Gets an office365 consent.", + "operationId": "OfficeConsents_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ConsentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfficeConsent" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an office consent.": { + "$ref": "./examples/officeConsents/DeleteOfficeConsents.json" + } + }, + "tags": [ + "Office Consents" + ], + "description": "Delete the office365 consent.", + "operationId": "OfficeConsents_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ConsentId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "ConsentId": { + "description": "consent ID", + "in": "path", + "name": "consentId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "OfficeConsent": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "description": "Consent for Office365 tenant that already made.", + "properties": { + "properties": { + "$ref": "#/definitions/OfficeConsentProperties", + "description": "Office consent properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "OfficeConsentList": { + "description": "List of all the office365 consents.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of office consents.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of the consents.", + "items": { + "$ref": "#/definitions/OfficeConsent" + }, + "type": "array" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "OfficeConsentProperties": { + "description": "Consent property bag.", + "properties": { + "tenantId": { + "description": "The tenantId of the Office365 with the consent.", + "type": "string" + }, + "consentId": { + "description": "Help to easily cascade among the data layers.", + "type": "string" + } + }, + "type": "object" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/OnboardingStates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/OnboardingStates.json new file mode 100644 index 000000000000..3e468a3bb352 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/OnboardingStates.json @@ -0,0 +1,284 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/onboardingStates/{sentinelOnboardingStateName}": { + "get": { + "x-ms-examples": { + "Get Sentinel onboarding state": { + "$ref": "./examples/onboardingStates/GetSentinelOnboardingState.json" + } + }, + "tags": [ + "SentinelOnboardingStates" + ], + "description": "Get Sentinel onboarding state", + "operationId": "SentinelOnboardingStates_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SentinelOnboardingStateName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SentinelOnboardingState" + } + }, + "default": { + "description": "Error in getting the Sentinel onboarding state", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create Sentinel onboarding state": { + "$ref": "./examples/onboardingStates/CreateSentinelOnboardingState.json" + } + }, + "tags": [ + "SentinelOnboardingStates" + ], + "description": "Create Sentinel onboarding state", + "operationId": "SentinelOnboardingStates_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SentinelOnboardingStateName" + }, + { + "$ref": "#/parameters/SentinelOnboardingStateParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SentinelOnboardingState" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SentinelOnboardingState" + } + }, + "default": { + "description": "Error in creating the Sentinel onboarding state", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete Sentinel onboarding state": { + "$ref": "./examples/onboardingStates/DeleteSentinelOnboardingState.json" + } + }, + "tags": [ + "SentinelOnboardingStates" + ], + "description": "Delete Sentinel onboarding state", + "operationId": "SentinelOnboardingStates_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SentinelOnboardingStateName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error in deleting the Sentinel onboarding state", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/onboardingStates": { + "get": { + "x-ms-examples": { + "Get all Sentinel onboarding states": { + "$ref": "./examples/onboardingStates/GetAllSentinelOnboardingStates.json" + } + }, + "tags": [ + "SentinelOnboardingStates" + ], + "description": "Gets all Sentinel onboarding states", + "operationId": "SentinelOnboardingStates_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SentinelOnboardingStatesList" + } + }, + "default": { + "description": "Error in listing the Sentinel onboarding states", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "SentinelOnboardingStateProperties": { + "description": "The Sentinel onboarding state properties", + "type": "object", + "properties": { + "customerManagedKey": { + "description": "Flag that indicates the status of the CMK setting", + "type": "boolean" + } + } + }, + "SentinelOnboardingState": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Sentinel onboarding state", + "properties": { + "properties": { + "$ref": "#/definitions/SentinelOnboardingStateProperties", + "description": "The Sentinel onboarding state object", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "SentinelOnboardingStatesList": { + "description": "List of the Sentinel onboarding states", + "properties": { + "value": { + "description": "Array of Sentinel onboarding states", + "items": { + "$ref": "#/definitions/SentinelOnboardingState" + }, + "type": "array" + } + }, + "required": [ + "value" + ], + "type": "object" + } + }, + "parameters": { + "SentinelOnboardingStateName": { + "description": "The Sentinel onboarding state name. Supports - default", + "in": "path", + "name": "sentinelOnboardingStateName", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SentinelOnboardingStateParameter": { + "description": "The Sentinel onboarding state parameter", + "in": "body", + "name": "sentinelOnboardingStateParameter", + "required": false, + "schema": { + "$ref": "#/definitions/SentinelOnboardingState" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Recommendations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Recommendations.json new file mode 100644 index 000000000000..357061042c2c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Recommendations.json @@ -0,0 +1,452 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/recommendations": { + "get": { + "x-ms-examples": { + "Get Recommendations list.": { + "$ref": "./examples/recommendations/GetRecommendations.json" + } + }, + "tags": [ + "recommendations" + ], + "description": "Gets a list of all recommendations.", + "operationId": "GetRecommendations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecommendationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/recommendations/{recommendationId}": { + "get": { + "x-ms-examples": { + "Get a recommendation.": { + "$ref": "./examples/recommendations/GetRecommendation.json" + } + }, + "tags": [ + "recommendations" + ], + "description": "Gets a recommendation by its id.", + "operationId": "Get_SingleRecommendation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RecommendationId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Recommendation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "patch": { + "x-ms-examples": { + "Creates a recommendation.": { + "$ref": "./examples/recommendations/PatchRecommendation.json" + } + }, + "tags": [ + "recommendations" + ], + "description": "Patch a recommendation.", + "operationId": "Update_Recommendation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RecommendationId" + }, + { + "$ref": "#/parameters/RecommendationPatch" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Recommendation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/recommendations/{recommendationId}/triggerEvaluation": { + "post": { + "x-ms-examples": { + "Reevaluate a recommendation.": { + "$ref": "./examples/recommendations/ReevaluateRecommendation.json" + } + }, + "tags": [ + "recommendations" + ], + "description": "Reevaluate a recommendation.", + "operationId": "Reevaluate_Recommendation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RecommendationId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReevaluateResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "Recommendation": { + "type": "object", + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Recommendation object.", + "properties": { + "properties": { + "type": "object", + "$ref": "#/definitions/RecommendationProperties", + "x-ms-client-flatten": true + } + } + }, + "RecommendationProperties": { + "description": "Recommendation properties object.", + "properties": { + "recommendationTypeId": { + "description": "Id of the recommendation type.", + "type": "string" + }, + "state": { + "description": "State of the recommendation.", + "$ref": "#/definitions/RecommendationState" + }, + "title": { + "description": "Title of the recommendation.", + "type": "string" + }, + "description": { + "description": "Description of the recommendation.", + "type": "string" + }, + "creationTimeUtc": { + "description": "The time stamp (UTC) when the recommendation was created.", + "type": "string", + "format": "date-time" + }, + "lastEvaluatedTimeUtc": { + "description": "The time stamp (UTC) when the recommendation was last evaluated.", + "type": "string", + "format": "date-time" + }, + "lastModifiedTimeUtc": { + "description": "The time stamp (UTC) when the recommendation was last modified.", + "type": "string", + "format": "date-time" + }, + "suggestions": { + "description": "List of suggestions to take for this recommendation.", + "type": "array", + "items": { + "$ref": "#/definitions/RecommendedSuggestion" + }, + "x-ms-identifiers": [] + }, + "resourceId": { + "description": "Id of the resource this recommendation refers to.", + "type": "string", + "x-nullable": true + }, + "additionalProperties": { + "description": "Collection of additional properties for the recommendation.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-nullable": true + } + }, + "required": [ + "recommendationTypeId", + "state", + "title", + "description", + "creationTimeUtc", + "lastEvaluatedTimeUtc", + "lastModifiedTimeUtc", + "suggestions" + ], + "type": "object" + }, + "RecommendationList": { + "description": "A list of recommendations", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Recommendation" + }, + "description": "An list of recommendations" + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "RecommendedSuggestion": { + "description": "What suggestions should be taken to complete the recommendation.", + "properties": { + "suggestionTypeId": { + "description": "Id of the suggestion type.", + "type": "string" + }, + "title": { + "description": "Title of the suggestion.", + "type": "string" + }, + "description": { + "description": "Description of the suggestion.", + "type": "string" + }, + "action": { + "description": "Action of the suggestion.", + "type": "string" + }, + "additionalProperties": { + "description": "Collection of additional properties for the suggestion.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-nullable": true + } + }, + "required": [ + "suggestionTypeId", + "title", + "description", + "action" + ], + "type": "object" + }, + "RecommendationPatch": { + "description": "Recommendation Fields to update.", + "properties": { + "properties": { + "$ref": "#/definitions/RecommendationPatchProperties" + } + }, + "type": "object" + }, + "RecommendationPatchProperties": { + "description": "Recommendation Fields Properties to update.", + "properties": { + "state": { + "description": "State of the recommendation.", + "$ref": "#/definitions/RecommendationState" + } + }, + "type": "object" + }, + "RecommendationState": { + "description": "State of recommendation.", + "type": "string", + "enum": [ + "Active", + "InProgress", + "Dismissed", + "CompletedByUser", + "CompletedBySystem" + ], + "x-ms-enum": { + "name": "State", + "modelAsString": true, + "values": [ + { + "value": "Active", + "description": "Recommendation is active." + }, + { + "value": "InProgress", + "description": "Recommendation is in progress." + }, + { + "value": "Dismissed", + "description": "Recommendation has been dismissed." + }, + { + "value": "CompletedByUser", + "description": "Recommendation has been completed by user." + }, + { + "value": "CompletedBySystem", + "description": "Recommendation has been completed by the system." + } + ] + } + }, + "ReevaluateResponse": { + "description": "Reevaluate response object.", + "properties": { + "lastEvaluatedTimeUtc": { + "description": "The time stamp (UTC) when the recommendation was last evaluated.", + "type": "string", + "format": "date-time" + } + }, + "type": "object" + } + }, + "parameters": { + "RecommendationId": { + "description": "Recommendation Id.", + "in": "path", + "name": "recommendationId", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method" + }, + "RecommendationPatch": { + "description": "Recommendation Fields to Update.", + "in": "body", + "name": "recommendationPatch", + "required": true, + "schema": { + "type": "object", + "$ref": "#/definitions/RecommendationPatch", + "x-ms-identifiers": [] + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/SecurityMLAnalyticsSettings.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/SecurityMLAnalyticsSettings.json new file mode 100644 index 000000000000..d4cbd0478b24 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/SecurityMLAnalyticsSettings.json @@ -0,0 +1,444 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/securityMLAnalyticsSettings": { + "get": { + "x-ms-examples": { + "Get all Security ML Analytics Settings.": { + "$ref": "./examples/securityMLAnalyticsSettings/GetAllSecurityMLAnalyticsSettings.json" + } + }, + "tags": [ + "Security ML Analytics Settings" + ], + "description": "Gets all Security ML Analytics Settings.", + "operationId": "SecurityMLAnalyticsSettings_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityMLAnalyticsSettingsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/securityMLAnalyticsSettings/{settingsResourceName}": { + "get": { + "x-ms-examples": { + "Get a Anomaly Security ML Analytics Settings.": { + "$ref": "./examples/securityMLAnalyticsSettings/GetAnomalySecurityMLAnalyticsSetting.json" + } + }, + "tags": [ + "Security ML Analytics Settings" + ], + "description": "Gets the Security ML Analytics Settings.", + "operationId": "SecurityMLAnalyticsSettings_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SettingsResourceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityMLAnalyticsSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a Anomaly Security ML Analytics Settings.": { + "$ref": "./examples/securityMLAnalyticsSettings/CreateAnomalySecurityMLAnalyticsSetting.json" + } + }, + "tags": [ + "Security ML Analytics Settings" + ], + "description": "Creates or updates the Security ML Analytics Settings.", + "operationId": "SecurityMLAnalyticsSettings_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SettingsResourceName" + }, + { + "$ref": "#/parameters/SecurityMLAnalyticsSetting" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityMLAnalyticsSetting" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SecurityMLAnalyticsSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a Security ML Analytics Settings.": { + "$ref": "./examples/securityMLAnalyticsSettings/DeleteSecurityMLAnalyticsSetting.json" + } + }, + "tags": [ + "Security ML Analytics Settings" + ], + "description": "Delete the Security ML Analytics Settings.", + "operationId": "SecurityMLAnalyticsSettings_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SettingsResourceName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "SecurityMLAnalyticsSetting": { + "description": "The security ML Analytics setting", + "in": "body", + "name": "securityMLAnalyticsSetting", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityMLAnalyticsSetting" + }, + "x-ms-parameter-location": "method" + }, + "SettingsResourceName": { + "description": "Security ML Analytics Settings resource name", + "in": "path", + "name": "settingsResourceName", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "SecurityMLAnalyticsSetting": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Security ML Analytics Setting", + "properties": { + "kind": { + "$ref": "#/definitions/SecurityMLAnalyticsSettingsKindEnum", + "description": "The kind of security ML Analytics Settings" + } + }, + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] + }, + "SecurityMLAnalyticsSettingsKindEnum": { + "description": "The kind of security ML analytics settings", + "enum": [ + "Anomaly" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "SecurityMLAnalyticsSettingsKind", + "values": [ + { + "value": "Anomaly" + } + ] + } + }, + "SecurityMLAnalyticsSettingsList": { + "description": "List all the SecurityMLAnalyticsSettings", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of SecurityMLAnalyticsSettings.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of SecurityMLAnalyticsSettings", + "items": { + "$ref": "#/definitions/SecurityMLAnalyticsSetting" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "AnomalySecurityMLAnalyticsSettings": { + "allOf": [ + { + "$ref": "#/definitions/SecurityMLAnalyticsSetting" + } + ], + "description": "Represents Anomaly Security ML Analytics Settings", + "properties": { + "properties": { + "$ref": "#/definitions/AnomalySecurityMLAnalyticsSettingsProperties", + "description": "Anomaly Security ML Analytics Settings properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Anomaly" + }, + "AnomalySecurityMLAnalyticsSettingsProperties": { + "description": "AnomalySecurityMLAnalytics settings base property bag.", + "properties": { + "description": { + "description": "The description of the SecurityMLAnalyticsSettings.", + "type": "string" + }, + "displayName": { + "description": "The display name for settings created by this SecurityMLAnalyticsSettings.", + "type": "string" + }, + "enabled": { + "description": "Determines whether this settings is enabled or disabled.", + "type": "boolean" + }, + "lastModifiedUtc": { + "description": "The last time that this SecurityMLAnalyticsSettings has been modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "requiredDataConnectors": { + "description": "The required data sources for this SecurityMLAnalyticsSettings", + "items": { + "$ref": "#/definitions/SecurityMLAnalyticsSettingsDataSource" + }, + "x-ms-identifiers": [ + "connectorId" + ], + "type": "array" + }, + "tactics": { + "description": "The tactics of the SecurityMLAnalyticsSettings", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" + }, + "type": "array" + }, + "techniques": { + "description": "The techniques of the SecurityMLAnalyticsSettings", + "items": { + "type": "string" + }, + "type": "array" + }, + "anomalyVersion": { + "description": "The anomaly version of the AnomalySecurityMLAnalyticsSettings.", + "type": "string" + }, + "customizableObservations": { + "description": "The customizable observations of the AnomalySecurityMLAnalyticsSettings.", + "type": "object" + }, + "frequency": { + "description": "The frequency that this SecurityMLAnalyticsSettings will be run.", + "format": "duration", + "type": "string" + }, + "settingsStatus": { + "$ref": "#/definitions/AnomalySecurityMLAnalyticsSettingsStatus", + "description": "The anomaly SecurityMLAnalyticsSettings status" + }, + "isDefaultSettings": { + "description": "Determines whether this anomaly security ml analytics settings is a default settings", + "type": "boolean" + }, + "anomalySettingsVersion": { + "description": "The anomaly settings version of the Anomaly security ml analytics settings that dictates whether job version gets updated or not.", + "type": "integer", + "format": "int32" + }, + "settingsDefinitionId": { + "description": "The anomaly settings definition Id", + "format": "uuid", + "type": "string" + } + }, + "required": [ + "displayName", + "enabled", + "anomalyVersion", + "frequency", + "settingsStatus", + "isDefaultSettings" + ], + "type": "object" + }, + "SecurityMLAnalyticsSettingsDataSource": { + "description": "security ml analytics settings data sources", + "properties": { + "connectorId": { + "description": "The connector id that provides the following data types", + "type": "string" + }, + "dataTypes": { + "description": "The data types used by the security ml analytics settings", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AnomalySecurityMLAnalyticsSettingsStatus": { + "description": "The anomaly SecurityMLAnalyticsSettings status", + "enum": [ + "Production", + "Flighting" + ], + "type": "string", + "x-ms-enum": { + "name": "SettingsStatus", + "modelAsString": true, + "values": [ + { + "description": "Anomaly settings status in Production mode", + "value": "Production" + }, + { + "description": "Anomaly settings status in Flighting mode", + "value": "Flighting" + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Settings.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Settings.json new file mode 100644 index 000000000000..56749cb682fc --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Settings.json @@ -0,0 +1,438 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/settings": { + "get": { + "x-ms-examples": { + "Get all settings.": { + "$ref": "./examples/settings/GetAllSettings.json" + } + }, + "tags": [ + "Settings" + ], + "description": "List of all the settings", + "operationId": "ProductSettings_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SettingList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/settings/{settingsName}": { + "get": { + "x-ms-examples": { + "Get EyesOn settings.": { + "$ref": "./examples/settings/GetEyesOnSetting.json" + } + }, + "tags": [ + "Settings" + ], + "description": "Gets a setting.", + "operationId": "ProductSettings_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SettingsName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Settings" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete EyesOn settings.": { + "$ref": "./examples/settings/DeleteEyesOnSetting.json" + } + }, + "tags": [ + "Settings" + ], + "description": "Delete setting of the product.", + "operationId": "ProductSettings_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SettingsName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Update EyesOn settings.": { + "$ref": "./examples/settings/UpdateEyesOnSetting.json" + } + }, + "tags": [ + "Settings" + ], + "description": "Updates setting.", + "operationId": "ProductSettings_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SettingsName" + }, + { + "$ref": "#/parameters/Settings" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Settings" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Settings" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "SettingList": { + "description": "List of all the settings.", + "properties": { + "value": { + "description": "Array of settings.", + "items": { + "$ref": "#/definitions/Settings" + }, + "type": "array" + }, + "nextLink": { + "description": "URL to fetch the next set of settings.", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "Settings": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "The Setting.", + "properties": { + "kind": { + "description": "The kind of the setting", + "enum": [ + "Anomalies", + "EyesOn", + "EntityAnalytics", + "Ueba" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "SettingKind" + } + } + }, + "required": [ + "kind" + ], + "discriminator": "kind", + "type": "object" + }, + "Anomalies": { + "allOf": [ + { + "$ref": "#/definitions/Settings" + } + ], + "description": "Settings with single toggle.", + "properties": { + "properties": { + "$ref": "#/definitions/AnomaliesSettingsProperties", + "description": "Anomalies properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Anomalies" + }, + "AnomaliesSettingsProperties": { + "description": "Anomalies property bag.", + "properties": { + "isEnabled": { + "description": "Determines whether the setting is enable or disabled.", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, + "EyesOn": { + "allOf": [ + { + "$ref": "#/definitions/Settings" + } + ], + "description": "Settings with single toggle.", + "properties": { + "properties": { + "$ref": "#/definitions/EyesOnSettingsProperties", + "description": "EyesOn properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "EyesOn" + }, + "EyesOnSettingsProperties": { + "description": "EyesOn property bag.", + "properties": { + "isEnabled": { + "description": "Determines whether the setting is enable or disabled.", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, + "EntityAnalytics": { + "allOf": [ + { + "$ref": "#/definitions/Settings" + } + ], + "description": "Settings with single toggle.", + "properties": { + "properties": { + "$ref": "#/definitions/EntityAnalyticsProperties", + "description": "EntityAnalytics properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "EntityAnalytics" + }, + "EntityAnalyticsProperties": { + "description": "EntityAnalytics property bag.", + "properties": { + "entityProviders": { + "description": "The relevant entity providers that are synced", + "items": { + "$ref": "#/definitions/EntityProviders" + }, + "type": "array" + } + }, + "type": "object" + }, + "EntityProviders": { + "description": "The entity provider that is synced.", + "enum": [ + "ActiveDirectory", + "AzureActiveDirectory" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EntityProviders" + } + }, + "Ueba": { + "allOf": [ + { + "$ref": "#/definitions/Settings" + } + ], + "description": "Settings with single toggle.", + "properties": { + "properties": { + "$ref": "#/definitions/UebaProperties", + "description": "Ueba properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Ueba" + }, + "UebaProperties": { + "description": "Ueba property bag.", + "properties": { + "dataSources": { + "description": "The relevant data sources that enriched by ueba", + "items": { + "$ref": "#/definitions/UebaDataSources" + }, + "type": "array" + } + }, + "type": "object" + }, + "UebaDataSources": { + "description": "The data source that enriched by ueba.", + "enum": [ + "AuditLogs", + "AzureActivity", + "SecurityEvent", + "SigninLogs" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "UebaDataSources" + } + } + }, + "parameters": { + "Settings": { + "description": "The setting", + "in": "body", + "name": "settings", + "required": true, + "schema": { + "$ref": "#/definitions/Settings" + }, + "x-ms-parameter-location": "method" + }, + "SettingsName": { + "description": "The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba", + "in": "path", + "name": "settingsName", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z][a-zA-Z0-9]*$" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/SourceControls.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/SourceControls.json new file mode 100644 index 000000000000..289fad4ab71c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/SourceControls.json @@ -0,0 +1,1005 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/listRepositories": { + "post": { + "x-ms-examples": { + "Get repository list.": { + "$ref": "./examples/repositories/GetRepositories.json" + } + }, + "tags": [ + "Repositories" + ], + "description": "Gets a list of repositories metadata.", + "operationId": "SourceControl_listRepositories", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RepositoryAccess" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RepoList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/sourcecontrols": { + "get": { + "x-ms-examples": { + "Get all source controls.": { + "$ref": "./examples/sourcecontrols/GetSourceControls.json" + } + }, + "tags": [ + "SourceControls" + ], + "description": "Gets all source controls, without source control items.", + "operationId": "SourceControls_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SourceControlList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/sourcecontrols/{sourceControlId}": { + "get": { + "x-ms-examples": { + "Get a source control.": { + "$ref": "./examples/sourcecontrols/GetSourceControlById.json" + } + }, + "tags": [ + "SourceControls" + ], + "description": "Gets a source control byt its identifier.", + "operationId": "SourceControls_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SourceControlIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SourceControl" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a source control.": { + "$ref": "./examples/sourcecontrols/CreateSourceControl.json" + } + }, + "tags": [ + "SourceControls" + ], + "description": "Creates a source control.", + "operationId": "SourceControls_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SourceControlIdParameter" + }, + { + "$ref": "#/parameters/SourceControl" + } + ], + "responses": { + "200": { + "description": "Updated", + "schema": { + "$ref": "#/definitions/SourceControl" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SourceControl" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/sourcecontrols/{sourceControlId}/delete": { + "post": { + "x-ms-examples": { + "Delete a source control.": { + "$ref": "./examples/sourcecontrols/DeleteSourceControl.json" + } + }, + "tags": [ + "SourceControls" + ], + "description": "Delete a source control.", + "operationId": "SourceControls_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SourceControlIdParameter" + }, + { + "$ref": "#/parameters/RepositoryAccess" + } + ], + "responses": { + "200": { + "description": "Source control deleted.", + "schema": { + "$ref": "#/definitions/Warning" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "RepoList": { + "description": "List all the source controls.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of repositories.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of repositories.", + "items": { + "$ref": "#/definitions/Repo" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "Repo": { + "description": "Represents a repository.", + "properties": { + "url": { + "description": "The url to access the repository.", + "type": "string" + }, + "fullName": { + "description": "The name of the repository.", + "type": "string" + }, + "installationId": { + "description": "The installation id of the repository.", + "type": "integer", + "format": "int64" + }, + "branches": { + "description": "Array of branches.", + "items": { + "description": "name of branch.", + "type": "string" + }, + "type": "array" + } + }, + "x-ms-azure-resource": false, + "type": "object" + }, + "SourceControlList": { + "description": "List all the source controls.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of source controls.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of source controls.", + "items": { + "$ref": "#/definitions/SourceControl" + }, + "type": "array" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "SourceControl": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a SourceControl in Azure Security Insights.", + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "source control properties", + "$ref": "#/definitions/SourceControlProperties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "SourceControlProperties": { + "description": "Describes source control properties", + "properties": { + "id": { + "description": "The id (a Guid) of the source control", + "type": "string", + "readOnly": true + }, + "version": { + "$ref": "#/definitions/Version", + "description": "The version number associated with the source control", + "type": "string" + }, + "displayName": { + "description": "The display name of the source control", + "type": "string" + }, + "description": { + "description": "A description of the source control", + "type": "string" + }, + "repoType": { + "$ref": "#/definitions/RepoType", + "description": "The repository type of the source control", + "type": "string" + }, + "contentTypes": { + "description": "Array of source control content types.", + "items": { + "$ref": "#/definitions/ContentType" + }, + "type": "array" + }, + "repository": { + "description": "Repository metadata.", + "$ref": "#/definitions/Repository" + }, + "servicePrincipal": { + "description": "Service principal metadata.", + "$ref": "#/definitions/ServicePrincipal" + }, + "repositoryAccess": { + "description": "Repository access credentials. This is write-only object and it never returns back to a user.", + "x-ms-mutability": [ + "create", + "update" + ], + "$ref": "#/definitions/RepositoryAccess" + }, + "repositoryResourceInfo": { + "description": "Information regarding the resources created in user's repository.", + "$ref": "#/definitions/RepositoryResourceInfo" + }, + "lastDeploymentInfo": { + "description": "Information regarding the latest deployment for the source control.", + "$ref": "#/definitions/DeploymentInfo" + }, + "pullRequest": { + "description": "Information regarding the pull request of the source control.", + "$ref": "#/definitions/PullRequest" + } + }, + "required": [ + "displayName", + "repoType", + "contentTypes", + "repository" + ], + "type": "object" + }, + "RepositoryAccess": { + "type": "object", + "description": "Credentials to access repository.", + "required": [ + "kind" + ], + "properties": { + "kind": { + "description": "The kind of repository access credentials", + "$ref": "#/definitions/RepositoryAccessKind" + }, + "code": { + "x-ms-secret": true, + "type": "string", + "description": "OAuth Code. Required when `kind` is `OAuth`" + }, + "state": { + "x-ms-secret": true, + "type": "string", + "description": "OAuth State. Required when `kind` is `OAuth`" + }, + "clientId": { + "type": "string", + "description": "OAuth ClientId. Required when `kind` is `OAuth`" + }, + "token": { + "x-ms-secret": true, + "type": "string", + "description": "Personal Access Token. Required when `kind` is `PAT`" + }, + "installationId": { + "type": "string", + "description": "Application installation ID. Required when `kind` is `App`. Supported by `GitHub` only." + } + } + }, + "RepositoryAccessObject": { + "description": "Credentials to access repository.", + "type": "object", + "required": [ + "repositoryAccess" + ], + "properties": { + "repositoryAccess": { + "description": "RepositoryAccess properties", + "$ref": "#/definitions/RepositoryAccess", + "x-ms-client-flatten": true + } + } + }, + "RepositoryAccessProperties": { + "description": "Credentials to access repository.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "RepositoryAccess properties", + "$ref": "#/definitions/RepositoryAccessObject", + "x-ms-client-flatten": true + } + } + }, + "Repository": { + "type": "object", + "required": [ + "url", + "branch" + ], + "description": "metadata of a repository.", + "properties": { + "url": { + "description": "Url of repository.", + "type": "string" + }, + "branch": { + "description": "Branch name of repository.", + "type": "string" + }, + "displayUrl": { + "description": "Display url of repository.", + "type": "string" + }, + "deploymentLogsUrl": { + "description": "Url to access repository action logs.", + "type": "string", + "readOnly": true + } + } + }, + "ServicePrincipal": { + "type": "object", + "description": "Service principal metadata.", + "properties": { + "id": { + "description": "Id of service principal.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Tenant id of service principal.", + "type": "string", + "readOnly": true + }, + "appId": { + "description": "App id of service principal.", + "type": "string", + "readOnly": true + }, + "credentialsExpireOn": { + "format": "date-time", + "description": "Expiration time of service principal credentials.", + "type": "string" + } + } + }, + "RepositoryResourceInfo": { + "type": "object", + "description": "Resources created in user's repository for the source-control.", + "properties": { + "webhook": { + "type": "object", + "description": "The webhook object created for the source-control.", + "$ref": "#/definitions/Webhook" + }, + "gitHubResourceInfo": { + "type": "object", + "description": "Resources created in GitHub for this source-control.", + "$ref": "#/definitions/GitHubResourceInfo" + }, + "azureDevOpsResourceInfo": { + "type": "object", + "description": "Resources created in Azure DevOps for this source-control.", + "$ref": "#/definitions/AzureDevOpsResourceInfo" + } + } + }, + "Webhook": { + "description": "Detail about the webhook object.", + "type": "object", + "properties": { + "webhookId": { + "description": "Unique identifier for the webhook.", + "type": "string", + "readOnly": true + }, + "webhookUrl": { + "description": "URL that gets invoked by the webhook.", + "type": "string", + "readOnly": true + }, + "webhookSecretUpdateTime": { + "format": "date-time", + "description": "Time when the webhook secret was updated.", + "type": "string", + "readOnly": true + }, + "rotateWebhookSecret": { + "description": "A flag to instruct the backend service to rotate webhook secret.", + "type": "boolean" + } + } + }, + "GitHubResourceInfo": { + "readOnly": true, + "description": "Resources created in GitHub repository.", + "type": "object", + "properties": { + "appInstallationId": { + "description": "GitHub application installation id.", + "type": "string" + } + } + }, + "AzureDevOpsResourceInfo": { + "readOnly": true, + "description": "Resources created in Azure DevOps repository.", + "type": "object", + "properties": { + "pipelineId": { + "description": "Id of the pipeline created for the source-control.", + "type": "string" + }, + "serviceConnectionId": { + "description": "Id of the service-connection created for the source-control.", + "type": "string" + } + } + }, + "DeploymentInfo": { + "readOnly": true, + "description": "Information regarding a deployment.", + "type": "object", + "properties": { + "deploymentFetchStatus": { + "$ref": "#/definitions/DeploymentFetchStatus", + "description": "Status while fetching the last deployment.", + "type": "string" + }, + "deployment": { + "$ref": "#/definitions/Deployment", + "description": "Deployment information.", + "type": "object" + }, + "message": { + "description": "Additional details about the deployment that can be shown to the user.", + "type": "string" + } + } + }, + "Deployment": { + "description": "Description about a deployment.", + "type": "object", + "properties": { + "deploymentId": { + "description": "Deployment identifier.", + "type": "string" + }, + "deploymentState": { + "$ref": "#/definitions/DeploymentState", + "description": "Current status of the deployment.", + "type": "string" + }, + "deploymentResult": { + "$ref": "#/definitions/DeploymentResult", + "description": "The outcome of the deployment.", + "type": "string" + }, + "deploymentTime": { + "format": "date-time", + "description": "The time when the deployment finished.", + "type": "string" + }, + "deploymentLogsUrl": { + "description": "Url to access repository action logs.", + "type": "string" + } + } + }, + "ContentType": { + "description": "The content type of a source control path.", + "enum": [ + "AnalyticRule", + "AutomationRule", + "HuntingQuery", + "Parser", + "Playbook", + "Workbook" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ContentType", + "values": [ + { + "value": "AnalyticRule" + }, + { + "value": "AutomationRule" + }, + { + "value": "HuntingQuery" + }, + { + "value": "Parser" + }, + { + "value": "Playbook" + }, + { + "value": "Workbook" + } + ] + } + }, + "RepoType": { + "description": "The type of repository.", + "enum": [ + "Github", + "AzureDevOps" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RepoType", + "values": [ + { + "value": "Github" + }, + { + "value": "AzureDevOps" + } + ] + } + }, + "RepositoryAccessKind": { + "description": "The kind of repository access credentials", + "enum": [ + "OAuth", + "PAT", + "App" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RepositoryAccessKind", + "values": [ + { + "value": "OAuth" + }, + { + "value": "PAT" + }, + { + "value": "App" + } + ] + } + }, + "Version": { + "readOnly": true, + "description": "The version of the source control.", + "enum": [ + "V1", + "V2" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "Version", + "values": [ + { + "value": "V1" + }, + { + "value": "V2" + } + ] + } + }, + "DeploymentFetchStatus": { + "description": "Status while trying to fetch the deployment information.", + "enum": [ + "Success", + "Unauthorized", + "NotFound" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DeploymentFetchStatus", + "values": [ + { + "value": "Success" + }, + { + "value": "Unauthorized" + }, + { + "value": "NotFound" + } + ] + } + }, + "DeploymentState": { + "description": "The current state of the deployment.", + "enum": [ + "In_Progress", + "Completed", + "Queued", + "Canceling" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DeploymentState", + "values": [ + { + "value": "In_Progress" + }, + { + "value": "Completed" + }, + { + "value": "Queued" + }, + { + "value": "Canceling" + } + ] + } + }, + "DeploymentResult": { + "description": "Status while trying to fetch the deployment information.", + "enum": [ + "Success", + "Canceled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DeploymentResult", + "values": [ + { + "value": "Success" + }, + { + "value": "Canceled" + }, + { + "value": "Failed" + } + ] + } + }, + "PullRequest": { + "readOnly": true, + "description": "Information regarding pull request for protected branches.", + "type": "object", + "properties": { + "url": { + "description": "URL of pull request", + "type": "string", + "readOnly": true + }, + "state": { + "$ref": "#/definitions/PullRequestState", + "description": "State of the pull request", + "type": "object", + "readOnly": true + } + } + }, + "PullRequestState": { + "description": "Status of the pull request.", + "enum": [ + "Open", + "Closed" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "state", + "values": [ + { + "value": "Open" + }, + { + "value": "Closed" + } + ] + } + }, + "Warning": { + "description": "Warning response structure.", + "properties": { + "warning": { + "$ref": "#/definitions/WarningBody", + "description": "Warning data." + } + }, + "type": "object" + }, + "WarningBody": { + "readOnly": true, + "description": "Warning details.", + "properties": { + "code": { + "description": "An identifier for the warning. Codes are invariant and are intended to be consumed programmatically.", + "readOnly": true, + "type": "object", + "$ref": "#/definitions/WarningCode" + }, + "message": { + "description": "A message describing the warning, intended to be suitable for display in a user interface.", + "readOnly": true, + "type": "string" + }, + "details": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/WarningBody" + }, + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "WarningCode": { + "readOnly": true, + "description": "The type of repository.", + "enum": [ + "SourceControlWarning_DeleteServicePrincipal", + "SourceControlWarning_DeletePipelineFromAzureDevOps", + "SourceControlWarning_DeleteWorkflowAndSecretFromGitHub", + "SourceControlWarning_DeleteRoleAssignment", + "SourceControl_DeletedWithWarnings" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "WarningCode", + "values": [ + { + "value": "SourceControlWarning_DeleteServicePrincipal" + }, + { + "value": "SourceControlWarning_DeletePipelineFromAzureDevOps" + }, + { + "value": "SourceControlWarning_DeleteWorkflowAndSecretFromGitHub" + }, + { + "value": "SourceControlWarning_DeleteRoleAssignment" + }, + { + "value": "SourceControl_DeletedWithWarnings" + } + ] + } + } + }, + "parameters": { + "RepoTypeParameter": { + "description": "The repo type.", + "in": "body", + "name": "repoType", + "required": true, + "schema": { + "$ref": "#/definitions/RepoType" + }, + "x-ms-parameter-location": "method" + }, + "SourceControlIdParameter": { + "description": "Source control Id", + "in": "path", + "name": "sourceControlId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SourceControl": { + "description": "The SourceControl", + "in": "body", + "name": "sourceControl", + "required": true, + "schema": { + "$ref": "#/definitions/SourceControl" + }, + "x-ms-parameter-location": "method" + }, + "RepositoryAccess": { + "description": "The repository access credentials.", + "in": "body", + "name": "repositoryAccess", + "required": true, + "schema": { + "required": [ + "repositoryAccess" + ], + "$ref": "#/definitions/RepositoryAccessProperties" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ThreatIntelligence.json new file mode 100644 index 000000000000..5c0c231c0499 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ThreatIntelligence.json @@ -0,0 +1,1097 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/createIndicator": { + "post": { + "x-ms-examples": { + "Create a new Threat Intelligence": { + "$ref": "./examples/threatintelligence/CreateThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Create a new threat intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_CreateIndicator", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceProperties" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed to create indicators.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators": { + "get": { + "x-ms-examples": { + "Get all threat intelligence indicators": { + "$ref": "./examples/threatintelligence/GetThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Get all threat intelligence indicators.", + "operationId": "ThreatIntelligenceIndicators_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformationList" + } + }, + "default": { + "description": "Error response describing why the operation failed to get indicators.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}": { + "get": { + "x-ms-examples": { + "View a threat intelligence indicator by name": { + "$ref": "./examples/threatintelligence/GetThreatIntelligenceById.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "View a threat intelligence indicator by name.", + "operationId": "ThreatIntelligenceIndicator_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed to view an indicator.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Update a threat Intelligence indicator": { + "$ref": "./examples/threatintelligence/UpdateThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Update a threat Intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceProperties" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed to update an indicator.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a threat intelligence indicator": { + "$ref": "./examples/threatintelligence/DeleteThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Delete a threat intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed to delete an indicator.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/queryIndicators": { + "post": { + "x-ms-examples": { + "Query threat intelligence indicators as per filtering criteria": { + "$ref": "./examples/threatintelligence/QueryThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Query threat intelligence indicators as per filtering criteria.", + "operationId": "ThreatIntelligenceIndicator_QueryIndicators", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceFilteringCriteria" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/metrics": { + "get": { + "x-ms-examples": { + "Get threat intelligence indicators metrics.": { + "$ref": "./examples/threatintelligence/CollectThreatIntelligenceMetrics.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Get threat intelligence indicators metrics (Indicators counts by Type, Threat Type, Source).", + "operationId": "ThreatIntelligenceIndicatorMetrics_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceMetricsList" + } + }, + "default": { + "description": "Error response describing why the operation failed to get metrics.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}/appendTags": { + "post": { + "x-ms-examples": { + "Append tags to a threat intelligence indicator": { + "$ref": "./examples/threatintelligence/AppendTagsThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Append tags to a threat intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_AppendTags", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceAppendTags" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed to append tags.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}/replaceTags": { + "post": { + "x-ms-examples": { + "Replace tags to a Threat Intelligence": { + "$ref": "./examples/threatintelligence/ReplaceTagsThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Replace tags added to a threat intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_ReplaceTags", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceReplaceTags" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed to replace tags.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "ThreatIntelligenceName": { + "description": "Threat intelligence indicator name field.", + "in": "path", + "name": "name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceProperties": { + "description": "Properties of threat intelligence indicators to create and update.", + "in": "body", + "name": "ThreatIntelligenceProperties", + "required": true, + "schema": { + "$ref": "#/definitions/ThreatIntelligenceIndicatorModel" + }, + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceReplaceTags": { + "description": "Tags in the threat intelligence indicator to be replaced.", + "in": "body", + "name": "ThreatIntelligenceReplaceTags", + "required": true, + "schema": { + "$ref": "#/definitions/ThreatIntelligenceIndicatorModel" + }, + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceFilteringCriteria": { + "description": "Filtering criteria for querying threat intelligence indicators.", + "in": "body", + "name": "ThreatIntelligenceFilteringCriteria", + "required": true, + "schema": { + "$ref": "#/definitions/ThreatIntelligenceFilteringCriteria" + }, + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceIndicatorEntityKind": { + "description": "The threat intelligence entity kind", + "in": "query", + "name": "ctiEntityKind", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceAppendTags": { + "description": "The threat intelligence append tags request body", + "in": "body", + "name": "ThreatIntelligenceAppendTags", + "required": true, + "schema": { + "$ref": "#/definitions/ThreatIntelligenceAppendTags" + }, + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "ThreatIntelligenceInformationList": { + "description": "List of all the threat intelligence information objects.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of information objects.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of threat intelligence information objects.", + "items": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "ThreatIntelligenceInformation": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Threat intelligence information object.", + "properties": { + "kind": { + "$ref": "#/definitions/ThreatIntelligenceResourceInnerKind", + "description": "The kind of the entity." + } + }, + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] + }, + "ThreatIntelligenceIndicatorModel": { + "allOf": [ + { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + ], + "description": "Threat intelligence indicator entity.", + "properties": { + "properties": { + "$ref": "#/definitions/ThreatIntelligenceIndicatorProperties", + "description": "Threat Intelligence Entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "indicator" + }, + "ThreatIntelligenceResourceInnerKind": { + "description": "The kind of the threat intelligence entity", + "enum": [ + "indicator" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ThreatIntelligenceResourceInnerKind", + "values": [ + { + "description": "Entity represents threat intelligence indicator in the system.", + "value": "indicator" + } + ] + } + }, + "ThreatIntelligenceIndicatorProperties": { + "allOf": [ + { + "$ref": "./common/EntityTypes.json#/definitions/EntityCommonProperties" + } + ], + "description": "Describes threat intelligence entity properties", + "properties": { + "threatIntelligenceTags": { + "description": "List of tags", + "items": { + "description": "tag", + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "lastUpdatedTimeUtc": { + "description": "Last updated time in UTC", + "type": "string" + }, + "source": { + "description": "Source of a threat intelligence entity", + "type": "string" + }, + "displayName": { + "description": "Display name of a threat intelligence entity", + "type": "string" + }, + "description": { + "description": "Description of a threat intelligence entity", + "type": "string" + }, + "indicatorTypes": { + "description": "Indicator types of threat intelligence entities", + "items": { + "description": "Indicator type of a threat intelligence entity", + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "pattern": { + "description": "Pattern of a threat intelligence entity", + "type": "string" + }, + "patternType": { + "description": "Pattern type of a threat intelligence entity", + "type": "string" + }, + "patternVersion": { + "description": "Pattern version of a threat intelligence entity", + "type": "string" + }, + "killChainPhases": { + "description": "Kill chain phases", + "items": { + "description": "Kill chain phase", + "$ref": "#/definitions/ThreatIntelligenceKillChainPhase" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "parsedPattern": { + "description": "Parsed patterns", + "items": { + "description": "Parsed pattern", + "$ref": "#/definitions/ThreatIntelligenceParsedPattern" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "externalId": { + "description": "External ID of threat intelligence entity", + "type": "string" + }, + "createdByRef": { + "description": "Created by reference of threat intelligence entity", + "type": "string" + }, + "defanged": { + "description": "Is threat intelligence entity defanged", + "type": "boolean" + }, + "externalLastUpdatedTimeUtc": { + "description": "External last updated time in UTC", + "type": "string" + }, + "externalReferences": { + "description": "External References", + "items": { + "description": "external_reference", + "$ref": "#/definitions/ThreatIntelligenceExternalReference" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "granularMarkings": { + "description": "Granular Markings", + "items": { + "description": "Granular marking", + "$ref": "#/definitions/ThreatIntelligenceGranularMarkingModel" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "labels": { + "description": "Labels of threat intelligence entity", + "items": { + "description": "label", + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "revoked": { + "description": "Is threat intelligence entity revoked", + "type": "boolean" + }, + "confidence": { + "description": "Confidence of threat intelligence entity", + "type": "integer", + "format": "int32" + }, + "objectMarkingRefs": { + "description": "Threat intelligence entity object marking references", + "items": { + "description": "Threat intelligence entity object marking reference", + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "language": { + "description": "Language of threat intelligence entity", + "type": "string" + }, + "threatTypes": { + "description": "Threat types", + "items": { + "description": "Threat type", + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "validFrom": { + "description": "Valid from", + "type": "string" + }, + "validUntil": { + "description": "Valid until", + "type": "string" + }, + "created": { + "description": "Created by", + "type": "string" + }, + "modified": { + "description": "Modified by", + "type": "string" + }, + "extensions": { + "description": "Extensions map", + "type": "object", + "additionalProperties": {} + } + }, + "type": "object" + }, + "ThreatIntelligenceKillChainPhase": { + "description": "Describes threat kill chain phase entity", + "properties": { + "killChainName": { + "description": "Kill chainName name", + "type": "string" + }, + "phaseName": { + "description": "Phase name", + "type": "string" + } + }, + "type": "object" + }, + "ThreatIntelligenceParsedPattern": { + "description": "Describes parsed pattern entity", + "properties": { + "patternTypeKey": { + "description": "Pattern type key", + "type": "string" + }, + "patternTypeValues": { + "description": "Pattern type keys", + "items": { + "description": "Pattern type key", + "$ref": "#/definitions/ThreatIntelligenceParsedPatternTypeValue" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "ThreatIntelligenceParsedPatternTypeValue": { + "description": "Describes threat kill chain phase entity", + "properties": { + "valueType": { + "description": "Type of the value", + "type": "string" + }, + "value": { + "description": "Value of parsed pattern", + "type": "string" + } + }, + "type": "object" + }, + "ThreatIntelligenceGranularMarkingModel": { + "description": "Describes threat granular marking model entity", + "properties": { + "language": { + "description": "Language granular marking model", + "type": "string" + }, + "markingRef": { + "description": "marking reference granular marking model", + "type": "integer", + "format": "int32" + }, + "selectors": { + "description": "granular marking model selectors", + "items": { + "description": "granular marking model selector", + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "ThreatIntelligenceExternalReference": { + "description": "Describes external reference", + "properties": { + "description": { + "description": "External reference description", + "type": "string" + }, + "externalId": { + "description": "External reference ID", + "type": "string" + }, + "sourceName": { + "description": "External reference source name", + "type": "string" + }, + "url": { + "description": "External reference URL", + "type": "string" + }, + "hashes": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "External reference hashes" + } + }, + "type": "object" + }, + "ThreatIntelligenceFilteringCriteria": { + "description": "Filtering criteria for querying threat intelligence indicators.", + "properties": { + "pageSize": { + "description": "Page size", + "type": "integer", + "format": "int32" + }, + "minConfidence": { + "description": "Minimum confidence.", + "type": "integer", + "format": "int32" + }, + "maxConfidence": { + "description": "Maximum confidence.", + "type": "integer", + "format": "int32" + }, + "minValidUntil": { + "description": "Start time for ValidUntil filter.", + "type": "string" + }, + "maxValidUntil": { + "description": "End time for ValidUntil filter.", + "type": "string" + }, + "includeDisabled": { + "description": "Parameter to include/exclude disabled indicators.", + "type": "boolean" + }, + "sortBy": { + "description": "Columns to sort by and sorting order", + "items": { + "description": "Sort By", + "$ref": "#/definitions/ThreatIntelligenceSortingCriteria" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "sources": { + "description": "Sources of threat intelligence indicators", + "items": { + "description": "Source", + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "patternTypes": { + "description": "Pattern types", + "items": { + "description": "Pattern type", + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "threatTypes": { + "description": "Threat types of threat intelligence indicators", + "items": { + "description": "Threat type of a threat intelligence indicator", + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "ids": { + "description": "Ids of threat intelligence indicators", + "items": { + "description": "Id of a threat intelligence indicator", + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "keywords": { + "description": "Keywords for searching threat intelligence indicators", + "items": { + "description": "keyword for searching threat intelligence indicators", + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "skipToken": { + "description": "Skip token.", + "type": "string" + } + }, + "type": "object" + }, + "ThreatIntelligenceSortingCriteria": { + "description": "List of available columns for sorting", + "properties": { + "itemKey": { + "description": "Column name", + "type": "string" + }, + "sortOrder": { + "$ref": "#/definitions/ThreatIntelligenceSortingOrder", + "description": "Sorting order (ascending/descending/unsorted)." + } + }, + "type": "object" + }, + "ThreatIntelligenceSortingOrder": { + "description": "Sorting order (ascending/descending/unsorted).", + "enum": [ + "unsorted", + "ascending", + "descending" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ThreatIntelligenceSortingOrder", + "values": [ + { + "value": "unsorted" + }, + { + "value": "ascending" + }, + { + "value": "descending" + } + ] + } + }, + "ThreatIntelligenceAppendTags": { + "description": "Array of tags to be appended to the threat intelligence indicator.", + "properties": { + "threatIntelligenceTags": { + "description": "List of tags to be appended.", + "items": { + "description": "parameter", + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "ThreatIntelligenceMetricsList": { + "description": "List of all the threat intelligence metric fields (type/threat type/source).", + "properties": { + "value": { + "description": "Array of threat intelligence metric fields (type/threat type/source).", + "items": { + "$ref": "#/definitions/ThreatIntelligenceMetrics" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "ThreatIntelligenceMetrics": { + "description": "Threat intelligence metrics.", + "properties": { + "properties": { + "description": "Threat intelligence metrics.", + "$ref": "#/definitions/ThreatIntelligenceMetric" + } + }, + "type": "object" + }, + "ThreatIntelligenceMetric": { + "description": "Describes threat intelligence metric", + "properties": { + "lastUpdatedTimeUtc": { + "description": "Last updated indicator metric", + "type": "string" + }, + "threatTypeMetrics": { + "description": "Threat type metrics", + "items": { + "description": "parameter", + "$ref": "#/definitions/ThreatIntelligenceMetricEntity" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "patternTypeMetrics": { + "description": "Pattern type metrics", + "items": { + "description": "parameter", + "$ref": "#/definitions/ThreatIntelligenceMetricEntity" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "sourceMetrics": { + "description": "Source metrics", + "items": { + "description": "parameter", + "$ref": "#/definitions/ThreatIntelligenceMetricEntity" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "ThreatIntelligenceMetricEntity": { + "description": "Describes threat intelligence metric entity", + "properties": { + "metricName": { + "description": "Metric name", + "type": "string" + }, + "metricValue": { + "description": "Metric value", + "type": "integer", + "format": "int32" + } + }, + "type": "object" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ThreatIntelligenceCount.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ThreatIntelligenceCount.json new file mode 100644 index 000000000000..71599e678748 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ThreatIntelligenceCount.json @@ -0,0 +1,348 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/{tiType}/count": { + "post": { + "x-ms-examples": { + "Get TI object count": { + "$ref": "./examples/threatintelligence/PostThreatIntelligenceCount.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Gets the count of all TI objects for the workspace.", + "operationId": "ThreatIntelligence_Count", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/TiType" + }, + { + "$ref": "#/parameters/CountQuery" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceCount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "ThreatIntelligenceCount": { + "description": "Count of all the threat intelligence objects on the workspace that match the provided query.", + "properties": { + "count": { + "description": "Count of all the threat intelligence objects on the workspace that match the provided query.", + "readOnly": true, + "format": "int32", + "type": "integer" + } + }, + "type": "object", + "required": [ + "count" + ] + }, + "CountQuery": { + "description": "Represents a query to run on the TI objects in the workspace.", + "properties": { + "properties": { + "$ref": "#/definitions/QueryProperties", + "description": "Query properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "QueryProperties": { + "description": "Describes the query properties", + "properties": { + "condition": { + "$ref": "#/definitions/ConditionProperties", + "description": "Represents a condition used to query for TI objects.", + "type": "string" + } + }, + "type": "object" + }, + "ConditionProperties": { + "description": "Represents a condition used to query for TI objects.", + "properties": { + "stixObjectType": { + "description": "The STIX type for the objects returned by this query.", + "readOnly": true, + "type": "string" + }, + "clauses": { + "description": "The list of clauses to be evaluated in disjunction or conjunction base on the specified top level connective operator.", + "items": { + "$ref": "#/definitions/ConditionClause" + }, + "type": "array" + }, + "conditionConnective": { + "description": "The top level connective operator for this condition.", + "type": "string", + "$ref": "#/definitions/Connective" + } + }, + "required": [ + "clauses" + ], + "type": "object" + }, + "ConditionClause": { + "description": "Represents a single clause to be evaluated by a NormalizedCondition.", + "properties": { + "clauseConnective": { + "description": "The connective used to join all values in this ConditionClause", + "type": "string", + "$ref": "#/definitions/Connective" + }, + "field": { + "description": "The name of the field that is evaluated.", + "type": "string" + }, + "operator": { + "description": "Represents an operator in a ConditionClause.", + "type": "string", + "enum": [ + "Equals", + "NotEquals", + "LessThan", + "LessThanEqual", + "GreaterThan", + "GreaterThanEqual", + "StringContains", + "StringNotContains", + "StringStartsWith", + "StringNotStartsWith", + "StringEndsWith", + "StringNotEndsWith", + "StringIsEmpty", + "IsNull", + "IsTrue", + "IsFalse", + "ArrayContains", + "ArrayNotContains", + "OnOrAfterRelative", + "AfterRelative", + "OnOrBeforeRelative", + "BeforeRelative", + "OnOrAfterAbsolute", + "AfterAbsolute", + "OnOrBeforeAbsolute", + "BeforeAbsolute" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "Operator", + "values": [ + { + "value": "Equals" + }, + { + "value": "NotEquals" + }, + { + "value": "LessThan" + }, + { + "value": "LessThanEqual" + }, + { + "value": "GreaterThan" + }, + { + "value": "GreaterThanEqual" + }, + { + "value": "StringContains" + }, + { + "value": "StringNotContains" + }, + { + "value": "StringStartsWith" + }, + { + "value": "StringNotStartsWith" + }, + { + "value": "StringEndsWith" + }, + { + "value": "StringNotEndsWith" + }, + { + "value": "StringIsEmpty" + }, + { + "value": "IsNull" + }, + { + "value": "IsTrue" + }, + { + "value": "IsFalse" + }, + { + "value": "ArrayContains" + }, + { + "value": "ArrayNotContains" + }, + { + "value": "OnOrAfterRelative" + }, + { + "value": "AfterRelative" + }, + { + "value": "OnOrBeforeRelative" + }, + { + "value": "BeforeRelative" + }, + { + "value": "OnOrAfterAbsolute" + }, + { + "value": "AfterAbsolute" + }, + { + "value": "OnOrBeforeAbsolute" + }, + { + "value": "BeforeAbsolute" + } + ] + } + }, + "values": { + "description": "The top level connective operator for this condition.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "field", + "operator", + "values" + ], + "type": "object" + }, + "Connective": { + "description": "Represents boolean connectives used to join clauses in conditions.", + "readOnly": true, + "enum": [ + "And", + "Or" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "Connective", + "values": [ + { + "description": "'And' connective", + "value": "And" + }, + { + "description": "'Or' connective", + "value": "Or" + } + ] + } + } + }, + "parameters": { + "CountQuery": { + "description": "The query to run on the TI objects in the workspace.", + "in": "body", + "name": "query", + "schema": { + "$ref": "#/definitions/CountQuery" + }, + "x-ms-parameter-location": "method" + }, + "TiType": { + "description": "TI type", + "in": "path", + "name": "tiType", + "required": true, + "enum": [ + "main" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "TiType", + "values": [ + { + "value": "main" + } + ] + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ThreatIntelligenceQuery.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ThreatIntelligenceQuery.json new file mode 100644 index 000000000000..4a122dba33ef --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/ThreatIntelligenceQuery.json @@ -0,0 +1,583 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/{tiType}/query": { + "post": { + "x-ms-examples": { + "Get TI objects": { + "$ref": "./examples/threatintelligence/PostThreatIntelligenceQuery.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Gets all TI objects for the workspace.", + "operationId": "ThreatIntelligence_Query", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/TiType" + }, + { + "$ref": "#/parameters/Query" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "TIObject": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "description": "Represents a threat intelligence object in Azure Security Insights.", + "properties": { + "properties": { + "$ref": "#/definitions/TIObjectCommonProperties", + "description": "The properties of the TI object", + "type": "object", + "x-ms-client-flatten": true + }, + "kind": { + "description": "The kind of the TI object", + "enum": [ + "AttackPattern", + "Identity", + "Indicator", + "Relationship", + "ThreatActor" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "TIObjectKind", + "values": [ + { + "description": "A TI object that represents an attack pattern.", + "value": "AttackPattern" + }, + { + "description": "A TI object that represents an identity.", + "value": "Identity" + }, + { + "description": "A TI object that represents an indicator.", + "value": "Indicator" + }, + { + "description": "A TI object that represents a relationship between two TI objects.", + "value": "Relationship" + }, + { + "description": "A TI object that represents a threat actor.", + "value": "ThreatActor" + } + ] + } + } + }, + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] + }, + "ThreatIntelligenceList": { + "description": "List all the threat intelligence objects on the workspace that match the provided query.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of threat intelligence objects.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of threat intelligence objects on the workspace that match the provided query.", + "items": { + "$ref": "#/definitions/TIObject" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "TIObjectCommonProperties": { + "description": "Describes properties common to all threat intelligence objects", + "properties": { + "data": { + "description": "The core STIX object that this TI object represents.", + "readOnly": true, + "type": "object", + "additionalProperties": {} + }, + "createdBy": { + "description": "The UserInfo of the user/entity which originally created this TI object.", + "$ref": "../../../common/2.0/types.json#/definitions/UserInfo", + "readOnly": true, + "type": "object" + }, + "source": { + "description": "The source name for this TI object.", + "readOnly": true, + "type": "string" + }, + "firstIngestedTimeUtc": { + "description": "The timestamp for the first time this object was ingested.", + "readOnly": true, + "format": "date-time", + "type": "string" + }, + "lastIngestedTimeUtc": { + "description": "The timestamp for the last time this object was ingested.", + "readOnly": true, + "format": "date-time", + "type": "string" + }, + "ingestionRulesVersion": { + "description": "The ID of the rules version that was active when this TI object was last ingested.", + "readOnly": true, + "format": "uuid", + "type": "string" + }, + "lastUpdateMethod": { + "description": "The name of the method/application that initiated the last write to this TI object.", + "readOnly": true, + "type": "string" + }, + "lastModifiedBy": { + "description": "The UserInfo of the user/entity which last modified this TI object.", + "$ref": "../../../common/2.0/types.json#/definitions/UserInfo", + "readOnly": true, + "type": "object" + }, + "lastUpdatedDateTimeUtc": { + "description": "The timestamp for the last time this TI object was updated.", + "readOnly": true, + "format": "date-time", + "type": "string" + }, + "relationshipHints": { + "description": "A dictionary used to help follow relationships from this object to other STIX objects. The keys are field names from the STIX object (in the 'data' field), and the values are lists of sources that can be prepended to the object ID in order to efficiently locate the target TI object.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RelationshipHint" + } + } + }, + "type": "object" + }, + "RelationshipHint": { + "description": "An object used to help follow relationships from this object to other STIX objects.", + "properties": { + "fieldName": { + "type": "string" + }, + "source": { + "type": "string" + } + }, + "type": "object" + }, + "Query": { + "description": "Represents a query to run on the TI objects in the workspace.", + "properties": { + "condition": { + "description": "Represents a condition used to query for TI objects.", + "properties": { + "stixObjectType": { + "description": "The STIX type for the objects returned by this query.", + "type": "string" + }, + "clauses": { + "description": "The list of clauses to be evaluated in disjunction or conjunction base on the specified top level connective operator.", + "items": { + "$ref": "#/definitions/ConditionClause" + }, + "type": "array" + }, + "conditionConnective": { + "description": "The top level connective operator for this condition.", + "type": "string", + "$ref": "#/definitions/Connective" + } + }, + "required": [ + "clauses" + ], + "type": "object" + }, + "sortBy": { + "description": "Specifies how to sort the query results.", + "properties": { + "direction": { + "description": "The direction to sort the results by.", + "enum": [ + "ASC", + "DESC" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "SortingDirection", + "values": [ + { + "description": "Indicates that the query should be sorted from lowest-to-highest value.", + "value": "ASC" + }, + { + "description": "Indicates that the query should be sorted from lowest-to-highest value.", + "value": "DESC" + } + ] + } + }, + "field": { + "description": "Represents the field to sort the results by.", + "type": "string" + } + }, + "type": "object" + }, + "maxPageSize": { + "description": "Represents the maximum size of the page that will be returned from the query API.", + "format": "int32", + "type": "integer" + }, + "minPageSize": { + "description": "Represents the minimum size of the page that will be returned from the query API.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Connective": { + "description": "Represents boolean connectives used to join clauses in conditions.", + "enum": [ + "And", + "Or" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "Connective", + "values": [ + { + "description": "'And' connective", + "value": "And" + }, + { + "description": "'Or' connective", + "value": "Or" + } + ] + } + }, + "ConditionClause": { + "description": "Represents a single clause to be evaluated by a NormalizedCondition.", + "properties": { + "clauseConnective": { + "description": "The connective used to join all values in this ConditionClause", + "type": "string", + "$ref": "#/definitions/Connective" + }, + "field": { + "description": "The name of the field that is evaluated.", + "type": "string" + }, + "operator": { + "description": "Represents an operator in a ConditionClause.", + "type": "string", + "enum": [ + "Equals", + "NotEquals", + "LessThan", + "LessThanEqual", + "GreaterThan", + "GreaterThanEqual", + "StringContains", + "StringNotContains", + "StringStartsWith", + "StringNotStartsWith", + "StringEndsWith", + "StringNotEndsWith", + "StringIsEmpty", + "IsNull", + "IsTrue", + "IsFalse", + "ArrayContains", + "ArrayNotContains", + "OnOrAfterRelative", + "AfterRelative", + "OnOrBeforeRelative", + "BeforeRelative", + "OnOrAfterAbsolute", + "AfterAbsolute", + "OnOrBeforeAbsolute", + "BeforeAbsolute" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "Operator", + "values": [ + { + "value": "Equals" + }, + { + "value": "NotEquals" + }, + { + "value": "LessThan" + }, + { + "value": "LessThanEqual" + }, + { + "value": "GreaterThan" + }, + { + "value": "GreaterThanEqual" + }, + { + "value": "StringContains" + }, + { + "value": "StringNotContains" + }, + { + "value": "StringStartsWith" + }, + { + "value": "StringNotStartsWith" + }, + { + "value": "StringEndsWith" + }, + { + "value": "StringNotEndsWith" + }, + { + "value": "StringIsEmpty" + }, + { + "value": "IsNull" + }, + { + "value": "IsTrue" + }, + { + "value": "IsFalse" + }, + { + "value": "ArrayContains" + }, + { + "value": "ArrayNotContains" + }, + { + "value": "OnOrAfterRelative" + }, + { + "value": "AfterRelative" + }, + { + "value": "OnOrBeforeRelative" + }, + { + "value": "BeforeRelative" + }, + { + "value": "OnOrAfterAbsolute" + }, + { + "value": "AfterAbsolute" + }, + { + "value": "OnOrBeforeAbsolute" + }, + { + "value": "BeforeAbsolute" + } + ] + } + }, + "values": { + "description": "The top level connective operator for this condition.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "field", + "operator", + "values" + ], + "type": "object" + }, + "ThreatActor": { + "allOf": [ + { + "$ref": "#/definitions/TIObject" + } + ], + "description": "Represents a threat actor in Azure Security Insights.", + "type": "object" + }, + "AttackPattern": { + "allOf": [ + { + "$ref": "#/definitions/TIObject" + } + ], + "description": "Represents an attack pattern in Azure Security Insights.", + "type": "object" + }, + "Identity": { + "allOf": [ + { + "$ref": "#/definitions/TIObject" + } + ], + "description": "Represents an identity in Azure Security Insights.", + "type": "object" + }, + "Relationship": { + "allOf": [ + { + "$ref": "#/definitions/TIObject" + } + ], + "description": "Represents a relationship in Azure Security Insights.", + "type": "object" + }, + "Indicator": { + "allOf": [ + { + "$ref": "#/definitions/TIObject" + } + ], + "description": "Represents an indicator in Azure Security Insights.", + "properties": { + "observables": { + "description": "The observables of this indicator", + "items": { + "description": "An observable of this indicator", + "properties": { + "type": { + "description": "The type of the observable of this indicator", + "type": "string" + }, + "value": { + "description": "The value of the observable of this indicator", + "type": "string" + } + }, + "type": "object", + "readOnly": true + }, + "type": "array" + } + }, + "type": "object" + } + }, + "parameters": { + "Query": { + "description": "The query to run on the TI objects in the workspace.", + "in": "body", + "name": "query", + "schema": { + "$ref": "#/definitions/Query" + }, + "x-ms-parameter-location": "method" + }, + "TiType": { + "description": "TI type", + "in": "path", + "name": "tiType", + "required": true, + "enum": [ + "main" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "TiType", + "values": [ + { + "value": "main" + } + ] + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/TriggeredAnalyticsRuleRuns.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/TriggeredAnalyticsRuleRuns.json new file mode 100644 index 000000000000..c3a0a087d1e1 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/TriggeredAnalyticsRuleRuns.json @@ -0,0 +1,354 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/triggeredAnalyticsRuleRuns/{ruleRunId}": { + "get": { + "tags": [ + "triggered analytics rule run" + ], + "description": "Gets the triggered analytics rule run.", + "operationId": "triggeredAnalyticsRuleRun_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "description": "the triggered rule id", + "in": "path", + "name": "ruleRunId", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TriggeredAnalyticsRuleRun" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "triggeredAnalyticsRuleRun_Get": { + "$ref": "./examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRun_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/triggeredAnalyticsRuleRuns": { + "get": { + "tags": [ + "triggered analytics rule runs" + ], + "description": "Gets the triggered analytics rule runs.", + "operationId": "getTriggeredAnalyticsRuleRuns_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TriggeredAnalyticsRuleRuns" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "triggeredAnalyticsRuleRuns_Get": { + "$ref": "./examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRuns_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}/triggerRuleRun": { + "post": { + "tags": [ + "trigger analytics rule run" + ], + "description": "triggers analytics rule run", + "operationId": "alertRule_TriggerRuleRun", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + }, + { + "$ref": "#/parameters/AnalyticsRuleRunTriggerParameter" + } + ], + "responses": { + "202": { + "description": "The analytics rule run was successfully triggered.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "triggerRuleRun_Post": { + "$ref": "./examples/triggeredAnalyticsRuleRuns/triggerRuleRun_Post.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "ProvisioningState": { + "enum": [ + "Accepted", + "InProgress", + "Succeeded", + "Failed", + "Canceled" + ], + "description": "The triggered analytics rule run provisioning state", + "type": "string", + "readOnly": true, + "example": "Accepted", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Accepted" + }, + { + "value": "InProgress" + }, + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Canceled" + } + ] + } + }, + "TriggeredAnalyticsRuleRun": { + "required": [ + "properties" + ], + "description": "The triggered analytics rule run", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TriggeredAnalyticsRuleRunProperties", + "x-ms-client-flatten": true + } + } + }, + "TriggeredAnalyticsRuleRunProperties": { + "required": [ + "executionTimeUtc", + "provisioningState", + "ruleId", + "triggeredAnalyticsRuleRunId" + ], + "description": "The triggered analytics rule run Properties", + "type": "object", + "properties": { + "executionTimeUtc": { + "format": "date-time", + "type": "string" + }, + "ruleId": { + "type": "string" + }, + "triggeredAnalyticsRuleRunId": { + "type": "string" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + }, + "ruleRunAdditionalData": { + "type": "object", + "additionalProperties": {} + } + } + }, + "TriggeredAnalyticsRuleRuns": { + "required": [ + "value" + ], + "description": "The triggered analytics rule run array", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TriggeredAnalyticsRuleRun" + } + }, + "nextLink": { + "type": "string", + "readOnly": true + } + } + }, + "AnalyticsRuleRunTriggerProperties": { + "required": [ + "executionTimeUtc" + ], + "description": "The Analytics Rule Run Trigger properties", + "type": "object", + "properties": { + "executionTimeUtc": { + "format": "date-time", + "type": "string" + } + } + }, + "AnalyticsRuleRunTrigger": { + "required": [ + "properties" + ], + "description": "Analytics Rule Run Trigger request", + "properties": { + "properties": { + "$ref": "#/definitions/AnalyticsRuleRunTriggerProperties", + "description": "The analytics Rule Run Trigger request", + "x-ms-client-flatten": true + } + }, + "type": "object" + } + }, + "parameters": { + "RuleId": { + "description": "Alert rule ID", + "in": "path", + "name": "ruleId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AnalyticsRuleRunTriggerParameter": { + "description": "The Analytics Rule Run Trigger parameter", + "in": "body", + "name": "analyticsRuleRunTriggerParameter", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyticsRuleRunTrigger" + }, + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "tags": [ + { + "name": "AnalyticsOnDemandArm", + "description": "Controller that handles requests for triggeredAnalyticsRuleRuns ARM API." + }, + { + "name": "AnalyticsOnDemandArm", + "description": "Triggered Analytics Rule Runs" + } + ], + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Watchlists.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Watchlists.json new file mode 100644 index 000000000000..e6e12ab1f641 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/Watchlists.json @@ -0,0 +1,745 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists": { + "get": { + "x-ms-examples": { + "Get all watchlists.": { + "$ref": "./examples/watchlists/GetWatchlists.json" + } + }, + "tags": [ + "Watchlists" + ], + "description": "Gets all watchlists, without watchlist items.", + "operationId": "Watchlists_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WatchlistList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}": { + "get": { + "x-ms-examples": { + "Get a watchlist.": { + "$ref": "./examples/watchlists/GetWatchlistByAlias.json" + } + }, + "tags": [ + "Watchlists" + ], + "description": "Gets a watchlist, without its watchlist items.", + "operationId": "Watchlists_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WatchlistAlias" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Watchlist" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a watchlist.": { + "$ref": "./examples/watchlists/DeleteWatchlist.json" + } + }, + "tags": [ + "Watchlists" + ], + "description": "Delete a watchlist.", + "operationId": "Watchlists_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WatchlistAlias" + } + ], + "responses": { + "202": { + "description": "OK", + "headers": { + "Azure-AsyncOperation": { + "description": "Contains the status URL on which clients are expected to poll the status of the delete operation.", + "type": "string" + }, + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "x-ms-examples": { + "Creates or updates a watchlist.": { + "$ref": "./examples/watchlists/CreateWatchlist.json" + }, + "Creates or updates a watchlist and bulk creates watchlist items.": { + "$ref": "./examples/watchlists/CreateWatchlistAndWatchlistItems.json" + } + }, + "tags": [ + "Watchlists" + ], + "description": "Create or update a Watchlist and its Watchlist Items (bulk creation, e.g. through text/csv content type). To create a Watchlist and its Items, we should call this endpoint with either rawContent or a valid SAR URI and contentType properties. The rawContent is mainly used for small watchlist (content size below 3.8 MB). The SAS URI enables the creation of large watchlist, where the content size can go up to 500 MB. The status of processing such large file can be polled through the URL returned in Azure-AsyncOperation header.", + "operationId": "Watchlists_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WatchlistAlias" + }, + { + "$ref": "#/parameters/Watchlist" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Watchlist" + } + }, + "201": { + "description": "Created. The response includes the Provisioning State and the Azure-AsyncOperation header. To get the progress of the operation, call GET operation on the URL in Azure-AsyncOperation header field.", + "schema": { + "$ref": "#/definitions/Watchlist" + }, + "headers": { + "Azure-AsyncOperation": { + "description": "Contains the status URL on which clients are expected to poll the status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItems": { + "get": { + "x-ms-examples": { + "Get all watchlist Items.": { + "$ref": "./examples/watchlists/GetWatchlistItems.json" + } + }, + "tags": [ + "WatchlistItems" + ], + "description": "Gets all watchlist Items.", + "operationId": "WatchlistItems_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + }, + { + "$ref": "#/parameters/WatchlistAlias" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WatchlistItemList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItems/{watchlistItemId}": { + "get": { + "x-ms-examples": { + "Get a watchlist item.": { + "$ref": "./examples/watchlists/GetWatchlistItemById.json" + } + }, + "tags": [ + "WatchlistItems" + ], + "description": "Gets a watchlist, without its watchlist items.", + "operationId": "WatchlistItems_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WatchlistAlias" + }, + { + "$ref": "#/parameters/WatchlistItemId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WatchlistItem" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a watchlist Item.": { + "$ref": "./examples/watchlists/DeleteWatchlistItem.json" + } + }, + "tags": [ + "WatchlistItems" + ], + "description": "Delete a watchlist item.", + "operationId": "WatchlistItems_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WatchlistAlias" + }, + { + "$ref": "#/parameters/WatchlistItemId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a watchlist item.": { + "$ref": "./examples/watchlists/CreateWatchlistItem.json" + } + }, + "tags": [ + "WatchlistItems" + ], + "description": "Creates or updates a watchlist item.", + "operationId": "WatchlistItems_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WatchlistAlias" + }, + { + "$ref": "#/parameters/WatchlistItemId" + }, + { + "$ref": "#/parameters/WatchlistItem" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WatchlistItem" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/WatchlistItem" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "WatchlistList": { + "description": "List all the watchlists.", + "type": "object", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of watchlists.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of watchlist.", + "items": { + "$ref": "#/definitions/Watchlist" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + }, + "Watchlist": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a Watchlist in Azure Security Insights.", + "properties": { + "properties": { + "$ref": "#/definitions/WatchlistProperties", + "description": "Watchlist properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "WatchlistProperties": { + "description": "Describes watchlist properties", + "properties": { + "watchlistId": { + "description": "The id (a Guid) of the watchlist", + "type": "string" + }, + "displayName": { + "description": "The display name of the watchlist", + "type": "string" + }, + "provider": { + "description": "The provider of the watchlist", + "type": "string" + }, + "source": { + "description": "The filename of the watchlist, called 'source'", + "type": "string" + }, + "sourceType": { + "description": "The sourceType of the watchlist", + "enum": [ + "Local file", + "Remote storage" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "sourceType" + } + }, + "created": { + "description": "The time the watchlist was created", + "format": "date-time", + "type": "string" + }, + "updated": { + "description": "The last time the watchlist was updated", + "format": "date-time", + "type": "string" + }, + "createdBy": { + "$ref": "../../../common/2.0/types.json#/definitions/UserInfo", + "description": "Describes a user that created the watchlist", + "type": "object" + }, + "updatedBy": { + "$ref": "../../../common/2.0/types.json#/definitions/UserInfo", + "description": "Describes a user that updated the watchlist", + "type": "object" + }, + "description": { + "description": "A description of the watchlist", + "type": "string" + }, + "watchlistType": { + "description": "The type of the watchlist", + "type": "string" + }, + "watchlistAlias": { + "description": "The alias of the watchlist", + "type": "string" + }, + "isDeleted": { + "description": "A flag that indicates if the watchlist is deleted or not", + "type": "boolean" + }, + "labels": { + "description": "List of labels relevant to this watchlist", + "items": { + "$ref": "../../../common/2.0/types.json#/definitions/Label" + }, + "type": "array" + }, + "defaultDuration": { + "description": "The default duration of a watchlist (in ISO 8601 duration format)", + "format": "duration", + "type": "string" + }, + "tenantId": { + "description": "The tenantId where the watchlist belongs to", + "type": "string" + }, + "numberOfLinesToSkip": { + "description": "The number of lines in a csv/tsv content to skip before the header", + "type": "integer", + "format": "int32" + }, + "rawContent": { + "description": "The raw content that represents to watchlist items to create. In case of csv/tsv content type, it's the content of the file that will parsed by the endpoint", + "type": "string" + }, + "itemsSearchKey": { + "description": "The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address.", + "type": "string" + }, + "contentType": { + "description": "The content type of the raw content. Example : text/csv or text/tsv ", + "type": "string" + }, + "uploadStatus": { + "description": "The status of the Watchlist upload : New, InProgress or Complete. Pls note : When a Watchlist upload status is equal to InProgress, the Watchlist cannot be deleted", + "type": "string" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + } + }, + "required": [ + "displayName", + "provider", + "itemsSearchKey" + ], + "type": "object" + }, + "WatchlistItemList": { + "description": "List all the watchlist items.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of watchlist item.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of watchlist items.", + "items": { + "$ref": "#/definitions/WatchlistItem" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "WatchlistItem": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a Watchlist item in Azure Security Insights.", + "properties": { + "properties": { + "$ref": "#/definitions/WatchlistItemProperties", + "description": "Watchlist Item properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "WatchlistItemProperties": { + "description": "Describes watchlist item properties", + "properties": { + "watchlistItemType": { + "description": "The type of the watchlist item", + "type": "string" + }, + "watchlistItemId": { + "description": "The id (a Guid) of the watchlist item", + "type": "string" + }, + "tenantId": { + "description": "The tenantId to which the watchlist item belongs to", + "type": "string" + }, + "isDeleted": { + "description": "A flag that indicates if the watchlist item is deleted or not", + "type": "boolean" + }, + "created": { + "description": "The time the watchlist item was created", + "format": "date-time", + "type": "string" + }, + "updated": { + "description": "The last time the watchlist item was updated", + "format": "date-time", + "type": "string" + }, + "createdBy": { + "$ref": "../../../common/2.0/types.json#/definitions/UserInfo", + "description": "Describes a user that created the watchlist item", + "type": "object" + }, + "updatedBy": { + "$ref": "../../../common/2.0/types.json#/definitions/UserInfo", + "description": "Describes a user that updated the watchlist item" + }, + "itemsKeyValue": { + "description": "key-value pairs for a watchlist item", + "type": "object" + }, + "entityMapping": { + "description": "key-value pairs for a watchlist item entity mapping", + "type": "object" + } + }, + "required": [ + "itemsKeyValue" + ], + "type": "object" + }, + "ProvisioningState": { + "description": "Describes provisioning state", + "enum": [ + "New", + "InProgress", + "Uploading", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + } + }, + "parameters": { + "WatchlistAlias": { + "description": "Watchlist Alias", + "in": "path", + "name": "watchlistAlias", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Watchlist": { + "description": "The watchlist", + "in": "body", + "name": "watchlist", + "required": true, + "schema": { + "$ref": "#/definitions/Watchlist" + }, + "x-ms-parameter-location": "method" + }, + "WatchlistItem": { + "description": "The watchlist item", + "in": "body", + "name": "watchlistItem", + "required": true, + "schema": { + "$ref": "#/definitions/WatchlistItem" + }, + "x-ms-parameter-location": "method" + }, + "WatchlistItemId": { + "description": "Watchlist Item Id (GUID)", + "in": "path", + "name": "watchlistItemId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/WorkspaceManagerAssignments.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/WorkspaceManagerAssignments.json new file mode 100644 index 000000000000..be447fbca3eb --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/WorkspaceManagerAssignments.json @@ -0,0 +1,737 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/workspaceManagerAssignments": { + "get": { + "x-ms-examples": { + "Get all workspace manager assignments for the Sentinel workspace manager.": { + "$ref": "./examples/workspaceManagerAssignments/GetAllWorkspaceManagerAssignments.json" + } + }, + "tags": [ + "workspaceManagerAssignments" + ], + "description": "Get all workspace manager assignments for the Sentinel workspace manager.", + "operationId": "WorkspaceManagerAssignments_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceManagerAssignmentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/workspaceManagerAssignments/{workspaceManagerAssignmentName}": { + "get": { + "x-ms-examples": { + "Get a workspace manager assignment": { + "$ref": "./examples/workspaceManagerAssignments/GetWorkspaceManagerAssignment.json" + } + }, + "tags": [ + "workspaceManagerAssignments" + ], + "description": "Gets a workspace manager assignment", + "operationId": "WorkspaceManagerAssignments_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerAssignmentName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceManagerAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a workspace manager assignment.": { + "$ref": "./examples/workspaceManagerAssignments/CreateOrUpdateWorkspaceManagerAssignment.json" + } + }, + "tags": [ + "workspaceManagerAssignments" + ], + "description": "Creates or updates a workspace manager assignment.", + "operationId": "WorkspaceManagerAssignments_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerAssignmentName" + }, + { + "$ref": "#/parameters/WorkspaceManagerAssignment" + } + ], + "responses": { + "200": { + "description": "OK, created or updated an instance", + "schema": { + "$ref": "#/definitions/WorkspaceManagerAssignment" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/WorkspaceManagerAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a workspace manager assignment.": { + "$ref": "./examples/workspaceManagerAssignments/DeleteWorkspaceManagerAssignment.json" + } + }, + "tags": [ + "workspaceManagerAssignments" + ], + "description": "Deletes a workspace manager assignment", + "operationId": "WorkspaceManagerAssignments_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerAssignmentName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/workspaceManagerAssignments/{workspaceManagerAssignmentName}/jobs": { + "get": { + "x-ms-examples": { + "Get all jobs for the specified Sentinel workspace manager assignment.": { + "$ref": "./examples/workspaceManagerAssignments/GetAllJobs.json" + } + }, + "tags": [ + "workspaceManagerAssignments" + ], + "description": "Get all jobs for the specified workspace manager assignment", + "operationId": "WorkspaceManagerAssignmentJobs_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerAssignmentName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + }, + "post": { + "x-ms-examples": { + "Creates a job for the specified workspace manager assignment": { + "$ref": "./examples/workspaceManagerAssignments/CreateJob.json" + } + }, + "tags": [ + "workspaceManagerAssignments" + ], + "description": "Create a job for the specified workspace manager assignment", + "operationId": "WorkspaceManagerAssignmentJobs_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerAssignmentName" + } + ], + "responses": { + "200": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/workspaceManagerAssignments/{workspaceManagerAssignmentName}/jobs/{jobName}": { + "get": { + "x-ms-examples": { + "Get a workspace manager job": { + "$ref": "./examples/workspaceManagerAssignments/GetJob.json" + } + }, + "tags": [ + "workspaceManagerAssignments" + ], + "description": "Gets a job", + "operationId": "WorkspaceManagerAssignmentJobs_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerAssignmentName" + }, + { + "$ref": "#/parameters/JobName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a workspace manager job.": { + "$ref": "./examples/workspaceManagerAssignments/DeleteJob.json" + } + }, + "tags": [ + "workspaceManagerAssignments" + ], + "description": "Deletes the specified job from the specified workspace manager assignment", + "operationId": "WorkspaceManagerAssignmentJobs_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerAssignmentName" + }, + { + "$ref": "#/parameters/JobName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "WorkspaceManagerAssignment": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/AzureEntityResource" + } + ], + "description": "The workspace manager assignment", + "properties": { + "properties": { + "$ref": "#/definitions/WorkspaceManagerAssignmentProperties", + "description": "The workspace manager assignment object", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "WorkspaceManagerAssignmentProperties": { + "description": "The workspace manager assignment properties", + "properties": { + "targetResourceName": { + "description": "The resource name of the workspace manager group targeted by the workspace manager assignment", + "type": "string" + }, + "lastJobEndTime": { + "description": "The time the last job associated to this assignment ended at", + "format": "date-time", + "type": "string", + "readOnly": true + }, + "lastJobProvisioningState": { + "description": "State of the last job associated to this assignment", + "enum": [ + "Succeeded", + "InProgress", + "Canceled", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "modelAsString": true, + "name": "provisioningState", + "values": [ + { + "description": "The job succeeded", + "value": "Succeeded" + }, + { + "description": "The job was canceled", + "value": "Canceled" + }, + { + "description": "The job is in progress", + "value": "InProgress" + }, + { + "description": "The job failed", + "value": "Failed" + } + ] + } + }, + "items": { + "description": "List of resources included in this workspace manager assignment", + "items": { + "$ref": "#/definitions/assignmentItem" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "required": [ + "targetResourceName", + "items" + ], + "type": "object" + }, + "assignmentItem": { + "description": "An entity describing a content item.", + "properties": { + "resourceId": { + "description": "The resource id of the content item", + "type": "string" + } + }, + "type": "object" + }, + "WorkspaceManagerAssignmentList": { + "description": "List of all the workspace manager assignments.", + "type": "object", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of workspace manager assignments.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of workspace manager assignments.", + "items": { + "$ref": "#/definitions/WorkspaceManagerAssignment" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + }, + "Job": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "The assignment job", + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The job object", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "JobProperties": { + "description": "The job properties", + "properties": { + "endTime": { + "description": "The time the job completed", + "format": "date-time", + "type": "string", + "readOnly": true + }, + "items": { + "description": "List of items published by the job", + "items": { + "$ref": "#/definitions/jobItem" + }, + "x-ms-identifiers": [], + "type": "array" + }, + "provisioningState": { + "description": "State of the job", + "enum": [ + "Succeeded", + "InProgress", + "Canceled", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "modelAsString": true, + "name": "provisioningState", + "values": [ + { + "description": "The job succeeded", + "value": "Succeeded" + }, + { + "description": "The job was canceled", + "value": "Canceled" + }, + { + "description": "The job is in progress", + "value": "InProgress" + }, + { + "description": "The job failed", + "value": "Failed" + } + ] + } + }, + "startTime": { + "description": "The time the job started", + "format": "date-time", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "Message to describe error, if an error exists", + "type": "string", + "readOnly": true + } + }, + "type": "object" + }, + "jobItem": { + "description": "An entity describing the publish status of a content item.", + "properties": { + "resourceId": { + "description": "The resource id of the content item", + "type": "string" + }, + "status": { + "description": "Status of the item publication", + "enum": [ + "Succeeded", + "Failed", + "InProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "modelAsString": true, + "name": "status", + "values": [ + { + "description": "The item publication succeeded", + "value": "Succeeded" + }, + { + "description": "The item publication failed", + "value": "Failed" + }, + { + "description": "The item publication is in progress", + "value": "InProgress" + } + ] + } + }, + "executionTime": { + "description": "The time the item publishing was completed", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "errors": { + "description": "The list of error descriptions if the item publication fails.", + "items": { + "$ref": "#/definitions/error" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "type": "object" + }, + "error": { + "description": "The error description for why a publication failed", + "type": "object", + "properties": { + "memberResourceName": { + "description": "The member resource name for which the publication error occured", + "type": "string" + }, + "errorMessage": { + "description": "The error message", + "type": "string" + } + }, + "required": [ + "memberResourceName", + "errorMessage" + ] + }, + "JobList": { + "description": "List of all the jobs", + "type": "object", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of jobs.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of jobs.", + "items": { + "$ref": "#/definitions/Job" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + } + }, + "parameters": { + "WorkspaceManagerAssignmentName": { + "description": "The name of the workspace manager assignment", + "in": "path", + "name": "workspaceManagerAssignmentName", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$", + "x-ms-parameter-location": "method" + }, + "WorkspaceManagerAssignment": { + "description": "The workspace manager assignment", + "in": "body", + "name": "workspaceManagerAssignment", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceManagerAssignment" + }, + "x-ms-parameter-location": "method" + }, + "JobName": { + "description": "The job name", + "in": "path", + "name": "jobName", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/WorkspaceManagerConfigurations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/WorkspaceManagerConfigurations.json new file mode 100644 index 000000000000..3a41694a16e5 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/WorkspaceManagerConfigurations.json @@ -0,0 +1,323 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/workspaceManagerConfigurations": { + "get": { + "x-ms-examples": { + "Get all workspace manager configurations for a Sentinel workspace.": { + "$ref": "./examples/workspaceManagerConfigurations/GetAllWorkspaceManagerConfigurations.json" + } + }, + "tags": [ + "workspaceManagerConfigurations" + ], + "description": "Gets all workspace manager configurations for a Sentinel workspace.", + "operationId": "WorkspaceManagerConfigurations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceManagerConfigurationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/workspaceManagerConfigurations/{workspaceManagerConfigurationName}": { + "get": { + "x-ms-examples": { + "Get a workspace manager configuration.": { + "$ref": "./examples/workspaceManagerConfigurations/GetWorkspaceManagerConfiguration.json" + } + }, + "tags": [ + "workspaceManagerConfigurations" + ], + "description": "Gets a workspace manager configuration", + "operationId": "WorkspaceManagerConfigurations_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerConfigurationName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceManagerConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a workspace manager configuration.": { + "$ref": "./examples/workspaceManagerConfigurations/DeleteWorkspaceManagerConfiguration.json" + } + }, + "tags": [ + "workspaceManagerConfigurations" + ], + "description": "Deletes a workspace manager configuration", + "operationId": "WorkspaceManagerConfigurations_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerConfigurationName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create or Update a workspace manager Configuration": { + "$ref": "./examples/workspaceManagerConfigurations/CreateOrUpdateWorkspaceManagerConfiguration.json" + } + }, + "tags": [ + "workspaceManagerConfigurations" + ], + "description": "Creates or updates a workspace manager configuration.", + "operationId": "WorkspaceManagerConfigurations_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerConfigurationName" + }, + { + "$ref": "#/parameters/WorkspaceManagerConfiguration" + } + ], + "responses": { + "200": { + "description": "OK, created or updated an instance", + "schema": { + "$ref": "#/definitions/WorkspaceManagerConfiguration" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/WorkspaceManagerConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "WorkspaceManagerConfiguration": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/AzureEntityResource" + } + ], + "description": "The workspace manager configuration", + "properties": { + "properties": { + "$ref": "#/definitions/WorkspaceManagerConfigurationProperties", + "description": "The workspace manager configuration object", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "WorkspaceManagerConfigurationProperties": { + "description": "The workspace manager configuration properties", + "properties": { + "mode": { + "description": "The current mode of the workspace manager configuration", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "mode", + "values": [ + { + "description": "The workspace manager configuration is enabled", + "value": "Enabled" + }, + { + "description": "The workspace manager configuration is disabled", + "value": "Disabled" + } + ] + } + } + }, + "required": [ + "mode" + ], + "type": "object" + }, + "WorkspaceManagerConfigurationList": { + "description": "List all the workspace manager configurations for the workspace.", + "type": "object", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of workspace manager configurations.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of workspace manager configurations.", + "items": { + "$ref": "#/definitions/WorkspaceManagerConfiguration" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + } + }, + "parameters": { + "WorkspaceManagerConfigurationName": { + "description": "The name of the workspace manager configuration", + "in": "path", + "name": "workspaceManagerConfigurationName", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$", + "x-ms-parameter-location": "method" + }, + "WorkspaceManagerConfiguration": { + "description": "The workspace manager configuration", + "in": "body", + "name": "workspaceManagerConfiguration", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceManagerConfiguration" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/WorkspaceManagerGroups.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/WorkspaceManagerGroups.json new file mode 100644 index 000000000000..f302a1ad362d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/WorkspaceManagerGroups.json @@ -0,0 +1,318 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/workspaceManagerGroups": { + "get": { + "x-ms-examples": { + "Get all workspace manager groups in the Sentinel workspace manager.": { + "$ref": "./examples/workspaceManagerGroups/GetAllWorkspaceManagerGroups.json" + } + }, + "tags": [ + "workspaceManagerGroups" + ], + "description": "Gets all workspace manager groups in the Sentinel workspace manager", + "operationId": "WorkspaceManagerGroups_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceManagerGroupList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/workspaceManagerGroups/{workspaceManagerGroupName}": { + "get": { + "x-ms-examples": { + "Get a workspace manager group": { + "$ref": "./examples/workspaceManagerGroups/GetWorkspaceManagerGroup.json" + } + }, + "tags": [ + "workspaceManagerGroups" + ], + "description": "Gets a workspace manager group", + "operationId": "WorkspaceManagerGroups_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerGroupName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceManagerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a workspace manager group.": { + "$ref": "./examples/workspaceManagerGroups/CreateOrUpdateWorkspaceManagerGroup.json" + } + }, + "tags": [ + "workspaceManagerGroups" + ], + "description": "Creates or updates a workspace manager group.", + "operationId": "WorkspaceManagerGroups_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerGroupName" + }, + { + "$ref": "#/parameters/WorkspaceManagerGroup" + } + ], + "responses": { + "200": { + "description": "OK, created or updated an instance", + "schema": { + "$ref": "#/definitions/WorkspaceManagerGroup" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/WorkspaceManagerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a workspace manager group.": { + "$ref": "./examples/workspaceManagerGroups/DeleteWorkspaceManagerGroup.json" + } + }, + "tags": [ + "workspaceManagerGroups" + ], + "description": "Deletes a workspace manager group", + "operationId": "WorkspaceManagerGroups_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerGroupName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "WorkspaceManagerGroup": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/AzureEntityResource" + } + ], + "description": "The workspace manager group", + "properties": { + "properties": { + "$ref": "#/definitions/WorkspaceManagerGroupProperties", + "description": "The workspace manager group object", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "WorkspaceManagerGroupProperties": { + "description": "The workspace manager group properties", + "properties": { + "description": { + "description": "The description of the workspace manager group", + "type": "string" + }, + "displayName": { + "description": "The display name of the workspace manager group", + "type": "string" + }, + "memberResourceNames": { + "description": "The names of the workspace manager members participating in this group.", + "items": { + "description": "memberResourceName", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "displayName", + "memberResourceNames" + ], + "type": "object" + }, + "WorkspaceManagerGroupList": { + "description": "List of all the workspace manager groups.", + "type": "object", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of workspace manager groups.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of workspace manager groups.", + "items": { + "$ref": "#/definitions/WorkspaceManagerGroup" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + } + }, + "parameters": { + "WorkspaceManagerGroupName": { + "description": "The name of the workspace manager group", + "in": "path", + "name": "workspaceManagerGroupName", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$", + "x-ms-parameter-location": "method" + }, + "WorkspaceManagerGroup": { + "description": "The workspace manager group object", + "in": "body", + "name": "workspaceManagerGroup", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceManagerGroup" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/WorkspaceManagerMembers.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/WorkspaceManagerMembers.json new file mode 100644 index 000000000000..01a2fb4f5b80 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/WorkspaceManagerMembers.json @@ -0,0 +1,310 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/workspaceManagerMembers/": { + "get": { + "x-ms-examples": { + "Get all workspace manager members": { + "$ref": "./examples/workspaceManagerMembers/GetAllWorkspaceManagerMembers.json" + } + }, + "tags": [ + "workspaceManagerMember" + ], + "description": "Gets all workspace manager members that exist for the given Sentinel workspace manager", + "operationId": "WorkspaceManagerMembers_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceManagerMembersList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/workspaceManagerMembers/{workspaceManagerMemberName}": { + "get": { + "x-ms-examples": { + "Get a workspace manager member": { + "$ref": "./examples/workspaceManagerMembers/GetWorkspaceManagerMember.json" + } + }, + "tags": [ + "workspaceManagerMember" + ], + "description": "Gets a workspace manager member", + "operationId": "WorkspaceManagerMembers_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerMemberName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceManagerMember" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create or Update a workspace manager member": { + "$ref": "./examples/workspaceManagerMembers/CreateOrUpdateWorkspaceManagerMember.json" + } + }, + "tags": [ + "workspaceManagerMember" + ], + "description": "Creates or updates a workspace manager member", + "operationId": "WorkspaceManagerMembers_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerMemberName" + }, + { + "$ref": "#/parameters/WorkspaceManagerMember" + } + ], + "responses": { + "200": { + "description": "OK, created or updated an instance", + "schema": { + "$ref": "#/definitions/WorkspaceManagerMember" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/WorkspaceManagerMember" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a workspace manager member": { + "$ref": "./examples/workspaceManagerMembers/DeleteWorkspaceManagerMember.json" + } + }, + "tags": [ + "workspaceManagerMember" + ], + "description": "Deletes a workspace manager member", + "operationId": "WorkspaceManagerMembers_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerMemberName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "WorkspaceManagerMemberProperties": { + "description": "The workspace manager member properties", + "properties": { + "targetWorkspaceResourceId": { + "description": "Fully qualified resource ID of the target Sentinel workspace joining the given Sentinel workspace manager", + "type": "string" + }, + "targetWorkspaceTenantId": { + "description": "Tenant id of the target Sentinel workspace joining the given Sentinel workspace manager", + "type": "string" + } + }, + "required": [ + "targetWorkspaceResourceId", + "targetWorkspaceTenantId" + ], + "type": "object" + }, + "WorkspaceManagerMember": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/AzureEntityResource" + } + ], + "description": "The workspace manager member", + "properties": { + "properties": { + "$ref": "#/definitions/WorkspaceManagerMemberProperties", + "description": "The workspace manager member object", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "WorkspaceManagerMembersList": { + "description": "List of workspace manager members", + "type": "object", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of workspace manager members", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of workspace manager members", + "items": { + "$ref": "#/definitions/WorkspaceManagerMember" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + } + }, + "parameters": { + "WorkspaceManagerMemberName": { + "description": "The name of the workspace manager member", + "in": "path", + "name": "workspaceManagerMemberName", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$", + "x-ms-parameter-location": "method" + }, + "WorkspaceManagerMember": { + "description": "The workspace manager member object", + "in": "body", + "name": "workspaceManagerMember", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceManagerMember" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/common/AlertTypes.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/common/AlertTypes.json new file mode 100644 index 000000000000..9af26f3119e3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/common/AlertTypes.json @@ -0,0 +1,81 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01-preview", + "title": "Common Alert types" + }, + "paths": {}, + "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": { + "AlertSeverityEnum": { + "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" + } + ] + } + }, + "AttackTactic": { + "description": "The severity for alerts created by this alert rule.", + "enum": [ + "Reconnaissance", + "ResourceDevelopment", + "InitialAccess", + "Execution", + "Persistence", + "PrivilegeEscalation", + "DefenseEvasion", + "CredentialAccess", + "Discovery", + "LateralMovement", + "Collection", + "Exfiltration", + "CommandAndControl", + "Impact", + "PreAttack", + "ImpairProcessControl", + "InhibitResponseFunction" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AttackTactic" + } + } + }, + "parameters": {} +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/common/ContentCommonTypes.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/common/ContentCommonTypes.json new file mode 100644 index 000000000000..5340e8cc3330 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/common/ContentCommonTypes.json @@ -0,0 +1,646 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01-preview", + "title": "Common content metadata types" + }, + "paths": {}, + "definitions": { + "metadataContentId": { + "description": "Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a metadata, both will have the same contentId.", + "type": "string" + }, + "metadataParentId": { + "description": "Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group)", + "type": "string" + }, + "metadataDisplayName": { + "description": "DisplayName of the content.", + "type": "string" + }, + "metadataVersion": { + "description": "Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks", + "type": "string" + }, + "metadataPackageKind": { + "description": "The package kind", + "enum": [ + "Solution", + "Standalone" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "packageKind", + "values": [ + { + "value": "Solution" + }, + { + "value": "Standalone" + } + ] + } + }, + "metadataKind": { + "type": "string", + "description": "The kind of content the metadata is for.", + "enum": [ + "DataConnector", + "DataType", + "Workbook", + "WorkbookTemplate", + "Playbook", + "PlaybookTemplate", + "AnalyticsRuleTemplate", + "AnalyticsRule", + "HuntingQuery", + "InvestigationQuery", + "Parser", + "Watchlist", + "WatchlistTemplate", + "Solution", + "AzureFunction", + "LogicAppsCustomConnector", + "AutomationRule" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "kind", + "values": [ + { + "value": "DataConnector" + }, + { + "value": "DataType" + }, + { + "value": "Workbook" + }, + { + "value": "WorkbookTemplate" + }, + { + "value": "Playbook" + }, + { + "value": "PlaybookTemplate" + }, + { + "value": "AnalyticsRuleTemplate" + }, + { + "value": "AnalyticsRule" + }, + { + "value": "HuntingQuery" + }, + { + "value": "InvestigationQuery" + }, + { + "value": "Parser" + }, + { + "value": "Watchlist" + }, + { + "value": "WatchlistTemplate" + }, + { + "value": "Solution" + }, + { + "value": "AzureFunction" + }, + { + "value": "LogicAppsCustomConnector" + }, + { + "value": "AutomationRule" + } + ] + } + }, + "metadataTrueFalseFlag": { + "type": "string", + "description": "The boolean value the metadata is for.", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "flag", + "values": [ + { + "value": "true" + }, + { + "value": "false" + } + ] + } + }, + "metadataSource": { + "description": "The original source of the content item, where it comes from.", + "type": "object", + "required": [ + "kind" + ], + "properties": { + "kind": { + "description": "Source type of the content", + "type": "string", + "enum": [ + "LocalWorkspace", + "Community", + "Solution", + "SourceRepository" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "sourceKind", + "values": [ + { + "value": "LocalWorkspace" + }, + { + "value": "Community" + }, + { + "value": "Solution" + }, + { + "value": "SourceRepository" + } + ] + } + }, + "name": { + "description": "Name of the content source. The repo name, solution name, LA workspace name etc.", + "type": "string" + }, + "sourceId": { + "description": "ID of the content source. The solution ID, workspace ID, etc", + "type": "string" + } + } + }, + "metadataAuthor": { + "type": "object", + "description": "Publisher or creator of the content item.", + "properties": { + "name": { + "description": "Name of the author. Company or person.", + "type": "string" + }, + "email": { + "description": "Email of author contact", + "type": "string" + }, + "link": { + "description": "Link for author/vendor page", + "type": "string" + } + } + }, + "metadataSupport": { + "type": "object", + "description": "Support information for the content item.", + "required": [ + "tier" + ], + "properties": { + "tier": { + "description": "Type of support for content item", + "type": "string", + "enum": [ + "Microsoft", + "Partner", + "Community" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "supportTier", + "values": [ + { + "value": "Microsoft" + }, + { + "value": "Partner" + }, + { + "value": "Community" + } + ] + } + }, + "name": { + "description": "Name of the support contact. Company or person.", + "type": "string" + }, + "email": { + "description": "Email of support contact", + "type": "string" + }, + "link": { + "description": "Link for support help, like to support page to open a ticket etc.", + "type": "string" + } + } + }, + "metadataDependencies": { + "description": "Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex dependencies.", + "type": "object", + "properties": { + "contentId": { + "description": "Id of the content item we depend on", + "$ref": "#/definitions/metadataContentId" + }, + "kind": { + "description": "Type of the content item we depend on", + "$ref": "#/definitions/metadataKind" + }, + "version": { + "description": "Version of the the content item we depend on. Can be blank, * or missing to indicate any version fulfills the dependency. If version does not match our defined numeric format then an exact match is required.", + "$ref": "#/definitions/metadataVersion" + }, + "name": { + "description": "Name of the content item", + "type": "string" + }, + "operator": { + "description": "Operator used for list of dependencies in criteria array.", + "type": "string", + "enum": [ + "AND", + "OR" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "operator", + "values": [ + { + "value": "AND" + }, + { + "value": "OR" + } + ] + } + }, + "criteria": { + "description": "This is the list of dependencies we must fulfill, according to the AND/OR operator", + "type": "array", + "items": { + "$ref": "#/definitions/metadataDependencies", + "description": "Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex formats." + }, + "x-ms-identifiers": [ + "contentId" + ], + "example": [ + { + "kind": "DataConnector", + "contentId": "68b1de8a-b635-430d-b208-01ba3dda5877", + "version": "1.0.0" + }, + { + "kind": "Workbook", + "contentId": "ad903b46-9905-4504-9825-3bcce796da8e", + "version": "1.0.0" + } + ] + } + } + }, + "metadataCategories": { + "type": "object", + "description": "ies for the solution content item", + "properties": { + "domains": { + "description": "domain for the solution content item", + "type": "array", + "example": [ + "str1", + "str2", + "str3" + ], + "items": { + "type": "string" + } + }, + "verticals": { + "description": "Industry verticals for the solution content item", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "str1", + "str2", + "str3" + ] + } + } + }, + "metadataProviders": { + "description": "Providers for the solution content item", + "type": "array", + "example": [ + "str1", + "str2", + "str3" + ], + "items": { + "type": "string" + } + }, + "metadataFirstPublishDate": { + "description": "first publish date of solution content item", + "type": "string", + "format": "date" + }, + "metadataLastPublishDate": { + "description": "last publish date of solution content item", + "type": "string", + "format": "date" + }, + "metadataCustomVersion": { + "description": "The custom version of the content. A optional free text", + "type": "string" + }, + "metadataContentSchemaVersion": { + "description": "Schema version of the content. Can be used to distinguish between different flow based on the schema version", + "type": "string" + }, + "metadataIcon": { + "description": "the icon identifier. this id can later be fetched from the metadata", + "type": "string" + }, + "metadataThreatAnalysisTactics": { + "description": "the tactics the resource covers", + "type": "array", + "example": [ + "reconnaissance", + "exfiltration" + ], + "items": { + "type": "string" + } + }, + "metadataThreatAnalysisTechniques": { + "description": "the techniques the resource covers, these have to be aligned with the tactics being used", + "type": "array", + "example": [ + "T1548", + "T1548.001", + "T1134.003" + ], + "items": { + "type": "string" + } + }, + "metadataPreviewImages": { + "description": "preview image file names. These will be taken from the solution artifacts", + "type": "array", + "example": [ + "example.png", + "example2.jpeg" + ], + "items": { + "type": "string" + } + }, + "metadataPreviewImagesDark": { + "description": "preview image file names. These will be taken from the solution artifacts. used for dark theme support", + "type": "array", + "example": [ + "example.png", + "example2.jpeg" + ], + "items": { + "type": "string" + } + }, + "metadataTags": { + "description": "the tags assigned to the resource", + "type": "array", + "example": [ + "str1", + "str2", + "str3" + ], + "items": { + "type": "string" + } + }, + "templateBaseProperties": { + "description": "Template property bag.", + "type": "object", + "properties": { + "contentId": { + "$ref": "#/definitions/metadataContentId", + "description": "Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Dynamic for user-created. This is the resource name" + }, + "contentProductId": { + "type": "string", + "description": "Unique ID for the content. It should be generated based on the contentId of the package, contentId of the template, contentKind of the template and the contentVersion of the template" + }, + "packageVersion": { + "$ref": "#/definitions/metadataVersion", + "description": "Version of the package. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM metadata best practices. Can also be any string, but then we cannot guarantee any version checks" + }, + "version": { + "$ref": "#/definitions/metadataVersion", + "description": "Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM metadata best practices. Can also be any string, but then we cannot guarantee any version checks" + }, + "displayName": { + "$ref": "#/definitions/metadataDisplayName", + "description": "The display name of the template" + }, + "contentKind": { + "$ref": "#/definitions/metadataKind", + "description": "The kind of content the template is for." + }, + "source": { + "$ref": "#/definitions/metadataSource", + "description": "Source of the content. This is where/how it was created." + }, + "author": { + "$ref": "#/definitions/metadataAuthor", + "description": "The creator of the content item." + }, + "support": { + "$ref": "#/definitions/metadataSupport", + "description": "Support information for the template - type, name, contact information" + }, + "dependencies": { + "$ref": "#/definitions/metadataDependencies", + "description": "Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex formats." + }, + "categories": { + "$ref": "#/definitions/metadataCategories", + "description": "Categories for the item" + }, + "providers": { + "$ref": "#/definitions/metadataProviders", + "description": "Providers for the content item" + }, + "firstPublishDate": { + "$ref": "#/definitions/metadataFirstPublishDate", + "description": "first publish date content item" + }, + "lastPublishDate": { + "$ref": "#/definitions/metadataLastPublishDate", + "description": "last publish date for the content item" + }, + "customVersion": { + "$ref": "#/definitions/metadataCustomVersion", + "description": "The custom version of the content. A optional free text" + }, + "contentSchemaVersion": { + "$ref": "#/definitions/metadataContentSchemaVersion", + "description": "Schema version of the content. Can be used to distinguish between different flow based on the schema version" + }, + "icon": { + "$ref": "#/definitions/metadataIcon", + "description": "the icon identifier. this id can later be fetched from the content metadata" + }, + "threatAnalysisTactics": { + "$ref": "#/definitions/metadataThreatAnalysisTactics", + "description": "the tactics the resource covers" + }, + "threatAnalysisTechniques": { + "$ref": "#/definitions/metadataThreatAnalysisTechniques", + "description": "the techniques the resource covers, these have to be aligned with the tactics being used" + }, + "previewImages": { + "$ref": "#/definitions/metadataPreviewImages", + "description": "preview image file names. These will be taken from the solution artifacts" + }, + "previewImagesDark": { + "$ref": "#/definitions/metadataPreviewImagesDark", + "description": "preview image file names. These will be taken from the solution artifacts. used for dark theme support" + }, + "packageId": { + "$ref": "#/definitions/metadataContentId", + "description": "the package Id contains this template" + }, + "packageKind": { + "$ref": "#/definitions/metadataPackageKind", + "description": "the packageKind of the package contains this template" + }, + "packageName": { + "$ref": "#/definitions/metadataDisplayName", + "description": "the name of the package contains this template" + }, + "isDeprecated": { + "$ref": "#/definitions/metadataTrueFalseFlag", + "description": "Flag indicates if this template is deprecated", + "readOnly": true + } + } + }, + "packageBaseProperties": { + "description": "Describes package properties", + "properties": { + "contentId": { + "$ref": "#/definitions/metadataContentId", + "description": "The content id of the package" + }, + "contentProductId": { + "type": "string", + "description": "Unique ID for the content. It should be generated based on the contentId, contentKind and the contentVersion of the package" + }, + "contentKind": { + "$ref": "#/definitions/metadataPackageKind", + "description": "The package kind" + }, + "contentSchemaVersion": { + "$ref": "#/definitions/metadataVersion", + "description": "The version of the content schema." + }, + "isNew": { + "$ref": "#/definitions/metadataTrueFalseFlag", + "description": "Flag indicates if this is a newly published package." + }, + "isPreview": { + "$ref": "#/definitions/metadataTrueFalseFlag", + "description": "Flag indicates if this package is in preview." + }, + "isFeatured": { + "$ref": "#/definitions/metadataTrueFalseFlag", + "description": "Flag indicates if this package is among the featured list." + }, + "isDeprecated": { + "$ref": "#/definitions/metadataTrueFalseFlag", + "description": "Flag indicates if this template is deprecated" + }, + "version": { + "$ref": "#/definitions/metadataVersion", + "description": "the latest version number of the package" + }, + "displayName": { + "$ref": "#/definitions/metadataDisplayName", + "description": "The display name of the package" + }, + "description": { + "description": "The description of the package", + "type": "string" + }, + "publisherDisplayName": { + "$ref": "#/definitions/metadataDisplayName", + "description": "The publisher display name of the package" + }, + "source": { + "$ref": "#/definitions/metadataSource", + "description": "The source of the package" + }, + "author": { + "$ref": "#/definitions/metadataAuthor", + "description": "The author of the package" + }, + "support": { + "$ref": "#/definitions/metadataSupport", + "description": "The support tier of the package" + }, + "dependencies": { + "$ref": "#/definitions/metadataDependencies", + "description": "The support tier of the package" + }, + "providers": { + "$ref": "#/definitions/metadataProviders", + "description": "Providers for the package item" + }, + "firstPublishDate": { + "$ref": "#/definitions/metadataFirstPublishDate", + "description": "first publish date package item" + }, + "lastPublishDate": { + "$ref": "#/definitions/metadataLastPublishDate", + "description": "last publish date for the package item" + }, + "categories": { + "$ref": "#/definitions/metadataCategories", + "description": "The categories of the package" + }, + "threatAnalysisTactics": { + "$ref": "#/definitions/metadataThreatAnalysisTactics", + "description": "the tactics the resource covers" + }, + "threatAnalysisTechniques": { + "$ref": "#/definitions/metadataThreatAnalysisTechniques", + "description": "the techniques the resource covers, these have to be aligned with the tactics being used" + }, + "icon": { + "$ref": "#/definitions/metadataIcon", + "description": "the icon identifier. this id can later be fetched from the content metadata" + } + }, + "type": "object" + } + }, + "parameters": {} +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/common/EntityTypes.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/common/EntityTypes.json new file mode 100644 index 000000000000..47b21ed53f1b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/common/EntityTypes.json @@ -0,0 +1,2550 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01-preview", + "title": "Common Entity types" + }, + "paths": {}, + "definitions": { + "AccountEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents an account entity.", + "properties": { + "properties": { + "$ref": "#/definitions/AccountEntityProperties", + "description": "Account entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Account" + }, + "AccountEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Account entity property bag.", + "properties": { + "aadTenantId": { + "description": "The Azure Active Directory tenant id.", + "readOnly": true, + "type": "string" + }, + "aadUserId": { + "description": "The Azure Active Directory user id.", + "readOnly": true, + "type": "string" + }, + "accountName": { + "description": "The name of the account. This field should hold only the name without any domain added to it, i.e. administrator.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "The display name of the account.", + "readOnly": true, + "type": "string" + }, + "hostEntityId": { + "description": "The Host entity id that contains the account in case it is a local account (not domain joined)", + "readOnly": true, + "type": "string" + }, + "isDomainJoined": { + "description": "Determines whether this is a domain account.", + "readOnly": true, + "type": "boolean" + }, + "ntDomain": { + "description": "The NetBIOS domain name as it appears in the alert format domain/username. Examples: NT AUTHORITY.", + "readOnly": true, + "type": "string" + }, + "objectGuid": { + "description": "The objectGUID attribute is a single-value attribute that is the unique identifier for the object, assigned by active directory.", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "puid": { + "description": "The Azure Active Directory Passport User ID.", + "readOnly": true, + "type": "string" + }, + "sid": { + "description": "The account security identifier, e.g. S-1-5-18.", + "readOnly": true, + "type": "string" + }, + "upnSuffix": { + "description": "The user principal name suffix for the account, in some cases it is also the domain name. Examples: contoso.com.", + "readOnly": true, + "type": "string" + }, + "dnsDomain": { + "description": "The fully qualified domain DNS name.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AzureResourceEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents an azure resource entity.", + "properties": { + "properties": { + "$ref": "#/definitions/AzureResourceEntityProperties", + "description": "AzureResource entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureResource" + }, + "AzureResourceEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "AzureResource entity property bag.", + "properties": { + "resourceId": { + "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" + }, + "CloudApplicationEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a cloud application entity.", + "properties": { + "properties": { + "$ref": "#/definitions/CloudApplicationEntityProperties", + "description": "CloudApplication entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "CloudApplication" + }, + "CloudApplicationEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "CloudApplication entity property bag.", + "properties": { + "appId": { + "description": "The technical identifier of the application.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "appName": { + "description": "The name of the related cloud application.", + "readOnly": true, + "type": "string" + }, + "instanceName": { + "description": "The user defined instance name of the cloud application. It is often used to distinguish between several applications of the same type that a customer has.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DnsEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a dns entity.", + "properties": { + "properties": { + "$ref": "#/definitions/DnsEntityProperties", + "description": "Dns entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "DnsResolution" + }, + "DnsEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Dns entity property bag.", + "properties": { + "dnsServerIpEntityId": { + "description": "An ip entity id for the dns server resolving the request", + "readOnly": true, + "type": "string" + }, + "domainName": { + "description": "The name of the dns record associated with the alert", + "readOnly": true, + "type": "string" + }, + "hostIpAddressEntityId": { + "description": "An ip entity id for the dns request client", + "readOnly": true, + "type": "string" + }, + "ipAddressEntityIds": { + "description": "Ip entity identifiers for the resolved ip address.", + "items": { + "description": "Ip entity id", + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "Entity": { + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "kind": { + "$ref": "#/definitions/EntityInnerKind", + "description": "The kind of the entity." + } + }, + "description": "Specific entity.", + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] + }, + "EntityCommonProperties": { + "description": "Entity common property bag.", + "properties": { + "additionalData": { + "additionalProperties": true, + "description": "A bag of custom fields that should be part of the entity and will be presented to the user.", + "readOnly": true, + "type": "object" + }, + "friendlyName": { + "description": "The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "EntityInnerKind": { + "description": "The kind of the entity", + "enum": [ + "Account", + "Host", + "File", + "AzureResource", + "CloudApplication", + "DnsResolution", + "FileHash", + "Ip", + "Malware", + "Process", + "RegistryKey", + "RegistryValue", + "SecurityGroup", + "Url", + "IoTDevice", + "SecurityAlert", + "Bookmark", + "Mailbox", + "MailCluster", + "MailMessage", + "SubmissionMail", + "Nic" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EntityKindEnum", + "values": [ + { + "description": "Entity represents account in the system.", + "value": "Account" + }, + { + "description": "Entity represents host in the system.", + "value": "Host" + }, + { + "description": "Entity represents file in the system.", + "value": "File" + }, + { + "description": "Entity represents azure resource in the system.", + "value": "AzureResource" + }, + { + "description": "Entity represents cloud application in the system.", + "value": "CloudApplication" + }, + { + "description": "Entity represents dns resolution in the system.", + "value": "DnsResolution" + }, + { + "description": "Entity represents file hash in the system.", + "value": "FileHash" + }, + { + "description": "Entity represents ip in the system.", + "value": "Ip" + }, + { + "description": "Entity represents malware in the system.", + "value": "Malware" + }, + { + "description": "Entity represents process in the system.", + "value": "Process" + }, + { + "description": "Entity represents registry key in the system.", + "value": "RegistryKey" + }, + { + "description": "Entity represents registry value in the system.", + "value": "RegistryValue" + }, + { + "description": "Entity represents security group in the system.", + "value": "SecurityGroup" + }, + { + "description": "Entity represents url in the system.", + "value": "Url" + }, + { + "description": "Entity represents IoT device in the system.", + "value": "IoTDevice" + }, + { + "description": "Entity represents security alert in the system.", + "value": "SecurityAlert" + }, + { + "description": "Entity represents bookmark in the system.", + "value": "Bookmark" + }, + { + "description": "Entity represents mail cluster in the system.", + "value": "MailCluster" + }, + { + "description": "Entity represents mail message in the system.", + "value": "MailMessage" + }, + { + "description": "Entity represents mailbox in the system.", + "value": "Mailbox" + }, + { + "description": "Entity represents submission mail in the system.", + "value": "SubmissionMail" + }, + { + "description": "Entity represents network interface in the system.", + "value": "Nic" + } + ] + } + }, + "EntityInnerType": { + "description": "The type of the entity", + "enum": [ + "Account", + "Host", + "File", + "AzureResource", + "CloudApplication", + "DNS", + "FileHash", + "IP", + "Malware", + "Process", + "RegistryKey", + "RegistryValue", + "SecurityGroup", + "URL", + "IoTDevice", + "SecurityAlert", + "HuntingBookmark", + "MailCluster", + "MailMessage", + "Mailbox", + "SubmissionMail", + "Nic" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EntityType", + "values": [ + { + "description": "Entity represents account in the system.", + "value": "Account" + }, + { + "description": "Entity represents host in the system.", + "value": "Host" + }, + { + "description": "Entity represents file in the system.", + "value": "File" + }, + { + "description": "Entity represents azure resource in the system.", + "value": "AzureResource" + }, + { + "description": "Entity represents cloud application in the system.", + "value": "CloudApplication" + }, + { + "description": "Entity represents dns in the system.", + "value": "DNS" + }, + { + "description": "Entity represents file hash in the system.", + "value": "FileHash" + }, + { + "description": "Entity represents ip in the system.", + "value": "IP" + }, + { + "description": "Entity represents malware in the system.", + "value": "Malware" + }, + { + "description": "Entity represents process in the system.", + "value": "Process" + }, + { + "description": "Entity represents registry key in the system.", + "value": "RegistryKey" + }, + { + "description": "Entity represents registry value in the system.", + "value": "RegistryValue" + }, + { + "description": "Entity represents security group in the system.", + "value": "SecurityGroup" + }, + { + "description": "Entity represents url in the system.", + "value": "URL" + }, + { + "description": "Entity represents IoT device in the system.", + "value": "IoTDevice" + }, + { + "description": "Entity represents security alert in the system.", + "value": "SecurityAlert" + }, + { + "description": "Entity represents HuntingBookmark in the system.", + "value": "HuntingBookmark" + }, + { + "description": "Entity represents mail cluster in the system.", + "value": "MailCluster" + }, + { + "description": "Entity represents mail message in the system.", + "value": "MailMessage" + }, + { + "description": "Entity represents mailbox in the system.", + "value": "Mailbox" + }, + { + "description": "Entity represents submission mail in the system.", + "value": "SubmissionMail" + }, + { + "description": "Entity represents network interface in the system.", + "value": "Nic" + } + ] + } + }, + "EntityQueryKind": { + "description": "The kind of the entity query", + "enum": [ + "Expansion", + "Insight", + "Activity" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EntityQueryKind", + "values": [ + { + "value": "Expansion" + }, + { + "value": "Insight" + }, + { + "value": "Activity" + } + ] + } + }, + "ExpansionResultAggregation": { + "description": "Information of a specific aggregation in the expansion result.", + "properties": { + "aggregationType": { + "description": "The common type of the aggregation. (for e.g. entity field name)", + "type": "string" + }, + "count": { + "description": "Total number of aggregations of the given kind (and aggregationType if given) in the expansion result.", + "type": "integer", + "format": "int32" + }, + "displayName": { + "description": "The display name of the aggregation by type.", + "type": "string" + }, + "entityKind": { + "$ref": "#/definitions/EntityInnerKind", + "description": "The kind of the aggregated entity." + } + }, + "required": [ + "entityKind", + "count" + ], + "type": "object" + }, + "ExpansionResultsMetadata": { + "description": "Expansion result metadata.", + "properties": { + "aggregations": { + "description": "Information of the aggregated nodes in the expansion result.", + "items": { + "$ref": "#/definitions/ExpansionResultAggregation" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "FileEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a file entity.", + "properties": { + "properties": { + "$ref": "#/definitions/FileEntityProperties", + "description": "File entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "File" + }, + "FileEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "File entity property bag.", + "properties": { + "directory": { + "description": "The full path to the file.", + "readOnly": true, + "type": "string" + }, + "fileHashEntityIds": { + "description": "The file hash entity identifiers associated with this file", + "items": { + "description": "file hash id", + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "fileName": { + "description": "The file name without path (some alerts might not include path).", + "readOnly": true, + "type": "string" + }, + "hostEntityId": { + "description": "The Host entity id which the file belongs to", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "FileHashEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a file hash entity.", + "properties": { + "properties": { + "$ref": "#/definitions/FileHashEntityProperties", + "description": "FileHash entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "FileHash" + }, + "FileHashEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "FileHash entity property bag.", + "properties": { + "algorithm": { + "description": "The hash algorithm type.", + "enum": [ + "Unknown", + "MD5", + "SHA1", + "SHA256", + "SHA256AC" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "FileHashAlgorithm", + "values": [ + { + "description": "Unknown hash algorithm", + "value": "Unknown" + }, + { + "description": "MD5 hash type", + "value": "MD5" + }, + { + "description": "SHA1 hash type", + "value": "SHA1" + }, + { + "description": "SHA256 hash type", + "value": "SHA256" + }, + { + "description": "SHA256 Authenticode hash type", + "value": "SHA256AC" + } + ] + } + }, + "hashValue": { + "description": "The file hash value.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "HostEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a host entity.", + "properties": { + "properties": { + "$ref": "#/definitions/HostEntityProperties", + "description": "Host entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Host" + }, + "HostEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Host entity property bag.", + "properties": { + "azureID": { + "description": "The azure resource id of the VM.", + "readOnly": true, + "type": "string" + }, + "dnsDomain": { + "description": "The DNS domain that this host belongs to. Should contain the compete DNS suffix for the domain", + "readOnly": true, + "type": "string" + }, + "hostName": { + "description": "The hostname without the domain suffix.", + "readOnly": true, + "type": "string" + }, + "isDomainJoined": { + "description": "Determines whether this host belongs to a domain.", + "readOnly": true, + "type": "boolean" + }, + "netBiosName": { + "description": "The host name (pre-windows2000).", + "readOnly": true, + "type": "string" + }, + "ntDomain": { + "description": "The NT domain that this host belongs to.", + "readOnly": true, + "type": "string" + }, + "omsAgentID": { + "description": "The OMS agent id, if the host has OMS agent installed.", + "readOnly": true, + "type": "string" + }, + "osFamily": { + "description": "The operating system type.", + "enum": [ + "Linux", + "Windows", + "Android", + "IOS", + "Unknown" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": false, + "name": "OSFamily", + "values": [ + { + "description": "Host with Linux operating system.", + "value": "Linux" + }, + { + "description": "Host with Windows operating system.", + "value": "Windows" + }, + { + "description": "Host with Android operating system.", + "value": "Android" + }, + { + "description": "Host with IOS operating system.", + "value": "IOS" + }, + { + "description": "Host with Unknown operating system.", + "value": "Unknown" + } + ] + } + }, + "osVersion": { + "description": "A free text representation of the operating system. This field is meant to hold specific versions the are more fine grained than OSFamily or future values not supported by OSFamily enumeration", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "HuntingBookmark": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a Hunting bookmark entity.", + "properties": { + "properties": { + "$ref": "#/definitions/HuntingBookmarkProperties", + "description": "HuntingBookmark entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Bookmark" + }, + "HuntingBookmarkProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Describes bookmark properties", + "properties": { + "created": { + "description": "The time the bookmark was created", + "format": "date-time", + "type": "string" + }, + "createdBy": { + "$ref": "../../../../common/2.0/types.json#/definitions/UserInfo", + "description": "Describes a user that created the bookmark", + "type": "object" + }, + "displayName": { + "description": "The display name of the bookmark", + "type": "string" + }, + "eventTime": { + "description": "The time of the event", + "format": "date-time", + "type": "string" + }, + "labels": { + "description": "List of labels relevant to this bookmark", + "items": { + "$ref": "../../../../common/2.0/types.json#/definitions/Label" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "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": "../../../../common/2.0/types.json#/definitions/UserInfo", + "description": "Describes a user that updated the bookmark", + "type": "object" + }, + "incidentInfo": { + "$ref": "IncidentTypes.json#/definitions/IncidentInfo", + "description": "Describes an incident that relates to bookmark", + "type": "object" + } + }, + "required": [ + "displayName", + "query" + ], + "type": "object" + }, + "IoTDeviceEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents an IoT device entity.", + "properties": { + "properties": { + "$ref": "#/definitions/IoTDeviceEntityProperties", + "description": "IoTDevice entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "IoTDevice" + }, + "IoTDeviceEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "IoTDevice entity property bag.", + "properties": { + "deviceId": { + "description": "The ID of the IoT Device in the IoT Hub", + "readOnly": true, + "type": "string" + }, + "deviceName": { + "description": "The friendly name of the device", + "readOnly": true, + "type": "string" + }, + "source": { + "description": "The source of the device", + "readOnly": true, + "type": "string" + }, + "iotSecurityAgentId": { + "description": "The ID of the security agent running on the device", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "deviceType": { + "description": "The type of the device", + "readOnly": true, + "type": "string" + }, + "vendor": { + "description": "The vendor of the device", + "readOnly": true, + "type": "string" + }, + "edgeId": { + "description": "The ID of the edge device", + "readOnly": true, + "type": "string" + }, + "macAddress": { + "description": "The MAC address of the device", + "readOnly": true, + "type": "string" + }, + "model": { + "description": "The model of the device", + "readOnly": true, + "type": "string" + }, + "serialNumber": { + "description": "The serial number of the device", + "readOnly": true, + "type": "string" + }, + "firmwareVersion": { + "description": "The firmware version of the device", + "readOnly": true, + "type": "string" + }, + "operatingSystem": { + "description": "The operating system of the device", + "readOnly": true, + "type": "string" + }, + "iotHubEntityId": { + "description": "The AzureResource entity id of the IoT Hub", + "readOnly": true, + "type": "string" + }, + "hostEntityId": { + "description": "The Host entity id of this device", + "readOnly": true, + "type": "string" + }, + "ipAddressEntityId": { + "description": "The IP entity if of this device", + "readOnly": true, + "type": "string" + }, + "threatIntelligence": { + "description": "A list of TI contexts attached to the IoTDevice entity.", + "items": { + "$ref": "ThreatIntelligenceTypes.json#/definitions/ThreatIntelligence" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "protocols": { + "description": "A list of protocols of the IoTDevice entity.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "owners": { + "description": "A list of owners of the IoTDevice entity.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "nicEntityIds": { + "description": "A list of Nic entity ids of the IoTDevice entity.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "site": { + "description": "The site of the device", + "readOnly": true, + "type": "string" + }, + "zone": { + "description": "The zone location of the device within a site", + "readOnly": true, + "type": "string" + }, + "sensor": { + "description": "The sensor the device is monitored by", + "readOnly": true, + "type": "string" + }, + "deviceSubType": { + "description": "The subType of the device ('PLC', 'HMI', 'EWS', etc.)", + "readOnly": true, + "type": "string" + }, + "importance": { + "description": "Device importance, determines if the device classified as 'crown jewel'", + "enum": [ + "Unknown", + "Low", + "Normal", + "High" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DeviceImportance", + "values": [ + { + "description": "Unknown - Default value", + "value": "Unknown" + }, + { + "description": "Low", + "value": "Low" + }, + { + "description": "Normal", + "value": "Normal" + }, + { + "description": "High", + "value": "High" + } + ] + } + }, + "purdueLayer": { + "description": "The Purdue Layer of the device", + "readOnly": true, + "type": "string" + }, + "isAuthorized": { + "description": "Determines whether the device classified as authorized device", + "readOnly": true, + "type": "boolean" + }, + "isProgramming": { + "description": "Determines whether the device classified as programming device", + "readOnly": true, + "type": "boolean" + }, + "isScanner": { + "description": "Is the device classified as a scanner device", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, + "IpEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents an ip entity.", + "properties": { + "properties": { + "$ref": "#/definitions/IpEntityProperties", + "description": "Ip entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Ip" + }, + "IpEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Ip entity property bag.", + "properties": { + "address": { + "description": "The IP address as string, e.g. 127.0.0.1 (either in Ipv4 or Ipv6)", + "readOnly": true, + "type": "string" + }, + "location": { + "$ref": "#/definitions/GeoLocation", + "description": "The geo-location context attached to the ip entity" + }, + "threatIntelligence": { + "description": "A list of TI contexts attached to the ip entity.", + "items": { + "$ref": "ThreatIntelligenceTypes.json#/definitions/ThreatIntelligence" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "GeoLocation": { + "description": "The geo-location context attached to the ip entity", + "properties": { + "asn": { + "description": "Autonomous System Number", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "city": { + "description": "City name", + "readOnly": true, + "type": "string" + }, + "countryCode": { + "description": "The country code according to ISO 3166 format", + "readOnly": true, + "type": "string" + }, + "countryName": { + "description": "Country name according to ISO 3166 Alpha 2: the lowercase of the English Short Name", + "readOnly": true, + "type": "string" + }, + "latitude": { + "description": "The latitude of the identified location, expressed as a floating point number with range of - 90 to 90. Latitude and longitude are derived from the city or postal code.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "longitude": { + "description": "The longitude of the identified location, expressed as a floating point number with range of -180 to 180. Latitude and longitude are derived from the city or postal code.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "state": { + "description": "State name", + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object" + }, + "MailboxEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a mailbox entity.", + "properties": { + "properties": { + "$ref": "#/definitions/MailboxEntityProperties", + "description": "Mailbox entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Mailbox" + }, + "MailboxEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Mailbox entity property bag.", + "properties": { + "mailboxPrimaryAddress": { + "description": "The mailbox's primary address", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "The mailbox's display name", + "readOnly": true, + "type": "string" + }, + "upn": { + "description": "The mailbox's UPN", + "readOnly": true, + "type": "string" + }, + "externalDirectoryObjectId": { + "description": "The AzureAD identifier of mailbox. Similar to AadUserId in account entity but this property is specific to mailbox object on office side", + "format": "uuid", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MailClusterEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a mail cluster entity.", + "properties": { + "properties": { + "$ref": "#/definitions/MailClusterEntityProperties", + "description": "Mail cluster entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MailCluster" + }, + "MailClusterEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Mail cluster entity property bag.", + "properties": { + "networkMessageIds": { + "description": "The mail message IDs that are part of the mail cluster", + "items": { + "description": "A mail message ID", + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "countByDeliveryStatus": { + "description": "Count of mail messages by DeliveryStatus string representation", + "readOnly": true, + "type": "object" + }, + "countByThreatType": { + "description": "Count of mail messages by ThreatType string representation", + "readOnly": true, + "type": "object" + }, + "countByProtectionStatus": { + "description": "Count of mail messages by ProtectionStatus string representation", + "readOnly": true, + "type": "object" + }, + "threats": { + "description": "The threats of mail messages that are part of the mail cluster", + "items": { + "description": "A threat", + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "query": { + "description": "The query that was used to identify the messages of the mail cluster", + "readOnly": true, + "type": "string" + }, + "queryTime": { + "description": "The query time", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "mailCount": { + "description": "The number of mail messages that are part of the mail cluster", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "isVolumeAnomaly": { + "description": "Is this a volume anomaly mail cluster", + "readOnly": true, + "type": "boolean" + }, + "source": { + "description": "The source of the mail cluster (default is 'O365 ATP')", + "readOnly": true, + "type": "string" + }, + "clusterSourceIdentifier": { + "description": "The id of the cluster source", + "readOnly": true, + "type": "string" + }, + "clusterSourceType": { + "description": "The type of the cluster source", + "readOnly": true, + "type": "string" + }, + "clusterQueryStartTime": { + "description": "The cluster query start time", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "clusterQueryEndTime": { + "description": "The cluster query end time", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "clusterGroup": { + "description": "The cluster group", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MailMessageEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a mail message entity.", + "properties": { + "properties": { + "$ref": "#/definitions/MailMessageEntityProperties", + "description": "Mail message entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MailMessage" + }, + "MailMessageEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Mail message entity property bag.", + "properties": { + "fileEntityIds": { + "description": "The File entity ids of this mail message's attachments", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "recipient": { + "description": "The recipient of this mail message. Note that in case of multiple recipients the mail message is forked and each copy has one recipient", + "readOnly": true, + "type": "string" + }, + "urls": { + "description": "The Urls contained in this mail message", + "items": { + "description": "A Url contained in this mail message", + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "threats": { + "description": "The threats of this mail message", + "items": { + "description": "A threat of the mail message", + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "p1Sender": { + "description": "The p1 sender's email address", + "readOnly": true, + "type": "string" + }, + "p1SenderDisplayName": { + "description": "The p1 sender's display name", + "readOnly": true, + "type": "string" + }, + "p1SenderDomain": { + "description": "The p1 sender's domain", + "readOnly": true, + "type": "string" + }, + "senderIP": { + "description": "The sender's IP address", + "readOnly": true, + "type": "string" + }, + "p2Sender": { + "description": "The p2 sender's email address", + "readOnly": true, + "type": "string" + }, + "p2SenderDisplayName": { + "description": "The p2 sender's display name", + "readOnly": true, + "type": "string" + }, + "p2SenderDomain": { + "description": "The p2 sender's domain", + "readOnly": true, + "type": "string" + }, + "receiveDate": { + "description": "The receive date of this message", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "networkMessageId": { + "description": "The network message id of this mail message", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "internetMessageId": { + "description": "The internet message id of this mail message", + "readOnly": true, + "type": "string" + }, + "subject": { + "description": "The subject of this mail message", + "readOnly": true, + "type": "string" + }, + "language": { + "description": "The language of this mail message", + "readOnly": true, + "type": "string" + }, + "threatDetectionMethods": { + "description": "The threat detection methods", + "items": { + "description": "A threat detection method", + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "bodyFingerprintBin1": { + "description": "The bodyFingerprintBin1", + "type": "integer", + "format": "int32" + }, + "bodyFingerprintBin2": { + "description": "The bodyFingerprintBin2", + "type": "integer", + "format": "int32" + }, + "bodyFingerprintBin3": { + "description": "The bodyFingerprintBin3", + "type": "integer", + "format": "int32" + }, + "bodyFingerprintBin4": { + "description": "The bodyFingerprintBin4", + "type": "integer", + "format": "int32" + }, + "bodyFingerprintBin5": { + "description": "The bodyFingerprintBin5", + "type": "integer", + "format": "int32" + }, + "antispamDirection": { + "description": "The directionality of this mail message", + "enum": [ + "Unknown", + "Inbound", + "Outbound", + "Intraorg" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AntispamMailDirection", + "values": [ + { + "description": "Unknown", + "value": "Unknown" + }, + { + "description": "Inbound", + "value": "Inbound" + }, + { + "description": "Outbound", + "value": "Outbound" + }, + { + "description": "Intraorg", + "value": "Intraorg" + } + ] + } + }, + "deliveryAction": { + "description": "The delivery action of this mail message like Delivered, Blocked, Replaced etc", + "enum": [ + "Unknown", + "DeliveredAsSpam", + "Delivered", + "Blocked", + "Replaced" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": false, + "name": "DeliveryAction", + "values": [ + { + "description": "Unknown", + "value": "Unknown" + }, + { + "description": "DeliveredAsSpam", + "value": "DeliveredAsSpam" + }, + { + "description": "Delivered", + "value": "Delivered" + }, + { + "description": "Blocked", + "value": "Blocked" + }, + { + "description": "Replaced", + "value": "Replaced" + } + ] + } + }, + "deliveryLocation": { + "description": "The delivery location of this mail message like Inbox, JunkFolder etc", + "enum": [ + "Unknown", + "Inbox", + "JunkFolder", + "DeletedFolder", + "Quarantine", + "External", + "Failed", + "Dropped", + "Forwarded" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": false, + "name": "DeliveryLocation", + "values": [ + { + "description": "Unknown", + "value": "Unknown" + }, + { + "description": "Inbox", + "value": "Inbox" + }, + { + "description": "JunkFolder", + "value": "JunkFolder" + }, + { + "description": "DeletedFolder", + "value": "DeletedFolder" + }, + { + "description": "Quarantine", + "value": "Quarantine" + }, + { + "description": "External", + "value": "External" + }, + { + "description": "Failed", + "value": "Failed" + }, + { + "description": "Dropped", + "value": "Dropped" + }, + { + "description": "Forwarded", + "value": "Forwarded" + } + ] + } + } + }, + "type": "object" + }, + "MalwareEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a malware entity.", + "properties": { + "properties": { + "$ref": "#/definitions/MalwareEntityProperties", + "description": "File entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Malware" + }, + "MalwareEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Malware entity property bag.", + "properties": { + "category": { + "description": "The malware category by the vendor, e.g. Trojan", + "readOnly": true, + "type": "string" + }, + "fileEntityIds": { + "description": "List of linked file entity identifiers on which the malware was found", + "items": { + "description": "file entity id", + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "malwareName": { + "description": "The malware name by the vendor, e.g. Win32/Toga!rfn", + "readOnly": true, + "type": "string" + }, + "processEntityIds": { + "description": "List of linked process entity identifiers on which the malware was found.", + "items": { + "description": "process entity id", + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "ProcessEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a process entity.", + "properties": { + "properties": { + "$ref": "#/definitions/ProcessEntityProperties", + "description": "Process entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Process" + }, + "ProcessEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Process entity property bag.", + "properties": { + "accountEntityId": { + "description": "The account entity id running the processes.", + "readOnly": true, + "type": "string" + }, + "commandLine": { + "description": "The command line used to create the process", + "readOnly": true, + "type": "string" + }, + "creationTimeUtc": { + "description": "The time when the process started to run", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "elevationToken": { + "description": "The elevation token associated with the process.", + "enum": [ + "Default", + "Full", + "Limited" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": false, + "name": "ElevationToken", + "values": [ + { + "description": "Default elevation token", + "value": "Default" + }, + { + "description": "Full elevation token", + "value": "Full" + }, + { + "description": "Limited elevation token", + "value": "Limited" + } + ] + } + }, + "hostEntityId": { + "description": "The host entity id on which the process was running", + "readOnly": true, + "type": "string" + }, + "hostLogonSessionEntityId": { + "description": "The session entity id in which the process was running", + "readOnly": true, + "type": "string" + }, + "imageFileEntityId": { + "description": "Image file entity id", + "readOnly": true, + "type": "string" + }, + "parentProcessEntityId": { + "description": "The parent process entity id.", + "readOnly": true, + "type": "string" + }, + "processId": { + "description": "The process ID", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "RegistryKeyEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a registry key entity.", + "properties": { + "properties": { + "$ref": "#/definitions/RegistryKeyEntityProperties", + "description": "RegistryKey entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "RegistryKey" + }, + "RegistryKeyEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "RegistryKey entity property bag.", + "properties": { + "hive": { + "description": "the hive that holds the registry key.", + "enum": [ + "HKEY_LOCAL_MACHINE", + "HKEY_CLASSES_ROOT", + "HKEY_CURRENT_CONFIG", + "HKEY_USERS", + "HKEY_CURRENT_USER_LOCAL_SETTINGS", + "HKEY_PERFORMANCE_DATA", + "HKEY_PERFORMANCE_NLSTEXT", + "HKEY_PERFORMANCE_TEXT", + "HKEY_A", + "HKEY_CURRENT_USER" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RegistryHive", + "values": [ + { + "description": "HKEY_LOCAL_MACHINE", + "value": "HKEY_LOCAL_MACHINE" + }, + { + "description": "HKEY_CLASSES_ROOT", + "value": "HKEY_CLASSES_ROOT" + }, + { + "description": "HKEY_CURRENT_CONFIG", + "value": "HKEY_CURRENT_CONFIG" + }, + { + "description": "HKEY_USERS", + "value": "HKEY_USERS" + }, + { + "description": "HKEY_CURRENT_USER_LOCAL_SETTINGS", + "value": "HKEY_CURRENT_USER_LOCAL_SETTINGS" + }, + { + "description": "HKEY_PERFORMANCE_DATA", + "value": "HKEY_PERFORMANCE_DATA" + }, + { + "description": "HKEY_PERFORMANCE_NLSTEXT", + "value": "HKEY_PERFORMANCE_NLSTEXT" + }, + { + "description": "HKEY_PERFORMANCE_TEXT", + "value": "HKEY_PERFORMANCE_TEXT" + }, + { + "description": "HKEY_A", + "value": "HKEY_A" + }, + { + "description": "HKEY_CURRENT_USER", + "value": "HKEY_CURRENT_USER" + } + ] + } + }, + "key": { + "description": "The registry key path.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "RegistryValueEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a registry value entity.", + "properties": { + "properties": { + "$ref": "#/definitions/RegistryValueEntityProperties", + "description": "RegistryKey entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "RegistryValue" + }, + "RegistryValueEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "RegistryValue entity property bag.", + "properties": { + "keyEntityId": { + "description": "The registry key entity id.", + "readOnly": true, + "type": "string" + }, + "valueData": { + "description": "String formatted representation of the value data.", + "readOnly": true, + "type": "string" + }, + "valueName": { + "description": "The registry value name.", + "readOnly": true, + "type": "string" + }, + "valueType": { + "description": "Specifies the data types to use when storing values in the registry, or identifies the data type of a value in the registry.", + "enum": [ + "None", + "Unknown", + "String", + "ExpandString", + "Binary", + "DWord", + "MultiString", + "QWord" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RegistryValueKind", + "values": [ + { + "description": "None", + "value": "None" + }, + { + "description": "Unknown value type", + "value": "Unknown" + }, + { + "description": "String value type", + "value": "String" + }, + { + "description": "ExpandString value type", + "value": "ExpandString" + }, + { + "description": "Binary value type", + "value": "Binary" + }, + { + "description": "DWord value type", + "value": "DWord" + }, + { + "description": "MultiString value type", + "value": "MultiString" + }, + { + "description": "QWord value type", + "value": "QWord" + } + ] + } + } + }, + "type": "object" + }, + "SecurityAlert": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a security alert entity.", + "properties": { + "properties": { + "$ref": "#/definitions/SecurityAlertProperties", + "description": "SecurityAlert entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "SecurityAlert" + }, + "SecurityAlertProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "SecurityAlert entity property bag.", + "properties": { + "alertDisplayName": { + "description": "The display name of the alert.", + "readOnly": true, + "type": "string" + }, + "alertType": { + "description": "The type name of the alert.", + "readOnly": true, + "type": "string" + }, + "compromisedEntity": { + "description": "Display name of the main entity being reported on.", + "readOnly": true, + "type": "string" + }, + "confidenceLevel": { + "description": "The confidence level of this alert.", + "enum": [ + "Unknown", + "Low", + "High" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ConfidenceLevel", + "values": [ + { + "description": "Unknown confidence, the is the default value", + "value": "Unknown" + }, + { + "description": "Low confidence, meaning we have some doubts this is indeed malicious or part of an attack", + "value": "Low" + }, + { + "description": "High confidence that the alert is true positive malicious", + "value": "High" + } + ] + } + }, + "confidenceReasons": { + "description": "The confidence reasons", + "items": { + "description": "confidence reason item", + "properties": { + "reason": { + "description": "The reason's description", + "readOnly": true, + "type": "string" + }, + "reasonType": { + "description": "The type (category) of the reason", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "confidenceScore": { + "description": "The confidence score of the alert.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "confidenceScoreStatus": { + "description": "The confidence score calculation status, i.e. indicating if score calculation is pending for this alert, not applicable or final.", + "enum": [ + "NotApplicable", + "InProcess", + "NotFinal", + "Final" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ConfidenceScoreStatus", + "values": [ + { + "description": "Score will not be calculated for this alert as it is not supported by virtual analyst", + "value": "NotApplicable" + }, + { + "description": "No score was set yet and calculation is in progress", + "value": "InProcess" + }, + { + "description": "Score is calculated and shown as part of the alert, but may be updated again at a later time following the processing of additional data", + "value": "NotFinal" + }, + { + "description": "Final score was calculated and available", + "value": "Final" + } + ] + } + }, + "description": { + "description": "Alert description.", + "readOnly": true, + "type": "string" + }, + "endTimeUtc": { + "description": "The impact end time of the alert (the time of the last event contributing to the alert).", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "intent": { + "description": "Holds the alert intent stage(s) mapping for this alert.", + "enum": [ + "Unknown", + "Probing", + "Exploitation", + "Persistence", + "PrivilegeEscalation", + "DefenseEvasion", + "CredentialAccess", + "Discovery", + "LateralMovement", + "Execution", + "Collection", + "Exfiltration", + "CommandAndControl", + "Impact" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "KillChainIntent", + "values": [ + { + "description": "The default value.", + "value": "Unknown" + }, + { + "description": "Probing could be an attempt to access a certain resource regardless of a malicious intent or a failed attempt to gain access to a target system to gather information prior to exploitation. This step is usually detected as an attempt originating from outside the network in attempt to scan the target system and find a way in.", + "value": "Probing" + }, + { + "description": "Exploitation is the stage where an attacker manage to get foothold on the attacked resource. This stage is applicable not only for compute hosts, but also for resources such as user accounts, certificates etc. Adversaries will often be able to control the resource after this stage.", + "value": "Exploitation" + }, + { + "description": "Persistence is any access, action, or configuration change to a system that gives an adversary a persistent presence on that system. Adversaries will often need to maintain access to systems through interruptions such as system restarts, loss of credentials, or other failures that would require a remote access tool to restart or alternate backdoor for them to regain access.", + "value": "Persistence" + }, + { + "description": "Privilege escalation is the result of actions that allow an adversary to obtain a higher level of permissions on a system or network. Certain tools or actions require a higher level of privilege to work and are likely necessary at many points throughout an operation. User accounts with permissions to access specific systems or perform specific functions necessary for adversaries to achieve their objective may also be considered an escalation of privilege.", + "value": "PrivilegeEscalation" + }, + { + "description": "Defense evasion consists of techniques an adversary may use to evade detection or avoid other defenses. Sometimes these actions are the same as or variations of techniques in other categories that have the added benefit of subverting a particular defense or mitigation. ", + "value": "DefenseEvasion" + }, + { + "description": "Credential access represents techniques resulting in access to or control over system, domain, or service credentials that are used within an enterprise environment. Adversaries will likely attempt to obtain legitimate credentials from users or administrator accounts (local system administrator or domain users with administrator access) to use within the network. With sufficient access within a network, an adversary can create accounts for later use within the environment.", + "value": "CredentialAccess" + }, + { + "description": "Discovery consists of techniques that allow the adversary to gain knowledge about the system and internal network. When adversaries gain access to a new system, they must navigate themselves to what they now have control of and what benefits operating from that system give to their current objective or overall goals during the intrusion. The operating system provides many native tools that aid in this post-compromise information-gathering phase.", + "value": "Discovery" + }, + { + "description": "Lateral movement consists of techniques that enable an adversary to access and control remote systems on a network and could, but does not necessarily, include execution of tools on remote systems. The lateral movement techniques could allow an adversary to gather information from a system without needing additional tools, such as a remote access tool. An adversary can use lateral movement for many purposes, including remote Execution of tools, pivoting to additional systems, access to specific information or files, access to additional credentials, or to cause an effect.", + "value": "LateralMovement" + }, + { + "description": "The execution tactic represents techniques that result in execution of adversary-controlled code on a local or remote system. This tactic is often used in conjunction with lateral movement to expand access to remote systems on a network.", + "value": "Execution" + }, + { + "description": "Collection consists of techniques used to identify and gather information, such as sensitive files, from a target network prior to exfiltration. This category also covers locations on a system or network where the adversary may look for information to exfiltrate.", + "value": "Collection" + }, + { + "description": "Exfiltration refers to techniques and attributes that result or aid in the adversary removing files and information from a target network. This category also covers locations on a system or network where the adversary may look for information to exfiltrate.", + "value": "Exfiltration" + }, + { + "description": "The command and control tactic represents how adversaries communicate with systems under their control within a target network.", + "value": "CommandAndControl" + }, + { + "description": "The impact intent primary objective is to directly reduce the availability or integrity of a system, service, or network; including manipulation of data to impact a business or operational process. This would often refer to techniques such as ransom-ware, defacement, data manipulation and others.", + "value": "Impact" + } + ] + } + }, + "providerAlertId": { + "description": "The identifier of the alert inside the product which generated the alert.", + "readOnly": true, + "type": "string" + }, + "processingEndTime": { + "description": "The time the alert was made available for consumption.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "productComponentName": { + "description": "The name of a component inside the product which generated the alert.", + "readOnly": true, + "type": "string" + }, + "productName": { + "description": "The name of the product which published this alert.", + "readOnly": true, + "type": "string" + }, + "productVersion": { + "description": "The version of the product generating the alert.", + "readOnly": true, + "type": "string" + }, + "remediationSteps": { + "description": "Manual action items to take to remediate the alert.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "severity": { + "$ref": "AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The severity of the alert", + "type": "string" + }, + "startTimeUtc": { + "description": "The impact start time of the alert (the time of the first event contributing to the alert).", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "The lifecycle status of the alert.", + "enum": [ + "Unknown", + "New", + "Resolved", + "Dismissed", + "InProgress" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AlertStatus", + "values": [ + { + "description": "Unknown value", + "value": "Unknown" + }, + { + "description": "New alert", + "value": "New" + }, + { + "description": "Alert closed after handling", + "value": "Resolved" + }, + { + "description": "Alert dismissed as false positive", + "value": "Dismissed" + }, + { + "description": "Alert is being handled", + "value": "InProgress" + } + ] + } + }, + "systemAlertId": { + "description": "Holds the product identifier of the alert for the product.", + "readOnly": true, + "type": "string" + }, + "tactics": { + "description": "The tactics of the alert", + "items": { + "$ref": "AlertTypes.json#/definitions/AttackTactic" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "timeGenerated": { + "description": "The time the alert was generated.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "vendorName": { + "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" + }, + "resourceIdentifiers": { + "description": "The list of resource identifiers of the alert.", + "items": { + "type": "object" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "SecurityGroupEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a security group entity.", + "properties": { + "properties": { + "$ref": "#/definitions/SecurityGroupEntityProperties", + "description": "SecurityGroup entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "SecurityGroup" + }, + "SecurityGroupEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "SecurityGroup entity property bag.", + "properties": { + "distinguishedName": { + "description": "The group distinguished name", + "readOnly": true, + "type": "string" + }, + "objectGuid": { + "description": "A single-value attribute that is the unique identifier for the object, assigned by active directory.", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "sid": { + "description": "The SID attribute is a single-value attribute that specifies the security identifier (SID) of the group", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "SubmissionMailEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a submission mail entity.", + "properties": { + "properties": { + "$ref": "#/definitions/SubmissionMailEntityProperties", + "description": "Submission mail entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "SubmissionMail" + }, + "SubmissionMailEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Submission mail entity property bag.", + "properties": { + "networkMessageId": { + "description": "The network message id of email to which submission belongs", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "submissionId": { + "description": "The submission id", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "submitter": { + "description": "The submitter", + "readOnly": true, + "type": "string" + }, + "submissionDate": { + "description": "The submission date", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "timestamp": { + "description": "The Time stamp when the message is received (Mail)", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "recipient": { + "description": "The recipient of the mail", + "readOnly": true, + "type": "string" + }, + "sender": { + "description": "The sender of the mail", + "readOnly": true, + "type": "string" + }, + "senderIp": { + "description": "The sender's IP", + "readOnly": true, + "type": "string" + }, + "subject": { + "description": "The subject of submission mail", + "readOnly": true, + "type": "string" + }, + "reportType": { + "description": "The submission type for the given instance. This maps to Junk, Phish, Malware or NotJunk.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "UrlEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a url entity.", + "properties": { + "properties": { + "$ref": "#/definitions/UrlEntityProperties", + "description": "Url entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Url" + }, + "UrlEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Url entity property bag.", + "properties": { + "url": { + "description": "A full URL the entity points to", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "NicEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents an network interface entity.", + "properties": { + "properties": { + "$ref": "#/definitions/NicEntityProperties", + "description": "Network interface entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Nic" + }, + "NicEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Nic entity property bag.", + "properties": { + "macAddress": { + "description": "The MAC address of this network interface", + "readOnly": true, + "type": "string" + }, + "ipAddressEntityId": { + "description": "The IP entity id of this network interface", + "readOnly": true, + "type": "string" + }, + "vlans": { + "description": "A list of VLANs of the network interface entity.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + } + }, + "parameters": {} +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/common/IncidentTypes.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/common/IncidentTypes.json new file mode 100644 index 000000000000..d3c53c42f100 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/common/IncidentTypes.json @@ -0,0 +1,246 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01-preview", + "title": "Common Incident types" + }, + "paths": {}, + "definitions": { + "IncidentClassificationEnum": { + "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" + } + ] + } + }, + "IncidentClassificationReasonEnum": { + "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" + } + ] + } + }, + "IncidentLabel": { + "description": "Represents an incident label", + "properties": { + "labelName": { + "description": "The name of the label", + "type": "string" + }, + "labelType": { + "$ref": "#/definitions/IncidentLabelType" + } + }, + "required": [ + "labelName" + ], + "type": "object" + }, + "IncidentLabelType": { + "description": "The type of the label", + "enum": [ + "User", + "AutoAssigned" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentLabelType", + "values": [ + { + "description": "Label manually created by a user", + "value": "User" + }, + { + "description": "Label automatically created by the system", + "value": "AutoAssigned" + } + ] + } + }, + "IncidentSeverityEnum": { + "description": "The severity of the incident", + "enum": [ + "High", + "Medium", + "Low", + "Informational" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentSeverity", + "values": [ + { + "description": "High severity", + "value": "High" + }, + { + "description": "Medium severity", + "value": "Medium" + }, + { + "description": "Low severity", + "value": "Low" + }, + { + "description": "Informational severity", + "value": "Informational" + } + ] + } + }, + "IncidentStatusEnum": { + "description": "The status of the incident", + "enum": [ + "New", + "Active", + "Closed" + ], + "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" + } + ] + } + }, + "IncidentOwnerInfo": { + "description": "Information on the user an incident is assigned to", + "properties": { + "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" + }, + "ownerType": { + "description": "The type of the owner the incident is assigned to.", + "type": "string", + "enum": [ + "Unknown", + "User", + "Group" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "OwnerType", + "values": [ + { + "description": "The incident owner type is unknown", + "value": "Unknown" + }, + { + "description": "The incident owner type is an AAD user", + "value": "User" + }, + { + "description": "The incident owner type is an AAD group", + "value": "Group" + } + ] + } + } + }, + "type": "object" + }, + "IncidentInfo": { + "description": "Describes related incident information for the bookmark", + "properties": { + "incidentId": { + "description": "Incident Id", + "type": "string" + }, + "severity": { + "description": "The severity of the incident", + "type": "string", + "$ref": "#/definitions/IncidentSeverityEnum" + }, + "title": { + "description": "The title of the incident", + "type": "string" + }, + "relationName": { + "description": "Relation Name", + "type": "string" + } + }, + "type": "object" + } + }, + "parameters": {} +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/common/RelationTypes.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/common/RelationTypes.json new file mode 100644 index 000000000000..e08c947d6326 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/common/RelationTypes.json @@ -0,0 +1,98 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01-preview", + "title": "Common Relation types" + }, + "paths": {}, + "definitions": { + "RelationList": { + "description": "List of relations.", + "properties": { + "nextLink": { + "readOnly": true, + "description": "URL to fetch the next set of relations.", + "type": "string" + }, + "value": { + "description": "Array of relations.", + "type": "array", + "items": { + "$ref": "#/definitions/Relation" + } + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "Relation": { + "type": "object", + "description": "Represents a relation between two resources", + "allOf": [ + { + "$ref": "../../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RelationProperties", + "description": "Relation properties", + "x-ms-client-flatten": true + } + } + }, + "RelationProperties": { + "description": "Relation property bag.", + "properties": { + "relatedResourceId": { + "description": "The resource ID of the related resource", + "type": "string" + }, + "relatedResourceName": { + "description": "The name of the related resource", + "readOnly": true, + "type": "string" + }, + "relatedResourceType": { + "description": "The resource type of the related resource", + "readOnly": true, + "type": "string" + }, + "relatedResourceKind": { + "description": "The resource kind of the related resource", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "relatedResourceId" + ], + "type": "object" + } + }, + "parameters": { + "RelationName": { + "name": "relationName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,63}$", + "minLength": 3, + "maxLength": 63, + "description": "Relation Name", + "x-ms-parameter-location": "method" + }, + "Relation": { + "name": "relation", + "in": "body", + "description": "The relation model", + "required": true, + "schema": { + "$ref": "#/definitions/Relation" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/common/ThreatIntelligenceTypes.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/common/ThreatIntelligenceTypes.json new file mode 100644 index 000000000000..6b76b039da25 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/common/ThreatIntelligenceTypes.json @@ -0,0 +1,48 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01-preview", + "title": "Common Relation types" + }, + "paths": {}, + "definitions": { + "ThreatIntelligence": { + "description": "ThreatIntelligence property bag.", + "properties": { + "confidence": { + "description": "Confidence (must be between 0 and 1)", + "format": "double", + "readOnly": true, + "type": "number" + }, + "providerName": { + "description": "Name of the provider from whom this Threat Intelligence information was received", + "readOnly": true, + "type": "string" + }, + "reportLink": { + "description": "Report link", + "readOnly": true, + "type": "string" + }, + "threatDescription": { + "description": "Threat description (free text)", + "readOnly": true, + "type": "string" + }, + "threatName": { + "description": "Threat name (e.g. \"Jedobot malware\")", + "readOnly": true, + "type": "string" + }, + "threatType": { + "description": "Threat type (e.g. \"Botnet\")", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + } + }, + "parameters": {} +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/dataConnectorDefinitions.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/dataConnectorDefinitions.json new file mode 100644 index 000000000000..fe7f1026c7dd --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/dataConnectorDefinitions.json @@ -0,0 +1,706 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectorDefinitions": { + "get": { + "x-ms-examples": { + "Get all data connector definitions.": { + "$ref": "./examples/dataConnectorDefinitions/GetDataConnectorDefinitions.json" + } + }, + "tags": [ + "ConnectorDefinitions" + ], + "description": "Gets all data connector definitions.", + "operationId": "DataConnectorDefinitions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataConnectorDefinitionArmCollectionWrapper" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/{dataConnectorDefinitionName}": { + "get": { + "x-ms-examples": { + "Get customize data connector definition": { + "$ref": "./examples/dataConnectorDefinitions/GetCustomizableDataConnectoeDefinitionById.json" + } + }, + "tags": [ + "ConnectorDefinitions" + ], + "description": "Gets a data connector definition.", + "operationId": "DataConnectorDefinitions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/dataConnectorDefinitionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataConnectorDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create data connector definition": { + "$ref": "./examples/dataConnectorDefinitions/CreateCustomizableDataConnectorDefinition.json" + } + }, + "tags": [ + "ConnectorDefinitions" + ], + "description": "Creates or updates the data connector definition.", + "operationId": "DataConnectorDefinitions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/dataConnectorDefinitionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "connectorDefinitionInput", + "required": true, + "schema": { + "$ref": "#/definitions/DataConnectorDefinition" + }, + "description": "The data connector definition", + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "Updated", + "schema": { + "$ref": "#/definitions/DataConnectorDefinition" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DataConnectorDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete data connector definition": { + "$ref": "./examples/dataConnectorDefinitions/DeleteDataConnectorDefinitionById.json" + } + }, + "tags": [ + "ConnectorDefinitions" + ], + "description": "Delete the data connector definition.", + "operationId": "DataConnectorDefinitions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/dataConnectorDefinitionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "ConnectorDefinitionsAvailability": { + "description": "The exposure status of the connector to the customers.", + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/AvailabilityStatus" + }, + "isPreview": { + "description": "Gets or sets a value indicating whether the connector is preview.", + "type": "boolean" + } + } + }, + "AvailabilityStatus": { + "description": "The exposure status of the connector to the customers. Available values are 0-4 (0=None, 1=Available, 2=FeatureFlag, 3=Internal).", + "type": "integer", + "format": "int32" + }, + "ConnectivityCriterion": { + "description": "The criteria by which we determine whether the connector is connected or not.\r\nFor Example, use a KQL query to check if the expected data type is flowing).", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "description": "Gets or sets the type of connectivity.", + "type": "string" + }, + "value": { + "description": "Gets or sets the queries for checking connectivity.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ConnectorDataType": { + "description": "The data type which is created by the connector,\r\nincluding a query indicated when was the last time that data type was received in the workspace.", + "required": [ + "lastDataReceivedQuery", + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "Gets or sets the name of the data type to show in the graph.", + "type": "string" + }, + "lastDataReceivedQuery": { + "description": "Gets or sets the query to indicate when relevant data was last received in the workspace.", + "type": "string" + } + } + }, + "DataConnectorDefinition": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "required": [ + "kind" + ], + "description": "An Azure resource, which encapsulate the entire info requires to display a data connector page in Azure portal,\r\nand the info required to define data connections.", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/DataConnectorDefinitionKind", + "description": "The data connector kind", + "type": "string" + } + }, + "discriminator": "kind" + }, + "DataConnectorDefinitionKind": { + "description": "The kind of the data connector definitions", + "enum": [ + "Customizable" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DataConnectorDefinitionKind", + "values": [ + { + "value": "Customizable" + } + ] + } + }, + "DataConnectorDefinitionArmCollectionWrapper": { + "type": "object", + "description": "Encapsulate the data connector definition object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DataConnectorDefinition" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "CustomizableConnectorDefinition": { + "description": "Connector definition for kind 'Customizable'.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDefinition" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/CustomizableConnectorDefinitionProperties", + "description": "Customizable properties.", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "Customizable" + }, + "CustomizableConnectorDefinitionProperties": { + "description": "The UiConfig for 'Customizable' connector definition kind.", + "type": "object", + "required": [ + "connectorUiConfig" + ], + "properties": { + "createdTimeUtc": { + "format": "date-time", + "description": "Gets or sets the connector definition created date in UTC format.", + "type": "string" + }, + "lastModifiedUtc": { + "format": "date-time", + "description": "Gets or sets the connector definition last modified date in UTC format.", + "type": "string" + }, + "connectorUiConfig": { + "$ref": "#/definitions/CustomizableConnectorUiConfig" + }, + "connectionsConfig": { + "$ref": "#/definitions/CustomizableConnectionsConfig" + } + } + }, + "CustomizableConnectionsConfig": { + "description": "The UiConfig for 'Customizable' connector definition kind.", + "required": [ + "templateSpecVersion", + "templateSpecName" + ], + "type": "object", + "properties": { + "templateSpecName": { + "description": "Gets or sets the template name. The template includes ARM templates that can be created by the connector, usually it will be the dataConnectors ARM templates.", + "type": "string" + }, + "templateSpecVersion": { + "description": "Gets or sets the template version.", + "type": "string" + } + } + }, + "CustomizableConnectorUiConfig": { + "description": "The UiConfig for 'Customizable' connector definition kind.", + "required": [ + "dataTypes", + "descriptionMarkdown", + "graphQueries", + "instructionSteps", + "permissions", + "publisher", + "title", + "connectivityCriteria" + ], + "type": "object", + "properties": { + "id": { + "description": "Gets or sets custom connector id. optional field.", + "type": "string" + }, + "title": { + "description": "Gets or sets the connector blade title.", + "type": "string" + }, + "publisher": { + "description": "Gets or sets the connector publisher name.", + "type": "string" + }, + "descriptionMarkdown": { + "description": "Gets or sets the connector description in markdown format.", + "type": "string" + }, + "graphQueries": { + "description": "Gets or sets the graph queries to show the current data volume over time.", + "type": "array", + "items": { + "$ref": "#/definitions/GraphQuery" + }, + "x-ms-identifiers": [] + }, + "dataTypes": { + "description": "Gets or sets the data types to check for last data received.", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectorDataType" + }, + "x-ms-identifiers": [] + }, + "connectivityCriteria": { + "description": "Gets or sets the way the connector checks whether the connector is connected.", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectivityCriterion" + }, + "x-ms-identifiers": [] + }, + "availability": { + "$ref": "#/definitions/ConnectorDefinitionsAvailability" + }, + "permissions": { + "$ref": "#/definitions/ConnectorDefinitionsPermissions" + }, + "instructionSteps": { + "description": "Gets or sets the instruction steps to enable the connector.", + "type": "array", + "items": { + "$ref": "#/definitions/InstructionStep" + }, + "x-ms-identifiers": [] + }, + "logo": { + "description": "Gets or sets the connector logo to be used when displaying the connector within Azure Sentinel's connector's gallery.\r\nThe logo value should be in SVG format.", + "type": "string" + }, + "isConnectivityCriteriasMatchSome": { + "description": "Gets or sets a value indicating whether to use 'OR'(SOME) or 'AND' between ConnectivityCriteria items.", + "type": "boolean" + } + } + }, + "CustomPermissionDetails": { + "description": "The Custom permissions required for the connector.", + "required": [ + "description", + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "Gets or sets the custom permissions name.", + "type": "string" + }, + "description": { + "description": "Gets or sets the custom permissions description.", + "type": "string" + } + } + }, + "GraphQuery": { + "description": "The graph query to show the volume of data arriving into the workspace over time.", + "required": [ + "baseQuery", + "legend", + "metricName" + ], + "type": "object", + "properties": { + "metricName": { + "description": "Gets or sets the metric name that the query is checking. For example: 'Total data receive'.", + "type": "string" + }, + "legend": { + "description": "Gets or sets the legend for the graph.", + "type": "string" + }, + "baseQuery": { + "description": "Gets or sets the base query for the graph.\r\nThe base query is wrapped by Sentinel UI infra with a KQL query, that measures the volume over time.", + "type": "string" + } + } + }, + "InstructionStep": { + "description": "Instruction steps to enable the connector.", + "type": "object", + "properties": { + "title": { + "description": "Gets or sets the instruction step title.", + "type": "string" + }, + "description": { + "description": "Gets or sets the instruction step description.", + "type": "string" + }, + "instructions": { + "description": "Gets or sets the instruction step details.", + "type": "array", + "items": { + "$ref": "#/definitions/InstructionStepDetails" + }, + "x-ms-identifiers": [] + }, + "innerSteps": { + "description": "Gets or sets the inner instruction steps details.\r\nFoe Example: instruction step 1 might contain inner instruction steps: [instruction step 1.1, instruction step 1.2].", + "type": "array", + "items": { + "$ref": "#/definitions/InstructionStep" + }, + "x-ms-identifiers": [] + } + } + }, + "InstructionStepDetails": { + "description": "Instruction step details, to be displayed in the Instructions steps section in the connector's page in Sentinel Portal.", + "required": [ + "parameters", + "type" + ], + "type": "object", + "properties": { + "parameters": { + "description": "Gets or sets the instruction type parameters settings.", + "type": "object" + }, + "type": { + "description": "Gets or sets the instruction type name.", + "type": "string" + } + } + }, + "ConnectorDefinitionsPermissions": { + "description": "The required Permissions for the connector.", + "type": "object", + "properties": { + "tenant": { + "description": "Gets or sets the required tenant permissions for the connector.", + "type": "array", + "items": { + "type": "string" + } + }, + "licenses": { + "description": "Gets or sets the required licenses for the user to create connections.", + "type": "array", + "items": { + "type": "string" + } + }, + "resourceProvider": { + "description": "Gets or sets the resource provider permissions required for the user to create connections.", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectorDefinitionsResourceProvider" + }, + "x-ms-identifiers": [] + }, + "customs": { + "description": "Gets or sets the customs permissions required for the user to create connections.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomPermissionDetails" + }, + "x-ms-identifiers": [] + } + } + }, + "ProviderPermissionsScope": { + "description": "The scope on which the user should have permissions, in order to be able to create connections.", + "enum": [ + "Subscription", + "ResourceGroup", + "Workspace" + ], + "type": "string", + "example": "Subscription", + "x-ms-enum": { + "name": "ProviderPermissionsScope", + "modelAsString": true, + "values": [ + { + "value": "Subscription" + }, + { + "value": "ResourceGroup" + }, + { + "value": "Workspace" + } + ] + } + }, + "ConnectorDefinitionsResourceProvider": { + "description": "The resource provider details include the required permissions for the user to create connections.\r\nThe user should have the required permissions(Read\\Write, ..) in the specified scope ProviderPermissionsScope against the specified resource provider.", + "required": [ + "permissionsDisplayText", + "provider", + "providerDisplayName", + "requiredPermissions", + "scope" + ], + "type": "object", + "properties": { + "provider": { + "description": "Gets or sets the provider name.", + "type": "string" + }, + "permissionsDisplayText": { + "description": "Gets or sets the permissions description text.", + "type": "string" + }, + "providerDisplayName": { + "description": "Gets or sets the permissions provider display name.", + "type": "string" + }, + "scope": { + "$ref": "#/definitions/ProviderPermissionsScope" + }, + "requiredPermissions": { + "$ref": "#/definitions/ResourceProviderRequiredPermissions" + } + } + }, + "ResourceProviderRequiredPermissions": { + "description": "Required permissions for the connector resource provider that define in ResourceProviders.\r\nFor more information about the permissions see here.", + "type": "object", + "properties": { + "read": { + "description": "Gets or sets a value indicating whether the permission is read action (GET).", + "type": "boolean" + }, + "write": { + "description": "Gets or sets a value indicating whether the permission is write action (PUT or PATCH).", + "type": "boolean" + }, + "delete": { + "description": "Gets or sets a value indicating whether the permission is delete action (DELETE).", + "type": "boolean" + }, + "action": { + "description": "Gets or sets a value indicating whether the permission is custom actions (POST).", + "type": "boolean" + } + } + } + }, + "parameters": { + "dataConnectorDefinitionName": { + "in": "path", + "name": "dataConnectorDefinitionName", + "description": "The data connector definition name.", + "required": true, + "type": "string", + "pattern": "^[a-z0-9A-Z-_]*$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/dataConnectors.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/dataConnectors.json new file mode 100644 index 000000000000..f810f0530679 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/dataConnectors.json @@ -0,0 +1,4060 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors": { + "get": { + "x-ms-examples": { + "Get all data connectors.": { + "$ref": "./examples/dataConnectors/GetDataConnectors.json" + } + }, + "tags": [ + "Data Connectors" + ], + "description": "Gets all data connectors.", + "operationId": "DataConnectors_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/DataConnectorList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors/{dataConnectorId}": { + "get": { + "x-ms-examples": { + "Get an Office365 data connector.": { + "$ref": "./examples/dataConnectors/GetOfficeDataConnetorById.json" + }, + "Get a TI data connector": { + "$ref": "./examples/dataConnectors/GetThreatIntelligenceById.json" + }, + "Get a TI Taxii data connector.": { + "$ref": "./examples/dataConnectors/GetThreatIntelligenceTaxiiById.json" + }, + "Get a MCAS data connector": { + "$ref": "./examples/dataConnectors/GetMicrosoftCloudAppSecurityById.json" + }, + "Get a ASC data connector": { + "$ref": "./examples/dataConnectors/GetAzureSecurityCenterById.json" + }, + "Get an AADIP (Azure Active Directory Identity Protection) data connector": { + "$ref": "./examples/dataConnectors/GetAzureActiveDirectoryById.json" + }, + "Get an AwsCloudTrail data connector": { + "$ref": "./examples/dataConnectors/GetAmazonWebServicesCloudTrailById.json" + }, + "Get an Aws S3 data connector": { + "$ref": "./examples/dataConnectors/GetAmazonWebServicesS3ById.json" + }, + "Get an AATP data connector": { + "$ref": "./examples/dataConnectors/GetAzureAdvancedThreatProtectionById.json" + }, + "Get a MDATP data connector": { + "$ref": "./examples/dataConnectors/GetMicrosoftDefenderAdvancedThreatProtectionById.json" + }, + "Get an Office ATP data connector": { + "$ref": "./examples/dataConnectors/GetOffice365AdvancedThreatProtectionById.json" + }, + "Get an Office IRM data connector": { + "$ref": "./examples/dataConnectors/GetMicrosoftInsiderRiskManagementById.json" + }, + "Get an Office365 Project data connector": { + "$ref": "./examples/dataConnectors/GetOffice365ProjectDataConnetorById.json" + }, + "Get a MicrosoftPurviewInformationProtection data connector": { + "$ref": "./examples/dataConnectors/GetMicrosoftPurviewInformationProtectionDataConnetorById.json" + }, + "Get an Office365 PowerBI data connector": { + "$ref": "./examples/dataConnectors/GetOfficePowerBIDataConnetorById.json" + }, + "Get a Dynamics365 data connector": { + "$ref": "./examples/dataConnectors/GetDynamics365DataConnectorById.json" + }, + "Get a MicrosoftThreatProtection data connector": { + "$ref": "./examples/dataConnectors/GetMicrosoftThreatProtectionById.json" + }, + "Get a MicrosoftThreatIntelligence data connector": { + "$ref": "./examples/dataConnectors/GetMicrosoftThreatIntelligenceById.json" + }, + "Get a GenericUI data connector": { + "$ref": "./examples/dataConnectors/GetGenericUI.json" + }, + "Get a APIPolling data connector": { + "$ref": "./examples/dataConnectors/GetAPIPolling.json" + }, + "Get a IoT data connector": { + "$ref": "./examples/dataConnectors/GetIoTById.json" + }, + "Get a GCP data connector": { + "$ref": "./examples/dataConnectors/GetGoogleCloudPlatformById.json" + }, + "Get a RestApiPoller data connector": { + "$ref": "./examples/dataConnectors/GetRestApiPollerById.json" + } + }, + "tags": [ + "Data Connectors" + ], + "description": "Gets a data connector.", + "operationId": "DataConnectors_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/DataConnectorId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/DataConnector" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-azure-resource": true, + "x-ms-examples": { + "Creates or updates an Office365 data connector": { + "$ref": "./examples/dataConnectors/CreateOfficeDataConnetor.json" + }, + "Creates or updates an Office365 Project data connector": { + "$ref": "./examples/dataConnectors/CreateOffice365ProjectDataConnetor.json" + }, + "Creates or updates an MicrosoftPurviewInformationProtection data connector": { + "$ref": "./examples/dataConnectors/CreateMicrosoftPurviewInformationProtectionDataConnetor.json" + }, + "Creates or updates a Microsoft Threat Intelligence data connector.": { + "$ref": "./examples/dataConnectors/CreateMicrosoftThreatIntelligenceDataConnector.json" + }, + "Creates or updates an Office PowerBI data connector": { + "$ref": "./examples/dataConnectors/CreateOfficePowerBIDataConnector.json" + }, + "Creates or updates a Threat Intelligence Taxii data connector.": { + "$ref": "./examples/dataConnectors/CreateThreatIntelligenceTaxiiDataConnector.json" + }, + "Creates or updates an Threat Intelligence Platform data connector": { + "$ref": "./examples/dataConnectors/CreateThreatIntelligenceDataConnector.json" + }, + "Creates or updates a Dynamics365 data connector.": { + "$ref": "./examples/dataConnectors/CreateDynamics365DataConnetor.json" + }, + "Creates or updates a GenericUI data connector": { + "$ref": "./examples/dataConnectors/CreateGenericUI.json" + }, + "Creates or updates a APIPolling data connector": { + "$ref": "./examples/dataConnectors/CreateAPIPolling.json" + }, + "Creates or updates a MicrosoftThreatProtection data connector": { + "$ref": "./examples/dataConnectors/CreateMicrosoftThreatProtectionDataConnetor.json" + }, + "Creates or updates a GCP data connector": { + "$ref": "./examples/dataConnectors/CreateGoogleCloudPlatform.json" + } + }, + "tags": [ + "Data Connectors" + ], + "description": "Creates or updates the data connector.", + "operationId": "DataConnectors_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/DataConnectorId" + }, + { + "$ref": "#/parameters/DataConnector" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/DataConnector" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DataConnector" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an Office365 data connector": { + "$ref": "./examples/dataConnectors/DeleteOfficeDataConnetor.json" + }, + "Delete an Office365 Project data connector": { + "$ref": "./examples/dataConnectors/DeleteOffice365ProjectDataConnetor.json" + }, + "Delete an MicrosoftPurviewInformationProtection data connector": { + "$ref": "./examples/dataConnectors/DeleteMicrosoftPurviewInformationProtectionDataConnetor.json" + }, + "Delete an MicrosoftThreatIntelligence data connector": { + "$ref": "./examples/dataConnectors/DeleteMicrosoftThreatIntelligenceDataConnector.json" + }, + "Delete an Office PowerBI data connector": { + "$ref": "./examples/dataConnectors/DeleteOfficePowerBIDataConnetor.json" + }, + "Delete a GenericUI data connector": { + "$ref": "./examples/dataConnectors/DeleteGenericUI.json" + }, + "Delete a APIPolling data connector": { + "$ref": "./examples/dataConnectors/DeleteAPIPolling.json" + }, + "Delete a GCP data connector": { + "$ref": "./examples/dataConnectors/DeleteGoogleCloudPlatform.json" + } + }, + "tags": [ + "Data Connectors" + ], + "description": "Delete the data connector.", + "operationId": "DataConnectors_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/DataConnectorId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors/{dataConnectorId}/connect": { + "post": { + "x-ms-examples": { + "Connect an APIPolling data connector": { + "$ref": "./examples/dataConnectors/ConnectAPIPolling.json" + }, + "Connect an APIPolling V2 logs data connector": { + "$ref": "./examples/dataConnectors/ConnectAPIPollingV2Logs.json" + } + }, + "tags": [ + "Data Connectors Connect" + ], + "description": "Connects a data connector.", + "operationId": "DataConnectors_Connect", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/DataConnectorId" + }, + { + "$ref": "#/parameters/DataConnectorConnectBody" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors/{dataConnectorId}/disconnect": { + "post": { + "x-ms-examples": { + "Disconnect an APIPolling data connector": { + "$ref": "./examples/dataConnectors/DisconnectAPIPolling.json" + } + }, + "tags": [ + "Data Connectors Disconnect" + ], + "description": "Disconnect a data connector.", + "operationId": "DataConnectors_Disconnect", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/DataConnectorId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectorsCheckRequirements": { + "post": { + "x-ms-examples": { + "Check requirements for TI.": { + "$ref": "./examples/dataConnectors/CheckRequirementsThreatIntelligence.json" + }, + "Check requirements for TI Taxii.": { + "$ref": "./examples/dataConnectors/CheckRequirementsThreatIntelligenceTaxii.json" + }, + "Check requirements for AADIP (Azure Active Directory Identity Protection).": { + "$ref": "./examples/dataConnectors/CheckRequirementsAzureActiveDirectory.json" + }, + "Check requirements for AADIP (Azure Active Directory Identity Protection) - no license.": { + "$ref": "./examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoLicense.json" + }, + "Check requirements for AADIP (Azure Active Directory Identity Protection) - no authorization.": { + "$ref": "./examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoAuthorization.json" + }, + "Check requirements for ASC.": { + "$ref": "./examples/dataConnectors/CheckRequirementsAzureSecurityCenter.json" + }, + "Check requirements for Mcas.": { + "$ref": "./examples/dataConnectors/CheckRequirementsMicrosoftCloudAppSecurity.json" + }, + "Check requirements for Mdatp.": { + "$ref": "./examples/dataConnectors/CheckRequirementsMdatp.json" + }, + "Check requirements for OfficeATP.": { + "$ref": "./examples/dataConnectors/CheckRequirementsOfficeATP.json" + }, + "Check requirements for OfficeIRM.": { + "$ref": "./examples/dataConnectors/CheckRequirementsOfficeIRM.json" + }, + "Check requirements for Office365Project.": { + "$ref": "./examples/dataConnectors/CheckRequirementsOffice365Project.json" + }, + "Check requirements for MicrosoftPurviewInformationProtection.": { + "$ref": "./examples/dataConnectors/CheckRequirementsMicrosoftPurviewInformationProtection.json" + }, + "Check requirements for OfficePowerBI.": { + "$ref": "./examples/dataConnectors/CheckRequirementsOfficePowerBI.json" + }, + "Check requirements for Dynamics365.": { + "$ref": "./examples/dataConnectors/CheckRequirementsDynamics365.json" + }, + "Check requirements for MicrosoftThreatProtection.": { + "$ref": "./examples/dataConnectors/CheckRequirementsMicrosoftThreatProtection.json" + }, + "Check requirements for MicrosoftThreatIntelligence.": { + "$ref": "./examples/dataConnectors/CheckRequirementsMicrosoftThreatIntelligence.json" + }, + "Check requirements for IoT.": { + "$ref": "./examples/dataConnectors/CheckRequirementsIoT.json" + } + }, + "tags": [ + "Check Data Connector Requirements" + ], + "description": "Get requirements state for a data connector type.", + "operationId": "DataConnectorsCheckRequirements_Post", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/DataConnectorsCheckRequirementsBody" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DataConnectorRequirementsState" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "AADCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents AADIP (Azure Active Directory Identity Protection) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/AADCheckRequirementsProperties", + "description": "AADIP (Azure Active Directory Identity Protection) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureActiveDirectory" + }, + "AADCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "AADIP (Azure Active Directory Identity Protection) requirements check properties.", + "type": "object" + }, + "AATPCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents AATP (Azure Advanced Threat Protection) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/AATPCheckRequirementsProperties", + "description": "AATP (Azure Advanced Threat Protection) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureAdvancedThreatProtection" + }, + "AATPCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "AATP (Azure Advanced Threat Protection) requirements check properties.", + "type": "object" + }, + "ASCCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents ASC (Azure Security Center) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/ASCCheckRequirementsProperties", + "description": "ASC (Azure Security Center) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureSecurityCenter" + }, + "ASCCheckRequirementsProperties": { + "description": "ASC (Azure Security Center) requirements check properties.", + "properties": { + "subscriptionId": { + "description": "The subscription id to connect to, and get the data from.", + "type": "string" + } + }, + "type": "object" + }, + "AwsCloudTrailCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Amazon Web Services CloudTrail requirements check request.", + "type": "object", + "x-ms-discriminator-value": "AmazonWebServicesCloudTrail" + }, + "AwsS3CheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Amazon Web Services S3 requirements check request.", + "type": "object", + "x-ms-discriminator-value": "AmazonWebServicesS3" + }, + "DataConnectorsCheckRequirements": { + "description": "Data connector requirements properties.", + "properties": { + "kind": { + "$ref": "#/definitions/DataConnectorKind", + "description": "Describes the kind of connector to be checked.", + "type": "string" + } + }, + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] + }, + "DataConnectorAuthorizationState": { + "description": "Describes the state of user's authorization for a connector kind.", + "enum": [ + "Valid", + "Invalid" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DataConnectorAuthorizationState", + "values": [ + { + "value": "Valid" + }, + { + "value": "Invalid" + } + ] + } + }, + "DataConnectorLicenseState": { + "description": "Describes the state of user's license for a connector kind.", + "enum": [ + "Valid", + "Invalid", + "Unknown" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DataConnectorLicenseState", + "values": [ + { + "value": "Valid" + }, + { + "value": "Invalid" + }, + { + "value": "Unknown" + } + ] + } + }, + "DataConnectorRequirementsState": { + "description": "Data connector requirements status.", + "properties": { + "authorizationState": { + "description": "Authorization state for this connector", + "$ref": "#/definitions/DataConnectorAuthorizationState" + }, + "licenseState": { + "description": "License state for this connector", + "$ref": "#/definitions/DataConnectorLicenseState" + } + }, + "type": "object" + }, + "Dynamics365CheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents Dynamics365 requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/Dynamics365CheckRequirementsProperties", + "description": "Dynamics365 requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Dynamics365" + }, + "Dynamics365CheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Dynamics365 requirements check properties.", + "type": "object" + }, + "MCASCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents MCAS (Microsoft Cloud App Security) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/MCASCheckRequirementsProperties", + "description": "MCAS (Microsoft Cloud App Security) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftCloudAppSecurity" + }, + "MCASCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "MCAS (Microsoft Cloud App Security) requirements check properties.", + "type": "object" + }, + "MDATPCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents MDATP (Microsoft Defender Advanced Threat Protection) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/MDATPCheckRequirementsProperties", + "description": "MDATP (Microsoft Defender Advanced Threat Protection) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftDefenderAdvancedThreatProtection" + }, + "MDATPCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "MDATP (Microsoft Defender Advanced Threat Protection) requirements check properties.", + "type": "object" + }, + "MSTICheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents Microsoft Threat Intelligence requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/MSTICheckRequirementsProperties", + "description": "Microsoft Threat Intelligence requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftThreatIntelligence" + }, + "MSTICheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Microsoft Threat Intelligence requirements check properties.", + "type": "object" + }, + "MtpCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents MTP (Microsoft Threat Protection) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/MTPCheckRequirementsProperties", + "description": "MTP (Microsoft Threat Protection) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftThreatProtection" + }, + "MTPCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "MTP (Microsoft Threat Protection) requirements check properties.", + "type": "object" + }, + "OfficeATPCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents OfficeATP (Office 365 Advanced Threat Protection) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/OfficeATPCheckRequirementsProperties", + "description": "OfficeATP (Office 365 Advanced Threat Protection) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "OfficeATP" + }, + "OfficeATPCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "OfficeATP (Office 365 Advanced Threat Protection) requirements check properties.", + "type": "object" + }, + "OfficeIRMCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents OfficeIRM (Microsoft Insider Risk Management) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/OfficeIRMCheckRequirementsProperties", + "description": "OfficeIRM (Microsoft Insider Risk Management) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "OfficeIRM" + }, + "OfficeIRMCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "OfficeIRM (Microsoft Insider Risk Management) requirements check properties.", + "type": "object" + }, + "MicrosoftPurviewInformationProtectionCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents MicrosoftPurviewInformationProtection requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/MicrosoftPurviewInformationProtectionCheckRequirementsProperties", + "description": "MicrosoftPurviewInformationProtection requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftPurviewInformationProtection" + }, + "MicrosoftPurviewInformationProtectionCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "MicrosoftPurviewInformationProtection requirements check properties.", + "type": "object" + }, + "Office365ProjectCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents Office365 Project requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/Office365ProjectCheckRequirementsProperties", + "description": "Office365 Project requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Office365Project" + }, + "Office365ProjectCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Office365 Project requirements check properties.", + "type": "object" + }, + "OfficePowerBICheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents Office PowerBI requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/OfficePowerBICheckRequirementsProperties", + "description": "Office Power BI requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "OfficePowerBI" + }, + "OfficePowerBICheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Office PowerBI requirements check properties.", + "type": "object" + }, + "TICheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Threat Intelligence Platforms data connector check requirements", + "properties": { + "properties": { + "$ref": "#/definitions/TICheckRequirementsProperties", + "description": "Threat Intelligence Platforms data connector check required properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "ThreatIntelligence" + }, + "TICheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Threat Intelligence Platforms data connector required properties.", + "properties": {}, + "type": "object" + }, + "TiTaxiiCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Threat Intelligence TAXII data connector check requirements", + "properties": { + "properties": { + "$ref": "#/definitions/TiTaxiiCheckRequirementsProperties", + "description": "Threat Intelligence TAXII check required properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "ThreatIntelligenceTaxii" + }, + "TiTaxiiCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Threat Intelligence TAXII data connector required properties.", + "type": "object" + }, + "IoTCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents IoT requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/IoTCheckRequirementsProperties", + "description": "IoT requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "IOT" + }, + "IoTCheckRequirementsProperties": { + "description": "IoT requirements check properties.", + "properties": { + "subscriptionId": { + "description": "The subscription id to connect to, and get the data from.", + "type": "string" + } + }, + "type": "object" + }, + "AADDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents AADIP (Azure Active Directory Identity Protection) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/AADDataConnectorProperties", + "description": "AADIP (Azure Active Directory Identity Protection) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureActiveDirectory" + }, + "AADDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + }, + { + "$ref": "#/definitions/DataConnectorWithAlertsProperties" + } + ], + "description": "AADIP (Azure Active Directory Identity Protection) data connector properties.", + "type": "object" + }, + "AlertsDataTypeOfDataConnector": { + "description": "Alerts data type for data connectors.", + "properties": { + "alerts": { + "$ref": "#/definitions/DataConnectorDataTypeCommon", + "description": "Alerts data type connection.", + "type": "object" + } + }, + "type": "object", + "required": [ + "alerts" + ] + }, + "MSTIDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents Microsoft Threat Intelligence data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/MSTIDataConnectorProperties", + "description": "Microsoft Threat Intelligence data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftThreatIntelligence" + }, + "MSTIDataConnectorDataTypes": { + "description": "The available data types for Microsoft Threat Intelligence Platforms data connector.", + "properties": { + "microsoftEmergingThreatFeed": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "properties": { + "lookbackPeriod": { + "description": "The lookback period for the feed to be imported.", + "type": "string" + } + }, + "description": "Data type for Microsoft Threat Intelligence Platforms data connector.", + "type": "object", + "required": [ + "lookbackPeriod" + ] + } + }, + "type": "object", + "required": [ + "microsoftEmergingThreatFeed" + ] + }, + "MSTIDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Microsoft Threat Intelligence data connector properties.", + "properties": { + "dataTypes": { + "$ref": "#/definitions/MSTIDataConnectorDataTypes", + "description": "The available data types for the connector." + } + }, + "required": [ + "dataTypes" + ], + "type": "object" + }, + "MTPDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents MTP (Microsoft Threat Protection) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/MTPDataConnectorProperties", + "description": "MTP (Microsoft Threat Protection) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftThreatProtection" + }, + "MTPDataConnectorDataTypes": { + "description": "The available data types for Microsoft Threat Protection Platforms data connector.", + "properties": { + "incidents": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Incidents data type for Microsoft Threat Protection Platforms data connector.", + "type": "object" + }, + "alerts": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Alerts data type for Microsoft Threat Protection Platforms data connector.", + "type": "object" + } + }, + "type": "object", + "required": [ + "incidents" + ] + }, + "MtpProvider": { + "description": "The available data providers.", + "enum": [ + "microsoftDefenderForCloudApps", + "microsoftDefenderForIdentity" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "MtpProvider" + } + }, + "MtpFilteredProviders": { + "description": "Represents the connector's Filtered providers", + "properties": { + "alerts": { + "description": "Alerts filtered providers. When filters are not applied, all alerts will stream through the MTP pipeline, still in private preview for all products EXCEPT MDA and MDI, which are in GA state.", + "items": { + "$ref": "#/definitions/MtpProvider" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "alerts" + ] + }, + "MTPDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "MTP (Microsoft Threat Protection) data connector properties.", + "properties": { + "dataTypes": { + "$ref": "#/definitions/MTPDataConnectorDataTypes", + "description": "The available data types for the connector." + }, + "filteredProviders": { + "$ref": "#/definitions/MtpFilteredProviders", + "description": "The available filtered providers for the connector." + } + }, + "required": [ + "dataTypes" + ], + "type": "object" + }, + "AATPDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "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": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + }, + { + "$ref": "#/definitions/DataConnectorWithAlertsProperties" + } + ], + "description": "AATP (Azure Advanced Threat Protection) data connector properties.", + "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" + }, + "AwsCloudTrailDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents Amazon Web Services CloudTrail data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/AwsCloudTrailDataConnectorProperties", + "description": "Amazon Web Services CloudTrail data connector 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", + "required": [ + "logs" + ] + }, + "AwsCloudTrailDataConnectorProperties": { + "description": "Amazon Web Services CloudTrail data connector properties.", + "properties": { + "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", + "required": [ + "dataTypes" + ] + }, + "AwsS3DataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents Amazon Web Services S3 data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/AwsS3DataConnectorProperties", + "description": "Amazon Web Services S3 data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AmazonWebServicesS3" + }, + "AwsS3DataConnectorDataTypes": { + "description": "The available data types for Amazon Web Services S3 data connector.", + "properties": { + "logs": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Logs data type.", + "type": "object" + } + }, + "type": "object", + "required": [ + "logs" + ] + }, + "AwsS3DataConnectorProperties": { + "description": "Amazon Web Services S3 data connector properties.", + "properties": { + "destinationTable": { + "description": "The logs destination table name in LogAnalytics.", + "type": "string" + }, + "sqsUrls": { + "description": "The AWS sqs urls for the connector.", + "x-ms-identifiers": [], + "type": "array", + "items": { + "description": "AWS sqs url.", + "type": "string" + } + }, + "roleArn": { + "description": "The Aws Role Arn that is used to access the Aws account.", + "type": "string" + }, + "dataTypes": { + "$ref": "#/definitions/AwsS3DataConnectorDataTypes", + "description": "The available data types for the connector." + } + }, + "type": "object", + "required": [ + "destinationTable", + "sqsUrls", + "roleArn", + "dataTypes" + ] + }, + "RestApiPollerDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents Rest Api Poller data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/RestApiPollerDataConnectorProperties", + "description": "Rest Api Poller data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "RestApiPoller" + }, + "RestApiPollerDataConnectorProperties": { + "description": "Rest Api Poller data connector properties.", + "properties": { + "connectorDefinitionName": { + "description": "The connector definition name (the dataConnectorDefinition resource id).", + "type": "string" + }, + "auth": { + "description": "The a authentication model.", + "$ref": "#/definitions/CcpAuthConfig" + }, + "request": { + "description": "The request configuration.", + "$ref": "#/definitions/RestApiPollerRequestConfig" + }, + "dcrConfig": { + "description": "The DCR related properties.", + "$ref": "#/definitions/DCRConfiguration" + }, + "isActive": { + "description": "Indicates whether the connector is active or not.", + "type": "boolean" + }, + "dataType": { + "description": "The Log Analytics table destination.", + "type": "string" + }, + "response": { + "description": "The response configuration.", + "$ref": "#/definitions/CcpResponseConfig" + }, + "paging": { + "description": "The paging configuration.", + "$ref": "#/definitions/RestApiPollerRequestPagingConfig" + }, + "addOnAttributes": { + "description": "The add on attributes. The key name will become attribute name (a column) and the value will become the attribute value in the payload.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "type": "object", + "required": [ + "connectorDefinitionName", + "auth", + "request" + ] + }, + "RestApiPollerRequestConfig": { + "type": "object", + "description": "The request configuration.", + "properties": { + "apiEndpoint": { + "description": "The API endpoint.", + "type": "string" + }, + "rateLimitQPS": { + "description": "The Rate limit queries per second for the request..", + "type": "integer", + "x-nullable": true, + "format": "int32" + }, + "queryWindowInMin": { + "description": "The query window in minutes for the request.", + "type": "integer", + "x-nullable": true, + "format": "int32" + }, + "httpMethod": { + "description": "The HTTP method, default value GET.", + "enum": [ + "GET", + "POST", + "PUT", + "DELETE" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "httpMethodVerb" + } + }, + "queryTimeFormat": { + "description": "The query time format. A remote server can have a query to pull data from range 'start' to 'end'. This property indicate what is the expected time format the remote server know to parse.", + "example": "UnixTimestamp, UnixTimestampInMills, or more specific formats, for example: yyyy-MM-ddTHH:mm:ssZ", + "type": "string" + }, + "retryCount": { + "description": "The retry count.", + "type": "integer", + "x-nullable": true, + "format": "int32" + }, + "timeoutInSeconds": { + "description": "The timeout in seconds.", + "type": "integer", + "x-nullable": true, + "format": "int32" + }, + "isPostPayloadJson": { + "description": "Flag to indicate if HTTP POST payload is in JSON format (vs form-urlencoded).", + "type": "boolean", + "x-nullable": true + }, + "headers": { + "description": "The header for the request for the remote server.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "queryParameters": { + "description": "The HTTP query parameters to RESTful API.", + "type": "object", + "additionalProperties": {} + }, + "queryParametersTemplate": { + "description": "the query parameters template. Defines the query parameters template to use when passing query parameters in advanced scenarios.", + "type": "string" + }, + "startTimeAttributeName": { + "description": "The query parameter name which the remote server expect to start query. This property goes hand to hand with `endTimeAttributeName`.", + "type": "string" + }, + "endTimeAttributeName": { + "description": "The query parameter name which the remote server expect to end query. This property goes hand to hand with `startTimeAttributeName`", + "type": "string" + }, + "queryTimeIntervalAttributeName": { + "description": "The query parameter name which we need to send the server for query logs in time interval. Should be defined with `queryTimeIntervalPrepend` and `queryTimeIntervalDelimiter`", + "type": "string" + }, + "queryTimeIntervalPrepend": { + "description": "The string prepend to the value of the query parameter in `queryTimeIntervalAttributeName`.", + "type": "string" + }, + "queryTimeIntervalDelimiter": { + "description": "The delimiter string between 2 QueryTimeFormat in the query parameter `queryTimeIntervalAttributeName`.", + "type": "string" + } + }, + "required": [ + "apiEndpoint" + ] + }, + "RestApiPollerRequestPagingKind": { + "type": "string", + "enum": [ + "LinkHeader", + "NextPageToken", + "NextPageUrl", + "PersistentToken", + "PersistentLinkHeader", + "Offset", + "CountBasedPaging" + ], + "description": "Type of paging", + "x-ms-enum": { + "modelAsString": true, + "name": "RestApiPollerRequestPagingKind", + "values": [ + { + "value": "LinkHeader" + }, + { + "value": "NextPageToken" + }, + { + "value": "NextPageUrl" + }, + { + "value": "PersistentToken" + }, + { + "value": "PersistentLinkHeader" + }, + { + "value": "Offset" + }, + { + "value": "CountBasedPaging" + } + ] + } + }, + "RestApiPollerRequestPagingConfig": { + "description": "The request paging configuration.", + "type": "object", + "properties": { + "pagingType": { + "type": "string", + "$ref": "#/definitions/RestApiPollerRequestPagingKind", + "description": "Type of paging" + }, + "pageSize": { + "type": "integer", + "description": "Page size", + "format": "int32" + }, + "pageSizeParameterName": { + "type": "string", + "description": "Page size parameter name" + } + }, + "x-ms-discriminator": { + "propertyName": "pagingType", + "mapping": { + "LinkHeader": "#/components/schemas/RestApiPollerRequestPagingLinkHeaderConfig", + "NextPageToken": "#/components/schemas/RestApiPollerRequestPagingTokenConfig", + "NextPageUrl": "#/components/schemas/RestApiPollerRequestPagingNextPageUrlConfig", + "PersistentToken": "#/components/schemas/RestApiPollerRequestPagingTokenConfig", + "PersistentLinkHeader": "#/components/schemas/RestApiPollerRequestPagingLinkHeaderConfig", + "Offset": "#/components/schemas/RestApiPollerRequestPagingOffsetConfig", + "CountBasedPaging": "#/components/schemas/RestApiPollerRequestPagingCountBaseConfig" + } + }, + "required": [ + "pagingType" + ] + }, + "RestApiPollerRequestPagingLinkHeaderConfig": { + "description": "The request paging configuration for LinkHeader and PersistentLinkHeader paging type parameters.", + "allOf": [ + { + "$ref": "#/definitions/RestApiPollerRequestPagingConfig" + } + ], + "type": "object", + "properties": { + "linkHeaderTokenJsonPath": { + "type": "string", + "description": "JSON path of link header token in HTTP response payload" + }, + "linkHeaderRelLinkName": { + "type": "string", + "description": "Rel link name from the link header" + } + } + }, + "RestApiPollerRequestPagingTokenConfig": { + "allOf": [ + { + "$ref": "#/definitions/RestApiPollerRequestPagingConfig" + } + ], + "description": "The request paging configuration for NextPageToken and PersistentToken paging type parameters.", + "type": "object", + "properties": { + "nextPageTokenJsonPath": { + "type": "string", + "description": "JSON path of next page token in HTTP response payload" + }, + "hasNextFlagJsonPath": { + "type": "string", + "description": "JSON path of flag in HTTP response payload to indicate more pages" + }, + "nextPageTokenResponseHeader": { + "type": "string", + "description": "HTTP response header name of next page token" + }, + "nextPageParaName": { + "type": "string", + "description": "Next page parameter name in HTTP request" + }, + "nextPageRequestHeader": { + "type": "string", + "description": "Next page header name in the request" + } + } + }, + "RestApiPollerRequestPagingNextPageUrlConfig": { + "allOf": [ + { + "$ref": "#/definitions/RestApiPollerRequestPagingConfig" + } + ], + "description": "The request paging configuration for NextPageUrl paging type parameters.", + "type": "object", + "properties": { + "nextPageUrl": { + "type": "string", + "description": "Next page URL" + }, + "nextPageUrlQueryParameters": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Query parameters of next page URL" + }, + "nextPageUrlQueryParametersTemplate": { + "type": "string", + "description": "Paging query parameters in string template format" + }, + "nextPageParaName": { + "type": "string", + "description": "Next page parameter name in HTTP request" + }, + "nextPageRequestHeader": { + "type": "string", + "description": "Next page header name in the request" + }, + "hasNextFlagJsonPath": { + "type": "string", + "description": "JSON path of flag in HTTP response payload to indicate more pages" + } + } + }, + "RestApiPollerRequestPagingOffsetConfig": { + "allOf": [ + { + "$ref": "#/definitions/RestApiPollerRequestPagingConfig" + } + ], + "description": "The request paging configuration for Offset paging type parameters.", + "type": "object", + "properties": { + "offsetParaName": { + "type": "string", + "description": "Offset parameter name in HTTP request" + } + } + }, + "RestApiPollerRequestPagingCountBaseConfig": { + "allOf": [ + { + "$ref": "#/definitions/RestApiPollerRequestPagingConfig" + } + ], + "description": "The request paging configuration for Count base paging type parameters.", + "type": "object", + "properties": { + "zeroBasedIndexing": { + "type": "boolean", + "description": "Indicates whether the count is zero based" + }, + "pageCountJsonPath": { + "type": "string", + "description": "JSON path of page count in HTTP response payload" + }, + "pageNumberParaName": { + "type": "string", + "description": "Parameter name of page number in HTTP request" + }, + "pageNumberJsonPath": { + "type": "string", + "description": "JSON path of page number in HTTP response payload" + }, + "totalResultsJsonPath": { + "type": "string", + "description": "JSON path of total number of results in HTTP response payload" + } + } + }, + "GCPDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents Google Cloud Platform data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/GCPDataConnectorProperties", + "description": "Google Cloud Platform data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "GCP" + }, + "GCPDataConnectorProperties": { + "description": "Google Cloud Platform data connector properties.", + "properties": { + "connectorDefinitionName": { + "description": "The name of the connector definition that represents the UI config.", + "type": "string" + }, + "auth": { + "$ref": "#/definitions/GCPAuthProperties", + "description": "The auth section of the connector." + }, + "request": { + "$ref": "#/definitions/GCPRequestProperties", + "description": "The request section of the connector." + }, + "dcrConfig": { + "$ref": "#/definitions/DCRConfiguration", + "description": "The configuration of the destination of the data." + } + }, + "type": "object", + "required": [ + "connectorDefinitionName", + "auth", + "request" + ] + }, + "GCPAuthProperties": { + "description": "Google Cloud Platform auth section properties.", + "properties": { + "serviceAccountEmail": { + "description": "The service account that is used to access the GCP project.", + "type": "string" + }, + "projectNumber": { + "description": "The GCP project number.", + "type": "string" + }, + "workloadIdentityProviderId": { + "description": "The workload identity provider id that is used to gain access to the GCP project.", + "type": "string" + } + }, + "type": "object", + "required": [ + "serviceAccountEmail", + "projectNumber", + "workloadIdentityProviderId" + ] + }, + "GCPRequestProperties": { + "description": "Google Cloud Platform request section properties.", + "properties": { + "projectId": { + "description": "The GCP project id.", + "type": "string" + }, + "subscriptionNames": { + "description": "The GCP pub/sub subscription names.", + "x-ms-identifiers": [], + "type": "array", + "items": { + "description": "GCP pub/sub subscription name.", + "type": "string" + } + } + }, + "type": "object", + "required": [ + "projectId", + "subscriptionNames" + ] + }, + "DCRConfiguration": { + "description": "The configuration of the destination of the data.", + "properties": { + "dataCollectionEndpoint": { + "description": "Represents the data collection ingestion endpoint in log analytics.", + "type": "string" + }, + "dataCollectionRuleImmutableId": { + "description": "The data collection rule immutable id, the rule defines the transformation and data destination.", + "type": "string" + }, + "streamName": { + "description": "The stream we are sending the data to.", + "type": "string" + } + }, + "type": "object", + "required": [ + "dataCollectionEndpoint", + "dataCollectionRuleImmutableId", + "streamName" + ] + }, + "CcpAuthType": { + "type": "string", + "enum": [ + "Basic", + "APIKey", + "OAuth2", + "AWS", + "GCP", + "Session", + "JwtToken", + "GitHub", + "ServiceBus", + "Oracle", + "None" + ], + "description": "Type of paging", + "x-ms-enum": { + "modelAsString": true, + "name": "CcpAuthType", + "values": [ + { + "value": "Basic" + }, + { + "value": "APIKey" + }, + { + "value": "OAuth2" + }, + { + "value": "AWS" + }, + { + "value": "GCP" + }, + { + "value": "Session" + }, + { + "value": "JwtToken" + }, + { + "value": "GitHub" + }, + { + "value": "ServiceBus" + }, + { + "value": "Oracle" + }, + { + "value": "None" + } + ] + } + }, + "CcpAuthConfig": { + "description": "Base Model for API authentication.", + "properties": { + "type": { + "description": "The auth type", + "$ref": "#/definitions/CcpAuthType", + "type": "string" + } + }, + "type": "object", + "required": [ + "type" + ], + "discriminator": "type" + }, + "ApiKeyAuthModel": { + "description": "Model for authentication with the API Key. Will result in additional header on the request (default behavior) to the remote server: 'ApiKeyName: ApiKeyIdentifier ApiKey'. If 'IsApiKeyInPostPayload' is true it will send it in the body of the request and not the header.", + "example": "ApiKey = placeholderApiKey, ApiKeyName = 'Authorization', ApiKeyIdentifier = 'token', IsApiKeyInPostPayload = false. will result in a new header on the request: 'Authorization: token placeholderApiKey'", + "allOf": [ + { + "$ref": "#/definitions/CcpAuthConfig" + } + ], + "type": "object", + "properties": { + "apiKey": { + "type": "string", + "description": "API Key for the user secret key credential" + }, + "apiKeyName": { + "type": "string", + "description": "API Key name" + }, + "apiKeyIdentifier": { + "type": "string", + "description": "API Key Identifier" + }, + "isApiKeyInPostPayload": { + "type": "boolean", + "description": "Flag to indicate if API key is set in HTTP POST payload" + } + }, + "required": [ + "apiKey", + "apiKeyName" + ], + "x-ms-discriminator-value": "APIKey" + }, + "AWSAuthModel": { + "description": "Model for API authentication with AWS.", + "allOf": [ + { + "$ref": "#/definitions/CcpAuthConfig" + } + ], + "type": "object", + "properties": { + "roleArn": { + "type": "string", + "description": "AWS STS assume role ARN", + "example": "arn:aws:iam::123456789012:role/your-role-name" + }, + "externalId": { + "type": "string", + "description": "AWS STS assume role external ID. This is used to prevent the confused deputy problem: 'https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html'" + } + }, + "required": [ + "roleArn" + ], + "x-ms-discriminator-value": "AWS" + }, + "BasicAuthModel": { + "description": "Model for API authentication with basic flow - user name + password.", + "allOf": [ + { + "$ref": "#/definitions/CcpAuthConfig" + } + ], + "type": "object", + "properties": { + "userName": { + "type": "string", + "description": "The user name." + }, + "password": { + "type": "string", + "description": "The password" + } + }, + "required": [ + "userName", + "password" + ], + "x-ms-discriminator-value": "Basic" + }, + "GCPAuthModel": { + "description": "Model for API authentication for all GCP kind connectors.", + "allOf": [ + { + "$ref": "#/definitions/CcpAuthConfig" + } + ], + "type": "object", + "properties": { + "serviceAccountEmail": { + "type": "string", + "description": "GCP Service Account Email" + }, + "projectNumber": { + "type": "string", + "description": "GCP Project Number" + }, + "workloadIdentityProviderId": { + "type": "string", + "description": "GCP Workload Identity Provider ID" + } + }, + "required": [ + "serviceAccountEmail", + "projectNumber", + "workloadIdentityProviderId" + ], + "x-ms-discriminator-value": "GCP" + }, + "GenericBlobSbsAuthModel": { + "description": "Model for API authentication for working with service bus or storage account.", + "allOf": [ + { + "$ref": "#/definitions/CcpAuthConfig" + } + ], + "type": "object", + "properties": { + "credentialsConfig": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Credentials for service bus namespace, keyvault uri for access key" + }, + "storageAccountCredentialsConfig": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Credentials for storage account, keyvault uri for access key" + } + }, + "x-ms-discriminator-value": "ServiceBus" + }, + "GitHubAuthModel": { + "description": "Model for API authentication for GitHub. For this authentication first we need to approve the Router app (Microsoft Security DevOps) to access the GitHub account, Then we only need the InstallationId to get the access token from https://api.github.com/app/installations/{installId}/access_tokens.", + "allOf": [ + { + "$ref": "#/definitions/CcpAuthConfig" + } + ], + "type": "object", + "properties": { + "installationId": { + "type": "string", + "description": "The GitHubApp auth installation id." + } + }, + "x-ms-discriminator-value": "GitHub" + }, + "NoneAuthModel": { + "description": "Model for API authentication with no authentication method - public API.", + "allOf": [ + { + "$ref": "#/definitions/CcpAuthConfig" + } + ], + "type": "object", + "x-ms-discriminator-value": "None" + }, + "JwtAuthModel": { + "description": "Model for API authentication with JWT. Simple exchange between user name + password to access token.", + "allOf": [ + { + "$ref": "#/definitions/CcpAuthConfig" + } + ], + "properties": { + "tokenEndpoint": { + "type": "string", + "description": "Token endpoint to request JWT" + }, + "userName": { + "description": "The user name. If user name and password sent in header request we only need to populate the `value` property with the user name (Same as basic auth). If user name and password sent in body request we need to specify the `Key` and `Value`.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "password": { + "description": "The password", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "queryParameters": { + "description": "The custom query parameter we want to add once we send request to token endpoint.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "headers": { + "description": "The custom headers we want to add once we send request to token endpoint.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "isCredentialsInHeaders": { + "type": "boolean", + "x-nullable": true, + "description": "Flag indicating whether we want to send the user name and password to token endpoint in the headers." + }, + "isJsonRequest": { + "type": "boolean", + "x-nullable": true, + "default": false, + "description": "Flag indicating whether the body request is JSON (header Content-Type = application/json), meaning its a Form URL encoded request (header Content-Type = application/x-www-form-urlencoded)." + }, + "requestTimeoutInSeconds": { + "type": "integer", + "format": "int32", + "default": 100, + "maximum": 180, + "description": "Request timeout in seconds." + } + }, + "type": "object", + "x-ms-discriminator-value": "JwtToken", + "required": [ + "tokenEndpoint", + "userName", + "password" + ] + }, + "OAuthModel": { + "description": "Model for API authentication with OAuth2.", + "allOf": [ + { + "$ref": "#/definitions/CcpAuthConfig" + } + ], + "properties": { + "authorizationCode": { + "type": "string", + "description": "The user's authorization code." + }, + "clientSecret": { + "type": "string", + "description": "The Application (client) secret that the OAuth provider assigned to your app." + }, + "clientId": { + "type": "string", + "description": "The Application (client) ID that the OAuth provider assigned to your app." + }, + "isCredentialsInHeaders": { + "type": "boolean", + "x-nullable": true, + "default": false, + "description": "Indicating whether we want to send the clientId and clientSecret to token endpoint in the headers." + }, + "scope": { + "type": "string", + "description": "The Application (client) Scope that the OAuth provider assigned to your app." + }, + "redirectUri": { + "type": "string", + "description": "The Application redirect url that the user config in the OAuth provider." + }, + "grantType": { + "type": "string", + "description": "The grant type, usually will be 'authorization code'." + }, + "tokenEndpoint": { + "type": "string", + "description": "The token endpoint. Defines the OAuth2 refresh token." + }, + "tokenEndpointHeaders": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The token endpoint headers." + }, + "tokenEndpointQueryParameters": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The token endpoint query parameters." + }, + "authorizationEndpoint": { + "type": "string", + "description": "The authorization endpoint." + }, + "authorizationEndpointHeaders": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The authorization endpoint headers." + }, + "authorizationEndpointQueryParameters": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The authorization endpoint query parameters." + }, + "isJwtBearerFlow": { + "type": "boolean", + "description": "A value indicating whether it's a JWT flow." + }, + "accessTokenPrepend": { + "type": "string", + "description": "Access token prepend. Default is 'Bearer'." + } + }, + "required": [ + "clientSecret", + "clientId", + "grantType", + "tokenEndpoint" + ], + "type": "object", + "x-ms-discriminator-value": "OAuth2" + }, + "OracleAuthModel": { + "description": "Model for API authentication for Oracle.", + "allOf": [ + { + "$ref": "#/definitions/CcpAuthConfig" + } + ], + "properties": { + "tenantId": { + "type": "string", + "description": "Oracle tenant ID" + }, + "userId": { + "type": "string", + "description": "Oracle user ID" + }, + "publicFingerprint": { + "type": "string", + "description": "Public Fingerprint" + }, + "pemFile": { + "type": "string", + "description": "Content of the PRM file" + } + }, + "type": "object", + "required": [ + "tenantId", + "userId", + "publicFingerprint", + "pemFile" + ], + "x-ms-discriminator-value": "Oracle" + }, + "SessionAuthModel": { + "description": "Model for API authentication with session cookie.", + "allOf": [ + { + "$ref": "#/definitions/CcpAuthConfig" + } + ], + "properties": { + "userName": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The user name attribute key value." + }, + "password": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The password attribute name." + }, + "queryParameters": { + "type": "object", + "additionalProperties": {}, + "description": "Query parameters to session service endpoint." + }, + "isPostPayloadJson": { + "type": "boolean", + "x-nullable": true, + "description": "Indicating whether API key is set in HTTP POST payload." + }, + "headers": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "HTTP request headers to session service endpoint." + }, + "sessionTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Session timeout in minutes." + }, + "sessionIdName": { + "type": "string", + "description": "Session id attribute name from HTTP response header." + }, + "sessionLoginRequestUri": { + "type": "string", + "description": "HTTP request URL to session service endpoint." + } + }, + "type": "object", + "required": [ + "userName", + "password" + ], + "x-ms-discriminator-value": "Session" + }, + "CcpResponseConfig": { + "description": "A custom response configuration for a rule.", + "properties": { + "eventsJsonPaths": { + "description": "The json paths, '$' char is the json root.", + "example": "'$', '$.someProperty'", + "type": "array", + "items": { + "type": "string" + } + }, + "successStatusJsonPath": { + "description": "The value where the status message/code should appear in the response.", + "type": "string" + }, + "successStatusValue": { + "description": "The the status value.", + "type": "string", + "x-nullable": true + }, + "isGzipCompressed": { + "description": "The value indicating whether the remote server support Gzip and we should expect Gzip response.", + "type": "boolean" + }, + "compressionAlgo": { + "description": "The compression algorithm.", + "type": "string" + }, + "format": { + "description": "The response format. possible values are json,csv,xml", + "type": "string", + "default": "json" + }, + "csvDelimiter": { + "description": "The csv delimiter, in case the response format is CSV.", + "type": "string" + }, + "hasCsvBoundary": { + "description": "The value indicating whether the response has CSV boundary in case the response in CSV format.", + "type": "boolean", + "x-nullable": true + }, + "hasCsvHeader": { + "description": "The value indicating whether the response has headers in case the response in CSV format.", + "type": "boolean", + "x-nullable": true + }, + "convertChildPropertiesToArray": { + "description": "The a value indicating whether the response isn't an array of events / logs. By setting this flag to true it means the remote server will response with an object which each property has as a value an array of events / logs.", + "type": "boolean", + "x-nullable": true + }, + "csvEscape": { + "description": "Th character used to escape characters in CSV.", + "type": "string", + "x-nullable": true, + "default": "\"", + "minLength": 1, + "maxLength": 1 + } + }, + "type": "object", + "required": [ + "eventsJsonPaths" + ] + }, + "DataConnector": { + "description": "Data connector", + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/DataConnectorKind", + "description": "The data connector kind", + "type": "string" + } + }, + "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", + "required": [ + "state" + ] + }, + "DataConnectorWithAlertsProperties": { + "description": "Data connector properties.", + "properties": { + "dataTypes": { + "$ref": "#/definitions/AlertsDataTypeOfDataConnector", + "description": "The available data types for the connector." + } + }, + "type": "object" + }, + "DataConnectorKind": { + "description": "The kind of the data connector", + "enum": [ + "AzureActiveDirectory", + "AzureSecurityCenter", + "MicrosoftCloudAppSecurity", + "ThreatIntelligence", + "ThreatIntelligenceTaxii", + "Office365", + "OfficeATP", + "OfficeIRM", + "Office365Project", + "MicrosoftPurviewInformationProtection", + "OfficePowerBI", + "AmazonWebServicesCloudTrail", + "AmazonWebServicesS3", + "AzureAdvancedThreatProtection", + "MicrosoftDefenderAdvancedThreatProtection", + "Dynamics365", + "MicrosoftThreatProtection", + "MicrosoftThreatIntelligence", + "GenericUI", + "APIPolling", + "IOT", + "GCP", + "RestApiPoller" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DataConnectorKind", + "values": [ + { + "value": "AzureActiveDirectory" + }, + { + "value": "AzureSecurityCenter" + }, + { + "value": "MicrosoftCloudAppSecurity" + }, + { + "value": "ThreatIntelligence" + }, + { + "value": "ThreatIntelligenceTaxii" + }, + { + "value": "Office365" + }, + { + "value": "OfficeATP" + }, + { + "value": "OfficeIRM" + }, + { + "value": "Office365Project" + }, + { + "value": "MicrosoftPurviewInformationProtection" + }, + { + "value": "OfficePowerBI" + }, + { + "value": "AmazonWebServicesCloudTrail" + }, + { + "value": "AmazonWebServicesS3" + }, + { + "value": "AzureAdvancedThreatProtection" + }, + { + "value": "MicrosoftDefenderAdvancedThreatProtection" + }, + { + "value": "Dynamics365" + }, + { + "value": "MicrosoftThreatProtection" + }, + { + "value": "MicrosoftThreatIntelligence" + }, + { + "value": "GenericUI" + }, + { + "value": "APIPolling" + }, + { + "value": "IOT" + }, + { + "value": "GCP" + }, + { + "value": "RestApiPoller" + } + ] + } + }, + "DataConnectorList": { + "description": "List all the data connectors.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of data connectors.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of data connectors.", + "items": { + "$ref": "#/definitions/DataConnector" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "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", + "required": [ + "tenantId" + ] + }, + "MCASDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents MCAS (Microsoft Cloud App Security) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/MCASDataConnectorProperties", + "description": "MCAS (Microsoft Cloud App Security) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftCloudAppSecurity" + }, + "MCASDataConnectorDataTypes": { + "allOf": [ + { + "$ref": "#/definitions/AlertsDataTypeOfDataConnector" + } + ], + "description": "The available data types for MCAS (Microsoft Cloud App Security) data connector.", + "properties": { + "discoveryLogs": { + "$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": { + "dataTypes": { + "$ref": "#/definitions/MCASDataConnectorDataTypes", + "description": "The available data types for the connector." + } + }, + "required": [ + "dataTypes" + ], + "type": "object" + }, + "Dynamics365DataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents Dynamics365 data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/Dynamics365DataConnectorProperties", + "description": "Dynamics365 data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Dynamics365" + }, + "Dynamics365DataConnectorDataTypes": { + "description": "The available data types for Dynamics365 data connector.", + "properties": { + "dynamics365CdsActivities": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Common Data Service data type connection.", + "type": "object" + } + }, + "type": "object", + "required": [ + "dynamics365CdsActivities" + ] + }, + "Dynamics365DataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Dynamics365 data connector properties.", + "properties": { + "dataTypes": { + "$ref": "#/definitions/Dynamics365DataConnectorDataTypes", + "description": "The available data types for the connector." + } + }, + "required": [ + "dataTypes" + ], + "type": "object" + }, + "OfficeATPDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents OfficeATP (Office 365 Advanced Threat Protection) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/OfficeATPDataConnectorProperties", + "description": "OfficeATP (Office 365 Advanced Threat Protection) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "OfficeATP" + }, + "OfficeATPDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + }, + { + "$ref": "#/definitions/DataConnectorWithAlertsProperties" + } + ], + "description": "OfficeATP (Office 365 Advanced Threat Protection) data connector properties.", + "type": "object" + }, + "MicrosoftPurviewInformationProtectionDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents Microsoft Purview Information Protection data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/MicrosoftPurviewInformationProtectionDataConnectorProperties", + "description": "Microsoft Purview Information Protection data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftPurviewInformationProtection" + }, + "MicrosoftPurviewInformationProtectionConnectorDataTypes": { + "description": "The available data types for Microsoft Purview Information Protection data connector.", + "properties": { + "logs": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Logs data type.", + "type": "object" + } + }, + "type": "object", + "required": [ + "logs" + ] + }, + "MicrosoftPurviewInformationProtectionDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Microsoft Purview Information Protection data connector properties.", + "properties": { + "dataTypes": { + "$ref": "#/definitions/MicrosoftPurviewInformationProtectionConnectorDataTypes", + "description": "The available data types for the connector." + } + }, + "type": "object", + "required": [ + "dataTypes" + ] + }, + "Office365ProjectDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents Office Microsoft Project data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/Office365ProjectDataConnectorProperties", + "description": "Office Microsoft Project data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Office365Project" + }, + "Office365ProjectConnectorDataTypes": { + "description": "The available data types for Office Microsoft Project data connector.", + "properties": { + "logs": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Logs data type.", + "type": "object" + } + }, + "type": "object", + "required": [ + "logs" + ] + }, + "Office365ProjectDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Office Microsoft Project data connector properties.", + "properties": { + "dataTypes": { + "$ref": "#/definitions/Office365ProjectConnectorDataTypes", + "description": "The available data types for the connector." + } + }, + "type": "object", + "required": [ + "dataTypes" + ] + }, + "OfficePowerBIDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents Office Microsoft PowerBI data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/OfficePowerBIDataConnectorProperties", + "description": "Office Microsoft PowerBI data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "OfficePowerBI" + }, + "OfficePowerBIConnectorDataTypes": { + "description": "The available data types for Office Microsoft PowerBI data connector.", + "properties": { + "logs": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Logs data type.", + "type": "object" + } + }, + "type": "object", + "required": [ + "logs" + ] + }, + "OfficePowerBIDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Office Microsoft PowerBI data connector properties.", + "properties": { + "dataTypes": { + "$ref": "#/definitions/OfficePowerBIConnectorDataTypes", + "description": "The available data types for the connector." + } + }, + "type": "object", + "required": [ + "dataTypes" + ] + }, + "OfficeIRMDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents OfficeIRM (Microsoft Insider Risk Management) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/OfficeIRMDataConnectorProperties", + "description": "OfficeIRM (Microsoft Insider Risk Management) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "OfficeIRM" + }, + "OfficeIRMDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + }, + { + "$ref": "#/definitions/DataConnectorWithAlertsProperties" + } + ], + "description": "OfficeIRM (Microsoft Insider Risk Management) data connector properties.", + "type": "object" + }, + "MDATPDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents MDATP (Microsoft Defender Advanced Threat Protection) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/MDATPDataConnectorProperties", + "description": "MDATP (Microsoft Defender Advanced Threat Protection) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftDefenderAdvancedThreatProtection" + }, + "MDATPDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + }, + { + "$ref": "#/definitions/DataConnectorWithAlertsProperties" + } + ], + "description": "MDATP (Microsoft Defender Advanced Threat Protection) data connector properties.", + "type": "object" + }, + "OfficeDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents office data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/OfficeDataConnectorProperties", + "description": "Office data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Office365" + }, + "OfficeDataConnectorDataTypes": { + "description": "The available data types for office data connector.", + "properties": { + "exchange": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Exchange data type connection.", + "type": "object" + }, + "sharePoint": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "SharePoint data type connection.", + "type": "object" + }, + "teams": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Teams data type connection.", + "type": "object" + } + }, + "required": [ + "exchange", + "sharePoint", + "teams" + ], + "type": "object" + }, + "OfficeDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Office data connector properties.", + "properties": { + "dataTypes": { + "$ref": "#/definitions/OfficeDataConnectorDataTypes", + "description": "The available data types for the connector." + } + }, + "required": [ + "dataTypes" + ], + "type": "object" + }, + "TIDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents threat intelligence data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/TIDataConnectorProperties", + "description": "TI (Threat Intelligence) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "ThreatIntelligence" + }, + "TIDataConnectorDataTypes": { + "description": "The available data types for TI (Threat Intelligence) data connector.", + "properties": { + "indicators": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Data type for indicators connection.", + "type": "object" + } + }, + "type": "object", + "required": [ + "indicators" + ] + }, + "TIDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "TI (Threat Intelligence) data connector properties.", + "properties": { + "tipLookbackPeriod": { + "description": "The lookback period for the feed to be imported.", + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "dataTypes": { + "$ref": "#/definitions/TIDataConnectorDataTypes", + "description": "The available data types for the connector." + } + }, + "type": "object", + "required": [ + "dataTypes" + ] + }, + "TiTaxiiDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Data connector to pull Threat intelligence data from TAXII 2.0/2.1 server", + "properties": { + "properties": { + "$ref": "#/definitions/TiTaxiiDataConnectorProperties", + "description": "Threat intelligence TAXII data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "ThreatIntelligenceTaxii" + }, + "TiTaxiiDataConnectorDataTypes": { + "description": "The available data types for Threat Intelligence TAXII data connector.", + "properties": { + "taxiiClient": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Data type for TAXII connector.", + "type": "object" + } + }, + "type": "object", + "required": [ + "taxiiClient" + ] + }, + "TiTaxiiDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Threat Intelligence TAXII data connector properties.", + "properties": { + "workspaceId": { + "description": "The workspace id.", + "type": "string" + }, + "friendlyName": { + "description": "The friendly name for the TAXII server.", + "type": "string" + }, + "taxiiServer": { + "description": "The API root for the TAXII server.", + "type": "string" + }, + "collectionId": { + "description": "The collection id of the TAXII server.", + "type": "string" + }, + "userName": { + "description": "The userName for the TAXII server.", + "type": "string" + }, + "password": { + "description": "The password for the TAXII server.", + "type": "string" + }, + "taxiiLookbackPeriod": { + "description": "The lookback period for the TAXII server.", + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "pollingFrequency": { + "description": "The polling frequency for the TAXII server.", + "type": "string", + "x-nullable": true, + "enum": [ + "OnceAMinute", + "OnceAnHour", + "OnceADay" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PollingFrequency", + "values": [ + { + "description": "Once a minute", + "value": "OnceAMinute" + }, + { + "description": "Once an hour", + "value": "OnceAnHour" + }, + { + "description": "Once a day", + "value": "OnceADay" + } + ] + } + }, + "dataTypes": { + "$ref": "#/definitions/TiTaxiiDataConnectorDataTypes", + "description": "The available data types for Threat Intelligence TAXII data connector." + } + }, + "required": [ + "dataTypes", + "pollingFrequency" + ], + "type": "object" + }, + "IoTDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents IoT data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/IoTDataConnectorProperties", + "description": "IoT data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "IOT" + }, + "IoTDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorWithAlertsProperties" + } + ], + "description": "IoT data connector properties.", + "properties": { + "subscriptionId": { + "description": "The subscription id to connect to, and get the data from.", + "type": "string" + } + }, + "type": "object" + }, + "CodelessUiDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents Codeless UI data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/CodelessParameters", + "description": "Codeless UI data connector properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "GenericUI" + }, + "CodelessParameters": { + "description": "Represents Codeless UI data connector", + "type": "object", + "properties": { + "connectorUiConfig": { + "$ref": "#/definitions/CodelessUiConnectorConfigProperties", + "description": "Config to describe the instructions blade" + } + } + }, + "CodelessUiConnectorConfigProperties": { + "description": "Config to describe the instructions blade", + "type": "object", + "properties": { + "title": { + "description": "Connector blade title", + "type": "string" + }, + "publisher": { + "description": "Connector publisher name", + "type": "string" + }, + "descriptionMarkdown": { + "description": "Connector description", + "type": "string" + }, + "customImage": { + "description": "An optional custom image to be used when displaying the connector within Azure Sentinel's connector's gallery", + "type": "string" + }, + "graphQueriesTableName": { + "description": "Name of the table the connector will insert the data to", + "type": "string" + }, + "graphQueries": { + "description": "The graph query to show the current data status", + "x-ms-identifiers": [], + "items": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GraphQueries" + } + ] + }, + "type": "array" + }, + "sampleQueries": { + "description": "The sample queries for the connector", + "x-ms-identifiers": [], + "items": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SampleQueries" + } + ] + }, + "type": "array" + }, + "dataTypes": { + "description": "Data types to check for last data received", + "x-ms-identifiers": [], + "items": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LastDataReceivedDataType" + } + ] + }, + "type": "array" + }, + "connectivityCriteria": { + "description": "Define the way the connector check connectivity", + "x-ms-identifiers": [], + "items": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConnectivityCriteria" + } + ] + }, + "type": "array" + }, + "availability": { + "description": "Connector Availability Status", + "$ref": "#/definitions/Availability" + }, + "permissions": { + "description": "Permissions required for the connector", + "$ref": "#/definitions/Permissions" + }, + "instructionSteps": { + "description": "Instruction steps to enable the connector", + "x-ms-identifiers": [], + "items": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/InstructionSteps" + } + ] + }, + "type": "array" + } + }, + "required": [ + "title", + "publisher", + "descriptionMarkdown", + "graphQueriesTableName", + "graphQueries", + "sampleQueries", + "dataTypes", + "connectivityCriteria", + "availability", + "permissions", + "instructionSteps" + ] + }, + "DataConnectorConnectBody": { + "description": "Represents Codeless API Polling data connector.", + "type": "object", + "x-ms-identifiers": [], + "properties": { + "kind": { + "description": "The authentication kind used to poll the data", + "enum": [ + "Basic", + "OAuth2", + "APIKey" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ConnectAuthKind" + } + }, + "apiKey": { + "type": "string", + "description": "The API key of the audit server." + }, + "dataCollectionEndpoint": { + "type": "string", + "description": "Used in v2 logs connector. Represents the data collection ingestion endpoint in log analytics." + }, + "dataCollectionRuleImmutableId": { + "type": "string", + "description": "Used in v2 logs connector. The data collection rule immutable id, the rule defines the transformation and data destination." + }, + "outputStream": { + "type": "string", + "description": "Used in v2 logs connector. The stream we are sending the data to, this is the name of the streamDeclarations defined in the DCR." + }, + "clientSecret": { + "type": "string", + "description": "The client secret of the OAuth 2.0 application." + }, + "clientId": { + "type": "string", + "description": "The client id of the OAuth 2.0 application." + }, + "authorizationCode": { + "type": "string", + "description": "The authorization code used in OAuth 2.0 code flow to issue a token." + }, + "userName": { + "type": "string", + "description": "The user name in the audit log server." + }, + "password": { + "type": "string", + "description": "The user password in the audit log server.", + "x-ms-secret": true + }, + "requestConfigUserInputValues": { + "type": "array", + "description": "", + "x-ms-identifiers": [], + "items": { + "type": "object" + } + } + } + }, + "CodelessApiPollingDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents Codeless API Polling data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/ApiPollingParameters", + "description": "Codeless poling data connector properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "APIPolling" + }, + "ApiPollingParameters": { + "description": "Represents Codeless API Polling data connector", + "type": "object", + "properties": { + "connectorUiConfig": { + "$ref": "#/definitions/CodelessUiConnectorConfigProperties", + "description": "Config to describe the instructions blade" + }, + "pollingConfig": { + "$ref": "#/definitions/CodelessConnectorPollingConfigProperties", + "description": "Config to describe the polling instructions" + } + } + }, + "CodelessConnectorPollingConfigProperties": { + "description": "Config to describe the polling config for API poller connector", + "type": "object", + "properties": { + "isActive": { + "description": "The poller active status", + "type": "boolean" + }, + "auth": { + "type": "object", + "$ref": "#/definitions/CodelessConnectorPollingAuthProperties", + "description": "Describe the authentication type of the poller" + }, + "request": { + "type": "object", + "$ref": "#/definitions/CodelessConnectorPollingRequestProperties", + "description": "Describe the poll request config parameters of the poller" + }, + "paging": { + "type": "object", + "$ref": "#/definitions/CodelessConnectorPollingPagingProperties", + "description": "Describe the poll request paging config of the poller" + }, + "response": { + "type": "object", + "$ref": "#/definitions/CodelessConnectorPollingResponseProperties", + "description": "Describe the response config parameters of the poller" + } + }, + "required": [ + "auth", + "request" + ] + }, + "CodelessConnectorPollingResponseProperties": { + "description": "Describes the response from the external server", + "type": "object", + "properties": { + "eventsJsonPaths": { + "description": "Describes the path we should extract the data in the response", + "x-ms-identifiers": [], + "items": { + "type": "string" + }, + "type": "array" + }, + "successStatusJsonPath": { + "description": "Describes the path we should extract the status code in the response", + "type": "string" + }, + "successStatusValue": { + "description": "Describes the path we should extract the status value in the response", + "type": "string" + }, + "isGzipCompressed": { + "description": "Describes if the data in the response is Gzip", + "type": "boolean" + } + }, + "required": [ + "eventsJsonPaths" + ] + }, + "CodelessConnectorPollingPagingProperties": { + "description": "Describe the properties needed to make a pagination call", + "type": "object", + "properties": { + "pagingType": { + "description": "Describes the type. could be 'None', 'PageToken', 'PageCount', 'TimeStamp'", + "type": "string" + }, + "nextPageParaName": { + "description": "Defines the name of a next page attribute", + "type": "string" + }, + "nextPageTokenJsonPath": { + "description": "Defines the path to a next page token JSON", + "type": "string" + }, + "pageCountAttributePath": { + "description": "Defines the path to a page count attribute", + "type": "string" + }, + "pageTotalCountAttributePath": { + "description": "Defines the path to a page total count attribute", + "type": "string" + }, + "pageTimeStampAttributePath": { + "description": "Defines the path to a paging time stamp attribute", + "type": "string" + }, + "searchTheLatestTimeStampFromEventsList": { + "description": "Determines whether to search for the latest time stamp in the events list", + "type": "string" + }, + "pageSizeParaName": { + "description": "Defines the name of the page size parameter", + "type": "string" + }, + "pageSize": { + "description": "Defines the paging size", + "format": "int32", + "type": "integer" + } + }, + "required": [ + "pagingType" + ] + }, + "CodelessConnectorPollingRequestProperties": { + "description": "Describe the request properties needed to successfully pull from the server", + "type": "object", + "properties": { + "apiEndpoint": { + "description": "Describe the endpoint we should pull the data from", + "type": "string" + }, + "rateLimitQps": { + "description": "Defines the rate limit QPS", + "format": "int32", + "type": "integer" + }, + "queryWindowInMin": { + "description": "The window interval we will use the pull the data", + "format": "int32", + "type": "integer" + }, + "httpMethod": { + "description": "The http method type we will use in the poll request, GET or POST", + "type": "string" + }, + "queryTimeFormat": { + "description": "The time format will be used the query events in a specific window", + "type": "string" + }, + "retryCount": { + "description": "Describe the amount of time we should try and poll the data in case of failure", + "format": "int32", + "type": "integer" + }, + "timeoutInSeconds": { + "description": "The number of seconds we will consider as a request timeout", + "format": "int32", + "type": "integer" + }, + "headers": { + "description": "Describe the headers sent in the poll request", + "type": "object" + }, + "queryParameters": { + "description": "Describe the query parameters sent in the poll request", + "type": "object" + }, + "queryParametersTemplate": { + "description": "For advanced scenarios for example user name/password embedded in nested JSON payload", + "type": "string" + }, + "startTimeAttributeName": { + "description": "This will be used the query events from a start of the time window", + "type": "string" + }, + "endTimeAttributeName": { + "description": "This will be used the query events from the end of the time window", + "type": "string" + } + }, + "required": [ + "apiEndpoint", + "httpMethod", + "queryWindowInMin", + "queryTimeFormat" + ] + }, + "CodelessConnectorPollingAuthProperties": { + "description": "Describe the authentication properties needed to successfully authenticate with the server", + "type": "object", + "properties": { + "authType": { + "description": "The authentication type", + "type": "string" + }, + "apiKeyName": { + "description": "The header name which the token is sent with", + "type": "string" + }, + "apiKeyIdentifier": { + "description": "A prefix send in the header before the actual token", + "type": "string" + }, + "isApiKeyInPostPayload": { + "description": "Marks if the key should sent in header", + "type": "string" + }, + "flowName": { + "description": "Describes the flow name, for example 'AuthCode' for Oauth 2.0", + "type": "string" + }, + "tokenEndpoint": { + "description": "The endpoint used to issue a token, used in Oauth 2.0 flow", + "type": "string" + }, + "authorizationEndpoint": { + "description": "The endpoint used to authorize the user, used in Oauth 2.0 flow", + "type": "string" + }, + "authorizationEndpointQueryParameters": { + "description": "The query parameters used in authorization request, used in Oauth 2.0 flow", + "type": "object" + }, + "redirectionEndpoint": { + "description": "The redirect endpoint where we will get the authorization code, used in Oauth 2.0 flow", + "type": "string" + }, + "tokenEndpointHeaders": { + "description": "The query headers used in token request, used in Oauth 2.0 flow", + "type": "object" + }, + "tokenEndpointQueryParameters": { + "description": "The query parameters used in token request, used in Oauth 2.0 flow", + "type": "object" + }, + "isClientSecretInHeader": { + "description": "Marks if we should send the client secret in header or payload, used in Oauth 2.0 flow", + "type": "boolean" + }, + "scope": { + "description": "The OAuth token scope", + "type": "string" + } + }, + "required": [ + "authType" + ] + }, + "LastDataReceivedDataType": { + "description": "Data type for last data received", + "type": "object", + "properties": { + "name": { + "description": "Name of the data type to show in the graph. can be use with {{graphQueriesTableName}} placeholder", + "type": "string" + }, + "lastDataReceivedQuery": { + "description": "Query for indicate last data received", + "type": "string" + } + } + }, + "Permissions": { + "description": "Permissions required for the connector", + "x-ms-identifiers": [], + "type": "object", + "properties": { + "resourceProvider": { + "description": "Resource provider permissions required for the connector", + "x-ms-identifiers": [], + "items": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceProvider" + } + ] + }, + "type": "array" + }, + "customs": { + "description": "Customs permissions required for the connector", + "x-ms-identifiers": [], + "items": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Customs" + } + ] + }, + "type": "array" + } + } + }, + "Customs": { + "description": "Customs permissions required for the connector", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CustomsPermission" + } + ] + }, + "CustomsPermission": { + "description": "Customs permissions required for the connector", + "type": "object", + "properties": { + "name": { + "description": "Customs permissions name", + "type": "string" + }, + "description": { + "description": "Customs permissions description", + "type": "string" + } + } + }, + "ResourceProvider": { + "description": "Resource provider permissions required for the connector", + "type": "object", + "properties": { + "provider": { + "description": "Provider name", + "enum": [ + "Microsoft.OperationalInsights/solutions", + "Microsoft.OperationalInsights/workspaces", + "Microsoft.OperationalInsights/workspaces/datasources", + "microsoft.aadiam/diagnosticSettings", + "Microsoft.OperationalInsights/workspaces/sharedKeys", + "Microsoft.Authorization/policyAssignments" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ProviderName" + } + }, + "permissionsDisplayText": { + "description": "Permission description text", + "type": "string" + }, + "providerDisplayName": { + "description": "Permission provider display name", + "type": "string" + }, + "scope": { + "description": "Permission provider scope", + "enum": [ + "ResourceGroup", + "Subscription", + "Workspace" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "PermissionProviderScope" + } + }, + "requiredPermissions": { + "description": "Required permissions for the connector", + "$ref": "#/definitions/RequiredPermissions" + } + } + }, + "InstructionSteps": { + "description": "Instruction steps to enable the connector", + "type": "object", + "properties": { + "title": { + "description": "Instruction step title", + "type": "string" + }, + "description": { + "description": "Instruction step description", + "type": "string" + }, + "instructions": { + "description": "Instruction step details", + "x-ms-identifiers": [], + "items": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConnectorInstructionModelBase" + } + ] + }, + "type": "array" + } + } + }, + "ConnectorInstructionModelBase": { + "description": "Instruction step details", + "type": "object", + "properties": { + "parameters": { + "type": "object", + "description": "The parameters for the setting" + }, + "type": { + "description": "The kind of the setting", + "enum": [ + "CopyableLabel", + "InstructionStepsGroup", + "InfoMessage" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "SettingType" + } + } + }, + "required": [ + "type" + ] + }, + "RequiredPermissions": { + "description": "Required permissions for the connector", + "type": "object", + "properties": { + "action": { + "description": "action permission", + "type": "boolean" + }, + "write": { + "description": "write permission", + "type": "boolean" + }, + "read": { + "description": "read permission", + "type": "boolean" + }, + "delete": { + "description": "delete permission", + "type": "boolean" + } + } + }, + "Availability": { + "description": "Connector Availability Status", + "type": "object", + "properties": { + "status": { + "description": "The connector Availability Status", + "format": "int32", + "type": "integer", + "enum": [ + 1 + ], + "x-ms-enum": { + "name": "AvailabilityStatus", + "values": [ + { + "value": 1, + "description": "Available" + } + ] + } + }, + "isPreview": { + "description": "Set connector as preview", + "type": "boolean" + } + } + }, + "ConnectivityCriteria": { + "description": "Setting for the connector check connectivity", + "type": "object", + "properties": { + "type": { + "description": "type of connectivity", + "enum": [ + "IsConnectedQuery" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ConnectivityType" + } + }, + "value": { + "description": "Queries for checking connectivity", + "x-ms-identifiers": [], + "type": "array", + "items": { + "description": "checking connectivity query", + "type": "string" + } + } + } + }, + "SampleQueries": { + "description": "The sample queries for the connector", + "type": "object", + "properties": { + "description": { + "description": "The sample query description", + "type": "string" + }, + "query": { + "description": "the sample query", + "type": "string" + } + } + }, + "GraphQueries": { + "type": "object", + "description": "The graph query to show the current data status", + "properties": { + "metricName": { + "description": "the metric that the query is checking", + "type": "string" + }, + "legend": { + "description": "The legend for the graph", + "type": "string" + }, + "baseQuery": { + "description": "The base query for the graph", + "type": "string" + } + } + } + }, + "parameters": { + "DataConnector": { + "description": "The data connector", + "in": "body", + "name": "dataConnector", + "required": true, + "schema": { + "$ref": "#/definitions/DataConnector" + }, + "x-ms-parameter-location": "method" + }, + "DataConnectorId": { + "description": "Connector ID", + "in": "path", + "name": "dataConnectorId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DataConnectorConnectBody": { + "description": "The data connector", + "in": "body", + "name": "connectBody", + "required": true, + "schema": { + "$ref": "#/definitions/DataConnectorConnectBody" + }, + "x-ms-parameter-location": "method" + }, + "DataConnectorsCheckRequirementsBody": { + "description": "The parameters for requirements check message", + "in": "body", + "name": "DataConnectorsCheckRequirements", + "required": true, + "schema": { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/actions/CreateActionOfAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/actions/CreateActionOfAlertRule.json new file mode 100644 index 000000000000..ad54cf0e193d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/actions/CreateActionOfAlertRule.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "actionId": "912bec42-cb66-4c03-ac63-1761b6898c3e", + "action": { + "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", + "logicAppResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Logic/workflows/MyAlerts" + } + } + }, + "responses": { + "200": { + "body": { + "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": { + "workflowId": "cd3765391efd48549fd7681ded1d48d7", + "logicAppResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Logic/workflows/MyAlerts" + } + } + }, + "201": { + "body": { + "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": { + "workflowId": "cd3765391efd48549fd7681ded1d48d7", + "logicAppResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Logic/workflows/MyAlerts" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/actions/DeleteActionOfAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/actions/DeleteActionOfAlertRule.json new file mode 100644 index 000000000000..a28d26e30b8c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/actions/DeleteActionOfAlertRule.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "actionId": "912bec42-cb66-4c03-ac63-1761b6898c3e" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/actions/GetActionOfAlertRuleById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/actions/GetActionOfAlertRuleById.json new file mode 100644 index 000000000000..6bcc5c79868c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/actions/GetActionOfAlertRuleById.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "actionId": "912bec42-cb66-4c03-ac63-1761b6898c3e" + }, + "responses": { + "200": { + "body": { + "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": { + "workflowId": "cd3765391efd48549fd7681ded1d48d7", + "logicAppResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Logic/workflows/MyAlerts" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/actions/GetAllActionsByAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/actions/GetAllActionsByAlertRule.json new file mode 100644 index 000000000000..f5e6f613373e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/actions/GetAllActionsByAlertRule.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "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/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": { + "workflowId": "cd3765391efd48549fd7681ded1d48d7", + "logicAppResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Logic/workflows/MyAlerts" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplateById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplateById.json new file mode 100644 index 000000000000..a91210d50863 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplateById.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "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/", + "eventGroupingSettings": { + "aggregationKind": "AlertPerResult" + }, + "tactics": [ + "PrivilegeEscalation", + "LateralMovement" + ], + "techniques": [ + "T1037", + "T1021" + ], + "lastUpdatedDateUTC": "2020-02-27T00:00:00Z", + "version": "1.0.2", + "createdDateUTC": "2019-02-27T00:00:00Z", + "status": "Available", + "requiredDataConnectors": [ + { + "connectorId": "AWS", + "dataTypes": [ + "AWSCloudTrail" + ] + } + ], + "alertRulesCreatedByTemplateCount": 0 + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplates.json new file mode 100644 index 000000000000..ac87681d8d02 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplates.json @@ -0,0 +1,238 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "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" + ], + "techniques": [ + "T1037", + "T1021" + ], + "lastUpdatedDateUTC": "2020-02-27T00:00:00Z", + "createdDateUTC": "2019-02-27T00:00:00Z", + "status": "Available", + "version": "1.0.1", + "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": "Microsoft Sentinel uses Fusion, a correlation engine based on scalable machine learning algorithms, to automatically detect multistage attacks by identifying combinations of anomalous behaviors and suspicious activities that are observed at various stages of the kill chain. On the basis of these discoveries, Azure Sentinel generates incidents that would otherwise be very difficult to catch. By design, these incidents are low-volume, high-fidelity, and high-severity, which is why this detection is turned ON by default.\n\nSince Fusion correlates multiple signals from various products to detect advanced multistage attacks, successful Fusion detections are presented as Fusion incidents on the Microsoft Sentinel Incidents page. This rule covers the following detections:\n- Fusion for emerging threats\n- Fusion for ransomware\n- Scenario-based Fusion detections (122 scenarios)\n\nTo enable these detections, we recommend you configure the following data connectors for best results:\n- Out-of-the-box anomaly detections\n- Azure Active Directory Identity Protection\n- Azure Defender\n- Azure Defender for IoT\n- Microsoft 365 Defender\n- Microsoft Cloud App Security \n- Microsoft Defender for Endpoint\n- Microsoft Defender for Identity\n- Microsoft Defender for Office 365\n- Palo Alto Networks\n- Scheduled analytics rules, both built-in and those created by your security analysts. Analytics rules must contain kill-chain (tactics) and entity mapping information in order to be used by Fusion.\n\nFor the full description of each detection that is supported by Fusion, go to https://aka.ms/SentinelFusion.", + "tactics": [ + "Collection", + "CommandAndControl", + "CredentialAccess", + "DefenseEvasion", + "Discovery", + "Execution", + "Exfiltration", + "Impact", + "InitialAccess", + "LateralMovement", + "Persistence", + "PrivilegeEscalation" + ], + "sourceSettings": [ + { + "sourceName": "Anomalies", + "sourceSubTypes": null + }, + { + "sourceName": "Alert providers", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Azure Active Directory Identity Protection", + "severityFilter": { + "enabled": true, + "isSupported": true, + "severityFilters": [ + "Informational", + "Low", + "Medium", + "High" + ] + } + }, + { + "sourceSubTypeName": "Azure Defender", + "severityFilter": { + "enabled": true, + "isSupported": true, + "severityFilters": [ + "Informational", + "Low", + "Medium", + "High" + ] + } + }, + { + "sourceSubTypeName": "Azure Defender for IoT", + "severityFilter": { + "enabled": true, + "isSupported": true, + "severityFilters": [ + "Informational", + "Low", + "Medium", + "High" + ] + } + }, + { + "sourceSubTypeName": "Microsoft 365 Defender", + "severityFilter": { + "enabled": true, + "isSupported": true, + "severityFilters": [ + "Informational", + "Low", + "Medium", + "High" + ] + } + }, + { + "sourceSubTypeName": "Microsoft Cloud App Security", + "severityFilter": { + "enabled": true, + "isSupported": true, + "severityFilters": [ + "Informational", + "Low", + "Medium", + "High" + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Endpoint", + "severityFilter": { + "enabled": true, + "isSupported": true, + "severityFilters": [ + "Informational", + "Low", + "Medium", + "High" + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Identity", + "severityFilter": { + "enabled": true, + "isSupported": true, + "severityFilters": [ + "Informational", + "Low", + "Medium", + "High" + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Office 365", + "severityFilter": { + "enabled": true, + "isSupported": true, + "severityFilters": [ + "Informational", + "Low", + "Medium", + "High" + ] + } + }, + { + "sourceSubTypeName": "Azure Sentinel scheduled analytics rules", + "severityFilter": { + "enabled": true, + "isSupported": true, + "severityFilters": [ + "Informational", + "Low", + "Medium", + "High" + ] + } + } + ] + }, + { + "sourceName": "Raw logs from other sources", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Palo Alto Networks", + "severityFilter": { + "enabled": false, + "isSupported": false, + "severityFilters": null + } + } + ] + } + ], + "lastUpdatedDateUTC": "2021-06-09T00:00:00Z", + "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", + "lastUpdatedDateUTC": "2020-02-27T00:00:00Z", + "createdDateUTC": "2019-07-16T00:00:00Z", + "status": "Available", + "alertRulesCreatedByTemplateCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/CreateFusionAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/CreateFusionAlertRule.json new file mode 100644 index 000000000000..9d8712aed9a7 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/CreateFusionAlertRule.json @@ -0,0 +1,845 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "myFirstFusionRule", + "alertRule": { + "kind": "Fusion", + "etag": "3d00c3ca-0000-0100-0000-5d42d5010000", + "properties": { + "enabled": true, + "sourceSettings": [ + { + "enabled": true, + "sourceName": "Anomalies", + "sourceSubTypes": null + }, + { + "enabled": true, + "sourceName": "Alert providers", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Azure Active Directory Identity Protection", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender for IoT", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft 365 Defender", + "enabled": true, + "severityFilter": [ + "High", + "Medium", + "Low", + "Informational" + ], + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Cloud App Security", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Endpoint", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Identity", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Office 365", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Sentinel scheduled analytics rules", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + } + ] + }, + { + "enabled": true, + "sourceName": "Raw logs from other sources", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Palo Alto Networks", + "enabled": true, + "severityFilters": { + "filters": null + } + } + ] + } + ], + "alertRuleTemplateName": "f71aba3d-28fb-450b-b192-4e76a83015c8" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/myFirstFusionRule", + "name": "myFirstFusionRule", + "etag": "\"260090e2-0000-0d00-0000-5d6fb8670000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Fusion", + "properties": { + "displayName": "Advanced Multi-Stage Attack Detection", + "description": "Using Fusion technology based on machine learning, Azure Sentinel automatically detects multistage attacks by identifying combinations of anomalous behaviors and suspicious activities observed at various stages of the kill chain. On the basis of these discoveries, Azure Sentinel generates incidents that would otherwise be very difficult to catch. By design, these incidents are low-volume, high-fidelity, and high-severity, which is why this detection is turned ON by default.\n\nThere are a total of 122 Fusion incident types detected by Azure Sentinel.\n\nTo detect these multistage attacks, the following data connectors must be configured:\n- Azure Active Directory Identity Protection.\n- Microsoft Cloud App Security.\n- Microsoft Defender for Endpoint.\n- Azure Defender.\n- Palo Alto Networks.\n- Scheduled Analytics Rules supported by Fusion\n\nFor a full list and description of each scenario that is supported for these multistage attacks, go to https://aka.ms/SentinelFusion.", + "alertRuleTemplateName": "f71aba3d-28fb-450b-b192-4e76a83015c8", + "tactics": [ + "Collection", + "CommandAndControl", + "CredentialAccess", + "DefenseEvasion", + "Discovery", + "Execution", + "Exfiltration", + "Impact", + "InitialAccess", + "LateralMovement", + "Persistence", + "PrivilegeEscalation" + ], + "sourceSettings": [ + { + "enabled": true, + "sourceName": "Anomalies", + "sourceSubTypes": null + }, + { + "enabled": true, + "sourceName": "Alert providers", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Azure Active Directory Identity Protection", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender for IoT", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft 365 Defender", + "enabled": true, + "severityFilter": [ + "High", + "Medium", + "Low", + "Informational" + ], + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Cloud App Security", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Endpoint", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Identity", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Office 365", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Sentinel scheduled analytics rules", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + } + ] + }, + { + "enabled": true, + "sourceName": "Raw logs from other sources", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Palo Alto Networks", + "enabled": true, + "severityFilters": { + "isSupported": false, + "filters": null + } + } + ] + } + ], + "severity": "High", + "enabled": true, + "lastModifiedUtc": "2019-09-04T13:13:11.5340061Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/myFirstFusionRule", + "name": "myFirstFusionRule", + "etag": "\"260090e2-0000-0d00-0000-5d6fb8670000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Fusion", + "properties": { + "displayName": "Advanced Multi-Stage Attack Detection", + "description": "Using Fusion technology based on machine learning, Azure Sentinel automatically detects multistage attacks by identifying combinations of anomalous behaviors and suspicious activities observed at various stages of the kill chain. On the basis of these discoveries, Azure Sentinel generates incidents that would otherwise be very difficult to catch. By design, these incidents are low-volume, high-fidelity, and high-severity, which is why this detection is turned ON by default.\n\nThere are a total of 122 Fusion incident types detected by Azure Sentinel.\n\nTo detect these multistage attacks, the following data connectors must be configured:\n- Azure Active Directory Identity Protection.\n- Microsoft Cloud App Security.\n- Microsoft Defender for Endpoint.\n- Azure Defender.\n- Palo Alto Networks.\n- Scheduled Analytics Rules supported by Fusion\n\nFor a full list and description of each scenario that is supported for these multistage attacks, go to https://aka.ms/SentinelFusion.", + "alertRuleTemplateName": "f71aba3d-28fb-450b-b192-4e76a83015c8", + "tactics": [ + "Collection", + "CommandAndControl", + "CredentialAccess", + "DefenseEvasion", + "Discovery", + "Execution", + "Exfiltration", + "Impact", + "InitialAccess", + "LateralMovement", + "Persistence", + "PrivilegeEscalation" + ], + "sourceSettings": [ + { + "enabled": true, + "sourceName": "Anomalies", + "sourceSubTypes": null + }, + { + "enabled": true, + "sourceName": "Alert providers", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Azure Active Directory Identity Protection", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender for IoT", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft 365 Defender", + "enabled": true, + "severityFilter": [ + "High", + "Medium", + "Low", + "Informational" + ], + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Cloud App Security", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Endpoint", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Identity", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Office 365", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Sentinel scheduled analytics rules", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + } + ] + }, + { + "enabled": true, + "sourceName": "Raw logs from other sources", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Palo Alto Networks", + "enabled": true, + "severityFilters": { + "isSupported": false, + "filters": null + } + } + ] + } + ], + "severity": "High", + "enabled": true, + "lastModifiedUtc": "2019-09-04T13:13:11.5340061Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/CreateFusionAlertRuleWithFusionScenarioExclusion.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/CreateFusionAlertRuleWithFusionScenarioExclusion.json new file mode 100644 index 000000000000..71251c3a1c08 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/CreateFusionAlertRuleWithFusionScenarioExclusion.json @@ -0,0 +1,851 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "myFirstFusionRule", + "alertRule": { + "kind": "Fusion", + "etag": "3d00c3ca-0000-0100-0000-5d42d5010000", + "properties": { + "enabled": true, + "sourceSettings": [ + { + "enabled": true, + "sourceName": "Anomalies", + "sourceSubTypes": null + }, + { + "enabled": true, + "sourceName": "Alert providers", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Azure Active Directory Identity Protection", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender for IoT", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft 365 Defender", + "enabled": true, + "severityFilter": [ + "High", + "Medium", + "Low", + "Informational" + ], + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Cloud App Security", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Endpoint", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Identity", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Office 365", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Sentinel scheduled analytics rules", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + } + ] + }, + { + "enabled": true, + "sourceName": "Raw logs from other sources", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Palo Alto Networks", + "enabled": true, + "severityFilters": { + "filters": null + } + } + ] + } + ], + "alertRuleTemplateName": "f71aba3d-28fb-450b-b192-4e76a83015c8" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/myFirstFusionRule", + "name": "myFirstFusionRule", + "etag": "\"260090e2-0000-0d00-0000-5d6fb8670000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Fusion", + "properties": { + "displayName": "Advanced Multi-Stage Attack Detection", + "description": "Using Fusion technology based on machine learning, Azure Sentinel automatically detects multistage attacks by identifying combinations of anomalous behaviors and suspicious activities observed at various stages of the kill chain. On the basis of these discoveries, Azure Sentinel generates incidents that would otherwise be very difficult to catch. By design, these incidents are low-volume, high-fidelity, and high-severity, which is why this detection is turned ON by default.\n\nThere are a total of 122 Fusion incident types detected by Azure Sentinel.\n\nTo detect these multistage attacks, the following data connectors must be configured:\n- Azure Active Directory Identity Protection.\n- Microsoft Cloud App Security.\n- Microsoft Defender for Endpoint.\n- Azure Defender.\n- Palo Alto Networks.\n- Scheduled Analytics Rules supported by Fusion\n\nFor a full list and description of each scenario that is supported for these multistage attacks, go to https://aka.ms/SentinelFusion.", + "alertRuleTemplateName": "f71aba3d-28fb-450b-b192-4e76a83015c8", + "tactics": [ + "Collection", + "CommandAndControl", + "CredentialAccess", + "DefenseEvasion", + "Discovery", + "Execution", + "Exfiltration", + "Impact", + "InitialAccess", + "LateralMovement", + "Persistence", + "PrivilegeEscalation" + ], + "sourceSettings": [ + { + "enabled": true, + "sourceName": "Anomalies", + "sourceSubTypes": null + }, + { + "enabled": true, + "sourceName": "Alert providers", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Azure Active Directory Identity Protection", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender for IoT", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft 365 Defender", + "enabled": true, + "severityFilter": [ + "High", + "Medium", + "Low", + "Informational" + ], + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Cloud App Security", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Endpoint", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Identity", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Office 365", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Sentinel scheduled analytics rules", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + } + ] + }, + { + "enabled": true, + "sourceName": "Raw logs from other sources", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Palo Alto Networks", + "enabled": true, + "severityFilters": { + "isSupported": false, + "filters": null + } + } + ] + } + ], + "severity": "High", + "enabled": true, + "lastModifiedUtc": "2019-09-04T13:13:11.5340061Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/myFirstFusionRule", + "name": "myFirstFusionRule", + "etag": "\"260090e2-0000-0d00-0000-5d6fb8670000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Fusion", + "properties": { + "displayName": "Advanced Multi-Stage Attack Detection", + "description": "Using Fusion technology based on machine learning, Azure Sentinel automatically detects multistage attacks by identifying combinations of anomalous behaviors and suspicious activities observed at various stages of the kill chain. On the basis of these discoveries, Azure Sentinel generates incidents that would otherwise be very difficult to catch. By design, these incidents are low-volume, high-fidelity, and high-severity, which is why this detection is turned ON by default.\n\nThere are a total of 122 Fusion incident types detected by Azure Sentinel.\n\nTo detect these multistage attacks, the following data connectors must be configured:\n- Azure Active Directory Identity Protection.\n- Microsoft Cloud App Security.\n- Microsoft Defender for Endpoint.\n- Azure Defender.\n- Palo Alto Networks.\n- Scheduled Analytics Rules supported by Fusion\n\nFor a full list and description of each scenario that is supported for these multistage attacks, go to https://aka.ms/SentinelFusion.", + "alertRuleTemplateName": "f71aba3d-28fb-450b-b192-4e76a83015c8", + "tactics": [ + "Collection", + "CommandAndControl", + "CredentialAccess", + "DefenseEvasion", + "Discovery", + "Execution", + "Exfiltration", + "Impact", + "InitialAccess", + "LateralMovement", + "Persistence", + "PrivilegeEscalation" + ], + "sourceSettings": [ + { + "enabled": true, + "sourceName": "Anomalies", + "sourceSubTypes": null + }, + { + "enabled": true, + "sourceName": "Alert providers", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Azure Active Directory Identity Protection", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender for IoT", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft 365 Defender", + "enabled": true, + "severityFilter": [ + "High", + "Medium", + "Low", + "Informational" + ], + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Cloud App Security", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Endpoint", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Identity", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Office 365", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Sentinel scheduled analytics rules", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + } + ] + }, + { + "enabled": true, + "sourceName": "Raw logs from other sources", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Palo Alto Networks", + "enabled": true, + "severityFilters": { + "isSupported": false, + "filters": null + } + } + ] + } + ], + "scenarioExclusionPatterns": [ + { + "exclusionPattern": "Alert providers:Azure Active Directory Identity Protection:Infected Device;Alert providers:Azure Defender:Crypto-mining activity", + "dateAddedInUTC": "2021-10-01T15:26:44.9429806Z" + } + ], + "severity": "High", + "enabled": true, + "lastModifiedUtc": "2019-09-04T13:13:11.5340061Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/CreateMicrosoftSecurityIncidentCreationAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/CreateMicrosoftSecurityIncidentCreationAlertRule.json new file mode 100644 index 000000000000..d2492fdca2c8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/CreateMicrosoftSecurityIncidentCreationAlertRule.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "microsoftSecurityIncidentCreationRuleExample", + "alertRule": { + "etag": "\"260097e0-0000-0d00-0000-5d6fa88f0000\"", + "kind": "MicrosoftSecurityIncidentCreation", + "properties": { + "productFilter": "Microsoft Cloud App Security", + "displayName": "testing displayname", + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExample", + "name": "microsoftSecurityIncidentCreationRuleExample", + "etag": "\"260097e0-0000-0d00-0000-5d6fa88f0000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "MicrosoftSecurityIncidentCreation", + "properties": { + "productFilter": "Microsoft Cloud App Security", + "severitiesFilter": null, + "displayNamesFilter": null, + "displayName": "testing displayname", + "enabled": true, + "description": null, + "alertRuleTemplateName": null, + "lastModifiedUtc": "2019-09-04T12:05:35.7296311Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExample", + "name": "microsoftSecurityIncidentCreationRuleExample", + "etag": "\"260097e0-0000-0d00-0000-5d6fa88f0000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "MicrosoftSecurityIncidentCreation", + "properties": { + "productFilter": "Microsoft Cloud App Security", + "severitiesFilter": null, + "displayNamesFilter": null, + "displayName": "testing displayname", + "enabled": true, + "description": null, + "alertRuleTemplateName": null, + "lastModifiedUtc": "2019-09-04T12:05:35.7296311Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/CreateNrtAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/CreateNrtAlertRule.json new file mode 100644 index 000000000000..8e9370d58d2a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/CreateNrtAlertRule.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "alertRule": { + "kind": "NRT", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "displayName": "Rule2", + "description": "", + "severity": "High", + "enabled": true, + "tactics": [ + "Persistence", + "LateralMovement" + ], + "techniques": [ + "T1037", + "T1021" + ], + "query": "ProtectionStatus | extend HostCustomEntity = Computer | extend IPCustomEntity = ComputerIP_Hidden", + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "eventGroupingSettings": { + "aggregationKind": "AlertPerResult" + }, + "incidentConfiguration": { + "createIncident": true, + "groupingConfiguration": { + "enabled": true, + "reopenClosedIncident": false, + "lookbackDuration": "PT5H", + "matchingMethod": "Selected", + "groupByEntities": [ + "Host", + "Account" + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "NRT", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "alertRuleTemplateName": null, + "displayName": "Rule2", + "description": "", + "severity": "High", + "enabled": true, + "tactics": [ + "Persistence", + "LateralMovement" + ], + "techniques": [ + "T1037", + "T1021" + ], + "query": "ProtectionStatus | extend HostCustomEntity = Computer | extend IPCustomEntity = ComputerIP_Hidden", + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "eventGroupingSettings": { + "aggregationKind": "AlertPerResult" + }, + "lastModifiedUtc": "2019-01-01T13:15:30Z", + "incidentConfiguration": { + "createIncident": true, + "groupingConfiguration": { + "enabled": true, + "reopenClosedIncident": false, + "lookbackDuration": "PT5H", + "matchingMethod": "Selected", + "groupByEntities": [ + "Host", + "Account" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "NRT", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "alertRuleTemplateName": null, + "displayName": "Rule2", + "description": "", + "severity": "High", + "enabled": true, + "tactics": [ + "Persistence", + "LateralMovement" + ], + "techniques": [ + "T1037", + "T1021" + ], + "query": "ProtectionStatus | extend HostCustomEntity = Computer | extend IPCustomEntity = ComputerIP_Hidden", + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "eventGroupingSettings": { + "aggregationKind": "AlertPerResult" + }, + "lastModifiedUtc": "2019-01-01T13:15:30Z", + "incidentConfiguration": { + "createIncident": true, + "groupingConfiguration": { + "enabled": true, + "reopenClosedIncident": false, + "lookbackDuration": "PT5H", + "matchingMethod": "Selected", + "groupByEntities": [ + "Host", + "Account" + ] + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/CreateScheduledAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/CreateScheduledAlertRule.json new file mode 100644 index 000000000000..6dc15bdce683 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/CreateScheduledAlertRule.json @@ -0,0 +1,270 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "alertRule": { + "kind": "Scheduled", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "displayName": "My scheduled rule", + "description": "An example for a scheduled rule", + "severity": "High", + "enabled": true, + "tactics": [ + "Persistence", + "LateralMovement" + ], + "techniques": [ + "T1037", + "T1021" + ], + "query": "Heartbeat", + "queryFrequency": "PT1H", + "queryPeriod": "P2DT1H30M", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "eventGroupingSettings": { + "aggregationKind": "AlertPerResult" + }, + "customDetails": { + "OperatingSystemName": "OSName", + "OperatingSystemType": "OSType" + }, + "entityMappings": [ + { + "entityType": "Host", + "fieldMappings": [ + { + "identifier": "FullName", + "columnName": "Computer" + } + ] + }, + { + "entityType": "IP", + "fieldMappings": [ + { + "identifier": "Address", + "columnName": "ComputerIP" + } + ] + } + ], + "sentinelEntitiesMappings": [ + { + "columnName": "Entities" + } + ], + "alertDetailsOverride": { + "alertDisplayNameFormat": "Alert from {{Computer}}", + "alertDescriptionFormat": "Suspicious activity was made by {{ComputerIP}}", + "alertDynamicProperties": [ + { + "alertProperty": "ProductComponentName", + "value": "ProductComponentNameCustomColumn" + }, + { + "alertProperty": "ProductName", + "value": "ProductNameCustomColumn" + }, + { + "alertProperty": "AlertLink", + "value": "Link" + } + ] + }, + "incidentConfiguration": { + "createIncident": true, + "groupingConfiguration": { + "enabled": true, + "reopenClosedIncident": false, + "lookbackDuration": "PT5H", + "matchingMethod": "Selected", + "groupByEntities": [ + "Host" + ], + "groupByAlertDetails": [ + "DisplayName" + ], + "groupByCustomDetails": [ + "OperatingSystemType", + "OperatingSystemName" + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Scheduled", + "etag": "\"01005144-0000-0d00-0000-6058632c0000\"", + "properties": { + "alertRuleTemplateName": null, + "displayName": "My scheduled rule", + "description": "An example for a scheduled rule", + "severity": "High", + "enabled": true, + "tactics": [ + "Persistence", + "LateralMovement" + ], + "techniques": [ + "T1037", + "T1021" + ], + "query": "Heartbeat", + "queryFrequency": "PT1H", + "queryPeriod": "P2DT1H30M", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "lastModifiedUtc": "2021-03-01T13:17:30Z", + "eventGroupingSettings": { + "aggregationKind": "AlertPerResult" + }, + "customDetails": { + "OperatingSystemName": "OSName", + "OperatingSystemType": "OSType" + }, + "entityMappings": [ + { + "entityType": "Host", + "fieldMappings": [ + { + "identifier": "FullName", + "columnName": "Computer" + } + ] + }, + { + "entityType": "IP", + "fieldMappings": [ + { + "identifier": "Address", + "columnName": "ComputerIP" + } + ] + } + ], + "alertDetailsOverride": { + "alertDisplayNameFormat": "Alert from {{Computer}}", + "alertDescriptionFormat": "Suspicious activity was made by {{ComputerIP}}", + "alertTacticsColumnName": null, + "alertSeverityColumnName": null + }, + "incidentConfiguration": { + "createIncident": true, + "groupingConfiguration": { + "enabled": true, + "reopenClosedIncident": false, + "lookbackDuration": "PT5H", + "matchingMethod": "Selected", + "groupByEntities": [ + "Host" + ], + "groupByAlertDetails": [ + "DisplayName" + ], + "groupByCustomDetails": [ + "OperatingSystemType", + "OperatingSystemName" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Scheduled", + "etag": "\"01007444-0000-0d00-0000-605863a70000\"", + "properties": { + "alertRuleTemplateName": null, + "displayName": "My scheduled rule", + "description": "An example for a scheduled rule", + "severity": "High", + "enabled": true, + "tactics": [ + "Persistence", + "LateralMovement" + ], + "techniques": [ + "T1037", + "T1021" + ], + "query": "Heartbeat", + "queryFrequency": "PT1H", + "queryPeriod": "P2DT1H30M", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "lastModifiedUtc": "2021-03-01T13:15:30Z", + "customDetails": { + "OperatingSystemName": "OSName", + "OperatingSystemType": "OSType" + }, + "entityMappings": [ + { + "entityType": "Host", + "fieldMappings": [ + { + "identifier": "FullName", + "columnName": "Computer" + } + ] + }, + { + "entityType": "IP", + "fieldMappings": [ + { + "identifier": "Address", + "columnName": "ComputerIP" + } + ] + } + ], + "alertDetailsOverride": { + "alertDisplayNameFormat": "Alert from {{Computer}}", + "alertDescriptionFormat": "Suspicious activity was made by {{ComputerIP}}", + "alertTacticsColumnName": null, + "alertSeverityColumnName": null + }, + "incidentConfiguration": { + "createIncident": true, + "groupingConfiguration": { + "enabled": true, + "reopenClosedIncident": false, + "lookbackDuration": "PT5H", + "matchingMethod": "Selected", + "groupByEntities": [ + "Host" + ], + "groupByAlertDetails": [ + "DisplayName" + ], + "groupByCustomDetails": [ + "OperatingSystemType", + "OperatingSystemName" + ] + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/DeleteAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/DeleteAlertRule.json new file mode 100644 index 000000000000..098bb63dd221 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/DeleteAlertRule.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/GetAllAlertRules.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/GetAllAlertRules.json new file mode 100644 index 000000000000..410564113133 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/GetAllAlertRules.json @@ -0,0 +1,412 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Scheduled", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "alertRuleTemplateName": null, + "displayName": "My scheduled rule", + "description": "An example for a scheduled rule", + "severity": "High", + "enabled": true, + "tactics": [ + "Persistence", + "LateralMovement" + ], + "techniques": [ + "T1037", + "T1021" + ], + "query": "Heartbeat", + "queryFrequency": "PT1H", + "queryPeriod": "P2DT1H30M", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "lastModifiedUtc": "2021-03-01T13:17:30Z", + "eventGroupingSettings": { + "aggregationKind": "AlertPerResult" + }, + "customDetails": { + "OperatingSystemName": "OSName", + "OperatingSystemType": "OSType" + }, + "entityMappings": [ + { + "entityType": "Host", + "fieldMappings": [ + { + "identifier": "FullName", + "columnName": "Computer" + } + ] + }, + { + "entityType": "IP", + "fieldMappings": [ + { + "identifier": "Address", + "columnName": "ComputerIP" + } + ] + } + ], + "alertDetailsOverride": { + "alertDisplayNameFormat": "Alert from {{Computer}}", + "alertDescriptionFormat": "Suspicious activity was made by {{ComputerIP}}", + "alertTacticsColumnName": null, + "alertSeverityColumnName": null + }, + "incidentConfiguration": { + "createIncident": true, + "groupingConfiguration": { + "enabled": true, + "reopenClosedIncident": false, + "lookbackDuration": "PT5H", + "matchingMethod": "Selected", + "groupByEntities": [ + "Host" + ], + "groupByAlertDetails": [ + "DisplayName" + ], + "groupByCustomDetails": [ + "OperatingSystemType", + "OperatingSystemName" + ] + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExample", + "name": "microsoftSecurityIncidentCreationRuleExample", + "etag": "\"260097e0-0000-0d00-0000-5d6fa88f0000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "MicrosoftSecurityIncidentCreation", + "properties": { + "productFilter": "Microsoft Cloud App Security", + "severitiesFilter": null, + "displayNamesFilter": null, + "displayName": "testing displayname", + "enabled": true, + "description": null, + "alertRuleTemplateName": null, + "lastModifiedUtc": "2019-09-04T12:05:35.7296311Z" + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/myFirstFusionRule", + "name": "myFirstFusionRule", + "etag": "\"25005c11-0000-0d00-0000-5d6cc0e20000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Fusion", + "properties": { + "displayName": "Advanced Multi-Stage Attack Detection", + "description": "Microsoft Sentinel uses Fusion, a correlation engine based on scalable machine learning algorithms, to automatically detect multistage attacks by identifying combinations of anomalous behaviors and suspicious activities that are observed at various stages of the kill chain. On the basis of these discoveries, Azure Sentinel generates incidents that would otherwise be very difficult to catch. By design, these incidents are low-volume, high-fidelity, and high-severity, which is why this detection is turned ON by default.\n\nSince Fusion correlates multiple signals from various products to detect advanced multistage attacks, successful Fusion detections are presented as Fusion incidents on the Microsoft Sentinel Incidents page. This rule covers the following detections:\n- Fusion for emerging threats\n- Fusion for ransomware\n- Scenario-based Fusion detections (122 scenarios)\n\nTo enable these detections, we recommend you configure the following data connectors for best results:\n- Out-of-the-box anomaly detections\n- Azure Active Directory Identity Protection\n- Azure Defender\n- Azure Defender for IoT\n- Microsoft 365 Defender\n- Microsoft Cloud App Security \n- Microsoft Defender for Endpoint\n- Microsoft Defender for Identity\n- Microsoft Defender for Office 365\n- Palo Alto Networks\n- Scheduled analytics rules, both built-in and those created by your security analysts. Analytics rules must contain kill-chain (tactics) and entity mapping information in order to be used by Fusion.\n\nFor the full description of each detection that is supported by Fusion, go to https://aka.ms/SentinelFusion.", + "alertRuleTemplateName": "f71aba3d-28fb-450b-b192-4e76a83015c8", + "tactics": [ + "Collection", + "CommandAndControl", + "CredentialAccess", + "DefenseEvasion", + "Discovery", + "Execution", + "Exfiltration", + "Impact", + "InitialAccess", + "LateralMovement", + "Persistence", + "PrivilegeEscalation" + ], + "sourceSettings": [ + { + "enabled": true, + "sourceName": "Anomalies", + "sourceSubTypes": null + }, + { + "enabled": true, + "sourceName": "Alert providers", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Azure Active Directory Identity Protection", + "sourceSubTypeDisplayName": "Azure Active Directory Identity Protection", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender", + "sourceSubTypeDisplayName": "Microsoft Defender for Cloud", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender for IoT", + "sourceSubTypeDisplayName": "Microsoft Defender for IoT", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft 365 Defender", + "sourceSubTypeDisplayName": "Microsoft 365 Defender", + "enabled": true, + "severityFilter": [ + "High", + "Medium", + "Low", + "Informational" + ], + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Cloud App Security", + "sourceSubTypeDisplayName": "Microsoft Cloud App Security", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Endpoint", + "sourceSubTypeDisplayName": "Microsoft Defender for Endpoint", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Identity", + "sourceSubTypeDisplayName": "Microsoft Defender for Identity", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Office 365", + "sourceSubTypeDisplayName": "Microsoft Defender for Office 365", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Sentinel scheduled analytics rules", + "sourceSubTypeDisplayName": "Azure Sentinel scheduled analytics rules", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + } + ] + }, + { + "enabled": true, + "sourceName": "Raw logs from other sources", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Palo Alto Networks", + "sourceSubTypeDisplayName": "Palo Alto Networks", + "enabled": true, + "severityFilters": { + "isSupported": false, + "filters": null + } + } + ] + } + ], + "severity": "High", + "enabled": true, + "lastModifiedUtc": "2021-10-22T07:12:34.9065092Z" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/GetFusionAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/GetFusionAlertRule.json new file mode 100644 index 000000000000..352048235c1a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/GetFusionAlertRule.json @@ -0,0 +1,310 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "myFirstFusionRule" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/myFirstFusionRule", + "name": "myFirstFusionRule", + "etag": "\"260090e2-0000-0d00-0000-5d6fb8670000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Fusion", + "properties": { + "displayName": "Advanced Multi-Stage Attack Detection", + "description": "Microsoft Sentinel uses Fusion, a correlation engine based on scalable machine learning algorithms, to automatically detect multistage attacks by identifying combinations of anomalous behaviors and suspicious activities that are observed at various stages of the kill chain. On the basis of these discoveries, Azure Sentinel generates incidents that would otherwise be very difficult to catch. By design, these incidents are low-volume, high-fidelity, and high-severity, which is why this detection is turned ON by default.\n\nSince Fusion correlates multiple signals from various products to detect advanced multistage attacks, successful Fusion detections are presented as Fusion incidents on the Microsoft Sentinel Incidents page. This rule covers the following detections:\n- Fusion for emerging threats\n- Fusion for ransomware\n- Scenario-based Fusion detections (122 scenarios)\n\nTo enable these detections, we recommend you configure the following data connectors for best results:\n- Out-of-the-box anomaly detections\n- Azure Active Directory Identity Protection\n- Azure Defender\n- Azure Defender for IoT\n- Microsoft 365 Defender\n- Microsoft Cloud App Security \n- Microsoft Defender for Endpoint\n- Microsoft Defender for Identity\n- Microsoft Defender for Office 365\n- Palo Alto Networks\n- Scheduled analytics rules, both built-in and those created by your security analysts. Analytics rules must contain kill-chain (tactics) and entity mapping information in order to be used by Fusion.\n\nFor the full description of each detection that is supported by Fusion, go to https://aka.ms/SentinelFusion.", + "alertRuleTemplateName": "f71aba3d-28fb-450b-b192-4e76a83015c8", + "tactics": [ + "Collection", + "CommandAndControl", + "CredentialAccess", + "DefenseEvasion", + "Discovery", + "Execution", + "Exfiltration", + "Impact", + "InitialAccess", + "LateralMovement", + "Persistence", + "PrivilegeEscalation" + ], + "sourceSettings": [ + { + "enabled": true, + "sourceName": "Anomalies", + "sourceSubTypes": null + }, + { + "enabled": true, + "sourceName": "Alert providers", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Azure Active Directory Identity Protection", + "sourceSubTypeDisplayName": "Azure Active Directory Identity Protection", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender", + "sourceSubTypeDisplayName": "Microsoft Defender for Cloud", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender for IoT", + "sourceSubTypeDisplayName": "Microsoft Defender for IoT", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft 365 Defender", + "sourceSubTypeDisplayName": "Microsoft 365 Defender", + "enabled": true, + "severityFilter": [ + "High", + "Medium", + "Low", + "Informational" + ], + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Cloud App Security", + "sourceSubTypeDisplayName": "Microsoft Cloud App Security", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Endpoint", + "sourceSubTypeDisplayName": "Microsoft Defender for Endpoint", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Identity", + "sourceSubTypeDisplayName": "Microsoft Defender for Identity", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Office 365", + "sourceSubTypeDisplayName": "Microsoft Defender for Office 365", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Sentinel scheduled analytics rules", + "sourceSubTypeDisplayName": "Azure Sentinel scheduled analytics rules", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + } + ] + }, + { + "enabled": true, + "sourceName": "Raw logs from other sources", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Palo Alto Networks", + "sourceSubTypeDisplayName": "Palo Alto Networks", + "enabled": true, + "severityFilters": { + "isSupported": false, + "filters": null + } + } + ] + } + ], + "severity": "High", + "enabled": true, + "lastModifiedUtc": "2021-10-20T13:13:11.5340061Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/GetMicrosoftSecurityIncidentCreationAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/GetMicrosoftSecurityIncidentCreationAlertRule.json new file mode 100644 index 000000000000..4f105fe9c139 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/GetMicrosoftSecurityIncidentCreationAlertRule.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "microsoftSecurityIncidentCreationRuleExample" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExample", + "name": "microsoftSecurityIncidentCreationRuleExample", + "etag": "\"260097e0-0000-0d00-0000-5d6fa88f0000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "MicrosoftSecurityIncidentCreation", + "properties": { + "productFilter": "Microsoft Cloud App Security", + "severitiesFilter": null, + "displayNamesFilter": null, + "displayName": "testing displayname", + "enabled": true, + "description": null, + "alertRuleTemplateName": null, + "lastModifiedUtc": "2019-09-04T12:05:35.7296311Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/GetNrtAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/GetNrtAlertRule.json new file mode 100644 index 000000000000..214b1fe2db82 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/GetNrtAlertRule.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "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/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "NRT", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "alertRuleTemplateName": null, + "displayName": "Rule2", + "description": "", + "severity": "High", + "enabled": true, + "tactics": [ + "Persistence", + "LateralMovement" + ], + "techniques": [ + "T1037", + "T1021" + ], + "query": "ProtectionStatus | extend HostCustomEntity = Computer | extend IPCustomEntity = ComputerIP_Hidden", + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "eventGroupingSettings": { + "aggregationKind": "AlertPerResult" + }, + "lastModifiedUtc": "2019-01-01T13:15:30Z", + "incidentConfiguration": { + "createIncident": true, + "groupingConfiguration": { + "enabled": true, + "reopenClosedIncident": false, + "lookbackDuration": "PT5H", + "matchingMethod": "Selected", + "groupByEntities": [ + "Host", + "Account" + ] + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/GetScheduledAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/GetScheduledAlertRule.json new file mode 100644 index 000000000000..5a8010218df9 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/alertRules/GetScheduledAlertRule.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "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/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Scheduled", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "alertRuleTemplateName": null, + "displayName": "My scheduled rule", + "description": "An example for a scheduled rule", + "severity": "High", + "enabled": true, + "tactics": [ + "Persistence", + "LateralMovement" + ], + "techniques": [ + "T1037", + "T1021" + ], + "query": "Heartbeat", + "queryFrequency": "PT1H", + "queryPeriod": "P2DT1H30M", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "lastModifiedUtc": "2021-03-01T13:17:30Z", + "eventGroupingSettings": { + "aggregationKind": "AlertPerResult" + }, + "customDetails": { + "OperatingSystemName": "OSName", + "OperatingSystemType": "OSType" + }, + "entityMappings": [ + { + "entityType": "Host", + "fieldMappings": [ + { + "identifier": "FullName", + "columnName": "Computer" + } + ] + }, + { + "entityType": "IP", + "fieldMappings": [ + { + "identifier": "Address", + "columnName": "ComputerIP" + } + ] + } + ], + "alertDetailsOverride": { + "alertDisplayNameFormat": "Alert from {{Computer}}", + "alertDescriptionFormat": "Suspicious activity was made by {{ComputerIP}}", + "alertTacticsColumnName": null, + "alertSeverityColumnName": null + }, + "incidentConfiguration": { + "createIncident": true, + "groupingConfiguration": { + "enabled": true, + "reopenClosedIncident": false, + "lookbackDuration": "PT5H", + "matchingMethod": "Selected", + "groupByEntities": [ + "Host" + ], + "groupByAlertDetails": [ + "DisplayName" + ], + "groupByCustomDetails": [ + "OperatingSystemType", + "OperatingSystemName" + ] + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/automationRules/AutomationRules_CreateOrUpdate.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/automationRules/AutomationRules_CreateOrUpdate.json new file mode 100644 index 000000000000..2189db1fe01d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/automationRules/AutomationRules_CreateOrUpdate.json @@ -0,0 +1,195 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "automationRuleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "automationRule": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/automationRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/automationRules", + "properties": { + "displayName": "Suspicious user sign-in events", + "order": 1, + "triggeringLogic": { + "isEnabled": true, + "triggersOn": "Incidents", + "triggersWhen": "Created", + "conditions": [ + { + "conditionType": "PropertyArray", + "conditionProperties": { + "arrayType": "IncidentLabels", + "arrayConditionType": "AnyItem", + "itemConditions": [ + { + "conditionType": "Property", + "conditionProperties": { + "propertyName": "IncidentLabel", + "operator": "Equals", + "propertyValues": [ + "myLabel" + ] + } + } + ] + } + } + ] + }, + "actions": [ + { + "order": 1, + "actionType": "AddIncidentTask", + "actionConfiguration": { + "title": "Reset user passwords", + "description": "Reset passwords for compromised users." + } + } + ], + "lastModifiedTimeUtc": "2019-01-01T13:00:30Z", + "createdTimeUtc": "2019-01-01T13:00:00Z", + "lastModifiedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + }, + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/automationRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/automationRules", + "properties": { + "displayName": "Suspicious user sign-in events", + "order": 1, + "triggeringLogic": { + "isEnabled": true, + "triggersOn": "Incidents", + "triggersWhen": "Created", + "conditions": [ + { + "conditionType": "PropertyArray", + "conditionProperties": { + "arrayType": "IncidentLabels", + "arrayConditionType": "AnyItem", + "itemConditions": [ + { + "conditionType": "Property", + "conditionProperties": { + "propertyName": "IncidentLabel", + "operator": "Equals", + "propertyValues": [ + "myLabel" + ] + } + } + ] + } + } + ] + }, + "actions": [ + { + "order": 1, + "actionType": "AddIncidentTask", + "actionConfiguration": { + "title": "Reset user passwords", + "description": "Reset passwords for compromised users." + } + } + ], + "lastModifiedTimeUtc": "2019-01-01T13:00:30Z", + "createdTimeUtc": "2019-01-01T13:00:00Z", + "lastModifiedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + }, + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/automationRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/automationRules", + "properties": { + "displayName": "Suspicious user sign-in events", + "order": 1, + "triggeringLogic": { + "isEnabled": true, + "triggersOn": "Incidents", + "triggersWhen": "Created", + "conditions": [ + { + "conditionType": "PropertyArray", + "conditionProperties": { + "arrayType": "IncidentLabels", + "arrayConditionType": "AnyItem", + "itemConditions": [ + { + "conditionType": "Property", + "conditionProperties": { + "propertyName": "IncidentLabel", + "operator": "Equals", + "propertyValues": [ + "myLabel" + ] + } + } + ] + } + } + ] + }, + "actions": [ + { + "order": 1, + "actionType": "AddIncidentTask", + "actionConfiguration": { + "title": "Reset user passwords", + "description": "Reset passwords for compromised users." + } + } + ], + "lastModifiedTimeUtc": "2019-01-01T13:00:30Z", + "createdTimeUtc": "2019-01-01T13:00:00Z", + "lastModifiedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + }, + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/automationRules/AutomationRules_Delete.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/automationRules/AutomationRules_Delete.json new file mode 100644 index 000000000000..2c5282f23d6a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/automationRules/AutomationRules_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "automationRuleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": {} + }, + "204": { + "body": {} + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/automationRules/AutomationRules_Get.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/automationRules/AutomationRules_Get.json new file mode 100644 index 000000000000..6a23f051d2e3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/automationRules/AutomationRules_Get.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "automationRuleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/automationRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/automationRules", + "properties": { + "displayName": "Suspicious user sign-in events", + "order": 1, + "triggeringLogic": { + "isEnabled": true, + "triggersOn": "Incidents", + "triggersWhen": "Created", + "conditions": [ + { + "conditionType": "PropertyArray", + "conditionProperties": { + "arrayType": "IncidentLabels", + "arrayConditionType": "AnyItem", + "itemConditions": [ + { + "conditionType": "Property", + "conditionProperties": { + "propertyName": "IncidentLabel", + "operator": "Equals", + "propertyValues": [ + "myLabel" + ] + } + } + ] + } + } + ] + }, + "actions": [ + { + "order": 1, + "actionType": "AddIncidentTask", + "actionConfiguration": { + "title": "Reset user passwords", + "description": "Reset passwords for compromised users." + } + } + ], + "lastModifiedTimeUtc": "2019-01-01T13:00:30Z", + "createdTimeUtc": "2019-01-01T13:00:00Z", + "lastModifiedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + }, + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/automationRules/AutomationRules_List.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/automationRules/AutomationRules_List.json new file mode 100644 index 000000000000..a8f7ed417ae7 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/automationRules/AutomationRules_List.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/automationRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/automationRules", + "properties": { + "displayName": "Suspicious user sign-in events", + "order": 1, + "triggeringLogic": { + "isEnabled": true, + "triggersOn": "Incidents", + "triggersWhen": "Created", + "conditions": [ + { + "conditionType": "PropertyArray", + "conditionProperties": { + "arrayType": "IncidentLabels", + "arrayConditionType": "AnyItem", + "itemConditions": [ + { + "conditionType": "Property", + "conditionProperties": { + "propertyName": "IncidentLabel", + "operator": "Equals", + "propertyValues": [ + "myLabel" + ] + } + } + ] + } + } + ] + }, + "actions": [ + { + "order": 1, + "actionType": "AddIncidentTask", + "actionConfiguration": { + "title": "Reset user passwords", + "description": "Reset passwords for compromised users." + } + } + ], + "lastModifiedTimeUtc": "2019-01-01T13:00:30Z", + "createdTimeUtc": "2019-01-01T13:00:00Z", + "lastModifiedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + }, + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/billingStatistics/GetAllBillingStatistics.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/billingStatistics/GetAllBillingStatistics.json new file mode 100644 index 000000000000..32aee49de124 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/billingStatistics/GetAllBillingStatistics.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/billingStatistics/sapUsage", + "etag": "\"3f6451dd-1b58-4bef-bce7-72eba6b354d7\"", + "name": "sapSolutionUsage", + "type": "Microsoft.SecurityInsights/billingStatistics", + "kind": "SapSolutionUsage", + "properties": { + "activeSystemIdCount": 5 + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/billingStatistics/GetBillingStatistic.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/billingStatistics/GetBillingStatistic.json new file mode 100644 index 000000000000..632ef1dfd2a8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/billingStatistics/GetBillingStatistic.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "billingStatisticName": "sapSolutionUsage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/billingStatistics/sapUsage", + "etag": "\"3f6451dd-1b58-4bef-bce7-72eba6b354d7\"", + "name": "sapSolutionUsage", + "type": "Microsoft.SecurityInsights/billingStatistics", + "kind": "SapSolutionUsage", + "properties": { + "activeSystemIdCount": 5 + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/CreateBookmark.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/CreateBookmark.json new file mode 100644 index 000000000000..9eac4cb29f63 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/CreateBookmark.json @@ -0,0 +1,143 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "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": "2021-09-01T13:15:30Z", + "created": "2021-09-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", + "tactics": [ + "Execution" + ], + "techniques": [ + "T1609" + ], + "entityMappings": [ + { + "entityType": "Account", + "fieldMappings": [ + { + "identifier": "Fullname", + "value": "johndoe@microsoft.com" + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/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": "2021-09-01T13:15:30Z", + "created": "2021-09-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", + "tactics": [ + "Execution" + ], + "techniques": [ + "T1609" + ], + "entityMappings": [ + { + "entityType": "Account", + "fieldMappings": [ + { + "identifier": "Fullname", + "value": "johndoe@microsoft.com" + } + ] + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/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": "2021-09-01T13:15:30Z", + "created": "2021-09-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", + "tactics": [ + "Execution" + ], + "techniques": [ + "T1609" + ], + "entityMappings": [ + { + "entityType": "Account", + "fieldMappings": [ + { + "identifier": "Fullname", + "value": "johndoe@microsoft.com" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/DeleteBookmark.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/DeleteBookmark.json new file mode 100644 index 000000000000..6ce9070461bd --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/DeleteBookmark.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "bookmarkId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/GetBookmarkById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/GetBookmarkById.json new file mode 100644 index 000000000000..5d857b5ef664 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/GetBookmarkById.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "bookmarkId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/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": "2021-09-01T13:15:30Z", + "created": "2021-09-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" + }, + "tactics": [ + "Execution" + ], + "techniques": [ + "T1609" + ], + "entityMappings": [ + { + "entityType": "Account", + "fieldMappings": [ + { + "identifier": "Fullname", + "value": "johndoe@microsoft.com" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/GetBookmarks.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/GetBookmarks.json new file mode 100644 index 000000000000..8da6ffff535f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/GetBookmarks.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/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": "2021-09-01T13:15:30Z", + "created": "2021-09-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" + }, + "tactics": [ + "Execution" + ], + "techniques": [ + "T1609" + ], + "entityMappings": [ + { + "entityType": "Account", + "fieldMappings": [ + { + "identifier": "Fullname", + "value": "johndoe@microsoft.com" + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/expand/PostExpandBookmark.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/expand/PostExpandBookmark.json new file mode 100644 index 000000000000..edf4fec6f74a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/expand/PostExpandBookmark.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "bookmarkId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "parameters": { + "expansionId": "27f76e63-c41b-480f-bb18-12ad2e011d49", + "startTime": "2019-12-25T17:21:00.000Z", + "endTime": "2020-01-24T17:21:00.000Z" + } + }, + "responses": { + "200": { + "body": { + "value": { + "entities": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/fe4ddab5-8cea-eca3-c8b8-9e92e830a387", + "name": "fe4ddab5-8cea-eca3-c8b8-9e92e830a387", + "type": "Microsoft.SecurityInsights/entities", + "kind": "Account", + "properties": { + "friendlyName": "administrator", + "accountName": "administrator", + "ntDomain": "domain" + } + } + ] + }, + "metaData": { + "aggregations": [ + { + "entityKind": "Account", + "count": 1 + } + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/relations/CreateBookmarkRelation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/relations/CreateBookmarkRelation.json new file mode 100644 index 000000000000..b7892df3adc6 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/relations/CreateBookmarkRelation.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "bookmarkId": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "relation": { + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/bookmarks/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812", + "relatedResourceName": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "relatedResourceType": "Microsoft.SecurityInsights/incidents" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/bookmarks/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812", + "relatedResourceName": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "relatedResourceType": "Microsoft.SecurityInsights/incidents" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/relations/DeleteBookmarkRelation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/relations/DeleteBookmarkRelation.json new file mode 100644 index 000000000000..7a802006d8de --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/relations/DeleteBookmarkRelation.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "bookmarkId": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/relations/GetAllBookmarkRelations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/relations/GetAllBookmarkRelations.json new file mode 100644 index 000000000000..7df53d030f99 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/relations/GetAllBookmarkRelations.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "bookmarkId": "2216d0e1-91e3-4902-89fd-d2df8c535096" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/bookmarks/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812", + "relatedResourceName": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "relatedResourceType": "Microsoft.SecurityInsights/incidents" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/relations/GetBookmarkRelationByName.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/relations/GetBookmarkRelationByName.json new file mode 100644 index 000000000000..0d97d247ec0a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/bookmarks/relations/GetBookmarkRelationByName.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "bookmarkId": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/bookmarks/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812", + "relatedResourceName": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "relatedResourceType": "Microsoft.SecurityInsights/incidents" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/BusinessApplicationAgent_Get.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/BusinessApplicationAgent_Get.json new file mode 100644 index 000000000000..d1a817717f48 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/BusinessApplicationAgent_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "agentResourceName": "3d69632b-0b60-4af3-8720-77f01a25d34a" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/businessApplicationAgents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/businessApplicationAgents", + "properties": { + "configuration": { + "agentContainerName": "MyAgentContainer", + "sdkPath": "/path/to/nwrfc750P_8-70002755.zip", + "sncPath": "/path/to/snc", + "keyVaultResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.KeyVault/vaults/myVault", + "keyVaultAuthenticationMode": "ManagedIdentity", + "secretSource": "AzureKeyVault", + "type": "SAP" + }, + "agentSystems": [ + { + "systemResourceName": "3b6bed7b-3f1c-47fc-ab8e-2c57047ed446", + "systemDisplayName": "MySystem" + } + ], + "displayName": "MyAgent", + "lastModifiedTimeUtc": "2024-03-01T13:00:30Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/BusinessApplicationAgents_CreateOrUpdate.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/BusinessApplicationAgents_CreateOrUpdate.json new file mode 100644 index 000000000000..4e70267a84b2 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/BusinessApplicationAgents_CreateOrUpdate.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "agentResourceName": "3d69632b-0b60-4af3-8720-77f01a25d34a", + "businessApplicationAgentToUpsert": { + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "configuration": { + "agentContainerName": "MyAgentContainer", + "sdkPath": "/path/to/nwrfc750P_8-70002755.zip", + "sncPath": "/path/to/snc", + "keyVaultResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.KeyVault/vaults/myVault", + "keyVaultAuthenticationMode": "ManagedIdentity", + "secretSource": "AzureKeyVault", + "type": "SAP" + }, + "displayName": "MyAgent" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/businessApplicationAgents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/businessApplicationAgents", + "properties": { + "configuration": { + "agentContainerName": "MyAgentContainer", + "sdkPath": "/path/to/nwrfc750P_8-70002755.zip", + "sncPath": "/path/to/snc", + "keyVaultResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.KeyVault/vaults/myVault", + "keyVaultAuthenticationMode": "ManagedIdentity", + "secretSource": "AzureKeyVault", + "type": "SAP" + }, + "displayName": "MyAgent", + "lastModifiedTimeUtc": "2024-03-01T13:00:30Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/businessApplicationAgents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/businessApplicationAgents", + "properties": { + "configuration": { + "agentContainerName": "MyAgentContainer", + "sdkPath": "/path/to/nwrfc750P_8-70002755.zip", + "sncPath": "/path/to/snc", + "keyVaultResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.KeyVault/vaults/myVault", + "keyVaultAuthenticationMode": "ManagedIdentity", + "secretSource": "AzureKeyVault", + "type": "SAP" + }, + "displayName": "MyAgent", + "lastModifiedTimeUtc": "2024-03-01T13:00:30Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/BusinessApplicationAgents_Delete.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/BusinessApplicationAgents_Delete.json new file mode 100644 index 000000000000..39ac16a78274 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/BusinessApplicationAgents_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "agentResourceName": "3d69632b-0b60-4af3-8720-77f01a25d34a" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/BusinessApplicationAgents_List.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/BusinessApplicationAgents_List.json new file mode 100644 index 000000000000..25d0fd0047ee --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/BusinessApplicationAgents_List.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "agentResourceName": "3d69632b-0b60-4af3-8720-77f01a25d34a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/businessApplicationAgents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/businessApplicationAgents", + "properties": { + "configuration": { + "agentContainerName": "MyAgentContainer", + "sdkPath": "/path/to/nwrfc750P_8-70002755.zip", + "sncPath": "/path/to/snc", + "keyVaultResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.KeyVault/vaults/myVault", + "keyVaultAuthenticationMode": "ManagedIdentity", + "secretSource": "AzureKeyVault", + "type": "SAP" + }, + "agentSystems": [ + { + "systemResourceName": "3b6bed7b-3f1c-47fc-ab8e-2c57047ed446", + "systemDisplayName": "MySystem" + } + ], + "displayName": "MyAgent", + "lastModifiedTimeUtc": "2024-03-01T13:00:30Z" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/actions/ListActions.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/actions/ListActions.json new file mode 100644 index 000000000000..ba66c6c8b0fe --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/actions/ListActions.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "agentResourceName": "247b377a-7137-4b3c-bf15-df1d3260ef1b", + "systemResourceName": "3d69632b-0b60-4af3-8720-77f01a25d34a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kind": "UnlockUser", + "actionId": "e85000a3-de69-41a4-b347-c6b823e6ec79", + "status": "Pending", + "user": "someuser@someorg.com", + "lastModifiedTimeUtc": "2023-07-01T00:00:00Z" + }, + { + "kind": "LockUser", + "actionId": "56b70fa0-9afd-4916-9ab9-e79de3e24add", + "status": "Pending", + "user": "someuser1@someorg.com", + "lastModifiedTimeUtc": "2024-02-01T00:00:00Z" + }, + { + "kind": "LockUser", + "actionId": "56b70fa0-9afd-4916-9ab9-e79de3e24add", + "status": "Failed", + "user": "someuser1@someorg.com", + "lastModifiedTimeUtc": "2024-02-01T00:00:00Z", + "failureReason": "Some reason for failure" + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/actions/ReportActionStatus.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/actions/ReportActionStatus.json new file mode 100644 index 000000000000..c10a19b93b43 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/actions/ReportActionStatus.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "agentResourceName": "247b377a-7137-4b3c-bf15-df1d3260ef1b", + "systemResourceName": "3d69632b-0b60-4af3-8720-77f01a25d34a", + "ReportActionStatusPayload": { + "actionId": "81f5d153-4c26-4c64-829a-06df62d1ddc5", + "actionStatus": "Completed", + "failureReason": "Failed to execute the action" + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/actions/UndoAction.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/actions/UndoAction.json new file mode 100644 index 000000000000..828553da25e5 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/actions/UndoAction.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "agentResourceName": "247b377a-7137-4b3c-bf15-df1d3260ef1b", + "systemResourceName": "3d69632b-0b60-4af3-8720-77f01a25d34a", + "UndoActionPayload": { + "actionId": "e85000a3-de69-41a4-b347-c6b823e6ec79" + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/systems/Systems_CreateOrUpdate.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/systems/Systems_CreateOrUpdate.json new file mode 100644 index 000000000000..d0982232d896 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/systems/Systems_CreateOrUpdate.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "systemResourceName": "3d69632b-0b60-4af3-8720-77f01a25d34a", + "agentResourceName": "3123432b-0b60-4af3-8720-77f01a25d34a", + "systemToUpsert": { + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "status": "Running", + "configuration": { + "azureResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace", + "connector": { + "abapServerHost": "1.1.1.1", + "systemNumber": "001", + "systemId": "A4H", + "client": "001", + "authenticationType": "UsernamePassword", + "type": "Rfc" + }, + "logs": [ + { + "type": "AbapAuditLog", + "ingestionType": "Incremental", + "status": "Enabled", + "scheduleInterval": 60, + "bulkSize": 100, + "filters": [ + "filter1", + "filter2" + ] + }, + { + "type": "USR01", + "ingestionType": "Incremental", + "status": "Enabled", + "scheduleInterval": 60, + "bulkSize": 100, + "filters": [ + "filter1", + "filter2" + ] + } + ], + "type": "SAP" + }, + "displayName": "A4H_System" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/businessApplicationAgents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/systems/3b6bed7b-3f1c-47fc-ab8e-2c57047ed446", + "name": "3b6bed7b-3f1c-47fc-ab8e-2c57047ed446", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/businessApplicationAgents/systems", + "properties": { + "status": "Running", + "configuration": { + "azureResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace", + "connector": { + "abapServerHost": "1.1.1.1", + "systemNumber": "001", + "systemId": "A4H", + "client": "001", + "authenticationType": "UsernamePassword", + "type": "Rfc" + }, + "logs": [ + { + "type": "AbapAuditLog", + "ingestionType": "Incremental", + "status": "Enabled", + "scheduleInterval": 60, + "bulkSize": 100, + "filters": [ + "filter1", + "filter2" + ] + }, + { + "type": "USR01", + "ingestionType": "Incremental", + "status": "Enabled", + "scheduleInterval": 60, + "bulkSize": 100, + "filters": [ + "filter1", + "filter2" + ] + } + ], + "type": "SAP" + }, + "displayName": "A4H_System", + "lastModifiedTimeUtc": "2024-03-01T13:00:30Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/businessApplicationAgents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/systems/3b6bed7b-3f1c-47fc-ab8e-2c57047ed446", + "name": "3b6bed7b-3f1c-47fc-ab8e-2c57047ed446", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/businessApplicationAgents/systems", + "properties": { + "status": "Running", + "configuration": { + "azureResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace", + "connector": { + "abapServerHost": "1.1.1.1", + "systemNumber": "001", + "systemId": "A4H", + "client": "001", + "authenticationType": "UsernamePassword", + "type": "Rfc" + }, + "logs": [ + { + "type": "AbapAuditLog", + "ingestionType": "Incremental", + "status": "Enabled", + "scheduleInterval": 60, + "bulkSize": 100, + "filters": [ + "filter1", + "filter2" + ] + }, + { + "type": "USR01", + "ingestionType": "Incremental", + "status": "Enabled", + "scheduleInterval": 60, + "bulkSize": 100, + "filters": [ + "filter1", + "filter2" + ] + } + ], + "type": "SAP" + }, + "displayName": "A4H_System", + "lastModifiedTimeUtc": "2024-03-01T13:00:30Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/systems/Systems_Delete.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/systems/Systems_Delete.json new file mode 100644 index 000000000000..372f6468bc97 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/systems/Systems_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "systemResourceName": "3d69632b-0b60-4af3-8720-77f01a25d34a", + "agentResourceName": "3123432b-0b60-4af3-8720-77f01a25d34a" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/systems/Systems_Get.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/systems/Systems_Get.json new file mode 100644 index 000000000000..14da9430fa14 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/systems/Systems_Get.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "systemResourceName": "3d69632b-0b60-4af3-8720-77f01a25d34a", + "agentResourceName": "3123432b-0b60-4af3-8720-77f01a25d34a" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/businessApplicationAgents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/systems/3b6bed7b-3f1c-47fc-ab8e-2c57047ed446", + "name": "3b6bed7b-3f1c-47fc-ab8e-2c57047ed446", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/businessApplicationAgents/systems", + "properties": { + "status": "Running", + "configuration": { + "azureResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace", + "connector": { + "abapServerHost": "1.1.1.1", + "systemNumber": "001", + "systemId": "A4H", + "client": "001", + "authenticationType": "UsernamePassword", + "type": "Rfc" + }, + "logs": [ + { + "type": "AbapAuditLog", + "ingestionType": "Incremental", + "status": "Enabled", + "scheduleInterval": 60, + "bulkSize": 100, + "filters": [ + "filter1", + "filter2" + ] + }, + { + "type": "USR01", + "ingestionType": "Incremental", + "status": "Enabled", + "scheduleInterval": 60, + "bulkSize": 100, + "filters": [ + "filter1", + "filter2" + ] + } + ], + "type": "SAP" + }, + "displayName": "A4H_System", + "lastModifiedTimeUtc": "2024-03-01T13:00:30Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/systems/Systems_List.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/systems/Systems_List.json new file mode 100644 index 000000000000..42fdb99e561a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/businessApplicationAgents/systems/Systems_List.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "agentResourceName": "3123432b-0b60-4af3-8720-77f01a25d34a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/businessApplicationAgents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/systems/3b6bed7b-3f1c-47fc-ab8e-2c57047ed446", + "name": "3b6bed7b-3f1c-47fc-ab8e-2c57047ed446", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/businessApplicationAgents/systems", + "properties": { + "status": "Running", + "configuration": { + "azureResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace", + "connector": { + "abapServerHost": "1.1.1.1", + "systemNumber": "001", + "systemId": "A4H", + "client": "001", + "authenticationType": "UsernamePassword", + "type": "Rfc" + }, + "logs": [ + { + "type": "AbapAuditLog", + "ingestionType": "Incremental", + "status": "Enabled", + "scheduleInterval": 60, + "bulkSize": 100, + "filters": [ + "filter1", + "filter2" + ] + }, + { + "type": "USR01", + "ingestionType": "Incremental", + "status": "Enabled", + "scheduleInterval": 60, + "bulkSize": 100, + "filters": [ + "filter1", + "filter2" + ] + } + ], + "type": "SAP" + }, + "displayName": "A4H_System", + "lastModifiedTimeUtc": "2024-03-01T13:00:30Z" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentPackages/GetPackageById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentPackages/GetPackageById.json new file mode 100644 index 000000000000..5692c0392310 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentPackages/GetPackageById.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfeab2-9ae0-4464-9919-dccaee2e48f0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "packageId": "str.azure-sentinel-solution-str" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentPackages/str.azure-sentinel-solution-str", + "name": "str.azure-sentinel-solution-str", + "type": "Microsoft.SecurityInsights/contentpackages", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contentId": "str.azure-sentinel-solution-str", + "contentProductId": "str.azure-sentinel-solution-str-sl-igl6jawr4gwmu", + "contentKind": "Solution", + "version": "2.0.0", + "displayName": "str" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentPackages/GetPackages.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentPackages/GetPackages.json new file mode 100644 index 000000000000..e82ad12624a7 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentPackages/GetPackages.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfeab2-9ae0-4464-9919-dccaee2e48f0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "packageId": "str.azure-sentinel-solution-str" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentPackages/str.azure-sentinel-solution-str", + "name": "str.azure-sentinel-solution-str", + "type": "Microsoft.SecurityInsights/contentpackages", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contentId": "str.azure-sentinel-solution-str", + "contentProductId": "str.azure-sentinel-solution-str-sl-igl6jawr4gwmu", + "contentKind": "Solution", + "contentSchemaVersion": "3.0.0", + "version": "2.0.0", + "displayName": "str" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentPackages/GetProductPackageById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentPackages/GetProductPackageById.json new file mode 100644 index 000000000000..63dd217a2a53 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentPackages/GetProductPackageById.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfeab2-9ae0-4464-9919-dccaee2e48f0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "packageId": "str.azure-sentinel-solution-str" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentProductPackages/str.azure-sentinel-solution-str", + "name": "str.azure-sentinel-solution-str", + "type": "Microsoft.SecurityInsights/contentproductpackages", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contentId": "str.azure-sentinel-solution-str", + "contentProductId": "str.azure-sentinel-solution-str-sl-igl6jawr4gwmu", + "contentKind": "Solution", + "installedVersion": "2.0.0", + "version": "2.0.0", + "displayName": "str", + "source": { + "kind": "Solution", + "name": "str", + "sourceId": "str.azure-sentinel-solution-str" + }, + "author": { + "name": "Microsoft", + "email": "support@microsoft.com" + }, + "support": { + "tier": "Microsoft", + "name": "Microsoft Corporation", + "email": "support@microsoft.com", + "link": "https://support.microsoft.com/" + }, + "dependencies": { + "criteria": [ + { + "contentId": "strDataConnector", + "kind": "DataConnector", + "version": "2.0.0" + }, + { + "contentId": "str-Parser", + "kind": "Parser", + "version": "2.0.0" + } + ], + "operator": "AND" + }, + "providers": [ + "Microsoft" + ], + "categories": { + "domains": [ + "Security - Cloud Security" + ], + "verticals": null + }, + "firstPublishDate": "2022-04-01", + "packageContent": "JSON string of the package" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentPackages/GetProductPackages.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentPackages/GetProductPackages.json new file mode 100644 index 000000000000..0de51265923b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentPackages/GetProductPackages.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfeab2-9ae0-4464-9919-dccaee2e48f0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentProductPackages/str.azure-sentinel-solution-str", + "name": "str.azure-sentinel-solution-str", + "type": "Microsoft.SecurityInsights/contentproductpackages", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contentId": "str.azure-sentinel-solution-str", + "contentProductId": "str.azure-sentinel-solution-str-sl-igl6jawr4gwmu", + "contentKind": "Solution", + "installedVersion": "2.0.0", + "version": "2.0.0", + "displayName": "str", + "source": { + "kind": "Solution", + "name": "str", + "sourceId": "str.azure-sentinel-solution-str" + }, + "author": { + "name": "Microsoft", + "email": "support@microsoft.com" + }, + "support": { + "tier": "Microsoft", + "name": "Microsoft Corporation", + "email": "support@microsoft.com", + "link": "https://support.microsoft.com/" + }, + "dependencies": { + "criteria": [ + { + "contentId": "strDataConnector", + "kind": "DataConnector", + "version": "2.0.0" + }, + { + "contentId": "str-Parser", + "kind": "Parser", + "version": "2.0.0" + } + ], + "operator": "AND" + }, + "providers": [ + "Microsoft" + ], + "categories": { + "domains": [ + "Security - Cloud Security" + ], + "verticals": null + }, + "firstPublishDate": "2022-04-01" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentPackages/InstallPackage.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentPackages/InstallPackage.json new file mode 100644 index 000000000000..f961db38ab5d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentPackages/InstallPackage.json @@ -0,0 +1,151 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfeab2-9ae0-4464-9919-dccaee2e48f0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "packageId": "str.azure-sentinel-solution-str", + "packageInstallationProperties": { + "properties": { + "contentId": "str.azure-sentinel-solution-str", + "contentProductId": "str.azure-sentinel-solution-str-sl-igl6jawr4gwmu", + "contentKind": "Solution", + "version": "2.0.0", + "displayName": "str" + }, + "tags": { + "tag1": "str" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentPackages/str.azure-sentinel-solution-str", + "name": "str.azure-sentinel-solution-str", + "type": "Microsoft.SecurityInsights/contentpackages", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contentId": "str.azure-sentinel-solution-str", + "contentKind": "Solution", + "contentProductId": "str.azure-sentinel-solution-str-sl-igl6jawr4gwmu", + "installedVersion": "2.0.0", + "version": "2.0.0", + "displayName": "str", + "source": { + "kind": "Solution", + "name": "str", + "sourceId": "str.azure-sentinel-solution-str" + }, + "author": { + "name": "Microsoft", + "email": "support@microsoft.com" + }, + "support": { + "tier": "Microsoft", + "name": "Microsoft Corporation", + "email": "support@microsoft.com", + "link": "https://support.microsoft.com/" + }, + "dependencies": { + "criteria": [ + { + "contentId": "strDataConnector", + "kind": "DataConnector", + "version": "2.0.0" + }, + { + "contentId": "str-Parser", + "kind": "Parser", + "version": "2.0.0" + } + ], + "operator": "AND" + }, + "providers": [ + "Microsoft" + ], + "categories": { + "domains": [ + "Security - Cloud Security" + ], + "verticals": null + }, + "firstPublishDate": "2022-04-01" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentPackages/str.azure-sentinel-solution-str", + "name": "str.azure-sentinel-solution-str", + "type": "Microsoft.SecurityInsights/contentpackages", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contentId": "str.azure-sentinel-solution-str", + "contentProductId": "str.azure-sentinel-solution-str-sl-igl6jawr4gwmu", + "contentKind": "Solution", + "installedVersion": "2.0.0", + "version": "2.0.0", + "displayName": "str", + "source": { + "kind": "Solution", + "name": "str", + "sourceId": "str.azure-sentinel-solution-str" + }, + "author": { + "name": "Microsoft", + "email": "support@microsoft.com" + }, + "support": { + "tier": "Microsoft", + "name": "Microsoft Corporation", + "email": "support@microsoft.com", + "link": "https://support.microsoft.com/" + }, + "dependencies": { + "criteria": [ + { + "contentId": "strDataConnector", + "kind": "DataConnector", + "version": "2.0.0" + }, + { + "contentId": "str-Parser", + "kind": "Parser", + "version": "2.0.0" + } + ], + "operator": "AND" + }, + "providers": [ + "Microsoft" + ], + "categories": { + "domains": [ + "Security - Cloud Security" + ], + "verticals": null + }, + "firstPublishDate": "2022-04-01" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentPackages/UninstallPackage.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentPackages/UninstallPackage.json new file mode 100644 index 000000000000..6c62ffc0742c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentPackages/UninstallPackage.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfeab2-9ae0-4464-9919-dccaee2e48f0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "packageId": "str.azure-sentinel-solution-str" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentTemplates/DeleteTemplate.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentTemplates/DeleteTemplate.json new file mode 100644 index 000000000000..7fa85a536c85 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentTemplates/DeleteTemplate.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfeab2-9ae0-4464-9919-dccaee2e48f0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "templateId": "8365ebfe-a381-45b7-ad08-7d818070e11f" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentTemplates/GetProductTemplateById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentTemplates/GetProductTemplateById.json new file mode 100644 index 000000000000..097ab1afea70 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentTemplates/GetProductTemplateById.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfeab2-9ae0-4464-9919-dccaee2e48f0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "templateId": "8365ebfe-a381-45b7-ad08-7d818070e11f" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentProductTemplates/8365ebfe-a381-45b7-ad08-7d818070e11f", + "name": "8365ebfe-a381-45b7-ad08-7d818070e11f", + "type": "Microsoft.SecurityInsights/contentproducttemplates", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contentId": "contentId", + "version": "1.0.0", + "packageVersion": "1.0.0", + "displayName": "My installed template", + "contentKind": "Workbooks", + "contentProductId": "packageId-wb-rimnsoeh4nt32", + "packageId": "packageId", + "packageKind": "Standalone", + "packageName": "package name", + "source": { + "kind": "Standalone", + "name": "Source name" + }, + "mainTemplate": {} + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentTemplates/GetProductTemplates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentTemplates/GetProductTemplates.json new file mode 100644 index 000000000000..5ddf19b41b08 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentTemplates/GetProductTemplates.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfeab2-9ae0-4464-9919-dccaee2e48f0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentProductTemplates/8365ebfe-a381-45b7-ad08-7d818070e11f", + "name": "8365ebfe-a381-45b7-ad08-7d818070e11f", + "type": "Microsoft.SecurityInsights/contentproducttemplates", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contentId": "contentId", + "contentProductId": "packageId-wb-rimnsoeh4nt32", + "version": "1.0.0", + "packageVersion": "1.0.0", + "displayName": "My installed template", + "contentKind": "Workbooks", + "packageId": "packageId", + "packageKind": "Standalone", + "packageName": "package name", + "source": { + "kind": "Standalone", + "name": "Source name" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentTemplates/GetTemplateById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentTemplates/GetTemplateById.json new file mode 100644 index 000000000000..677ec16953dd --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentTemplates/GetTemplateById.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfeab2-9ae0-4464-9919-dccaee2e48f0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "templateId": "8365ebfe-a381-45b7-ad08-7d818070e11f" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentTemplates/8365ebfe-a381-45b7-ad08-7d818070e11f", + "name": "8365ebfe-a381-45b7-ad08-7d818070e11f", + "type": "Microsoft.SecurityInsights/contenttemplates", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contentId": "contentId", + "contentProductId": "packageId-wb-rimnsoeh4nt32", + "version": "1.0.0", + "packageVersion": "1.0.0", + "displayName": "My installed template", + "contentKind": "Workbooks", + "packageId": "packageId", + "source": { + "kind": "Standalone", + "name": "Source name" + }, + "mainTemplate": {} + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentTemplates/GetTemplates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentTemplates/GetTemplates.json new file mode 100644 index 000000000000..071cbf9045f8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentTemplates/GetTemplates.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfeab2-9ae0-4464-9919-dccaee2e48f0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentTemplates/8365ebfe-a381-45b7-ad08-7d818070e11f", + "name": "8365ebfe-a381-45b7-ad08-7d818070e11f", + "type": "Microsoft.SecurityInsights/contenttemplates", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contentId": "contentId", + "contentProductId": "packageId-wb-rimnsoeh4nt32", + "packageVersion": "1.0.0", + "version": "1.0.0", + "displayName": "My installed template", + "contentKind": "Workbooks", + "packageId": "packageId", + "source": { + "kind": "Standalone", + "name": "Source name" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentTemplates/InstallTemplate.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentTemplates/InstallTemplate.json new file mode 100644 index 000000000000..532b6e3cc936 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/contentTemplates/InstallTemplate.json @@ -0,0 +1,228 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfeab2-9ae0-4464-9919-dccaee2e48f0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "templateId": "str.azure-sentinel-solution-str", + "templateInstallationProperties": { + "properties": { + "contentId": "8365ebfe-a381-45b7-ad08-7d818070e11f", + "contentProductId": "str.azure-sentinel-solution-str-ar-cbfe4fndz66bi", + "displayName": "API Protection workbook template", + "contentKind": "AnalyticsRule", + "version": "1.0.1", + "packageVersion": "1.0.0", + "packageId": "str.azure-sentinel-solution-str", + "packageName": "str", + "packageKind": "Solution", + "source": { + "kind": "Solution", + "name": "str", + "sourceId": "str.azure-sentinel-solution-str" + }, + "author": { + "name": "Microsoft", + "email": "support@microsoft.com" + }, + "support": { + "tier": "Microsoft", + "name": "Microsoft Corporation", + "email": "support@microsoft.com", + "link": "https://support.microsoft.com/" + }, + "mainTemplate": { + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#", + "contentVersion": "1.0.1", + "resources": [ + { + "type": "Microsoft.SecurityInsights/AlertRuleTemplates", + "name": "8365ebfe-a381-45b7-ad08-7d818070e11f", + "apiVersion": "2022-04-01-preview", + "kind": "Scheduled", + "location": "[parameters('workspace-location')]", + "properties": { + "description": "Creates an incident when a large number of Critical/High severity CrowdStrike Falcon sensor detections is triggered by a single user", + "displayName": "Critical or High Severity Detections by User", + "enabled": false, + "query": "...", + "queryFrequency": "PT1H", + "queryPeriod": "PT1H", + "severity": "High", + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "status": "Available" + } + }, + { + "type": "Microsoft.OperationalInsights/workspaces/providers/metadata", + "apiVersion": "2022-01-01-preview", + "name": "[concat(parameters('workspace'),'/Microsoft.SecurityInsights/',concat('AnalyticsRule-', last(split([resourceId('Microsoft.SecurityInsights/AlertRuleTemplates', 8365ebfe-a381-45b7-ad08-7d818070e11f)],'/'))))]", + "properties": { + "description": "CrowdStrike Falcon Endpoint Protection Analytics Rule 1", + "parentId": "[resourceId('Microsoft.SecurityInsights/AlertRuleTemplates', 8365ebfe-a381-45b7-ad08-7d818070e11f)]", + "contentId": "4465ebde-b381-45f7-ad08-7d818070a11c", + "kind": "AnalyticsRule", + "version": "1.0.0", + "source": { + "kind": "Solution", + "name": "str", + "sourceId": "str.azure-sentinel-solution-str" + }, + "author": { + "name": "Microsoft", + "email": "support@microsoft.com" + }, + "support": { + "tier": "Microsoft", + "name": "Microsoft Corporation", + "email": "support@microsoft.com", + "link": "https://support.microsoft.com/" + } + } + } + ] + } + }, + "tags": { + "tag1": "str" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentPackages/azuresentinel.azure-sentinel-solution-ciscoumbrella", + "name": "azuresentinel.azure-sentinel-solution-ciscoumbrella", + "type": "Microsoft.SecurityInsights/contenttemplates", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contentId": "8365ebfe-a381-45b7-ad08-7d818070e11f", + "contentProductId": "str.azure-sentinel-solution-str-ar-cbfe4fndz66bi", + "packageKind": "Solution", + "packageId": "str.azure-sentinel-solution-str", + "packageVersion": "1.0.0", + "contentKind": "AnalyticsRule", + "version": "1.0.1", + "displayName": "API Protection workbook template", + "source": { + "kind": "Solution", + "name": "CiscoUmbrella", + "sourceId": "azuresentinel.azure-sentinel-solution-ciscoumbrella" + }, + "author": { + "name": "Microsoft", + "email": "support@microsoft.com" + }, + "support": { + "tier": "Microsoft", + "name": "Microsoft Corporation", + "email": "support@microsoft.com", + "link": "https://support.microsoft.com/" + }, + "dependencies": { + "criteria": [ + { + "contentId": "strDataConnector", + "kind": "DataConnector", + "version": "2.0.0" + }, + { + "contentId": "str-Parser", + "kind": "Parser", + "version": "2.0.0" + } + ], + "operator": "AND" + }, + "providers": [ + "Microsoft" + ], + "categories": { + "domains": [ + "Security - Cloud Security" + ], + "verticals": null + }, + "firstPublishDate": "2022-04-01" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentPackages/azuresentinel.azure-sentinel-solution-ciscoumbrella", + "name": "azuresentinel.azure-sentinel-solution-ciscoumbrella", + "type": "Microsoft.SecurityInsights/contenttemplates", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contentId": "8365ebfe-a381-45b7-ad08-7d818070e11f", + "contentProductId": "str.azure-sentinel-solution-str-ar-cbfe4fndz66bi", + "packageKind": "Solution", + "packageId": "str.azure-sentinel-solution-str", + "packageVersion": "1.0.0", + "contentKind": "AnalyticsRule", + "version": "1.0.1", + "displayName": "API Protection workbook template", + "source": { + "kind": "Solution", + "name": "CiscoUmbrella", + "sourceId": "azuresentinel.azure-sentinel-solution-ciscoumbrella" + }, + "author": { + "name": "Microsoft", + "email": "support@microsoft.com" + }, + "support": { + "tier": "Microsoft", + "name": "Microsoft Corporation", + "email": "support@microsoft.com", + "link": "https://support.microsoft.com/" + }, + "dependencies": { + "criteria": [ + { + "contentId": "strDataConnector", + "kind": "DataConnector", + "version": "2.0.0" + }, + { + "contentId": "str-Parser", + "kind": "Parser", + "version": "2.0.0" + } + ], + "operator": "AND" + }, + "providers": [ + "Microsoft" + ], + "categories": { + "domains": [ + "Security - Cloud Security" + ], + "verticals": null + }, + "firstPublishDate": "2022-04-01" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectorDefinitions/CreateCustomizableDataConnectorDefinition.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectorDefinitions/CreateCustomizableDataConnectorDefinition.json new file mode 100644 index 000000000000..176964161c98 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectorDefinitions/CreateCustomizableDataConnectorDefinition.json @@ -0,0 +1,258 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorDefinitionName": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "connectorDefinitionInput": { + "kind": "Customizable", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "connectorUiConfig": { + "title": "GitHub Enterprise Audit Log", + "publisher": "GitHub", + "descriptionMarkdown": "The GitHub audit log connector provides the capability to ingest GitHub logs into Azure Sentinel. By connecting GitHub audit logs into Azure Sentinel, you can view this data in workbooks, use it to create custom alerts, and improve your investigation process.", + "graphQueries": [ + { + "metricName": "Total events received", + "legend": "GitHub audit log events", + "baseQuery": "GitHubAuditLogPolling_CL" + } + ], + "dataTypes": [ + { + "name": "GitHubAuditLogPolling_CL", + "lastDataReceivedQuery": "GitHubAuditLogPolling_CL \n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "IsConnectedQuery", + "value": [ + "GitHubAuditLogPolling_CL \n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)" + ] + } + ], + "availability": { + "status": 1, + "isPreview": false + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": false, + "delete": false, + "action": false + } + } + ], + "customs": [ + { + "name": "GitHub API personal token Key", + "description": "You need access to GitHub personal token, the key should have 'admin:org' scope" + } + ] + }, + "instructionSteps": [ + { + "title": "Connect GitHub Enterprise Audit Log to Azure Sentinel", + "description": "Enable GitHub audit Logs. \n Follow [this](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create or find your personal key", + "instructions": [ + { + "type": "OAuthForm", + "parameters": { + "clientIdLabel": "Client ID", + "clientSecretLabel": "Client Secret", + "connectButtonLabel": "Connect", + "disconnectButtonLabel": "Disconnect" + } + } + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectorDefinitions", + "kind": "Customizable", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "connectorUiConfig": { + "title": "GitHub Enterprise Audit Log", + "publisher": "GitHub", + "descriptionMarkdown": "The GitHub audit log connector provides the capability to ingest GitHub logs into Azure Sentinel. By connecting GitHub audit logs into Azure Sentinel, you can view this data in workbooks, use it to create custom alerts, and improve your investigation process.", + "graphQueries": [ + { + "metricName": "Total events received", + "legend": "GitHub audit log events", + "baseQuery": "GitHubAuditLogPolling_CL" + } + ], + "sampleQueries": [ + { + "description": "All logs", + "query": "GitHubAuditLogPolling_CL \n | take 10" + } + ], + "dataTypes": [ + { + "name": "GitHubAuditLogPolling_CL", + "lastDataReceivedQuery": "GitHubAuditLogPolling_CL \n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "IsConnectedQuery", + "value": [ + "GitHubAuditLogPolling_CL \n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)" + ] + } + ], + "availability": { + "status": 1, + "isPreview": false + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": false, + "delete": false, + "action": false + } + } + ], + "customs": [ + { + "name": "GitHub API personal token Key", + "description": "You need access to GitHub personal token, the key should have 'admin:org' scope" + } + ] + }, + "instructionSteps": [ + { + "title": "Connect GitHub Enterprise Audit Log to Azure Sentinel", + "description": "Enable GitHub audit Logs. \n Follow [this](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create or find your personal key", + "instructions": [ + { + "type": "OAuthForm", + "parameters": { + "clientIdLabel": "Client ID", + "clientSecretLabel": "Client Secret", + "connectButtonLabel": "Connect", + "disconnectButtonLabel": "Disconnect" + } + } + ] + } + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectorDefinitions", + "kind": "Customizable", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "connectorUiConfig": { + "title": "GitHub Enterprise Audit Log", + "publisher": "GitHub", + "descriptionMarkdown": "The GitHub audit log connector provides the capability to ingest GitHub logs into Azure Sentinel. By connecting GitHub audit logs into Azure Sentinel, you can view this data in workbooks, use it to create custom alerts, and improve your investigation process.", + "graphQueries": [ + { + "metricName": "Total events received", + "legend": "GitHub audit log events", + "baseQuery": "GitHubAuditLogPolling_CL" + } + ], + "sampleQueries": [ + { + "description": "All logs", + "query": "GitHubAuditLogPolling_CL \n | take 10" + } + ], + "dataTypes": [ + { + "name": "GitHubAuditLogPolling_CL", + "lastDataReceivedQuery": "GitHubAuditLogPolling_CL \n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "IsConnectedQuery", + "value": [ + "GitHubAuditLogPolling_CL \n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)" + ] + } + ], + "availability": { + "status": 1, + "isPreview": false + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": false, + "delete": false, + "action": false + } + } + ], + "customs": [ + { + "name": "GitHub API personal token Key", + "description": "You need access to GitHub personal token, the key should have 'admin:org' scope" + } + ] + }, + "instructionSteps": [ + { + "title": "Connect GitHub Enterprise Audit Log to Azure Sentinel", + "description": "Enable GitHub audit Logs. \n Follow [this](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create or find your personal key", + "instructions": [ + { + "type": "OAuthForm", + "parameters": { + "clientIdLabel": "Client ID", + "clientSecretLabel": "Client Secret", + "connectButtonLabel": "Connect", + "disconnectButtonLabel": "Disconnect" + } + } + ] + } + ] + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectorDefinitions/DeleteDataConnectorDefinitionById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectorDefinitions/DeleteDataConnectorDefinitionById.json new file mode 100644 index 000000000000..ae0d9c7ab517 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectorDefinitions/DeleteDataConnectorDefinitionById.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorDefinitionName": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectorDefinitions/GetCustomizableDataConnectoeDefinitionById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectorDefinitions/GetCustomizableDataConnectoeDefinitionById.json new file mode 100644 index 000000000000..24c138942ccc --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectorDefinitions/GetCustomizableDataConnectoeDefinitionById.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorDefinitionName": "763f9fa1-c2d3-4fa2-93e9-bccd4899aa12" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/763f9fa1-c2d3-4fa2-93e9-bccd4899aa12", + "name": "763f9fa1-c2d3-4fa2-93e9-bccd4899aa12", + "type": "Microsoft.SecurityInsights/dataConnectorDefinitions", + "kind": "Customizable", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "connectorUiConfig": { + "title": "GitHub Enterprise Audit Log", + "publisher": "GitHub", + "descriptionMarkdown": "The GitHub audit log connector provides the capability to ingest GitHub logs into Azure Sentinel. By connecting GitHub audit logs into Azure Sentinel, you can view this data in workbooks, use it to create custom alerts, and improve your investigation process.", + "graphQueries": [ + { + "metricName": "Total events received", + "legend": "GitHub audit log events", + "baseQuery": "GitHubAuditLogPolling_CL" + } + ], + "dataTypes": [ + { + "name": "GitHubAuditLogPolling_CL", + "lastDataReceivedQuery": "GitHubAuditLogPolling_CL \n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "IsConnectedQuery", + "value": [ + "GitHubAuditLogPolling_CL \n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)" + ] + } + ], + "availability": { + "status": 1, + "isPreview": false + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": false, + "delete": false, + "action": false + } + } + ], + "customs": [ + { + "name": "GitHub API personal token Key", + "description": "You need access to GitHub personal token, the key should have 'admin:org' scope" + } + ] + }, + "instructionSteps": [ + { + "title": "Connect GitHub Enterprise Audit Log to Azure Sentinel", + "description": "Enable GitHub audit Logs. \n Follow [this](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create or find your personal key", + "instructions": [ + { + "type": "OAuthForm", + "parameters": { + "clientIdLabel": "Client ID", + "clientSecretLabel": "Client Secret", + "connectButtonLabel": "Connect", + "disconnectButtonLabel": "Disconnect" + } + } + ] + } + ] + }, + "connectionsConfig": { + "templateSpecName": "templateNameMock", + "templateSpecVersion": "1.0.0" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectorDefinitions/GetDataConnectorDefinitions.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectorDefinitions/GetDataConnectorDefinitions.json new file mode 100644 index 000000000000..1aac6973ef1b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectorDefinitions/GetDataConnectorDefinitions.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/763f9fa1-c2d3-4fa2-93e9-bccd4899aa12", + "name": "763f9fa1-c2d3-4fa2-93e9-bccd4899aa12", + "type": "Microsoft.SecurityInsights/dataConnectorDefinitions", + "kind": "Customizable", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "connectorUiConfig": { + "title": "GitHub Enterprise Audit Log", + "publisher": "GitHub", + "descriptionMarkdown": "The GitHub audit log connector provides the capability to ingest GitHub logs into Azure Sentinel. By connecting GitHub audit logs into Azure Sentinel, you can view this data in workbooks, use it to create custom alerts, and improve your investigation process.", + "graphQueries": [ + { + "metricName": "Total events received", + "legend": "GitHub audit log events", + "baseQuery": "GitHubAuditLogPolling_CL" + } + ], + "dataTypes": [ + { + "name": "GitHubAuditLogPolling_CL", + "lastDataReceivedQuery": "GitHubAuditLogPolling_CL \n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "IsConnectedQuery", + "value": [ + "GitHubAuditLogPolling_CL \n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)" + ] + } + ], + "availability": { + "status": 1, + "isPreview": false + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": false, + "delete": false, + "action": false + } + } + ], + "customs": [ + { + "name": "GitHub API personal token Key", + "description": "You need access to GitHub personal token, the key should have 'admin:org' scope" + } + ] + }, + "instructionSteps": [ + { + "title": "Connect GitHub Enterprise Audit Log to Azure Sentinel", + "description": "Enable GitHub audit Logs. \n Follow [this](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create or find your personal key", + "instructions": [ + { + "type": "OAuthForm", + "parameters": { + "clientIdLabel": "Client ID", + "clientSecretLabel": "Client Secret", + "connectButtonLabel": "Connect", + "disconnectButtonLabel": "Disconnect" + } + } + ] + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectory.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectory.json new file mode 100644 index 000000000000..9530afafd974 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectory.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "AzureActiveDirectory", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoAuthorization.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoAuthorization.json new file mode 100644 index 000000000000..9530afafd974 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoAuthorization.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "AzureActiveDirectory", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoLicense.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoLicense.json new file mode 100644 index 000000000000..9530afafd974 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoLicense.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "AzureActiveDirectory", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsAzureSecurityCenter.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsAzureSecurityCenter.json new file mode 100644 index 000000000000..3d35b03ca82d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsAzureSecurityCenter.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "AzureSecurityCenter", + "properties": { + "subscriptionId": "c0688291-89d7-4bed-87a2-a7b1bff43f4c" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsDynamics365.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsDynamics365.json new file mode 100644 index 000000000000..20c26452e48b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsDynamics365.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "Dynamics365", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsIoT.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsIoT.json new file mode 100644 index 000000000000..ae28409c2277 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsIoT.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "IOT", + "properties": { + "subscriptionId": "c0688291-89d7-4bed-87a2-a7b1bff43f4c" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsMdatp.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsMdatp.json new file mode 100644 index 000000000000..adfc78ba768f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsMdatp.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "MicrosoftCloudAppSecurity", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftCloudAppSecurity.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftCloudAppSecurity.json new file mode 100644 index 000000000000..adfc78ba768f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftCloudAppSecurity.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "MicrosoftCloudAppSecurity", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftPurviewInformationProtection.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftPurviewInformationProtection.json new file mode 100644 index 000000000000..6d1eb822be6c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftPurviewInformationProtection.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "MicrosoftPurviewInformationProtection", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftThreatIntelligence.json new file mode 100644 index 000000000000..c2627d8a252a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftThreatIntelligence.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "MicrosoftThreatIntelligence", + "properties": { + "tenantId": "06b3ccb8-1384-4bcc-aec7-852f6d57161b" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftThreatProtection.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftThreatProtection.json new file mode 100644 index 000000000000..5b278b7a338e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftThreatProtection.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "MicrosoftThreatProtection", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsOffice365Project.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsOffice365Project.json new file mode 100644 index 000000000000..e273aa5fe9f4 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsOffice365Project.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "Office365Project", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsOfficeATP.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsOfficeATP.json new file mode 100644 index 000000000000..f8d9f286d1a5 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsOfficeATP.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "OfficeATP", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsOfficeIRM.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsOfficeIRM.json new file mode 100644 index 000000000000..861e63900778 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsOfficeIRM.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "OfficeIRM", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsOfficePowerBI.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsOfficePowerBI.json new file mode 100644 index 000000000000..35e64c74212b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsOfficePowerBI.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "OfficePowerBI", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsThreatIntelligence.json new file mode 100644 index 000000000000..63384967baba --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsThreatIntelligence.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "ThreatIntelligence", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsThreatIntelligenceTaxii.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsThreatIntelligenceTaxii.json new file mode 100644 index 000000000000..7ee47d9b555a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CheckRequirementsThreatIntelligenceTaxii.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "ThreatIntelligenceTaxii", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/ConnectAPIPolling.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/ConnectAPIPolling.json new file mode 100644 index 000000000000..56c5105ba17c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/ConnectAPIPolling.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "connectBody": { + "kind": "APIKey", + "apiKey": "123456789", + "requestConfigUserInputValues": [ + { + "displayText": "Organization Name", + "placeHolderName": "{{placeHolder1}}", + "placeHolderValue": "somePlaceHolderValue", + "requestObjectKey": "apiEndpoint" + } + ] + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/ConnectAPIPollingV2Logs.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/ConnectAPIPollingV2Logs.json new file mode 100644 index 000000000000..375af45b5f85 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/ConnectAPIPollingV2Logs.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "connectBody": { + "kind": "APIKey", + "apiKey": "123456789", + "dataCollectionEndpoint": "https://test.eastus.ingest.monitor.azure.com", + "dataCollectionRuleImmutableId": "dcr-34adsj9o7d6f9de204478b9cgb43b631", + "outputStream": "Custom-MyTableRawData", + "requestConfigUserInputValues": [ + { + "displayText": "Organization Name", + "placeHolderName": "{{placeHolder1}}", + "placeHolderValue": "somePlaceHolderValue", + "requestObjectKey": "apiEndpoint" + } + ] + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateAPIPolling.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateAPIPolling.json new file mode 100644 index 000000000000..331a1d2fa9c0 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateAPIPolling.json @@ -0,0 +1,368 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "dataConnector": { + "kind": "APIPolling", + "properties": { + "connectorUiConfig": { + "title": "GitHub Enterprise Audit Log", + "publisher": "GitHub", + "descriptionMarkdown": "The GitHub audit log connector provides the capability to ingest GitHub logs into Azure Sentinel. By connecting GitHub audit logs into Azure Sentinel, you can view this data in workbooks, use it to create custom alerts, and improve your investigation process.", + "graphQueriesTableName": "GitHubAuditLogPolling_CL", + "graphQueries": [ + { + "metricName": "Total events received", + "legend": "GitHub audit log events", + "baseQuery": "{{graphQueriesTableName}}" + } + ], + "sampleQueries": [ + { + "description": "All logs", + "query": "{{graphQueriesTableName}}\n | take 10 " + } + ], + "dataTypes": [ + { + "name": "{{graphQueriesTableName}}", + "lastDataReceivedQuery": "{{graphQueriesTableName}}\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "SentinelKindsV2", + "value": [] + } + ], + "availability": { + "status": 1, + "isPreview": true + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": true, + "delete": true + } + } + ], + "customs": [ + { + "name": "GitHub API personal token Key", + "description": "You need access to GitHub personal token, the key should have 'admin:org' scope" + } + ] + }, + "instructionSteps": [ + { + "title": "Connect GitHub Enterprise Audit Log to Azure Sentinel", + "description": "Enable GitHub audit Logs. \n Follow [this](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create or find your personal key", + "instructions": [ + { + "parameters": { + "enable": "true", + "userRequestPlaceHoldersInput": [ + { + "displayText": "Organization Name", + "requestObjectKey": "apiEndpoint", + "placeHolderName": "{{placeHolder1}}", + "placeHolderValue": "" + } + ] + }, + "type": "APIKey" + } + ] + } + ] + }, + "pollingConfig": { + "auth": { + "authType": "APIKey", + "apiKeyIdentifier": "token", + "apiKeyName": "Authorization" + }, + "request": { + "apiEndpoint": "https://api.github.com/organizations/{{placeHolder1}}/audit-log", + "rateLimitQps": 50, + "queryWindowInMin": 15, + "httpMethod": "Get", + "queryTimeFormat": "yyyy-MM-ddTHH:mm:ssZ", + "retryCount": 2, + "timeoutInSeconds": 60, + "headers": { + "Accept": "application/json", + "User-Agent": "Scuba" + }, + "queryParameters": { + "phrase": "created:{_QueryWindowStartTime}..{_QueryWindowEndTime}" + } + }, + "paging": { + "pagingType": "LinkHeader", + "pageSizeParaName": "per_page" + }, + "response": { + "eventsJsonPaths": [ + "$" + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "name": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "etag": "\"1a00b074-0000-0100-0000-606ef5bd0000\"", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "APIPolling", + "properties": { + "connectorUiConfig": { + "title": "GitHub Enterprise Audit Log", + "publisher": "GitHub", + "descriptionMarkdown": "The GitHub audit log connector provides the capability to ingest GitHub logs into Azure Sentinel. By connecting GitHub audit logs into Azure Sentinel, you can view this data in workbooks, use it to create custom alerts, and improve your investigation process.", + "graphQueriesTableName": "GitHubAuditLogPolling_CL", + "graphQueries": [ + { + "metricName": "Total events received", + "legend": "GitHub audit log events", + "baseQuery": "{{graphQueriesTableName}}" + } + ], + "sampleQueries": [ + { + "description": "All logs", + "query": "{{graphQueriesTableName}}\n | take 10 " + } + ], + "dataTypes": [ + { + "name": "{{graphQueriesTableName}}", + "lastDataReceivedQuery": "{{graphQueriesTableName}}\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "SentinelKindsV2", + "value": [] + } + ], + "availability": { + "status": 1, + "isPreview": true + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": true, + "delete": true + } + } + ], + "customs": [ + { + "name": "GitHub API personal token Key", + "description": "You need access to GitHub personal token, the key should have 'admin:org' scope" + } + ] + }, + "instructionSteps": [ + { + "title": "Connect GitHub Enterprise Audit Log to Azure Sentinel", + "description": "Enable GitHub audit Logs. \n Follow [this](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create or find your personal key", + "instructions": [ + { + "parameters": { + "enable": "true", + "userRequestPlaceHoldersInput": [ + { + "displayText": "Organization Name", + "requestObjectKey": "apiEndpoint", + "placeHolderName": "{{placeHolder1}}", + "placeHolderValue": "" + } + ] + }, + "type": "APIKey" + } + ] + } + ] + }, + "pollingConfig": { + "auth": { + "authType": "APIKey", + "apiKeyIdentifier": "token", + "apiKeyName": "Authorization" + }, + "request": { + "apiEndpoint": "https://api.github.com/organizations/{{placeHolder1}}/audit-log", + "rateLimitQps": 50, + "queryWindowInMin": 15, + "httpMethod": "Get", + "queryTimeFormat": "yyyy-MM-ddTHH:mm:ssZ", + "retryCount": 2, + "timeoutInSeconds": 60, + "headers": { + "Accept": "application/json", + "User-Agent": "Scuba" + }, + "queryParameters": { + "phrase": "created:{_QueryWindowStartTime}..{_QueryWindowEndTime}" + } + }, + "paging": { + "pagingType": "LinkHeader", + "pageSizeParaName": "per_page" + }, + "response": { + "eventsJsonPaths": [ + "$" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "name": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "etag": "\"1a00b074-0000-0100-0000-606ef5bd0000\"", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "APIPolling", + "properties": { + "connectorUiConfig": { + "title": "GitHub Enterprise Audit Log", + "publisher": "GitHub", + "descriptionMarkdown": "The GitHub audit log connector provides the capability to ingest GitHub logs into Azure Sentinel. By connecting GitHub audit logs into Azure Sentinel, you can view this data in workbooks, use it to create custom alerts, and improve your investigation process.", + "graphQueriesTableName": "GitHubAuditLogPolling_CL", + "graphQueries": [ + { + "metricName": "Total events received", + "legend": "GitHub audit log events", + "baseQuery": "{{graphQueriesTableName}}" + } + ], + "sampleQueries": [ + { + "description": "All logs", + "query": "{{graphQueriesTableName}}\n | take 10 " + } + ], + "dataTypes": [ + { + "name": "{{graphQueriesTableName}}", + "lastDataReceivedQuery": "{{graphQueriesTableName}}\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "SentinelKindsV2", + "value": [] + } + ], + "availability": { + "status": 1, + "isPreview": true + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": true, + "delete": true + } + } + ], + "customs": [ + { + "name": "GitHub API personal token Key", + "description": "You need access to GitHub personal token, the key should have 'admin:org' scope" + } + ] + }, + "instructionSteps": [ + { + "title": "Connect GitHub Enterprise Audit Log to Azure Sentinel", + "description": "Enable GitHub audit Logs. \n Follow [this](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create or find your personal key", + "instructions": [ + { + "parameters": { + "enable": "true", + "userRequestPlaceHoldersInput": [ + { + "displayText": "Organization Name", + "requestObjectKey": "apiEndpoint", + "placeHolderName": "{{placeHolder1}}", + "placeHolderValue": "" + } + ] + }, + "type": "APIKey" + } + ] + } + ] + }, + "pollingConfig": { + "auth": { + "authType": "APIKey", + "apiKeyIdentifier": "token", + "apiKeyName": "Authorization" + }, + "request": { + "apiEndpoint": "https://api.github.com/organizations/{{placeHolder1}}/audit-log", + "rateLimitQps": 50, + "queryWindowInMin": 15, + "httpMethod": "Get", + "queryTimeFormat": "yyyy-MM-ddTHH:mm:ssZ", + "retryCount": 2, + "timeoutInSeconds": 60, + "headers": { + "Accept": "application/json", + "User-Agent": "Scuba" + }, + "queryParameters": { + "phrase": "created:{_QueryWindowStartTime}..{_QueryWindowEndTime}" + } + }, + "paging": { + "pagingType": "LinkHeader", + "pageSizeParaName": "per_page" + }, + "response": { + "eventsJsonPaths": [ + "$" + ] + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateDynamics365DataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateDynamics365DataConnetor.json new file mode 100644 index 000000000000..affa1f51f642 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateDynamics365DataConnetor.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "c2541efb-c9a6-47fe-9501-87d1017d1512", + "dataConnector": { + "kind": "Dynamics365", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "dynamics365CdsActivities": { + "state": "Enabled" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "c2541efb-c9a6-47fe-9501-87d1017d1512", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Dynamics365", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "dynamics365CdsActivities": { + "state": "Enabled" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "c2541efb-c9a6-47fe-9501-87d1017d1512", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Dynamics365", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "dynamics365CdsActivities": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateGenericUI.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateGenericUI.json new file mode 100644 index 000000000000..8ad6ecc0a485 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateGenericUI.json @@ -0,0 +1,437 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "dataConnector": { + "kind": "GenericUI", + "properties": { + "connectorUiConfig": { + "title": "Qualys Vulnerability Management (CCP DEMO)", + "publisher": "Qualys", + "descriptionMarkdown": "The [Qualys Vulnerability Management (VM)](https://www.qualys.com/apps/vulnerability-management/) data connector provides the capability to ingest vulnerability host detection data into Azure Sentinel through the Qualys API. The connector provides visibility into host detection data from vulerability scans. This connector provides Azure Sentinel the capability to view dashboards, create custom alerts, and improve investigation ", + "graphQueriesTableName": "QualysHostDetection_CL", + "graphQueries": [ + { + "metricName": "Total data received", + "legend": "{{graphQueriesTableName}}", + "baseQuery": "{{graphQueriesTableName}}" + } + ], + "sampleQueries": [ + { + "description": "Top 10 Vulerabilities detected", + "query": "{{graphQueriesTableName}}\n | mv-expand todynamic(Detections_s)\n | extend Vulnerability = tostring(Detections_s.Results)\n | summarize count() by Vulnerability\n | top 10 by count_" + } + ], + "dataTypes": [ + { + "name": "{{graphQueriesTableName}}", + "lastDataReceivedQuery": "{{graphQueriesTableName}}\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "availability": { + "status": 1, + "isPreview": true + }, + "connectivityCriteria": [ + { + "type": "IsConnectedQuery", + "value": [ + "{{graphQueriesTableName}}\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)" + ] + } + ], + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions on the workspace are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": true, + "delete": true + } + }, + { + "provider": "Microsoft.OperationalInsights/workspaces/sharedKeys", + "permissionsDisplayText": "read permissions to shared keys for the workspace are required. [See the documentation to learn more about workspace keys](https://docs.microsoft.com/azure/azure-monitor/platform/agent-windows#obtain-workspace-id-and-key).", + "providerDisplayName": "Keys", + "scope": "Workspace", + "requiredPermissions": { + "action": true + } + } + ], + "customs": [ + { + "name": "Microsoft.Web/sites permissions", + "description": "Read and write permissions to Azure Functions to create a Function App is required. [See the documentation to learn more about Azure Functions](https://docs.microsoft.com/azure/azure-functions/)." + }, + { + "name": "Qualys API Key", + "description": "A Qualys VM API username and password is required. [See the documentation to learn more about Qualys VM API](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf)." + } + ] + }, + "instructionSteps": [ + { + "title": "", + "description": ">**NOTE:** This connector uses Azure Functions to connect to Qualys VM to pull its logs into Azure Sentinel. This might result in additional data ingestion costs. Check the [Azure Functions pricing page](https://azure.microsoft.com/pricing/details/functions/) for details." + }, + { + "title": "", + "description": ">**(Optional Step)** Securely store workspace and API authorization key(s) or token(s) in Azure Key Vault. Azure Key Vault provides a secure mechanism to store and retrieve key values. [Follow these instructions](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) to use Azure Key Vault with an Azure Function App." + }, + { + "title": "", + "description": "**STEP 1 - Configuration steps for the Qualys VM API**\n\n1. Log into the Qualys Vulnerability Management console with an administrator account, select the **Users** tab and the **Users** subtab. \n2. Click on the **New** drop-down menu and select **Users..**\n3. Create a username and password for the API account. \n4. In the **User Roles** tab, ensure the account role is set to **Manager** and access is allowed to **GUI** and **API**\n4. Log out of the administrator account and log into the console with the new API credentials for validation, then log out of the API account. \n5. Log back into the console using an administrator account and modify the API accounts User Roles, removing access to **GUI**. \n6. Save all changes." + }, + { + "title": "", + "description": "**STEP 2 - Choose ONE from the following two deployment options to deploy the connector and the associated Azure Function**\n\n>**IMPORTANT:** Before deploying the Qualys VM connector, have the Workspace ID and Workspace Primary Key (can be copied from the following), as well as the Qualys VM API Authorization Key(s), readily available.", + "instructions": [ + { + "parameters": { + "fillWith": [ + "WorkspaceId" + ], + "label": "Workspace ID" + }, + "type": "CopyableLabel" + }, + { + "parameters": { + "fillWith": [ + "PrimaryKey" + ], + "label": "Primary Key" + }, + "type": "CopyableLabel" + } + ] + }, + { + "title": "Option 1 - Azure Resource Manager (ARM) Template", + "description": "Use this method for automated deployment of the Qualys VM connector using an ARM Tempate.\n\n1. Click the **Deploy to Azure** button below. \n\n\t[![Deploy To Azure](https://aka.ms/deploytoazurebutton)](https://aka.ms/sentinelqualysvmazuredeploy)\n2. Select the preferred **Subscription**, **Resource Group** and **Location**. \n3. Enter the **Workspace ID**, **Workspace Key**, **API Username**, **API Password** , update the **URI**, and any additional URI **Filter Parameters** (each filter should be separated by an \"&\" symbol, no spaces.) \n> - Enter the URI that corresponds to your region. The complete list of API Server URLs can be [found here](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf#G4.735348) -- There is no need to add a time suffix to the URI, the Function App will dynamically append the Time Value to the URI in the proper format. \n - The default **Time Interval** is set to pull the last five (5) minutes of data. If the time interval needs to be modified, it is recommended to change the Function App Timer Trigger accordingly (in the function.json file, post deployment) to prevent overlapping data ingestion. \n> - Note: If using Azure Key Vault secrets for any of the values above, use the`@Microsoft.KeyVault(SecretUri={Security Identifier})`schema in place of the string values. Refer to [Key Vault references documentation](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) for further details. \n4. Mark the checkbox labeled **I agree to the terms and conditions stated above**. \n5. Click **Purchase** to deploy." + }, + { + "title": "Option 2 - Manual Deployment of Azure Functions", + "description": "Use the following step-by-step instructions to deploy the Quayls VM connector manually with Azure Functions." + }, + { + "title": "", + "description": "**1. Create a Function App**\n\n1. From the Azure Portal, navigate to [Function App](https://portal.azure.com/#blade/HubsExtension/BrowseResource/resourceType/Microsoft.Web%2Fsites/kind/functionapp), and select **+ Add**.\n2. In the **Basics** tab, ensure Runtime stack is set to **Powershell Core**. \n3. In the **Hosting** tab, ensure the **Consumption (Serverless)** plan type is selected.\n4. Make other preferrable configuration changes, if needed, then click **Create**." + }, + { + "title": "", + "description": "**2. Import Function App Code**\n\n1. In the newly created Function App, select **Functions** on the left pane and click **+ New Function**.\n2. Select **Timer Trigger**.\n3. Enter a unique Function **Name** and leave the default cron schedule of every 5 minutes, then click **Create**.\n5. Click on **Code + Test** on the left pane. \n6. Copy the [Function App Code](https://aka.ms/sentinelqualysvmazurefunctioncode) and paste into the Function App `run.ps1` editor.\n7. Click **Save**." + }, + { + "title": "", + "description": "**3. Configure the Function App**\n\n1. In the Function App, select the Function App Name and select **Configuration**.\n2. In the **Application settings** tab, select **+ New application setting**.\n3. Add each of the following seven (7) application settings individually, with their respective string values (case-sensitive): \n\t\tapiUsername\n\t\tapiPassword\n\t\tworkspaceID\n\t\tworkspaceKey\n\t\turi\n\t\tfilterParameters\n\t\ttimeInterval\n> - Enter the URI that corresponds to your region. The complete list of API Server URLs can be [found here](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf#G4.735348). The `uri` value must follow the following schema: `https:///api/2.0/fo/asset/host/vm/detection/?action=list&vm_processed_after=` -- There is no need to add a time suffix to the URI, the Function App will dynamically append the Time Value to the URI in the proper format.\n> - Add any additional filter parameters, for the `filterParameters` variable, that need to be appended to the URI. Each parameter should be seperated by an \"&\" symbol and should not include any spaces.\n> - Set the `timeInterval` (in minutes) to the value of `5` to correspond to the Timer Trigger of every `5` minutes. If the time interval needs to be modified, it is recommended to change the Function App Timer Trigger accordingly to prevent overlapping data ingestion.\n> - Note: If using Azure Key Vault, use the`@Microsoft.KeyVault(SecretUri={Security Identifier})`schema in place of the string values. Refer to [Key Vault references documentation](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) for further details.\n4. Once all application settings have been entered, click **Save**." + }, + { + "title": "", + "description": "**4. Configure the host.json**.\n\nDue to the potentially large amount of Qualys host detection data being ingested, it can cause the execution time to surpass the default Function App timeout of five (5) minutes. Increase the default timeout duration to the maximum of ten (10) minutes, under the Consumption Plan, to allow more time for the Function App to execute.\n\n1. In the Function App, select the Function App Name and select the **App Service Editor** blade.\n2. Click **Go** to open the editor, then select the **host.json** file under the **wwwroot** directory.\n3. Add the line `\"functionTimeout\": \"00:10:00\",` above the `managedDependancy` line \n4. Ensure **SAVED** appears on the top right corner of the editor, then exit the editor.\n\n> NOTE: If a longer timeout duration is required, consider upgrading to an [App Service Plan](https://docs.microsoft.com/azure/azure-functions/functions-scale#timeout)" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "name": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "etag": "\"1a00b074-0000-0100-0000-606ef5bd0000\"", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "GenericUI", + "properties": { + "connectorUiConfig": { + "title": "Qualys Vulnerability Management (CCP DEMO)", + "publisher": "Qualys", + "descriptionMarkdown": "The [Qualys Vulnerability Management (VM)](https://www.qualys.com/apps/vulnerability-management/) data connector provides the capability to ingest vulnerability host detection data into Azure Sentinel through the Qualys API. The connector provides visibility into host detection data from vulerability scans. This connector provides Azure Sentinel the capability to view dashboards, create custom alerts, and improve investigation ", + "graphQueriesTableName": "QualysHostDetection_CL", + "graphQueries": [ + { + "metricName": "Total data received", + "legend": "{{graphQueriesTableName}}", + "baseQuery": "{{graphQueriesTableName}}" + } + ], + "sampleQueries": [ + { + "description": "Top 10 Vulerabilities detected", + "query": "{{graphQueriesTableName}}\n | mv-expand todynamic(Detections_s)\n | extend Vulnerability = tostring(Detections_s.Results)\n | summarize count() by Vulnerability\n | top 10 by count_" + } + ], + "dataTypes": [ + { + "name": "{{graphQueriesTableName}}", + "lastDataReceivedQuery": "{{graphQueriesTableName}}\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "IsConnectedQuery", + "value": [ + "{{graphQueriesTableName}}\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)" + ] + } + ], + "availability": { + "status": 1, + "isPreview": true + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions on the workspace are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": true, + "delete": true + } + }, + { + "provider": "Microsoft.OperationalInsights/workspaces/sharedKeys", + "permissionsDisplayText": "read permissions to shared keys for the workspace are required. [See the documentation to learn more about workspace keys](https://docs.microsoft.com/azure/azure-monitor/platform/agent-windows#obtain-workspace-id-and-key).", + "providerDisplayName": "Keys", + "scope": "Workspace", + "requiredPermissions": { + "action": true + } + } + ], + "customs": [ + { + "name": "Microsoft.Web/sites permissions", + "description": "Read and write permissions to Azure Functions to create a Function App is required. [See the documentation to learn more about Azure Functions](https://docs.microsoft.com/azure/azure-functions/)." + }, + { + "name": "Qualys API Key", + "description": "A Qualys VM API username and password is required. [See the documentation to learn more about Qualys VM API](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf)." + } + ] + }, + "instructionSteps": [ + { + "title": "", + "description": ">**NOTE:** This connector uses Azure Functions to connect to Qualys VM to pull its logs into Azure Sentinel. This might result in additional data ingestion costs. Check the [Azure Functions pricing page](https://azure.microsoft.com/pricing/details/functions/) for details." + }, + { + "title": "", + "description": ">**(Optional Step)** Securely store workspace and API authorization key(s) or token(s) in Azure Key Vault. Azure Key Vault provides a secure mechanism to store and retrieve key values. [Follow these instructions](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) to use Azure Key Vault with an Azure Function App." + }, + { + "title": "", + "description": "**STEP 1 - Configuration steps for the Qualys VM API**\n\n1. Log into the Qualys Vulnerability Management console with an administrator account, select the **Users** tab and the **Users** subtab. \n2. Click on the **New** drop-down menu and select **Users..**\n3. Create a username and password for the API account. \n4. In the **User Roles** tab, ensure the account role is set to **Manager** and access is allowed to **GUI** and **API**\n4. Log out of the administrator account and log into the console with the new API credentials for validation, then log out of the API account. \n5. Log back into the console using an administrator account and modify the API accounts User Roles, removing access to **GUI**. \n6. Save all changes." + }, + { + "title": "", + "description": "**STEP 2 - Choose ONE from the following two deployment options to deploy the connector and the associated Azure Function**\n\n>**IMPORTANT:** Before deploying the Qualys VM connector, have the Workspace ID and Workspace Primary Key (can be copied from the following), as well as the Qualys VM API Authorization Key(s), readily available.", + "instructions": [ + { + "parameters": { + "fillWith": [ + "WorkspaceId" + ], + "label": "Workspace ID" + }, + "type": "CopyableLabel" + }, + { + "parameters": { + "fillWith": [ + "PrimaryKey" + ], + "label": "Primary Key" + }, + "type": "CopyableLabel" + } + ] + }, + { + "title": "Option 1 - Azure Resource Manager (ARM) Template", + "description": "Use this method for automated deployment of the Qualys VM connector using an ARM Tempate.\n\n1. Click the **Deploy to Azure** button below. \n\n\t[![Deploy To Azure](https://aka.ms/deploytoazurebutton)](https://aka.ms/sentinelqualysvmazuredeploy)\n2. Select the preferred **Subscription**, **Resource Group** and **Location**. \n3. Enter the **Workspace ID**, **Workspace Key**, **API Username**, **API Password** , update the **URI**, and any additional URI **Filter Parameters** (each filter should be separated by an \"&\" symbol, no spaces.) \n> - Enter the URI that corresponds to your region. The complete list of API Server URLs can be [found here](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf#G4.735348) -- There is no need to add a time suffix to the URI, the Function App will dynamically append the Time Value to the URI in the proper format. \n - The default **Time Interval** is set to pull the last five (5) minutes of data. If the time interval needs to be modified, it is recommended to change the Function App Timer Trigger accordingly (in the function.json file, post deployment) to prevent overlapping data ingestion. \n> - Note: If using Azure Key Vault secrets for any of the values above, use the`@Microsoft.KeyVault(SecretUri={Security Identifier})`schema in place of the string values. Refer to [Key Vault references documentation](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) for further details. \n4. Mark the checkbox labeled **I agree to the terms and conditions stated above**. \n5. Click **Purchase** to deploy." + }, + { + "title": "Option 2 - Manual Deployment of Azure Functions", + "description": "Use the following step-by-step instructions to deploy the Quayls VM connector manually with Azure Functions." + }, + { + "title": "", + "description": "**1. Create a Function App**\n\n1. From the Azure Portal, navigate to [Function App](https://portal.azure.com/#blade/HubsExtension/BrowseResource/resourceType/Microsoft.Web%2Fsites/kind/functionapp), and select **+ Add**.\n2. In the **Basics** tab, ensure Runtime stack is set to **Powershell Core**. \n3. In the **Hosting** tab, ensure the **Consumption (Serverless)** plan type is selected.\n4. Make other preferrable configuration changes, if needed, then click **Create**." + }, + { + "title": "", + "description": "**2. Import Function App Code**\n\n1. In the newly created Function App, select **Functions** on the left pane and click **+ New Function**.\n2. Select **Timer Trigger**.\n3. Enter a unique Function **Name** and leave the default cron schedule of every 5 minutes, then click **Create**.\n5. Click on **Code + Test** on the left pane. \n6. Copy the [Function App Code](https://aka.ms/sentinelqualysvmazurefunctioncode) and paste into the Function App `run.ps1` editor.\n7. Click **Save**." + }, + { + "title": "", + "description": "**3. Configure the Function App**\n\n1. In the Function App, select the Function App Name and select **Configuration**.\n2. In the **Application settings** tab, select **+ New application setting**.\n3. Add each of the following seven (7) application settings individually, with their respective string values (case-sensitive): \n\t\tapiUsername\n\t\tapiPassword\n\t\tworkspaceID\n\t\tworkspaceKey\n\t\turi\n\t\tfilterParameters\n\t\ttimeInterval\n> - Enter the URI that corresponds to your region. The complete list of API Server URLs can be [found here](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf#G4.735348). The `uri` value must follow the following schema: `https:///api/2.0/fo/asset/host/vm/detection/?action=list&vm_processed_after=` -- There is no need to add a time suffix to the URI, the Function App will dynamically append the Time Value to the URI in the proper format.\n> - Add any additional filter parameters, for the `filterParameters` variable, that need to be appended to the URI. Each parameter should be seperated by an \"&\" symbol and should not include any spaces.\n> - Set the `timeInterval` (in minutes) to the value of `5` to correspond to the Timer Trigger of every `5` minutes. If the time interval needs to be modified, it is recommended to change the Function App Timer Trigger accordingly to prevent overlapping data ingestion.\n> - Note: If using Azure Key Vault, use the`@Microsoft.KeyVault(SecretUri={Security Identifier})`schema in place of the string values. Refer to [Key Vault references documentation](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) for further details.\n4. Once all application settings have been entered, click **Save**." + }, + { + "title": "", + "description": "**4. Configure the host.json**.\n\nDue to the potentially large amount of Qualys host detection data being ingested, it can cause the execution time to surpass the default Function App timeout of five (5) minutes. Increase the default timeout duration to the maximum of ten (10) minutes, under the Consumption Plan, to allow more time for the Function App to execute.\n\n1. In the Function App, select the Function App Name and select the **App Service Editor** blade.\n2. Click **Go** to open the editor, then select the **host.json** file under the **wwwroot** directory.\n3. Add the line `\"functionTimeout\": \"00:10:00\",` above the `managedDependancy` line \n4. Ensure **SAVED** appears on the top right corner of the editor, then exit the editor.\n\n> NOTE: If a longer timeout duration is required, consider upgrading to an [App Service Plan](https://docs.microsoft.com/azure/azure-functions/functions-scale#timeout)" + } + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "name": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "etag": "\"1a00b074-0000-0100-0000-606ef5bd0000\"", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "GenericUI", + "properties": { + "connectorUiConfig": { + "title": "Qualys Vulnerability Management (CCP DEMO)", + "publisher": "Qualys", + "descriptionMarkdown": "The [Qualys Vulnerability Management (VM)](https://www.qualys.com/apps/vulnerability-management/) data connector provides the capability to ingest vulnerability host detection data into Azure Sentinel through the Qualys API. The connector provides visibility into host detection data from vulerability scans. This connector provides Azure Sentinel the capability to view dashboards, create custom alerts, and improve investigation ", + "graphQueriesTableName": "QualysHostDetection_CL", + "graphQueries": [ + { + "metricName": "Total data received", + "legend": "{{graphQueriesTableName}}", + "baseQuery": "{{graphQueriesTableName}}" + } + ], + "sampleQueries": [ + { + "description": "Top 10 Vulerabilities detected", + "query": "{{graphQueriesTableName}}\n | mv-expand todynamic(Detections_s)\n | extend Vulnerability = tostring(Detections_s.Results)\n | summarize count() by Vulnerability\n | top 10 by count_" + } + ], + "dataTypes": [ + { + "name": "{{graphQueriesTableName}}", + "lastDataReceivedQuery": "{{graphQueriesTableName}}\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "IsConnectedQuery", + "value": [ + "{{graphQueriesTableName}}\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)" + ] + } + ], + "availability": { + "status": 1, + "isPreview": true + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions on the workspace are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": true, + "delete": true + } + }, + { + "provider": "Microsoft.OperationalInsights/workspaces/sharedKeys", + "permissionsDisplayText": "read permissions to shared keys for the workspace are required. [See the documentation to learn more about workspace keys](https://docs.microsoft.com/azure/azure-monitor/platform/agent-windows#obtain-workspace-id-and-key).", + "providerDisplayName": "Keys", + "scope": "Workspace", + "requiredPermissions": { + "action": true + } + } + ], + "customs": [ + { + "name": "Microsoft.Web/sites permissions", + "description": "Read and write permissions to Azure Functions to create a Function App is required. [See the documentation to learn more about Azure Functions](https://docs.microsoft.com/azure/azure-functions/)." + }, + { + "name": "Qualys API Key", + "description": "A Qualys VM API username and password is required. [See the documentation to learn more about Qualys VM API](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf)." + } + ] + }, + "instructionSteps": [ + { + "title": "", + "description": ">**NOTE:** This connector uses Azure Functions to connect to Qualys VM to pull its logs into Azure Sentinel. This might result in additional data ingestion costs. Check the [Azure Functions pricing page](https://azure.microsoft.com/pricing/details/functions/) for details." + }, + { + "title": "", + "description": ">**(Optional Step)** Securely store workspace and API authorization key(s) or token(s) in Azure Key Vault. Azure Key Vault provides a secure mechanism to store and retrieve key values. [Follow these instructions](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) to use Azure Key Vault with an Azure Function App." + }, + { + "title": "", + "description": "**STEP 1 - Configuration steps for the Qualys VM API**\n\n1. Log into the Qualys Vulnerability Management console with an administrator account, select the **Users** tab and the **Users** subtab. \n2. Click on the **New** drop-down menu and select **Users..**\n3. Create a username and password for the API account. \n4. In the **User Roles** tab, ensure the account role is set to **Manager** and access is allowed to **GUI** and **API**\n4. Log out of the administrator account and log into the console with the new API credentials for validation, then log out of the API account. \n5. Log back into the console using an administrator account and modify the API accounts User Roles, removing access to **GUI**. \n6. Save all changes." + }, + { + "title": "", + "description": "**STEP 2 - Choose ONE from the following two deployment options to deploy the connector and the associated Azure Function**\n\n>**IMPORTANT:** Before deploying the Qualys VM connector, have the Workspace ID and Workspace Primary Key (can be copied from the following), as well as the Qualys VM API Authorization Key(s), readily available.", + "instructions": [ + { + "parameters": { + "fillWith": [ + "WorkspaceId" + ], + "label": "Workspace ID" + }, + "type": "CopyableLabel" + }, + { + "parameters": { + "fillWith": [ + "PrimaryKey" + ], + "label": "Primary Key" + }, + "type": "CopyableLabel" + } + ] + }, + { + "title": "Option 1 - Azure Resource Manager (ARM) Template", + "description": "Use this method for automated deployment of the Qualys VM connector using an ARM Tempate.\n\n1. Click the **Deploy to Azure** button below. \n\n\t[![Deploy To Azure](https://aka.ms/deploytoazurebutton)](https://aka.ms/sentinelqualysvmazuredeploy)\n2. Select the preferred **Subscription**, **Resource Group** and **Location**. \n3. Enter the **Workspace ID**, **Workspace Key**, **API Username**, **API Password** , update the **URI**, and any additional URI **Filter Parameters** (each filter should be separated by an \"&\" symbol, no spaces.) \n> - Enter the URI that corresponds to your region. The complete list of API Server URLs can be [found here](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf#G4.735348) -- There is no need to add a time suffix to the URI, the Function App will dynamically append the Time Value to the URI in the proper format. \n - The default **Time Interval** is set to pull the last five (5) minutes of data. If the time interval needs to be modified, it is recommended to change the Function App Timer Trigger accordingly (in the function.json file, post deployment) to prevent overlapping data ingestion. \n> - Note: If using Azure Key Vault secrets for any of the values above, use the`@Microsoft.KeyVault(SecretUri={Security Identifier})`schema in place of the string values. Refer to [Key Vault references documentation](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) for further details. \n4. Mark the checkbox labeled **I agree to the terms and conditions stated above**. \n5. Click **Purchase** to deploy." + }, + { + "title": "Option 2 - Manual Deployment of Azure Functions", + "description": "Use the following step-by-step instructions to deploy the Quayls VM connector manually with Azure Functions." + }, + { + "title": "", + "description": "**1. Create a Function App**\n\n1. From the Azure Portal, navigate to [Function App](https://portal.azure.com/#blade/HubsExtension/BrowseResource/resourceType/Microsoft.Web%2Fsites/kind/functionapp), and select **+ Add**.\n2. In the **Basics** tab, ensure Runtime stack is set to **Powershell Core**. \n3. In the **Hosting** tab, ensure the **Consumption (Serverless)** plan type is selected.\n4. Make other preferrable configuration changes, if needed, then click **Create**." + }, + { + "title": "", + "description": "**2. Import Function App Code**\n\n1. In the newly created Function App, select **Functions** on the left pane and click **+ New Function**.\n2. Select **Timer Trigger**.\n3. Enter a unique Function **Name** and leave the default cron schedule of every 5 minutes, then click **Create**.\n5. Click on **Code + Test** on the left pane. \n6. Copy the [Function App Code](https://aka.ms/sentinelqualysvmazurefunctioncode) and paste into the Function App `run.ps1` editor.\n7. Click **Save**." + }, + { + "title": "", + "description": "**3. Configure the Function App**\n\n1. In the Function App, select the Function App Name and select **Configuration**.\n2. In the **Application settings** tab, select **+ New application setting**.\n3. Add each of the following seven (7) application settings individually, with their respective string values (case-sensitive): \n\t\tapiUsername\n\t\tapiPassword\n\t\tworkspaceID\n\t\tworkspaceKey\n\t\turi\n\t\tfilterParameters\n\t\ttimeInterval\n> - Enter the URI that corresponds to your region. The complete list of API Server URLs can be [found here](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf#G4.735348). The `uri` value must follow the following schema: `https:///api/2.0/fo/asset/host/vm/detection/?action=list&vm_processed_after=` -- There is no need to add a time suffix to the URI, the Function App will dynamically append the Time Value to the URI in the proper format.\n> - Add any additional filter parameters, for the `filterParameters` variable, that need to be appended to the URI. Each parameter should be seperated by an \"&\" symbol and should not include any spaces.\n> - Set the `timeInterval` (in minutes) to the value of `5` to correspond to the Timer Trigger of every `5` minutes. If the time interval needs to be modified, it is recommended to change the Function App Timer Trigger accordingly to prevent overlapping data ingestion.\n> - Note: If using Azure Key Vault, use the`@Microsoft.KeyVault(SecretUri={Security Identifier})`schema in place of the string values. Refer to [Key Vault references documentation](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) for further details.\n4. Once all application settings have been entered, click **Save**." + }, + { + "title": "", + "description": "**4. Configure the host.json**.\n\nDue to the potentially large amount of Qualys host detection data being ingested, it can cause the execution time to surpass the default Function App timeout of five (5) minutes. Increase the default timeout duration to the maximum of ten (10) minutes, under the Consumption Plan, to allow more time for the Function App to execute.\n\n1. In the Function App, select the Function App Name and select the **App Service Editor** blade.\n2. Click **Go** to open the editor, then select the **host.json** file under the **wwwroot** directory.\n3. Add the line `\"functionTimeout\": \"00:10:00\",` above the `managedDependancy` line \n4. Ensure **SAVED** appears on the top right corner of the editor, then exit the editor.\n\n> NOTE: If a longer timeout duration is required, consider upgrading to an [App Service Plan](https://docs.microsoft.com/azure/azure-functions/functions-scale#timeout)" + } + ] + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateGoogleCloudPlatform.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateGoogleCloudPlatform.json new file mode 100644 index 000000000000..408a31ac3b15 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateGoogleCloudPlatform.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "GCP_fce27b90-d6f5-4d30-991a-af509a2b50a1", + "dataConnector": { + "kind": "GCP", + "properties": { + "connectorDefinitionName": "GcpConnector", + "auth": { + "serviceAccountEmail": "sentinel-service-account@project-id.iam.gserviceaccount.com", + "projectNumber": "123456789012", + "workloadIdentityProviderId": "sentinel-identity-provider", + "type": "GCP" + }, + "request": { + "projectId": "project-id", + "subscriptionNames": [ + "sentinel-subscription" + ] + }, + "dcrConfig": { + "dataCollectionEndpoint": "https://microsoft-sentinel-datacollectionendpoint-123m.westeurope-1.ingest.monitor.azure.com", + "dataCollectionRuleImmutableId": "dcr-de21b053bd5a44beb99a256c9db85023", + "streamName": "SENTINEL_GCP_AUDIT_LOGS" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/GCP_afef3743-0c88-469c-84ff-ca2e87dc1e48", + "name": "GCP_fce27b90-d6f5-4d30-991a-af509a2b50a1", + "type": "Microsoft.SecurityInsights/dataConnectors", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "kind": "GCP", + "properties": { + "connectorDefinitionName": "GcpConnector", + "auth": { + "serviceAccountEmail": "sentinel-service-account@project-id.iam.gserviceaccount.com", + "projectNumber": "123456789012", + "workloadIdentityProviderId": "sentinel-identity-provider", + "type": "GCP" + }, + "request": { + "projectId": "project-id", + "subscriptionNames": [ + "sentinel-subscription" + ] + }, + "dcrConfig": { + "dataCollectionEndpoint": "https://microsoft-sentinel-datacollectionendpoint-123m.westeurope-1.ingest.monitor.azure.com", + "dataCollectionRuleImmutableId": "dcr-de21b053bd5a44beb99a256c9db85023", + "streamName": "SENTINEL_GCP_AUDIT_LOGS" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/GCP_afef3743-0c88-469c-84ff-ca2e87dc1e48", + "name": "GCP_fce27b90-d6f5-4d30-991a-af509a2b50a1", + "type": "Microsoft.SecurityInsights/dataConnectors", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "kind": "GCP", + "properties": { + "connectorDefinitionName": "GcpConnector", + "auth": { + "serviceAccountEmail": "sentinel-service-account@project-id.iam.gserviceaccount.com", + "projectNumber": "123456789012", + "workloadIdentityProviderId": "sentinel-identity-provider", + "type": "GCP" + }, + "request": { + "projectId": "project-id", + "subscriptionNames": [ + "sentinel-subscription" + ] + }, + "dcrConfig": { + "dataCollectionEndpoint": "https://microsoft-sentinel-datacollectionendpoint-123m.westeurope-1.ingest.monitor.azure.com", + "dataCollectionRuleImmutableId": "dcr-de21b053bd5a44beb99a256c9db85023", + "streamName": "SENTINEL_GCP_AUDIT_LOGS" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateMicrosoftPurviewInformationProtectionDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateMicrosoftPurviewInformationProtectionDataConnetor.json new file mode 100644 index 000000000000..ad66092fc824 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateMicrosoftPurviewInformationProtectionDataConnetor.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "dataConnector": { + "kind": "MicrosoftPurviewInformationProtection", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "MicrosoftPurviewInformationProtection", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "MicrosoftPurviewInformationProtection", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateMicrosoftThreatIntelligenceDataConnector.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateMicrosoftThreatIntelligenceDataConnector.json new file mode 100644 index 000000000000..1a0f89f9cedd --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateMicrosoftThreatIntelligenceDataConnector.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "c345bf40-8509-4ed2-b947-50cb773aaf04", + "dataConnector": { + "kind": "MicrosoftThreatIntelligence", + "properties": { + "tenantId": "06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "dataTypes": { + "microsoftEmergingThreatFeed": { + "state": "Enabled", + "lookbackPeriod": "1970-01-01T00:00:00.000Z" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/c345bf40-8509-4ed2-b947-50cb773aaf04", + "name": "c345bf40-8509-4ed2-b947-50cb773aaf04", + "type": "Microsoft.SecurityInsights/dataConnectors", + "etag": "d12423f6-a60b-4ca5-88c0-feb1a182d0f0", + "kind": "MicrosoftThreatIntelligence", + "properties": { + "tenantId": "06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "dataTypes": { + "microsoftEmergingThreatFeed": { + "state": "Enabled", + "lookbackPeriod": "01/01/1970 00:00:00" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/c345bf40-8509-4ed2-b947-50cb773aaf04", + "name": "c345bf40-8509-4ed2-b947-50cb773aaf04", + "type": "Microsoft.SecurityInsights/dataConnectors", + "etag": "d12423f6-a60b-4ca5-88c0-feb1a182d0f0", + "kind": "MicrosoftThreatIntelligence", + "properties": { + "tenantId": "06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "dataTypes": { + "microsoftEmergingThreatFeed": { + "state": "Enabled", + "lookbackPeriod": "01/01/1970 00:00:00" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateMicrosoftThreatProtectionDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateMicrosoftThreatProtectionDataConnetor.json new file mode 100644 index 000000000000..b712a36e5804 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateMicrosoftThreatProtectionDataConnetor.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "dataConnector": { + "kind": "MicrosoftThreatProtection", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "178265c4-3136-4ff6-8ed1-b5b62b4cb5f5", + "dataTypes": { + "incidents": { + "state": "Disabled" + }, + "alerts": { + "state": "Enabled" + } + }, + "filteredProviders": { + "alerts": [ + "microsoftDefenderForCloudApps" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/595c870a-5b74-4a23-984c-9ddba29cefe3", + "name": "595c870a-5b74-4a23-984c-9ddba29cefe3", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "MicrosoftThreatProtection", + "etag": "2b61bd0c-62b4-4968-8f9a-71b91be61127", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "incidents": { + "state": "Disabled55" + }, + "alerts": { + "state": "Enabled" + } + }, + "filteredProviders": { + "alerts": [ + "microsoftDefenderForCloudApps" + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/595c870a-5b74-4a23-984c-9ddba29cefe3", + "name": "595c870a-5b74-4a23-984c-9ddba29cefe3", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "MicrosoftThreatProtection", + "etag": "2b61bd0c-62b4-4968-8f9a-71b91be61127", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "incidents": { + "state": "Disabled" + }, + "alerts": { + "state": "Enabled" + } + }, + "filteredProviders": { + "alerts": [ + "microsoftDefenderForCloudApps" + ] + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateOffice365ProjectDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateOffice365ProjectDataConnetor.json new file mode 100644 index 000000000000..f0c575663f11 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateOffice365ProjectDataConnetor.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "dataConnector": { + "kind": "Office365Project", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Office365Project", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Office365Project", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateOfficeDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateOfficeDataConnetor.json new file mode 100644 index 000000000000..64abe328282b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateOfficeDataConnetor.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "dataConnector": { + "kind": "Office365", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "sharePoint": { + "state": "Enabled" + }, + "exchange": { + "state": "Enabled" + }, + "teams": { + "state": "Enabled" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/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": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "sharePoint": { + "state": "Enabled" + }, + "exchange": { + "state": "Enabled" + }, + "teams": { + "state": "Enabled" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/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": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "sharePoint": { + "state": "Enabled" + }, + "exchange": { + "state": "Enabled" + }, + "teams": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateOfficePowerBIDataConnector.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateOfficePowerBIDataConnector.json new file mode 100644 index 000000000000..56814382a560 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateOfficePowerBIDataConnector.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "dataConnector": { + "kind": "OfficePowerBI", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "OfficePowerBI", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "OfficePowerBI", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateThreatIntelligenceDataConnector.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateThreatIntelligenceDataConnector.json new file mode 100644 index 000000000000..95f693e73f90 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateThreatIntelligenceDataConnector.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "dataConnector": { + "kind": "ThreatIntelligence", + "properties": { + "tenantId": "06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "tipLookbackPeriod": "2020-01-01T13:00:30.123Z", + "dataTypes": { + "indicators": { + "state": "Enabled" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "ThreatIntelligence", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "tipLookbackPeriod": "2020-01-01T13:00:30.123Z", + "dataTypes": { + "indicators": { + "state": "Enabled" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "ThreatIntelligence", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "tipLookbackPeriod": "2020-01-01T13:00:30.123Z", + "dataTypes": { + "indicators": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateThreatIntelligenceTaxiiDataConnector.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateThreatIntelligenceTaxiiDataConnector.json new file mode 100644 index 000000000000..08108c906137 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/CreateThreatIntelligenceTaxiiDataConnector.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "dataConnector": { + "etag": "d12423f6-a60b-4ca5-88c0-feb1a182d0f0", + "kind": "ThreatIntelligenceTaxii", + "properties": { + "tenantId": "06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "taxiiServer": "https://limo.anomali.com/api/v1/taxii2/feeds", + "collectionId": "135", + "workspaceId": "dd124572-4962-4495-9bd2-9dade12314b4", + "friendlyName": "testTaxii", + "userName": "--", + "password": "--", + "taxiiLookbackPeriod": "2020-01-01T13:00:30.123Z", + "pollingFrequency": "OnceADay", + "dataTypes": { + "taxiiClient": { + "state": "Enabled" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "etag": "d12423f6-a60b-4ca5-88c0-feb1a182d0f0", + "kind": "ThreatIntelligenceTaxii", + "properties": { + "tenantId": "06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "taxiiServer": "https://limo.anomali.com/api/v1/taxii2/feeds", + "collectionId": "135", + "workspaceId": "28e5f051-34cb-4208-9037-693e5342a871", + "friendlyName": "testTaxii", + "userName": null, + "password": null, + "taxiiLookbackPeriod": "2020-01-01T13:00:30.123Z", + "pollingFrequency": "OnceADay", + "dataTypes": { + "taxiiClient": { + "state": "Enabled" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "etag": "d12423f6-a60b-4ca5-88c0-feb1a182d0f0", + "kind": "ThreatIntelligenceTaxii", + "properties": { + "tenantId": "06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "taxiiServer": "https://limo.anomali.com/api/v1/taxii2/feeds", + "collectionId": "135", + "workspaceId": "28e5f051-34cb-4208-9037-693e5342a871", + "friendlyName": "testTaxii", + "userName": null, + "password": null, + "taxiiLookbackPeriod": "2020-01-01T13:00:30.123Z", + "pollingFrequency": "OnceADay", + "dataTypes": { + "taxiiClient": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteAPIPolling.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteAPIPolling.json new file mode 100644 index 000000000000..7a6f573393b2 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteAPIPolling.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "316ec55e-7138-4d63-ab18-90c8a60fd1c8" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteGenericUI.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteGenericUI.json new file mode 100644 index 000000000000..7a6f573393b2 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteGenericUI.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "316ec55e-7138-4d63-ab18-90c8a60fd1c8" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteGoogleCloudPlatform.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteGoogleCloudPlatform.json new file mode 100644 index 000000000000..d5fb06db27a8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteGoogleCloudPlatform.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "GCP_fce27b90-d6f5-4d30-991a-af509a2b50a1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteMicrosoftPurviewInformationProtectionDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteMicrosoftPurviewInformationProtectionDataConnetor.json new file mode 100644 index 000000000000..b291642fb40e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteMicrosoftPurviewInformationProtectionDataConnetor.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteMicrosoftThreatIntelligenceDataConnector.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteMicrosoftThreatIntelligenceDataConnector.json new file mode 100644 index 000000000000..8aeb320c6fac --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteMicrosoftThreatIntelligenceDataConnector.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "c345bf40-8509-4ed2-b947-50cb773aaf04" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteOffice365ProjectDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteOffice365ProjectDataConnetor.json new file mode 100644 index 000000000000..b291642fb40e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteOffice365ProjectDataConnetor.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteOfficeDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteOfficeDataConnetor.json new file mode 100644 index 000000000000..b291642fb40e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteOfficeDataConnetor.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteOfficePowerBIDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteOfficePowerBIDataConnetor.json new file mode 100644 index 000000000000..b291642fb40e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DeleteOfficePowerBIDataConnetor.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DisconnectAPIPolling.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DisconnectAPIPolling.json new file mode 100644 index 000000000000..68b110f7f5e8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/DisconnectAPIPolling.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "disconnectBody": {} + }, + "responses": { + "200": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetAPIPolling.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetAPIPolling.json new file mode 100644 index 000000000000..03e77586e7c9 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetAPIPolling.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "316ec55e-7138-4d63-ab18-90c8a60fd1c8" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "name": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "etag": "\"1a00b074-0000-0100-0000-606ef5bd0000\"", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "APIPolling", + "properties": { + "connectorUiConfig": { + "title": "GitHub Enterprise Audit Log", + "publisher": "GitHub", + "descriptionMarkdown": "The GitHub audit log connector provides the capability to ingest GitHub logs into Azure Sentinel. By connecting GitHub audit logs into Azure Sentinel, you can view this data in workbooks, use it to create custom alerts, and improve your investigation process.", + "customImage": "The image connector content", + "graphQueriesTableName": "GitHubAuditLogPolling_CL", + "graphQueries": [ + { + "metricName": "Total events received", + "legend": "GitHub audit log events", + "baseQuery": "{{graphQueriesTableName}}" + } + ], + "sampleQueries": [ + { + "description": "All logs", + "query": "{{graphQueriesTableName}}\n | take 10 " + } + ], + "dataTypes": [ + { + "name": "{{graphQueriesTableName}}", + "lastDataReceivedQuery": "{{graphQueriesTableName}}\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "SentinelKindsV2", + "value": [] + } + ], + "availability": { + "status": 1, + "isPreview": true + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": true, + "delete": true + } + } + ], + "customs": [ + { + "name": "GitHub API personal token Key", + "description": "You need access to GitHub personal token, the key should have 'admin:org' scope" + } + ] + }, + "instructionSteps": [ + { + "title": "Connect GitHub Enterprise Audit Log to Azure Sentinel", + "description": "Enable GitHub audit Logs. \n Follow [this](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create or find your personal key", + "instructions": [ + { + "parameters": { + "enable": "true", + "userRequestPlaceHoldersInput": [ + { + "displayText": "Organization Name", + "requestObjectKey": "apiEndpoint", + "placeHolderName": "{{placeHolder1}}", + "placeHolderValue": "" + } + ] + }, + "type": "APIKey" + } + ] + } + ] + }, + "pollingConfig": { + "auth": { + "authType": "APIKey", + "apiKeyIdentifier": "token", + "apiKeyName": "Authorization" + }, + "request": { + "apiEndpoint": "https://api.github.com/organizations/{{placeHolder1}}/audit-log", + "rateLimitQps": 50, + "queryWindowInMin": 15, + "httpMethod": "Get", + "queryTimeFormat": "yyyy-MM-ddTHH:mm:ssZ", + "retryCount": 2, + "timeoutInSeconds": 60, + "headers": { + "Accept": "application/json", + "User-Agent": "Scuba" + }, + "queryParameters": { + "phrase": "created:{_QueryWindowStartTime}..{_QueryWindowEndTime}" + } + }, + "paging": { + "pagingType": "LinkHeader", + "pageSizeParaName": "per_page" + }, + "response": { + "eventsJsonPaths": [ + "$" + ] + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetAmazonWebServicesCloudTrailById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetAmazonWebServicesCloudTrailById.json new file mode 100644 index 000000000000..c12e7bf8154b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetAmazonWebServicesCloudTrailById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "c345bf40-8509-4ed2-b947-50cb773aaf04" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/c345bf40-8509-4ed2-b947-50cb773aaf04", + "name": "c345bf40-8509-4ed2-b947-50cb773aaf04", + "type": "Microsoft.SecurityInsights/dataConnectors", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "kind": "AmazonWebServicesCloudTrail", + "properties": { + "awsRoleArn": "myAwsRoleArn", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetAmazonWebServicesS3ById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetAmazonWebServicesS3ById.json new file mode 100644 index 000000000000..315aebebf762 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetAmazonWebServicesS3ById.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "afef3743-0c88-469c-84ff-ca2e87dc1e48" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/afef3743-0c88-469c-84ff-ca2e87dc1e48", + "name": "afef3743-0c88-469c-84ff-ca2e87dc1e48", + "type": "Microsoft.SecurityInsights/dataConnectors", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "kind": "AmazonWebServicesS3", + "properties": { + "destinationTable": "AWSVPCFlow", + "roleArn": "arn:aws:iam::072643944673:role/RoleName", + "sqsUrls": [ + "https://sqs.us-west-1.amazonaws.com/111111111111/sqsTestName" + ], + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetAzureActiveDirectoryById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetAzureActiveDirectoryById.json new file mode 100644 index 000000000000..610035dc7776 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetAzureActiveDirectoryById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "f0cd27d2-5f03-4c06-ba31-d2dc82dcb51d" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/f0cd27d2-5f03-4c06-ba31-d2dc82dcb51d", + "name": "f0cd27d2-5f03-4c06-ba31-d2dc82dcb51d", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "AzureActiveDirectory", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetAzureAdvancedThreatProtectionById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetAzureAdvancedThreatProtectionById.json new file mode 100644 index 000000000000..23dd3d93d22b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetAzureAdvancedThreatProtectionById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "07e42cb3-e658-4e90-801c-efa0f29d3d44" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/07e42cb3-e658-4e90-801c-efa0f29d3d44", + "name": "07e42cb3-e658-4e90-801c-efa0f29d3d44", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "AzureAdvancedThreatProtection", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetAzureSecurityCenterById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetAzureSecurityCenterById.json new file mode 100644 index 000000000000..3c603f06e64c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetAzureSecurityCenterById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "763f9fa1-c2d3-4fa2-93e9-bccd4899aa12" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/763f9fa1-c2d3-4fa2-93e9-bccd4899aa12", + "name": "763f9fa1-c2d3-4fa2-93e9-bccd4899aa12", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "AzureSecurityCenter", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "subscriptionId": "c0688291-89d7-4bed-87a2-a7b1bff43f4c", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetDataConnectors.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetDataConnectors.json new file mode 100644 index 000000000000..9abe01ea8668 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetDataConnectors.json @@ -0,0 +1,508 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/763f9fa1-c2d3-4fa2-93e9-bccd4899aa12", + "name": "763f9fa1-c2d3-4fa2-93e9-bccd4899aa12", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "AzureSecurityCenter", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/c345bf40-8509-4ed2-b947-50cb773aaf04", + "name": "c345bf40-8509-4ed2-b947-50cb773aaf04", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "ThreatIntelligence", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "indicators": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/c39bb458-02a7-4b3f-b0c8-71a1d2692652", + "name": "c39bb458-02a7-4b3f-b0c8-71a1d2692652", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "ThreatIntelligenceTaxii", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "workspaceId": "8b014a77-4695-4ef4-96bb-6623afb121a2", + "friendlyName": "My TI Taxii Connector", + "taxiiServer": "https://mytaxiiserver.com/taxiing/v2/api", + "collectionId": "e0b1f32d-1188-48f7-a7a3-de71924e4b5e", + "userName": "", + "password": "", + "pollingFrequency": "OnceAMinute", + "dataTypes": { + "taxiiClient": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/f0cd27d2-5f03-4c06-ba31-d2dc82dcb51d", + "name": "f0cd27d2-5f03-4c06-ba31-d2dc82dcb51d", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "AzureActiveDirectory", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/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": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "sharePoint": { + "state": "Enabled" + }, + "exchange": { + "state": "Enabled" + }, + "teams": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/b96d014d-b5c2-4a01-9aba-a8058f629d42", + "name": "b96d014d-b5c2-4a01-9aba-a8058f629d42", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "MicrosoftCloudAppSecurity", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + }, + "discoveryLogs": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/07e42cb3-e658-4e90-801c-efa0f29d3d44", + "name": "07e42cb3-e658-4e90-801c-efa0f29d3d44", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "AzureAdvancedThreatProtection", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/c345bf40-8509-4ed2-b947-50cb773aaf04", + "name": "c345bf40-8509-4ed2-b947-50cb773aaf04", + "type": "Microsoft.SecurityInsights/dataConnectors", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "kind": "AmazonWebServicesCloudTrail", + "properties": { + "awsRoleArn": "myAwsRoleArn", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/afef3743-0c88-469c-84ff-ca2e87dc1e48", + "name": "afef3743-0c88-469c-84ff-ca2e87dc1e48", + "type": "Microsoft.SecurityInsights/dataConnectors", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "kind": "AmazonWebServicesS3", + "properties": { + "destinationTable": "AWSVPCFlow", + "roleArn": "arn:aws:iam::072643944673:role/RoleName", + "sqsUrls": [ + "https://sqs.us-west-1.amazonaws.com/111111111111/sqsTestName" + ], + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "name": "06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "MicrosoftDefenderAdvancedThreatProtection", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/3d3e955e-33eb-401d-89a7-251c81ddd660", + "name": "3d3e955e-33eb-401d-89a7-251c81ddd660", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "OfficeATP", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/3d3e955e-33eb-401d-89a7-251c81ddd660", + "name": "3d3e955e-33eb-401d-89a7-251c81ddd660", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Office365Project", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/3d3e955e-33eb-401d-89a7-251c81ddd660", + "name": "3d3e955e-33eb-401d-89a7-251c81ddd660", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "OfficePowerBI", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/3d3e955e-33eb-401d-89a7-251c81ddd660", + "name": "c2541efb-c9a6-47fe-9501-87d1017d1512", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Dynamics365", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "dynamics365CdsActivities": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "name": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "etag": "\"1a00b074-0000-0100-0000-606ef5bd0000\"", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "GenericUI", + "properties": { + "connectorUiConfig": { + "title": "Qualys Vulnerability Management (CCP DEMO)", + "publisher": "Qualys", + "descriptionMarkdown": "The [Qualys Vulnerability Management (VM)](https://www.qualys.com/apps/vulnerability-management/) data connector provides the capability to ingest vulnerability host detection data into Azure Sentinel through the Qualys API. The connector provides visibility into host detection data from vulerability scans. This connector provides Azure Sentinel the capability to view dashboards, create custom alerts, and improve investigation ", + "customImage": "The image connector content", + "graphQueriesTableName": "QualysHostDetection_CL", + "graphQueries": [ + { + "metricName": "Total data received", + "legend": "{{graphQueriesTableName}}", + "baseQuery": "{{graphQueriesTableName}}" + } + ], + "sampleQueries": [ + { + "description": "Top 10 Vulerabilities detected", + "query": "{{graphQueriesTableName}}\n | mv-expand todynamic(Detections_s)\n | extend Vulnerability = tostring(Detections_s.Results)\n | summarize count() by Vulnerability\n | top 10 by count_" + } + ], + "dataTypes": [ + { + "name": "{{graphQueriesTableName}}", + "lastDataReceivedQuery": "{{graphQueriesTableName}}\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "IsConnectedQuery", + "value": [ + "{{graphQueriesTableName}}\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)" + ] + } + ], + "availability": { + "status": 1, + "isPreview": true + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions on the workspace are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": true, + "delete": true + } + }, + { + "provider": "Microsoft.OperationalInsights/workspaces/sharedKeys", + "permissionsDisplayText": "read permissions to shared keys for the workspace are required. [See the documentation to learn more about workspace keys](https://docs.microsoft.com/azure/azure-monitor/platform/agent-windows#obtain-workspace-id-and-key).", + "providerDisplayName": "Keys", + "scope": "Workspace", + "requiredPermissions": { + "action": true + } + } + ], + "customs": [ + { + "name": "Microsoft.Web/sites permissions", + "description": "Read and write permissions to Azure Functions to create a Function App is required. [See the documentation to learn more about Azure Functions](https://docs.microsoft.com/azure/azure-functions/)." + }, + { + "name": "Qualys API Key", + "description": "A Qualys VM API username and password is required. [See the documentation to learn more about Qualys VM API](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf)." + } + ] + }, + "instructionSteps": [ + { + "title": "", + "description": ">**NOTE:** This connector uses Azure Functions to connect to Qualys VM to pull its logs into Azure Sentinel. This might result in additional data ingestion costs. Check the [Azure Functions pricing page](https://azure.microsoft.com/pricing/details/functions/) for details." + }, + { + "title": "", + "description": ">**(Optional Step)** Securely store workspace and API authorization key(s) or token(s) in Azure Key Vault. Azure Key Vault provides a secure mechanism to store and retrieve key values. [Follow these instructions](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) to use Azure Key Vault with an Azure Function App." + }, + { + "title": "", + "description": "**STEP 1 - Configuration steps for the Qualys VM API**\n\n1. Log into the Qualys Vulnerability Management console with an administrator account, select the **Users** tab and the **Users** subtab. \n2. Click on the **New** drop-down menu and select **Users..**\n3. Create a username and password for the API account. \n4. In the **User Roles** tab, ensure the account role is set to **Manager** and access is allowed to **GUI** and **API**\n4. Log out of the administrator account and log into the console with the new API credentials for validation, then log out of the API account. \n5. Log back into the console using an administrator account and modify the API accounts User Roles, removing access to **GUI**. \n6. Save all changes." + }, + { + "title": "", + "description": "**STEP 2 - Choose ONE from the following two deployment options to deploy the connector and the associated Azure Function**\n\n>**IMPORTANT:** Before deploying the Qualys VM connector, have the Workspace ID and Workspace Primary Key (can be copied from the following), as well as the Qualys VM API Authorization Key(s), readily available.", + "instructions": [ + { + "parameters": { + "fillWith": [ + "WorkspaceId" + ], + "label": "Workspace ID" + }, + "type": "CopyableLabel" + }, + { + "parameters": { + "fillWith": [ + "PrimaryKey" + ], + "label": "Primary Key" + }, + "type": "CopyableLabel" + } + ] + }, + { + "title": "Option 1 - Azure Resource Manager (ARM) Template", + "description": "Use this method for automated deployment of the Qualys VM connector using an ARM Tempate.\n\n1. Click the **Deploy to Azure** button below. \n\n\t[![Deploy To Azure](https://aka.ms/deploytoazurebutton)](https://aka.ms/sentinelqualysvmazuredeploy)\n2. Select the preferred **Subscription**, **Resource Group** and **Location**. \n3. Enter the **Workspace ID**, **Workspace Key**, **API Username**, **API Password** , update the **URI**, and any additional URI **Filter Parameters** (each filter should be separated by an \"&\" symbol, no spaces.) \n> - Enter the URI that corresponds to your region. The complete list of API Server URLs can be [found here](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf#G4.735348) -- There is no need to add a time suffix to the URI, the Function App will dynamically append the Time Value to the URI in the proper format. \n - The default **Time Interval** is set to pull the last five (5) minutes of data. If the time interval needs to be modified, it is recommended to change the Function App Timer Trigger accordingly (in the function.json file, post deployment) to prevent overlapping data ingestion. \n> - Note: If using Azure Key Vault secrets for any of the values above, use the`@Microsoft.KeyVault(SecretUri={Security Identifier})`schema in place of the string values. Refer to [Key Vault references documentation](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) for further details. \n4. Mark the checkbox labeled **I agree to the terms and conditions stated above**. \n5. Click **Purchase** to deploy." + }, + { + "title": "Option 2 - Manual Deployment of Azure Functions", + "description": "Use the following step-by-step instructions to deploy the Quayls VM connector manually with Azure Functions." + }, + { + "title": "", + "description": "**1. Create a Function App**\n\n1. From the Azure Portal, navigate to [Function App](https://portal.azure.com/#blade/HubsExtension/BrowseResource/resourceType/Microsoft.Web%2Fsites/kind/functionapp), and select **+ Add**.\n2. In the **Basics** tab, ensure Runtime stack is set to **Powershell Core**. \n3. In the **Hosting** tab, ensure the **Consumption (Serverless)** plan type is selected.\n4. Make other preferrable configuration changes, if needed, then click **Create**." + }, + { + "title": "", + "description": "**2. Import Function App Code**\n\n1. In the newly created Function App, select **Functions** on the left pane and click **+ New Function**.\n2. Select **Timer Trigger**.\n3. Enter a unique Function **Name** and leave the default cron schedule of every 5 minutes, then click **Create**.\n5. Click on **Code + Test** on the left pane. \n6. Copy the [Function App Code](https://aka.ms/sentinelqualysvmazurefunctioncode) and paste into the Function App `run.ps1` editor.\n7. Click **Save**." + }, + { + "title": "", + "description": "**3. Configure the Function App**\n\n1. In the Function App, select the Function App Name and select **Configuration**.\n2. In the **Application settings** tab, select **+ New application setting**.\n3. Add each of the following seven (7) application settings individually, with their respective string values (case-sensitive): \n\t\tapiUsername\n\t\tapiPassword\n\t\tworkspaceID\n\t\tworkspaceKey\n\t\turi\n\t\tfilterParameters\n\t\ttimeInterval\n> - Enter the URI that corresponds to your region. The complete list of API Server URLs can be [found here](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf#G4.735348). The `uri` value must follow the following schema: `https:///api/2.0/fo/asset/host/vm/detection/?action=list&vm_processed_after=` -- There is no need to add a time suffix to the URI, the Function App will dynamically append the Time Value to the URI in the proper format.\n> - Add any additional filter parameters, for the `filterParameters` variable, that need to be appended to the URI. Each parameter should be seperated by an \"&\" symbol and should not include any spaces.\n> - Set the `timeInterval` (in minutes) to the value of `5` to correspond to the Timer Trigger of every `5` minutes. If the time interval needs to be modified, it is recommended to change the Function App Timer Trigger accordingly to prevent overlapping data ingestion.\n> - Note: If using Azure Key Vault, use the`@Microsoft.KeyVault(SecretUri={Security Identifier})`schema in place of the string values. Refer to [Key Vault references documentation](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) for further details.\n4. Once all application settings have been entered, click **Save**." + }, + { + "title": "", + "description": "**4. Configure the host.json**.\n\nDue to the potentially large amount of Qualys host detection data being ingested, it can cause the execution time to surpass the default Function App timeout of five (5) minutes. Increase the default timeout duration to the maximum of ten (10) minutes, under the Consumption Plan, to allow more time for the Function App to execute.\n\n1. In the Function App, select the Function App Name and select the **App Service Editor** blade.\n2. Click **Go** to open the editor, then select the **host.json** file under the **wwwroot** directory.\n3. Add the line `\"functionTimeout\": \"00:10:00\",` above the `managedDependancy` line \n4. Ensure **SAVED** appears on the top right corner of the editor, then exit the editor.\n\n> NOTE: If a longer timeout duration is required, consider upgrading to an [App Service Plan](https://docs.microsoft.com/azure/azure-functions/functions-scale#timeout)" + } + ] + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "name": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "etag": "\"1a00b074-0000-0100-0000-606ef5bd0000\"", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "APIPolling", + "properties": { + "connectorUiConfig": { + "title": "GitHub Enterprise Audit Log", + "publisher": "GitHub", + "descriptionMarkdown": "The GitHub audit log connector provides the capability to ingest GitHub logs into Azure Sentinel. By connecting GitHub audit logs into Azure Sentinel, you can view this data in workbooks, use it to create custom alerts, and improve your investigation process.", + "graphQueriesTableName": "GitHubAuditLogPolling_CL", + "graphQueries": [ + { + "metricName": "Total events received", + "legend": "GitHub audit log events", + "baseQuery": "{{graphQueriesTableName}}" + } + ], + "sampleQueries": [ + { + "description": "All logs", + "query": "{{graphQueriesTableName}}\n | take 10 " + } + ], + "dataTypes": [ + { + "name": "{{graphQueriesTableName}}", + "lastDataReceivedQuery": "{{graphQueriesTableName}}\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "SentinelKindsV2", + "value": [] + } + ], + "availability": { + "status": 1, + "isPreview": true + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": true, + "delete": true + } + } + ], + "customs": [ + { + "name": "GitHub API personal token Key", + "description": "You need access to GitHub personal token, the key should have 'admin:org' scope" + } + ] + }, + "instructionSteps": [ + { + "title": "Connect GitHub Enterprise Audit Log to Azure Sentinel", + "description": "Enable GitHub audit Logs. \n Follow [this](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create or find your personal key", + "instructions": [ + { + "parameters": { + "enable": "true", + "userRequestPlaceHoldersInput": [ + { + "displayText": "Organization Name", + "requestObjectKey": "apiEndpoint", + "placeHolderName": "{{placeHolder1}}", + "placeHolderValue": "" + } + ] + }, + "type": "APIKey" + } + ] + } + ] + }, + "pollingConfig": { + "auth": { + "authType": "APIKey", + "apiKeyIdentifier": "token", + "apiKeyName": "Authorization" + }, + "request": { + "apiEndpoint": "https://api.github.com/organizations/{{placeHolder1}}/audit-log", + "rateLimitQps": 50, + "queryWindowInMin": 15, + "httpMethod": "Get", + "queryTimeFormat": "yyyy-MM-ddTHH:mm:ssZ", + "retryCount": 2, + "timeoutInSeconds": 60, + "headers": { + "Accept": "application/json", + "User-Agent": "Scuba" + }, + "queryParameters": { + "phrase": "created:{_QueryWindowStartTime}..{_QueryWindowEndTime}" + } + }, + "paging": { + "pagingType": "LinkHeader", + "pageSizeParaName": "per_page" + }, + "response": { + "eventsJsonPaths": [ + "$" + ] + } + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetDynamics365DataConnectorById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetDynamics365DataConnectorById.json new file mode 100644 index 000000000000..aec2c740d0f6 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetDynamics365DataConnectorById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "c2541efb-c9a6-47fe-9501-87d1017d1512" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/3d3e955e-33eb-401d-89a7-251c81ddd660", + "name": "c2541efb-c9a6-47fe-9501-87d1017d1512", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Dynamics365", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "dynamics365CdsActivities": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetGenericUI.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetGenericUI.json new file mode 100644 index 000000000000..aff28328cfe8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetGenericUI.json @@ -0,0 +1,156 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "316ec55e-7138-4d63-ab18-90c8a60fd1c8" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "name": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "etag": "\"1a00b074-0000-0100-0000-606ef5bd0000\"", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "GenericUI", + "properties": { + "connectorUiConfig": { + "title": "Qualys Vulnerability Management (CCP DEMO)", + "publisher": "Qualys", + "descriptionMarkdown": "The [Qualys Vulnerability Management (VM)](https://www.qualys.com/apps/vulnerability-management/) data connector provides the capability to ingest vulnerability host detection data into Azure Sentinel through the Qualys API. The connector provides visibility into host detection data from vulerability scans. This connector provides Azure Sentinel the capability to view dashboards, create custom alerts, and improve investigation ", + "customImage": "The image connector content", + "graphQueriesTableName": "QualysHostDetection_CL", + "graphQueries": [ + { + "metricName": "Total data received", + "legend": "{{graphQueriesTableName}}", + "baseQuery": "{{graphQueriesTableName}}" + } + ], + "sampleQueries": [ + { + "description": "Top 10 Vulerabilities detected", + "query": "{{graphQueriesTableName}}\n | mv-expand todynamic(Detections_s)\n | extend Vulnerability = tostring(Detections_s.Results)\n | summarize count() by Vulnerability\n | top 10 by count_" + } + ], + "dataTypes": [ + { + "name": "{{graphQueriesTableName}}", + "lastDataReceivedQuery": "{{graphQueriesTableName}}\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "IsConnectedQuery", + "value": [ + "{{graphQueriesTableName}}\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)" + ] + } + ], + "availability": { + "status": 1, + "isPreview": true + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions on the workspace are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": true, + "delete": true + } + }, + { + "provider": "Microsoft.OperationalInsights/workspaces/sharedKeys", + "permissionsDisplayText": "read permissions to shared keys for the workspace are required. [See the documentation to learn more about workspace keys](https://docs.microsoft.com/azure/azure-monitor/platform/agent-windows#obtain-workspace-id-and-key).", + "providerDisplayName": "Keys", + "scope": "Workspace", + "requiredPermissions": { + "action": true + } + } + ], + "customs": [ + { + "name": "Microsoft.Web/sites permissions", + "description": "Read and write permissions to Azure Functions to create a Function App is required. [See the documentation to learn more about Azure Functions](https://docs.microsoft.com/azure/azure-functions/)." + }, + { + "name": "Qualys API Key", + "description": "A Qualys VM API username and password is required. [See the documentation to learn more about Qualys VM API](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf)." + } + ] + }, + "instructionSteps": [ + { + "title": "", + "description": ">**NOTE:** This connector uses Azure Functions to connect to Qualys VM to pull its logs into Azure Sentinel. This might result in additional data ingestion costs. Check the [Azure Functions pricing page](https://azure.microsoft.com/pricing/details/functions/) for details." + }, + { + "title": "", + "description": ">**(Optional Step)** Securely store workspace and API authorization key(s) or token(s) in Azure Key Vault. Azure Key Vault provides a secure mechanism to store and retrieve key values. [Follow these instructions](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) to use Azure Key Vault with an Azure Function App." + }, + { + "title": "", + "description": "**STEP 1 - Configuration steps for the Qualys VM API**\n\n1. Log into the Qualys Vulnerability Management console with an administrator account, select the **Users** tab and the **Users** subtab. \n2. Click on the **New** drop-down menu and select **Users..**\n3. Create a username and password for the API account. \n4. In the **User Roles** tab, ensure the account role is set to **Manager** and access is allowed to **GUI** and **API**\n4. Log out of the administrator account and log into the console with the new API credentials for validation, then log out of the API account. \n5. Log back into the console using an administrator account and modify the API accounts User Roles, removing access to **GUI**. \n6. Save all changes." + }, + { + "title": "", + "description": "**STEP 2 - Choose ONE from the following two deployment options to deploy the connector and the associated Azure Function**\n\n>**IMPORTANT:** Before deploying the Qualys VM connector, have the Workspace ID and Workspace Primary Key (can be copied from the following), as well as the Qualys VM API Authorization Key(s), readily available.", + "instructions": [ + { + "parameters": { + "fillWith": [ + "WorkspaceId" + ], + "label": "Workspace ID" + }, + "type": "CopyableLabel" + }, + { + "parameters": { + "fillWith": [ + "PrimaryKey" + ], + "label": "Primary Key" + }, + "type": "CopyableLabel" + } + ] + }, + { + "title": "Option 1 - Azure Resource Manager (ARM) Template", + "description": "Use this method for automated deployment of the Qualys VM connector using an ARM Tempate.\n\n1. Click the **Deploy to Azure** button below. \n\n\t[![Deploy To Azure](https://aka.ms/deploytoazurebutton)](https://aka.ms/sentinelqualysvmazuredeploy)\n2. Select the preferred **Subscription**, **Resource Group** and **Location**. \n3. Enter the **Workspace ID**, **Workspace Key**, **API Username**, **API Password** , update the **URI**, and any additional URI **Filter Parameters** (each filter should be separated by an \"&\" symbol, no spaces.) \n> - Enter the URI that corresponds to your region. The complete list of API Server URLs can be [found here](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf#G4.735348) -- There is no need to add a time suffix to the URI, the Function App will dynamically append the Time Value to the URI in the proper format. \n - The default **Time Interval** is set to pull the last five (5) minutes of data. If the time interval needs to be modified, it is recommended to change the Function App Timer Trigger accordingly (in the function.json file, post deployment) to prevent overlapping data ingestion. \n> - Note: If using Azure Key Vault secrets for any of the values above, use the`@Microsoft.KeyVault(SecretUri={Security Identifier})`schema in place of the string values. Refer to [Key Vault references documentation](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) for further details. \n4. Mark the checkbox labeled **I agree to the terms and conditions stated above**. \n5. Click **Purchase** to deploy." + }, + { + "title": "Option 2 - Manual Deployment of Azure Functions", + "description": "Use the following step-by-step instructions to deploy the Quayls VM connector manually with Azure Functions." + }, + { + "title": "", + "description": "**1. Create a Function App**\n\n1. From the Azure Portal, navigate to [Function App](https://portal.azure.com/#blade/HubsExtension/BrowseResource/resourceType/Microsoft.Web%2Fsites/kind/functionapp), and select **+ Add**.\n2. In the **Basics** tab, ensure Runtime stack is set to **Powershell Core**. \n3. In the **Hosting** tab, ensure the **Consumption (Serverless)** plan type is selected.\n4. Make other preferrable configuration changes, if needed, then click **Create**." + }, + { + "title": "", + "description": "**2. Import Function App Code**\n\n1. In the newly created Function App, select **Functions** on the left pane and click **+ New Function**.\n2. Select **Timer Trigger**.\n3. Enter a unique Function **Name** and leave the default cron schedule of every 5 minutes, then click **Create**.\n5. Click on **Code + Test** on the left pane. \n6. Copy the [Function App Code](https://aka.ms/sentinelqualysvmazurefunctioncode) and paste into the Function App `run.ps1` editor.\n7. Click **Save**." + }, + { + "title": "", + "description": "**3. Configure the Function App**\n\n1. In the Function App, select the Function App Name and select **Configuration**.\n2. In the **Application settings** tab, select **+ New application setting**.\n3. Add each of the following seven (7) application settings individually, with their respective string values (case-sensitive): \n\t\tapiUsername\n\t\tapiPassword\n\t\tworkspaceID\n\t\tworkspaceKey\n\t\turi\n\t\tfilterParameters\n\t\ttimeInterval\n> - Enter the URI that corresponds to your region. The complete list of API Server URLs can be [found here](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf#G4.735348). The `uri` value must follow the following schema: `https:///api/2.0/fo/asset/host/vm/detection/?action=list&vm_processed_after=` -- There is no need to add a time suffix to the URI, the Function App will dynamically append the Time Value to the URI in the proper format.\n> - Add any additional filter parameters, for the `filterParameters` variable, that need to be appended to the URI. Each parameter should be seperated by an \"&\" symbol and should not include any spaces.\n> - Set the `timeInterval` (in minutes) to the value of `5` to correspond to the Timer Trigger of every `5` minutes. If the time interval needs to be modified, it is recommended to change the Function App Timer Trigger accordingly to prevent overlapping data ingestion.\n> - Note: If using Azure Key Vault, use the`@Microsoft.KeyVault(SecretUri={Security Identifier})`schema in place of the string values. Refer to [Key Vault references documentation](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) for further details.\n4. Once all application settings have been entered, click **Save**." + }, + { + "title": "", + "description": "**4. Configure the host.json**.\n\nDue to the potentially large amount of Qualys host detection data being ingested, it can cause the execution time to surpass the default Function App timeout of five (5) minutes. Increase the default timeout duration to the maximum of ten (10) minutes, under the Consumption Plan, to allow more time for the Function App to execute.\n\n1. In the Function App, select the Function App Name and select the **App Service Editor** blade.\n2. Click **Go** to open the editor, then select the **host.json** file under the **wwwroot** directory.\n3. Add the line `\"functionTimeout\": \"00:10:00\",` above the `managedDependancy` line \n4. Ensure **SAVED** appears on the top right corner of the editor, then exit the editor.\n\n> NOTE: If a longer timeout duration is required, consider upgrading to an [App Service Plan](https://docs.microsoft.com/azure/azure-functions/functions-scale#timeout)" + } + ] + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetGoogleCloudPlatformById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetGoogleCloudPlatformById.json new file mode 100644 index 000000000000..a571ae52daaa --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetGoogleCloudPlatformById.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "GCP_fce27b90-d6f5-4d30-991a-af509a2b50a1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/GCP_afef3743-0c88-469c-84ff-ca2e87dc1e48", + "name": "GCP_fce27b90-d6f5-4d30-991a-af509a2b50a1", + "type": "Microsoft.SecurityInsights/dataConnectors", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "kind": "GCP", + "properties": { + "connectorDefinitionName": "GcpConnector", + "auth": { + "serviceAccountEmail": "sentinel-service-account@project-id.iam.gserviceaccount.com", + "projectNumber": "123456789012", + "workloadIdentityProviderId": "sentinel-identity-provider", + "type": "GCP" + }, + "request": { + "projectId": "project-id", + "subscriptionNames": [ + "sentinel-subscription" + ] + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetIoTById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetIoTById.json new file mode 100644 index 000000000000..32458a85a86e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetIoTById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "d2e5dc7a-f3a2-429d-954b-939fa8c2932e" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/d2e5dc7a-f3a2-429d-954b-939fa8c2932e", + "name": "d2e5dc7a-f3a2-429d-954b-939fa8c2932e", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "IOT", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "subscriptionId": "c0688291-89d7-4bed-87a2-a7b1bff43f4c", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetMicrosoftCloudAppSecurityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetMicrosoftCloudAppSecurityById.json new file mode 100644 index 000000000000..062c10c1d871 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetMicrosoftCloudAppSecurityById.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "b96d014d-b5c2-4a01-9aba-a8058f629d42" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/b96d014d-b5c2-4a01-9aba-a8058f629d42", + "name": "b96d014d-b5c2-4a01-9aba-a8058f629d42", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "MicrosoftCloudAppSecurity", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + }, + "discoveryLogs": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetMicrosoftDefenderAdvancedThreatProtectionById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetMicrosoftDefenderAdvancedThreatProtectionById.json new file mode 100644 index 000000000000..b5819200b9c0 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetMicrosoftDefenderAdvancedThreatProtectionById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "06b3ccb8-1384-4bcc-aec7-852f6d57161b" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "name": "06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "MicrosoftDefenderAdvancedThreatProtection", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetMicrosoftInsiderRiskManagementById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetMicrosoftInsiderRiskManagementById.json new file mode 100644 index 000000000000..8607dea7cbb8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetMicrosoftInsiderRiskManagementById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "3d3e955e-33eb-401d-89a7-251c81ddd660" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/3d3e955e-33eb-401d-89a7-251c81ddd660", + "name": "3d3e955e-33eb-401d-89a7-251c81ddd660", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "OfficeIRM", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetMicrosoftPurviewInformationProtectionDataConnetorById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetMicrosoftPurviewInformationProtectionDataConnetorById.json new file mode 100644 index 000000000000..03f07d22861d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetMicrosoftPurviewInformationProtectionDataConnetorById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "MicrosoftPurviewInformationProtection", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetMicrosoftThreatIntelligenceById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetMicrosoftThreatIntelligenceById.json new file mode 100644 index 000000000000..8b4859363373 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetMicrosoftThreatIntelligenceById.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "c345bf40-8509-4ed2-b947-50cb773aaf04" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/c345bf40-8509-4ed2-b947-50cb773aaf04", + "name": "c345bf40-8509-4ed2-b947-50cb773aaf04", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "MicrosoftThreatIntelligence", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "microsoftEmergingThreatFeed": { + "state": "Enabled", + "lookbackPeriod": "01/01/1970 00:00:00" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetMicrosoftThreatProtectionById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetMicrosoftThreatProtectionById.json new file mode 100644 index 000000000000..871f74a4195b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetMicrosoftThreatProtectionById.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "c345bf40-8509-4ed2-b947-50cb773aaf04" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/c345bf40-8509-4ed2-b947-50cb773aaf04", + "name": "c345bf40-8509-4ed2-b947-50cb773aaf04", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "MicrosoftThreatProtection", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "incidents": { + "state": "Enabled" + }, + "alerts": { + "state": "Enabled" + } + }, + "filteredProviders": { + "alerts": [ + "microsoftDefenderForCloudApps" + ] + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetOffice365AdvancedThreatProtectionById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetOffice365AdvancedThreatProtectionById.json new file mode 100644 index 000000000000..25bb7e10552c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetOffice365AdvancedThreatProtectionById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "3d3e955e-33eb-401d-89a7-251c81ddd660" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/3d3e955e-33eb-401d-89a7-251c81ddd660", + "name": "3d3e955e-33eb-401d-89a7-251c81ddd660", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "OfficeATP", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetOffice365ProjectDataConnetorById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetOffice365ProjectDataConnetorById.json new file mode 100644 index 000000000000..68a82137243a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetOffice365ProjectDataConnetorById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Office365Project", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetOfficeDataConnetorById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetOfficeDataConnetorById.json new file mode 100644 index 000000000000..314fe383749b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetOfficeDataConnetorById.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/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": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "sharePoint": { + "state": "Enabled" + }, + "exchange": { + "state": "Enabled" + }, + "teams": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetOfficePowerBIDataConnetorById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetOfficePowerBIDataConnetorById.json new file mode 100644 index 000000000000..31bb77a53348 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetOfficePowerBIDataConnetorById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "OfficePowerBI", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetRestApiPollerById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetRestApiPollerById.json new file mode 100644 index 000000000000..3345d19d1f3b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetRestApiPollerById.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "RestApiPoller_fce27b90-d6f5-4d30-991a-af509a2b50a1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/RestApiPoller_afef3743-0c88-469c-84ff-ca2e87dc1e48", + "name": "RestApiPoller_fce27b90-d6f5-4d30-991a-af509a2b50a1", + "type": "Microsoft.SecurityInsights/dataConnectors", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "kind": "RestApiPoller", + "properties": { + "connectorDefinitionName": "RestApiPollerDefinition", + "auth": { + "type": "APIKey", + "apiKey": "6bec40cf957de430a6f1f2baa056b99a4fac9ea0", + "apiKeyName": "X-Cisco-Meraki-API-Key" + }, + "dcrConfig": { + "streamName": "Meraki", + "dataCollectionEndpoint": "data collection Endpoint", + "dataCollectionRuleImmutableId": "data collection rule immutableId" + }, + "request": { + "apiEndpoint": "https://api.meraki.com/api/v1/organizations/573083052582915028/networks", + "rateLimitQPS": 10, + "queryWindowInMin": 6, + "httpMethod": "GET", + "queryTimeFormat": "UnixTimestamp", + "startTimeAttributeName": "t0", + "endTimeAttributeName": "t1", + "retryCount": 3, + "timeoutInSeconds": 60, + "headers": { + "Accept": "application/json", + "User-Agent": "Scuba" + }, + "queryParameters": { + "perPage": 1000 + } + }, + "paging": { + "pagingType": "LinkHeader" + }, + "response": { + "eventsJsonPaths": [ + "$" + ] + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetThreatIntelligenceById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetThreatIntelligenceById.json new file mode 100644 index 000000000000..20203d03640d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetThreatIntelligenceById.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "c345bf40-8509-4ed2-b947-50cb773aaf04" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/c345bf40-8509-4ed2-b947-50cb773aaf04", + "name": "c345bf40-8509-4ed2-b947-50cb773aaf04", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "ThreatIntelligence", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "tipLookbackPeriod": "2020-01-01T13:00:30.123Z", + "dataTypes": { + "indicators": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetThreatIntelligenceTaxiiById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetThreatIntelligenceTaxiiById.json new file mode 100644 index 000000000000..a87688694333 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/dataConnectors/GetThreatIntelligenceTaxiiById.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "c39bb458-02a7-4b3f-b0c8-71a1d2692652" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/c39bb458-02a7-4b3f-b0c8-71a1d2692652", + "name": "c39bb458-02a7-4b3f-b0c8-71a1d2692652", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "ThreatIntelligenceTaxii", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "workspaceId": "8b014a77-4695-4ef4-96bb-6623afb121a2", + "friendlyName": "My TI Taxii Connector", + "taxiiServer": "https://mytaxiiserver.com/taxiing/v2/api", + "collectionId": "e0b1f32d-1188-48f7-a7a3-de71924e4b5e", + "userName": "", + "password": "", + "taxiiLookbackPeriod": "2020-01-01T13:00:30.123Z", + "pollingFrequency": "OnceADay", + "dataTypes": { + "taxiiClient": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/enrichment/GetGeodataWithWorkspaceByIp.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/enrichment/GetGeodataWithWorkspaceByIp.json new file mode 100644 index 000000000000..f898a9682ed2 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/enrichment/GetGeodataWithWorkspaceByIp.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "enrichmentType": "main", + "ipAddressBody": { + "ipAddress": "1.2.3.4" + } + }, + "responses": { + "200": { + "body": { + "asn": "12345", + "carrier": "Microsoft", + "city": "Redmond", + "cityCf": 90, + "continent": "north america", + "country": "united states", + "countryCf": 99, + "ipAddr": "1.2.3.4", + "ipRoutingType": "fixed", + "latitude": "40.2436", + "longitude": "-100.8891", + "organization": "Microsoft", + "organizationType": "tech", + "region": "western usa", + "state": "washington", + "stateCf": null, + "stateCode": "wa" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/enrichment/GetWhoisWithWorkspaceByDomainName.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/enrichment/GetWhoisWithWorkspaceByDomainName.json new file mode 100644 index 000000000000..9f053663c183 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/enrichment/GetWhoisWithWorkspaceByDomainName.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "enrichmentType": "main", + "domainBody": { + "domain": "microsoft.com" + } + }, + "responses": { + "200": { + "body": { + "domain": "microsoft.com", + "server": null, + "created": "2021-09-01T16:15:01.187045Z", + "updated": "2021-09-01T16:15:01.187045Z", + "expires": null, + "parsedWhois": { + "registrar": { + "name": "MarkMonitor, Inc", + "abuseContactPhone": "12083895770", + "abuseContactEmail": "abuse@microsoft.com", + "url": "http://www.markmonitor.com", + "whoisServer": "whois.markmonitor.com" + }, + "contacts": { + "admin": { + "name": "Administrator", + "org": "Microsoft", + "street": [ + "One Microsoft Way" + ], + "city": null, + "state": "WA", + "postal": "98052", + "country": "United States", + "phone": "1-800-555-1234", + "fax": null, + "email": "mail@microsoft.com" + }, + "registrant": null, + "billing": { + "name": "Administrator", + "org": "Microsoft", + "street": [ + "One Microsoft Way" + ], + "city": null, + "state": "WA", + "postal": "98052", + "country": "United States", + "phone": "1-800-555-1234", + "fax": null, + "email": "mail@microsoft.com" + }, + "tech": { + "name": "Administrator", + "org": "Microsoft", + "street": [ + "One Microsoft Way" + ], + "city": null, + "state": "WA", + "postal": "98052", + "country": "United States", + "phone": "1-800-555-1234", + "fax": null, + "email": "mail@microsoft.com" + } + }, + "nameServers": [ + "ns1-205.azure-dns.com", + "ns2-205.azure-dns.net", + "ns3-205.azure-dns.org", + "ns4-205.azure-dns.info" + ], + "statuses": [ + "clientUpdateProhibited", + "clientTransferProhibited", + "clientDeleteProhibited", + "serverUpdateProhibited", + "serverTransferProhibited", + "serverDeleteProhibited" + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetAccountEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetAccountEntityById.json new file mode 100644 index 000000000000..e5bd6a72b7bf --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetAccountEntityById.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "Account", + "properties": { + "friendlyName": "administrator", + "accountName": "administrator", + "ntDomain": "domain", + "upnSuffix": "contoso", + "sid": "S-1-5-18", + "aadTenantId": "70fbdad0-7441-4564-b2b5-2b8862d0fee0", + "aadUserId": "f7033626-2572-46b1-bba0-06646f4f95b3", + "puid": "ee3cb2d8-14ba-45ef-8009-d6f1cacfa04d", + "isDomainJoined": true, + "objectGuid": "11227b78-3c6e-436e-a2a2-02fc7662eca0", + "dnsDomain": "contoso.com" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetAzureResourceEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetAzureResourceEntityById.json new file mode 100644 index 000000000000..f205b3638e40 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetAzureResourceEntityById.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "AzureResource", + "properties": { + "friendlyName": "vm1", + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetCloudApplicationEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetCloudApplicationEntityById.json new file mode 100644 index 000000000000..0a248713e769 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetCloudApplicationEntityById.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "CloudApplication", + "properties": { + "friendlyName": "AppName", + "appId": 1, + "appName": "AppName", + "instanceName": "InstanceName" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetDnsEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetDnsEntityById.json new file mode 100644 index 000000000000..6ab86de79a20 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetDnsEntityById.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "f4e74920-f2c0-4412-a45f-66d94fdf01f8" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/f4e74920-f2c0-4412-a45f-66d94fdf01f8", + "name": "f4e74920-f2c0-4412-a45f-66d94fdf01f8", + "type": "Microsoft.SecurityInsights/entities", + "kind": "DnsResolution", + "properties": { + "friendlyName": "domain", + "domainName": "domain", + "ipAddressEntityIds": [ + "475d3120-33e0-4841-9f1c-a8f15a801d19" + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetEntities.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetEntities.json new file mode 100644 index 000000000000..5e07309dc170 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetEntities.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "Account", + "properties": { + "friendlyName": "administrator", + "accountName": "administrator", + "ntDomain": "domain", + "upnSuffix": "contoso", + "sid": "S-1-5-18", + "aadTenantId": "70fbdad0-7441-4564-b2b5-2b8862d0fee0", + "aadUserId": "f7033626-2572-46b1-bba0-06646f4f95b3", + "puid": "ee3cb2d8-14ba-45ef-8009-d6f1cacfa04d", + "isDomainJoined": true, + "objectGuid": "11227b78-3c6e-436e-a2a2-02fc7662eca0" + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/fed9fe89-dce8-40f2-bf44-70f23fe93b3c", + "name": "fed9fe89-dce8-40f2-bf44-70f23fe93b3c", + "type": "Microsoft.SecurityInsights/entities", + "kind": "Host", + "properties": { + "friendlyName": "vm1", + "dnsDomain": "contoso", + "ntDomain": "domain", + "hostName": "vm1", + "netBiosName": "contoso", + "azureID": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", + "omsAgentID": "70fbdad0-7441-4564-b2b5-2b8862d0fee0", + "osFamily": "Windows", + "osVersion": "1.0", + "isDomainJoined": true + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/af378b21-b4aa-4fe7-bc70-13f8621a322f", + "name": "af378b21-b4aa-4fe7-bc70-13f8621a322f", + "type": "Microsoft.SecurityInsights/entities", + "kind": "File", + "properties": { + "friendlyName": "cmd.exe", + "directory": "C:\\Windows\\System32", + "fileName": "cmd.exe" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetFileEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetFileEntityById.json new file mode 100644 index 000000000000..35611b84365e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetFileEntityById.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "af378b21-b4aa-4fe7-bc70-13f8621a322f" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/af378b21-b4aa-4fe7-bc70-13f8621a322f", + "name": "af378b21-b4aa-4fe7-bc70-13f8621a322f", + "type": "Microsoft.SecurityInsights/entities", + "kind": "File", + "properties": { + "friendlyName": "cmd.exe", + "directory": "C:\\Windows\\System32", + "fileName": "cmd.exe" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetFileHashEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetFileHashEntityById.json new file mode 100644 index 000000000000..842c32f16fd8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetFileHashEntityById.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "ea359fa6-c1e5-f878-e105-6344f3e399a1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/ea359fa6-c1e5-f878-e105-6344f3e399a1", + "name": "ea359fa6-c1e5-f878-e105-6344f3e399a1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "FileHash", + "properties": { + "friendlyName": "E923636F1093C414AAB39F846E9D7A372BEEFA7B628B28179197E539C56AA0F0(SHA256)", + "hashValue": "E923636F1093C414AAB39F846E9D7A372BEEFA7B628B28179197E539C56AA0F0", + "algorithm": "SHA256" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetHostEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetHostEntityById.json new file mode 100644 index 000000000000..041c6021ed03 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetHostEntityById.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "Host", + "properties": { + "friendlyName": "vm1", + "dnsDomain": "contoso", + "ntDomain": "domain", + "hostName": "vm1", + "netBiosName": "contoso", + "azureID": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", + "omsAgentID": "70fbdad0-7441-4564-b2b5-2b8862d0fee0", + "osFamily": "Windows", + "osVersion": "1.0", + "isDomainJoined": true + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetIoTDeviceEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetIoTDeviceEntityById.json new file mode 100644 index 000000000000..ca17b35689cc --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetIoTDeviceEntityById.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "IoTDevice", + "properties": { + "friendlyName": "device1", + "deviceId": "device1", + "deviceName": "device1", + "iotHubEntityId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/8b2d9401-f953-e89d-2583-be9b4975870c", + "nicEntityIds": [ + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/6ee379bd-ace8-44cf-ab10-ee669a1b71e2" + ], + "deviceType": "Industrial", + "firmwareVersion": "20.11", + "importance": "Normal", + "isAuthorized": true, + "isProgramming": false, + "isScanner": false, + "model": "demo-model", + "protocols": [ + "CIP", + "EtherNet/IP" + ], + "operatingSystem": "Windows", + "purdueLayer": "ProcessControl", + "sensor": "demo-sensor", + "site": "demo-site", + "vendor": "demo-vendor", + "zone": "zone" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetIpEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetIpEntityById.json new file mode 100644 index 000000000000..6182a282e456 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetIpEntityById.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "Ip", + "properties": { + "friendlyName": "10.3.2.8", + "address": "10.3.2.8" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetMailClusterEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetMailClusterEntityById.json new file mode 100644 index 000000000000..b066d809be70 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetMailClusterEntityById.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "MailCluster", + "properties": { + "friendlyName": "ClusterSourceIdentifier", + "networkMessageIds": [ + "ccfce855-e02f-491b-a1cc-5bafb371ad0c" + ], + "countByDeliveryStatus": { + "deliveryStatus": 5 + }, + "countByThreatType": { + "threatType": 6 + }, + "countByProtectionStatus": { + "protectionStatus": 65 + }, + "threats": [ + "thrreat1", + "thread2" + ], + "query": "kqlFilter", + "queryTime": "2021-09-01T01:42:01.6026755Z", + "source": "ClusterSourceIdentifier", + "clusterSourceIdentifier": "cluster source identifier", + "clusterSourceType": "Similarity", + "clusterGroup": "cluster group" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetMailMessageEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetMailMessageEntityById.json new file mode 100644 index 000000000000..35380ea7f744 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetMailMessageEntityById.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "MailMessage", + "properties": { + "friendlyName": "cmd.exe", + "fileEntityIds": [ + "ccfce855-e02f-491b-a1cc-5bafb371ad0c" + ], + "recipient": "recipient", + "urls": [ + "http://moqbrarcwmnk.banxhdcojlg.biz" + ], + "threats": [ + "thrreat1", + "thread2" + ], + "p1Sender": "email@fake.com", + "p1SenderDisplayName": "p1 sender display name", + "p1SenderDomain": "p1 sender domain", + "senderIP": "1.23.34.43", + "p2Sender": "the sender", + "deliveryAction": "Blocked", + "p2SenderDisplayName": "p2 sender display name", + "p2SenderDomain": "p2 Sender Domain", + "internetMessageId": "message id", + "subject": "subject", + "language": "language", + "threatDetectionMethods": [ + "thrreat1", + "thread2" + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetMailboxEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetMailboxEntityById.json new file mode 100644 index 000000000000..ab56a9e845d2 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetMailboxEntityById.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "Mailbox", + "properties": { + "friendlyName": "emailAddress1", + "displayName": "display name", + "mailboxPrimaryAddress": "emailAddress1", + "upn": "upn1", + "externalDirectoryObjectId": "18cc8fdc-e169-4451-983a-bd027db286eb" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetMalwareEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetMalwareEntityById.json new file mode 100644 index 000000000000..b14386fb0f96 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetMalwareEntityById.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "af378b21-b4aa-4fe7-bc70-13f8621a322f" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/af378b21-b4aa-4fe7-bc70-13f8621a322f", + "name": "af378b21-b4aa-4fe7-bc70-13f8621a322f", + "type": "Microsoft.SecurityInsights/entities", + "kind": "Malware", + "properties": { + "malwareName": "Win32/Toga!rfn", + "category": "Trojan", + "friendlyName": "Win32/Toga!rfn" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetProcessEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetProcessEntityById.json new file mode 100644 index 000000000000..05064334e97a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetProcessEntityById.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "7264685c-038c-42c6-948c-38e14ef1fb98" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/7264685c-038c-42c6-948c-38e14ef1fb98", + "name": "7264685c-038c-42c6-948c-38e14ef1fb98", + "type": "Microsoft.SecurityInsights/entities", + "kind": "Process", + "properties": { + "friendlyName": "cmd.exe", + "processId": "0x2aa48", + "commandLine": "\"cmd\"", + "imageFileEntityId": "bba7b47b-c1c1-4021-b568-5b07b9292f5e" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetQueries.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetQueries.json new file mode 100644 index 000000000000..d08ac1debd60 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetQueries.json @@ -0,0 +1,456 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "kind": "Insight" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1/queries/6db7f5d1-f41e-46c2-b935-230b36a569e6", + "name": "6db7f5d1-f41e-46c2-b935-230b36a569e6", + "type": "Microsoft.SecurityInsights/entities/queries", + "kind": "Insight", + "properties": { + "displayName": "Actions on account", + "description": "Summary of actions taken on the specified account, grouped by action: password resets and changes, account lockouts (policy or admin), account creation and deletion, account enabled and disabled\n", + "baseQuery": "let GetAccountActions = (v_Account_Name:string, v_Account_NTDomain:string, v_Account_UPNSuffix:string, v_Account_AADUserId:string, v_Account_SID:string){\nAuditLogs\n| where OperationName in~ ('Delete user', 'Change user password', 'Reset user password', 'Change password (self-service)', 'Reset password (by admin)', 'Reset password (self-service)', 'Update user')\n| extend UserPrincipalName = tostring(TargetResources[0].userPrincipalName)\n| extend Account_Name = tostring(split(UserPrincipalName, '@')[0])\n| extend Account_UPNSuffix = tostring(split(UserPrincipalName, '@')[1])\n| extend Action = tostring(parse_json(tostring(parse_json(tostring(TargetResources[0].modifiedProperties))[0])))\n| extend ModifiedProperty = parse_json(Action).displayName\n| extend ModifiedValue = parse_json(Action).newValue\n| extend Account_AADUserId = tostring(TargetResources[0].id)\n| extend DisableUser = iif(ModifiedProperty =~ 'AccountEnabled' and ModifiedValue =~ '[false]', 'True', 'False')\n| union isfuzzy=true (\nSecurityEvent\n| where EventID in (4720, 4722, 4723, 4724, 4725, 4726, 4740)\n| extend OperationName = tostring(EventID)\n| where AccountType =~ \"user\" or isempty(AccountType)\n| extend Account_Name = TargetUserName, Account_NTDomain = TargetDomainName, Account_SID = TargetSid\n)\n| where (Account_Name =~ v_Account_Name and (Account_UPNSuffix =~ v_Account_UPNSuffix or Account_NTDomain =~ v_Account_NTDomain)) or Account_AADUserId =~ v_Account_AADUserId or Account_SID =~ v_Account_SID\n};\nGetAccountActions('CTFFUser4', '', 'seccxp.ninja', '', '')\n", + "tableQuery": { + "columnsDefinitions": [ + { + "header": "Action", + "outputType": "String", + "supportDeepLink": false + }, + { + "header": "Most Recent", + "outputType": "Date", + "supportDeepLink": false + }, + { + "header": "Count", + "outputType": "Number", + "supportDeepLink": true + } + ], + "queriesDefinitions": [ + { + "filter": "where OperationName in~ ('Change user password', 'Reset user password', 'Change password (self-service)', 'Reset password (by admin)', 'Reset password (self-service)', '4724', '4723')", + "summarize": "summarize MostRecent = max(TimeGenerated), Count = count() by OperationName", + "project": "project Title = OperationName, MostRecent, Count", + "linkColumnsDefinitions": [ + { + "projectedName": "Count", + "Query": "{{BaseQuery}} | " + } + ] + }, + { + "filter": "where OperationName in~ ('Blocked from self-service password reset', '4740')", + "summarize": "summarize MostRecent = max(TimeGenerated), Count = count() by OperationName", + "project": "project Title = OperationName, MostRecent, Count", + "linkColumnsDefinitions": [ + { + "projectedName": "Count", + "Query": "{{BaseQuery}} | " + } + ] + }, + { + "filter": "where OperationName == '4725' or (OperationName =~ 'Update user' and DisableUser =~ 'True')", + "summarize": "summarize MostRecent = max(TimeGenerated), Count = count() by OperationName", + "project": "project Title = OperationName, MostRecent, Count", + "linkColumnsDefinitions": [ + { + "projectedName": "Count", + "Query": "{{BaseQuery}} | " + } + ] + }, + { + "filter": "where OperationName in~ ('Add user', '4720')", + "summarize": "summarize MostRecent = max(TimeGenerated), Count = count() by OperationName", + "project": "project Title = OperationName, MostRecent, Count", + "linkColumnsDefinitions": [ + { + "projectedName": "Count", + "Query": "{{BaseQuery}} | " + } + ] + }, + { + "filter": "where OperationName in~ ('Delete user', '4726')", + "summarize": "summarize MostRecent = max(TimeGenerated), Count = count() by OperationName", + "project": "project Title = OperationName, MostRecent, Count", + "linkColumnsDefinitions": [ + { + "projectedName": "Count", + "Query": "{{BaseQuery}} | " + } + ] + }, + { + "filter": "where OperationName in~ ('4725', 'Blocked from self-service password reset', '4740') or (OperationName =~ 'Update user' and DisableUser =~ 'True')", + "summarize": "summarize MostRecent = max(TimeGenerated), Count = count() by OperationName", + "project": "project Title = OperationName, MostRecent, Count", + "linkColumnsDefinitions": [ + { + "projectedName": "Count", + "Query": "{{BaseQuery}} | " + } + ] + }, + { + "filter": "where OperationName in~ ('4722', '4767') or (OperationName =~ 'Update user' and DisableUser =~ 'False')", + "summarize": "summarize MostRecent = max(TimeGenerated), Count = count() by OperationName", + "project": "project Title = OperationName, MostRecent, Count", + "linkColumnsDefinitions": [ + { + "projectedName": "Count", + "Query": "{{BaseQuery}} | " + } + ] + }, + { + "filter": "where OperationName in~ ('Update user','4738')", + "summarize": "summarize MostRecent = max(TimeGenerated), Count = count() by OperationName", + "project": "project Title = OperationName, MostRecent, Count", + "linkColumnsDefinitions": [ + { + "projectedName": "Count", + "Query": "{{BaseQuery}} | " + } + ] + } + ] + }, + "chartQuery": { + "title": "Actions by type", + "dataSets": [ + { + "query": "summarize Count = count() by bin(TimeGenerated, 1h), OperationName", + "xColumnName": "TimeGenerated", + "yColumnName": "Count", + "legendColumnName": "OperationName" + } + ], + "type": "BarChart" + }, + "additionalQuery": { + "text": "See all account activity", + "query": "project TimeGenerated, UserPrincipalName, Account_Name, OperationName, Activity, DisableUser, TargetSid, AADUserId, InitiatedBy, AADTenantId, AccountType, Computer, SubjectAccount, SubjectUserSid, EventData" + }, + "defaultTimeRange": { + "beforeRange": "12h", + "afterRange": "12h" + }, + "referenceTimeRange": null, + "dataTypes": [ + { + "dataType": "AuditLogs" + }, + { + "dataType": "SecurityEvent" + } + ], + "inputEntityType": "Account", + "requiredInputFieldsSets": [ + [ + "Account_Name", + "Account_NTDomain" + ], + [ + "Account_Name", + "Account_UPNSuffix" + ], + [ + "Account_AADUserId" + ], + [ + "Account_SID" + ] + ], + "entitiesFilter": {} + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1/queries/0a5d7b14-b485-450a-a0ac-4100c860ac32", + "name": "0a5d7b14-b485-450a-a0ac-4100c860ac32", + "type": "Microsoft.SecurityInsights/entities/queries", + "kind": "Insight", + "properties": { + "displayName": "Anomalously high office operation count", + "description": "Highlight office operations of the user with anomalously high count compared to those observed in the preceding 14 days.", + "baseQuery": "let AScoreThresh = 3; \nlet maxAnomalies = 3;\nlet BeforeRange = 12d; \nlet EndTime = todatetime('{{EndTimeUTC}}'); \nlet StartTime = todatetime('{{StartTimeUTC}}');\nlet numDays = tolong((EndTime-StartTime)/1d); \nlet userData = (v_Account_Name:string, v_Account_UPNSuffix:string) { \n OfficeActivity \n | extend splitUserId=split(UserId, '@')\n | extend Account_Name = tostring(splitUserId[0]), Account_UPNSuffix = tostring(splitUserId[1])\n | where Account_Name =~ v_Account_Name and Account_UPNSuffix =~ v_Account_UPNSuffix }; \nuserData('CTFFUser4', 'seccxp.ninja')\n", + "tableQuery": { + "columnsDefinitions": [ + { + "header": "Operation", + "outputType": "String", + "supportDeepLink": true + }, + { + "header": "Expected Count", + "outputType": "Number", + "supportDeepLink": false + }, + { + "header": "Actual Count", + "outputType": "Number", + "supportDeepLink": false + } + ], + "queriesDefinitions": [ + { + "filter": "make-series count() default=0 on TimeGenerated from (StartTime - BeforeRange) to EndTime step 1d by Operation \n| extend (anomalies,anomalyScore, expectedCount)=series_decompose_anomalies(count_,AScoreThresh,7,'linefit',numDays, 'ctukey') \n| extend count1=count_, TimeGenerated1=TimeGenerated, anomalyScore1=anomalyScore\n| mv-apply count1 to typeof(long), TimeGenerated1 to typeof(datetime), anomalyScore1 to typeof(double), anomalies to typeof(long) on (summarize totAnomalies=sumif(abs(anomalies), TimeGenerated1 < StartTime), baseStd=stdevif(count1, TimeGenerated1 < StartTime), baseAvg=avgif(count1, TimeGenerated1 < StartTime), maxCountPost=maxif(count1,TimeGenerated1 >= StartTime), maxAnomalyScorePost=maxif(anomalyScore1, TimeGenerated1 >= StartTime)) \n| extend count1=count_ \n| mv-apply count1 to typeof(long), anomalyScore to typeof(double), expectedCount to typeof(double) on ( summarize (dummy, postExpectedCount, postActualCount)=arg_min(abs(anomalyScore-maxAnomalyScorePost), expectedCount, count1) ) \n| where totAnomalies < maxAnomalies \n| extend postAnomalyScore=iff(baseStd == 0 and maxCountPost > tolong(count_[0]),1000.0,maxAnomalyScorePost), postExpectedCount=iff(postExpectedCount < 0,0.0,postExpectedCount) \n| where maxAnomalyScorePost > AScoreThresh \n| order by maxAnomalyScorePost desc\n", + "summarize": "take 1", + "project": "project Operation, expectedCount=round(postExpectedCount,2), actualCount=postActualCount, anomalyScore=round(postAnomalyScore,2)", + "linkColumnsDefinitions": [ + { + "projectedName": "Operation", + "Query": "{{BaseQuery}} \n| where TimeGenerated between (StartTime .. EndTime) \n| where Operation == ''\n" + } + ] + } + ] + }, + "chartQuery": { + "title": "Anomalous operation timeline", + "dataSets": [ + { + "query": "make-series count() default=0 on TimeGenerated from (StartTime - BeforeRange) to EndTime step 1d by Operation \n| extend (anomalies,anomalyScore, expectedCount)=series_decompose_anomalies(count_,AScoreThresh,7,'linefit',numDays, 'ctukey') \n| extend count1=count_, TimeGenerated1=TimeGenerated, anomalyScore1=anomalyScore\n| mv-apply count1 to typeof(long), TimeGenerated1 to typeof(datetime), anomalyScore1 to typeof(double), anomalies to typeof(long) on (summarize totAnomalies=sumif(abs(anomalies), TimeGenerated1 < StartTime), baseStd=stdevif(count1, TimeGenerated1 < StartTime), baseAvg=avgif(count1, TimeGenerated1 < StartTime), maxCountPost=maxif(count1,TimeGenerated1 >= StartTime), maxAnomalyScorePost=maxif(anomalyScore1, TimeGenerated1 >= StartTime)) \n| extend count1=count_ \n| mv-apply count1 to typeof(long), anomalyScore to typeof(double), expectedCount to typeof(double) on ( summarize (dummy, postExpectedCount, postActualCount)=arg_min(abs(anomalyScore-maxAnomalyScorePost), expectedCount, count1) ) \n| where totAnomalies < maxAnomalies \n| extend postAnomalyScore=iff(baseStd == 0 and maxCountPost > tolong(count_[0]),1000.0,maxAnomalyScorePost), postExpectedCount=iff(postExpectedCount < 0,0.0,round(postExpectedCount,2)) \n| where maxAnomalyScorePost > AScoreThresh \n| order by maxAnomalyScorePost desc \n| take 1 \n| project Operation, TimeGenerated, count_\n| mvexpand TimeGenerated, count_ | project todatetime(TimeGenerated), toint(count_), Operation\n", + "xColumnName": "TimeGenerated", + "yColumnName": "count_", + "legendColumnName": "Operation" + } + ], + "type": "LineChart" + }, + "additionalQuery": { + "text": "Query all anomalous operations", + "query": "make-series count() default=0 on TimeGenerated from (StartTime - BeforeRange) to EndTime step 1d by Operation \n| extend (anomalies,anomalyScore, expectedCount)=series_decompose_anomalies(count_,AScoreThresh,7,'linefit',numDays, 'ctukey') \n| extend count1=count_, TimeGenerated1=TimeGenerated, anomalyScore1=anomalyScore\n| mv-apply count1 to typeof(long), TimeGenerated1 to typeof(datetime), anomalyScore1 to typeof(double), anomalies to typeof(long) on (summarize totAnomalies=sumif(abs(anomalies), TimeGenerated1 < StartTime), baseStd=stdevif(count1, TimeGenerated1 < StartTime), baseAvg=avgif(count1, TimeGenerated1 < StartTime), maxCountPost=maxif(count1,TimeGenerated1 >= StartTime), maxAnomalyScorePost = maxif(anomalyScore1, TimeGenerated1 >= StartTime)) \n| extend count1=count_\n| mv-apply count1 to typeof(long), anomalyScore to typeof(double), expectedCount to typeof(double) on ( summarize (dummy, postExpectedCount, postActualCount)=arg_min(abs(anomalyScore - maxAnomalyScorePost), expectedCount, count1) ) \n| where totAnomalies < maxAnomalies\n| extend postAnomalyScore=iff(baseStd == 0 and maxCountPost > tolong(count_[0]),1000.0,maxAnomalyScorePost), postExpectedCount=iff(postExpectedCount < 0,0.0,postExpectedCount) \n| where maxAnomalyScorePost > AScoreThresh | order by maxAnomalyScorePost desc \n| project Operation, expectedCount=round(postExpectedCount,2), actualCount=postActualCount, anomalyScore=round(postAnomalyScore,2)\n" + }, + "defaultTimeRange": { + "beforeRange": "1d", + "afterRange": "0d" + }, + "referenceTimeRange": { + "beforeRange": "12d" + }, + "dataTypes": [ + { + "dataType": "OfficeActivity" + } + ], + "inputEntityType": "Account", + "requiredInputFieldsSets": [ + [ + "Account_Name", + "Account_UPNSuffix" + ] + ], + "entitiesFilter": {} + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1/queries/e6cf68e6-1eca-4fbb-9fad-6280f2a9476e", + "name": "e6cf68e6-1eca-4fbb-9fad-6280f2a9476e", + "type": "Microsoft.SecurityInsights/entities/queries", + "kind": "Insight", + "properties": { + "displayName": "Resource access", + "description": "Provides the count and distinct resource accesses by a given user account\n", + "baseQuery": "let Operations = dynamic([\"FileDownloaded\", \"FileUploaded\"]);\nlet UserOperationToSharePoint = (v_Account_Name:string, v_Account_UPNSuffix:string) {\nOfficeActivity\n// Select sharepoint activity that is relevant\n| where RecordType in~ ('SharePointFileOperation')\n| where Operation in~ (Operations)\n| extend Account_Name = tostring(split(UserId, '@')[0])\n| extend Account_UPNSuffix = tostring(split(UserId, '@')[1])\n| where Account_Name =~ v_Account_Name and Account_UPNSuffix =~ v_Account_UPNSuffix\n| project TimeGenerated, Account_Name, Account_UPNSuffix, UserId, OfficeId, RecordType, Operation, OrganizationId, UserType, UserKey, OfficeWorkload, OfficeObjectId, ClientIP, ItemType, UserAgent, Site_Url, SourceRelativeUrl, SourceFileName, SourceFileExtension , Start_Time , ElevationTime , TenantId, SourceSystem , Type\n};\nUserOperationToSharePoint ('CTFFUser4','seccxp.ninja')\n", + "tableQuery": { + "columnsDefinitions": [ + { + "header": "Resource Type", + "outputType": "String", + "supportDeepLink": false + }, + { + "header": "Distinct Resources", + "outputType": "Number", + "supportDeepLink": true + }, + { + "header": "Total Resources", + "outputType": "Number", + "supportDeepLink": true + }, + { + "header": "IPAddress(es)", + "outputType": "String", + "supportDeepLink": false + } + ], + "queriesDefinitions": [ + { + "filter": "where Operation =~ 'FileUploaded'", + "summarize": "summarize DistinctResources = dcount(SourceFileName), TotalResources = count(SourceFileName), IPAddresses = make_set(ClientIP) by Operation", + "project": "project Title = Operation, DistinctResources, TotalResources, IPAddresses = case(array_length(IPAddresses) == 1, tostring(IPAddresses[0]), array_length(IPAddresses) > 1, 'Many', 'None')", + "linkColumnsDefinitions": [ + { + "projectedName": "DistinctResources", + "Query": "{{BaseQuery}} | " + }, + { + "projectedName": "TotalResources", + "Query": "{{BaseQuery}} | " + } + ] + }, + { + "filter": "where Operation =~ 'FileDownloaded'", + "summarize": "summarize DistinctResources = dcount(SourceFileName), TotalResources = count(SourceFileName), IPAddresses = make_set(ClientIP) by Operation", + "project": "project Title = Operation, DistinctResources, TotalResources, IPAddresses = case(array_length(IPAddresses) == 1, tostring(IPAddresses[0]), array_length(IPAddresses) > 1, 'Many', 'None')", + "linkColumnsDefinitions": [ + { + "projectedName": "DistinctResources", + "Query": "{{BaseQuery}} | " + }, + { + "projectedName": "TotalResources", + "Query": "{{BaseQuery}} | " + } + ] + } + ] + }, + "chartQuery": { + "title": "Resource access over time", + "dataSets": [ + { + "query": "summarize DistinctResources = dcountif(Operation, Operation =~ 'FileUploaded'), TotalResources = countif(Operation =~ 'FileUploaded') by bin(TimeGenerated, 1h) | extend Legend = 'File Uploads'", + "xColumnName": "TimeGenerated", + "yColumnName": "TotalResources", + "legendColumnName": "Legend" + }, + { + "query": "summarize DistinctResources = dcountif(Operation, Operation =~ 'FileDownloaded'), TotalResources = countif(Operation =~ 'FileDownloaded') by bin(TimeGenerated, 1h) | extend Legend = 'File Downloads'", + "xColumnName": "TimeGenerated", + "yColumnName": "TotalResources", + "legendColumnName": "Legend" + } + ], + "type": "LineChart" + }, + "additionalQuery": { + "text": "See all resource activity", + "query": "where Operation in~ (Operations)" + }, + "defaultTimeRange": { + "beforeRange": "12h", + "afterRange": "12h" + }, + "referenceTimeRange": null, + "dataTypes": [ + { + "dataType": "OfficeActivity" + } + ], + "inputEntityType": "Account", + "requiredInputFieldsSets": [ + [ + "Account_Name", + "Account_UPNSuffix" + ], + [ + "Account_AADUserId" + ] + ], + "entitiesFilter": {} + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1/queries/cae8d0aa-aa45-4d53-8d88-17dd64ffd4e4", + "name": "cae8d0aa-aa45-4d53-8d88-17dd64ffd4e4", + "type": "Microsoft.SecurityInsights/entities/queries", + "kind": "Insight", + "properties": { + "displayName": "Anomalously high Azure sign-in result count", + "description": "Highlight Azure sign-in results by the user principal with anomalously high count compared to those observed in the preceding 14 days.", + "baseQuery": "let AScoreThresh=3; \nlet maxAnomalies=3; \nlet BeforeRange = 12d; \nlet EndTime=todatetime('{{EndTimeUTC}}');\nlet StartTime = todatetime('{{StartTimeUTC}}'); \nlet numDays = tolong((EndTime-StartTime)/1d); \nlet userData = (v_Account_Name:string, v_Account_UPNSuffix:string, v_Account_AADUserId:string) { \n SigninLogs \n | where TimeGenerated between ((StartTime-BeforeRange) .. EndTime)\n | extend splitUserId=split(UserPrincipalName, '@')\n | extend Account_Name = tostring(splitUserId[0]), Account_UPNSuffix = tostring(splitUserId[1])\n | where (Account_Name =~ v_Account_Name and Account_UPNSuffix =~ v_Account_UPNSuffix) or UserId =~ v_Account_AADUserId };\nuserData('CTFFUser4', 'seccxp.ninja', '')\n", + "tableQuery": { + "columnsDefinitions": [ + { + "header": "Result Description", + "outputType": "String", + "supportDeepLink": true + }, + { + "header": "Expected Count", + "outputType": "Number", + "supportDeepLink": false + }, + { + "header": "Actual Count", + "outputType": "Number", + "supportDeepLink": false + } + ], + "queriesDefinitions": [ + { + "filter": "make-series count() default=0 on TimeGenerated from (StartTime - BeforeRange) to EndTime step 1d by ResultDescription \n| extend (anomalies,anomalyScore, expectedCount)=series_decompose_anomalies(count_,AScoreThresh,7,'linefit',numDays, 'ctukey') \n| extend count1=count_, TimeGenerated1=TimeGenerated, anomalyScore1=anomalyScore\n| mv-apply count1 to typeof(long), TimeGenerated1 to typeof(datetime), anomalyScore1 to typeof(double), anomalies to typeof(long) on (summarize totAnomalies=sumif(abs(anomalies), TimeGenerated1 < StartTime), baseStd=stdevif(count1, TimeGenerated1 < StartTime), baseAvg=avgif(count1, TimeGenerated1 < StartTime), maxCountPost=maxif(count1,TimeGenerated1 >= StartTime), maxAnomalyScorePost = maxif(anomalyScore1, TimeGenerated1 >= StartTime)) \n| extend count1=count_ \n| mv-apply count1 to typeof(long), anomalyScore to typeof(double), expectedCount to typeof(double) on ( summarize (dummy, postExpectedCount, postActualCount)=arg_min(abs(anomalyScore - maxAnomalyScorePost), expectedCount, count1) ) \n| where totAnomalies < maxAnomalies \n| extend postAnomalyScore=iff(baseStd == 0 and maxCountPost > tolong(count_[0]),1000.0,maxAnomalyScorePost), postExpectedCount=iff(postExpectedCount < 0,0.0,postExpectedCount) \n| where maxAnomalyScorePost > AScoreThresh \n| order by maxAnomalyScorePost desc\n", + "summarize": "take 1", + "project": "project ResultDescription, expectedCount=round(postExpectedCount,2), actualCount=postActualCount, anomalyScore=round(postAnomalyScore,2)", + "linkColumnsDefinitions": [ + { + "projectedName": "ResultDescription", + "Query": "{{BaseQuery}} \n| where TimeGenerated between (StartTime .. EndTime) \n| where ResultDescription == ''\n" + } + ] + } + ] + }, + "chartQuery": { + "title": "Anomalous sign-in result timeline", + "dataSets": [ + { + "query": "make-series count() default=0 on TimeGenerated from (StartTime - BeforeRange) to EndTime step 1d by ResultDescription \n| extend (anomalies,anomalyScore, expectedCount)=series_decompose_anomalies(count_,AScoreThresh,7,'linefit',numDays, 'ctukey') \n| extend count1=count_, TimeGenerated1=TimeGenerated, anomalyScore1=anomalyScore\n| mv-apply count1 to typeof(long), TimeGenerated1 to typeof(datetime), anomalyScore1 to typeof(double), anomalies to typeof(long) on (summarize totAnomalies=sumif(abs(anomalies), TimeGenerated1 < StartTime), baseStd=stdevif(count1, TimeGenerated1 < StartTime), baseAvg=avgif(count1, TimeGenerated1 < StartTime), maxCountPost=maxif(count1,TimeGenerated1 >= StartTime), maxAnomalyScorePost = maxif(anomalyScore1, TimeGenerated1 >= StartTime)) \n| extend count1=count_ \n| mv-apply count1 to typeof(long), anomalyScore to typeof(double), expectedCount to typeof(double) on ( summarize (dummy, postExpectedCount, postActualCount)=arg_min(abs(anomalyScore - maxAnomalyScorePost), expectedCount, count1) ) \n| where totAnomalies < maxAnomalies \n| extend postAnomalyScore=iff(baseStd == 0 and maxCountPost > tolong(count_[0]),1000.0,maxAnomalyScorePost), postExpectedCount=iff(postExpectedCount < 0,0.0,round(postExpectedCount,2)) \n| where maxAnomalyScorePost > AScoreThresh \n| order by maxAnomalyScorePost desc \n| take 1 \n| project ResultDescription, TimeGenerated, count_ \n| mvexpand TimeGenerated, count_ \n| project todatetime(TimeGenerated), toint(count_), ResultDescription \n", + "xColumnName": "TimeGenerated", + "yColumnName": "count_", + "legendColumnName": "ResultDescription" + } + ], + "type": "LineChart" + }, + "additionalQuery": { + "text": "Query all anomalous sign-in results", + "query": "make-series count() default=0 on TimeGenerated from (StartTime - BeforeRange) to EndTime step 1d by ResultDescription \n| extend (anomalies,anomalyScore, expectedCount)=series_decompose_anomalies(count_,AScoreThresh,7,'linefit',numDays, 'ctukey') \n| extend count1=count_, TimeGenerated1=TimeGenerated, anomalyScore1=anomalyScore\n| mv-apply count1 to typeof(long), TimeGenerated1 to typeof(datetime), anomalyScore1 to typeof(double), anomalies to typeof(long) on (summarize totAnomalies=sumif(abs(anomalies), TimeGenerated1 < StartTime), baseStd=stdevif(count1, TimeGenerated1 < StartTime), baseAvg=avgif(count1, TimeGenerated1 < StartTime), maxCountPost=maxif(count1,TimeGenerated1 >= StartTime), maxAnomalyScorePost = maxif(anomalyScore1, TimeGenerated1 >= StartTime)) \n| extend count1=count_\n| mv-apply count1 to typeof(long), anomalyScore to typeof(double), expectedCount to typeof(double) on ( summarize (dummy, postExpectedCount, postActualCount)=arg_min(abs(anomalyScore - maxAnomalyScorePost), expectedCount, count1) ) \n| where totAnomalies < maxAnomalies\n| extend postAnomalyScore=iff(baseStd == 0 and maxCountPost > tolong(count_[0]),1000.0,maxAnomalyScorePost), postExpectedCount=iff(postExpectedCount < 0,0.0,postExpectedCount) \n| where maxAnomalyScorePost > AScoreThresh \n| order by maxAnomalyScorePost desc \n| project ResultDescription, expectedCount=round(postExpectedCount,2), actualCount=postActualCount, anomalyScore=round(postAnomalyScore,2)\n" + }, + "defaultTimeRange": { + "beforeRange": "1d", + "afterRange": "0d" + }, + "referenceTimeRange": { + "beforeRange": "12d" + }, + "dataTypes": [ + { + "dataType": "SigninLogs" + } + ], + "inputEntityType": "Account", + "requiredInputFieldsSets": [ + [ + "Account_Name", + "Account_UPNSuffix" + ], + [ + "Account_AADUserId" + ] + ], + "entitiesFilter": {} + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetRegistryKeyEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetRegistryKeyEntityById.json new file mode 100644 index 000000000000..89a8b49af01f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetRegistryKeyEntityById.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "RegistryKey", + "properties": { + "friendlyName": "SOFTWARE", + "hive": "HKEY_LOCAL_MACHINE", + "key": "SOFTWARE" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetRegistryValueEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetRegistryValueEntityById.json new file mode 100644 index 000000000000..f1d662aa1932 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetRegistryValueEntityById.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "dc44bd11-b348-4d76-ad29-37bf7aa41356" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/dc44bd11-b348-4d76-ad29-37bf7aa41356", + "name": "dc44bd11-b348-4d76-ad29-37bf7aa41356", + "type": "Microsoft.SecurityInsights/entities", + "kind": "RegistryValue", + "properties": { + "friendlyName": "Data", + "valueName": "Name", + "valueData": "Data", + "valueType": "String", + "keyEntityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetSecurityAlertEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetSecurityAlertEntityById.json new file mode 100644 index 000000000000..d5d9dbea68b8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetSecurityAlertEntityById.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "4aa486e0-6f85-41af-99ea-7acdce7be6c8" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/4aa486e0-6f85-41af-99ea-7acdce7be6c8", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "SecurityAlert", + "properties": { + "systemAlertId": "4aa486e0-6f85-41af-99ea-7acdce7be6c8", + "intent": "Unknown", + "alertDisplayName": "Suspicious account detected", + "description": "", + "confidenceLevel": "Unknown", + "severity": "Medium", + "vendorName": "Microsoft", + "productName": "Azure Sentinel", + "productComponentName": "Scheduled Alerts", + "alertType": "c8c99641-985d-4e4e-8e91-fb3466cd0e5b_46c7b6c0-ff43-44dd-8b4d-ceffff7aa7df", + "providerAlertId": "c2bafff9-fb31-41d0-a177-ecbff7a02ffe", + "processingEndTime": "2019-07-06T13:56:53.5392366Z", + "status": "New", + "endTimeUtc": "2021-09-01T13:21:45.926185Z", + "startTimeUtc": "2021-09-01T08:21:45.926185Z", + "timeGenerated": "2021-09-01T13:56:53.5392366Z", + "tactics": [ + "Persistence", + "LateralMovement" + ], + "additionalData": { + "Query": "Heartbeat \n| extend AccountCustomEntity = \"administrator\"", + "Query Period": "05:00:00", + "Trigger Operator": "GreaterThan", + "Trigger Threshold": "200", + "Search Query Results Overall Count": "203", + "Total Account Entities": "1" + }, + "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" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetSecurityGroupEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetSecurityGroupEntityById.json new file mode 100644 index 000000000000..521431dce8eb --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetSecurityGroupEntityById.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "SecurityGroup", + "properties": { + "friendlyName": "Name", + "distinguishedName": "Name", + "sid": "Sid", + "objectGuid": "fb1b8e04-d944-4986-b39a-1ce9adedcd98" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetSubmissionMailEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetSubmissionMailEntityById.json new file mode 100644 index 000000000000..23ef06f30dd1 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetSubmissionMailEntityById.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "SubmissionMail", + "properties": { + "friendlyName": "recipient", + "submissionId": "5bb3d8fe-54bc-499c-bc21-86fe8df2a184", + "submitter": "submitter", + "recipient": "recipient", + "sender": "sender", + "senderIp": "1.4.35.34", + "subject": "subject", + "reportType": "report type" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetUrlEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetUrlEntityById.json new file mode 100644 index 000000000000..1dd78c6ef0a4 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/GetUrlEntityById.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "Url", + "properties": { + "friendlyName": "https://bing.com", + "url": "https://bing.com" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/expand/PostExpandEntity.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/expand/PostExpandEntity.json new file mode 100644 index 000000000000..c54b36816e40 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/expand/PostExpandEntity.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "parameters": { + "expansionId": "a77992f3-25e9-4d01-99a4-5ff606cc410a", + "startTime": "2019-04-25T00:00:00.000Z", + "endTime": "2019-05-26T00:00:00.000Z" + } + }, + "responses": { + "200": { + "body": { + "value": { + "entities": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "Ip", + "properties": { + "address": "13.89.108.248", + "friendlyName": "13.89.108.248" + } + } + ], + "edges": [ + { + "targetEntityId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/c1d60d86-5988-11eb-ae93-0242ac130002", + "additionalData": { + "EpochTimestamp": "1608289949", + "FirstSeen": "2021-09-01T11:12:29.597Z", + "Source": "Heartbeat" + } + } + ] + }, + "metaData": { + "aggregations": [ + { + "entityKind": "Account", + "count": 1 + } + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/insights/PostGetInsights.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/insights/PostGetInsights.json new file mode 100644 index 000000000000..39e80f39d004 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/insights/PostGetInsights.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "parameters": { + "addDefaultExtendedTimeRange": false, + "startTime": "2021-09-01T00:00:00.000Z", + "endTime": "2021-10-01T00:00:00.000Z", + "insightQueryIds": [ + "cae8d0aa-aa45-4d53-8d88-17dd64ffd4e4" + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "tableQueryResults": { + "columns": [ + { + "name": "Title", + "type": "string" + }, + { + "name": "NameCount", + "type": "long" + }, + { + "name": "SIDCount", + "type": "long" + }, + { + "name": "InternalOrder", + "type": "long" + }, + { + "name": "Index", + "type": "long" + } + ], + "rows": [ + [ + "MyTitle", + "15", + "SID", + "1", + "1" + ] + ] + }, + "chartQueryResults": [ + { + "columns": [ + { + "name": "TimeGenerated", + "type": "datetime" + }, + { + "name": "Count", + "type": "long" + }, + { + "name": "Legend", + "type": "string" + } + ], + "rows": [ + [ + "2021-09-01T00:00:00.000Z", + "55", + "SomeLegend" + ] + ] + } + ], + "queryTimeInterval": { + "startTime": "2021-09-01T23:35:20Z", + "endTime": "2021-09-01T23:35:20Z" + }, + "queryId": "e29ee1ef-7445-455e-85f1-269f2d536d61" + } + ], + "metaData": { + "totalCount": 7, + "errors": [ + { + "kind": "Insight", + "queryId": "4a70a63d-25c4-6312-b73e-4f302a90c06a", + "errorMessage": "Internal server error" + } + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/relations/GetAllEntityRelations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/relations/GetAllEntityRelations.json new file mode 100644 index 000000000000..7d1f90e6481b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/relations/GetAllEntityRelations.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/entities/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/incidents" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/relations/GetEntityRelationByName.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/relations/GetEntityRelationByName.json new file mode 100644 index 000000000000..efe5e4bdc4bd --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/relations/GetEntityRelationByName.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/entities/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/incidents" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/timeline/PostTimelineEntity.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/timeline/PostTimelineEntity.json new file mode 100644 index 000000000000..6efec4201db1 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entities/timeline/PostTimelineEntity.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "parameters": { + "numberOfBucket": 4, + "startTime": "2021-09-01T00:00:00.000Z", + "endTime": "2021-10-01T00:00:00.000Z" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kind": "SecurityAlert", + "description": "The alert description", + "azureResourceId": "4467341f-fb73-4f99-a9b3-29473532cf5a_bf7c3a2f-b743-6410-3ff0-ec64b5995d50", + "productName": "Azure Sentinel", + "displayName": "Alert display name", + "severity": "Medium", + "endTimeUtc": "2021-09-01T23:31:28.02Z", + "startTimeUtc": "2021-09-01T23:32:28.01Z", + "timeGenerated": "2021-09-01T23:37:25.8136594Z", + "alertType": "4467341f-fb73-4f99-a9b3-29473532cf5a_c93bf33e-055e-4972-9e7d-f84fe3fb61ae", + "Intent": "Discovery" + }, + { + "kind": "Activity", + "queryId": "e0459780-ac9d-4b72-8bd4-fecf6b46a0a1", + "bucketStartTimeUTC": "2021-09-01T21:31:28.02Z", + "bucketEndTimeUTC": "2021-09-01T23:31:28.02Z", + "firstActivityTimeUTC": "2021-09-01T21:35:28.02Z", + "lastActivityTimeUTC": "2021-09-01T21:35:28.02Z", + "content": "he user has deleted the account 3 time(s)", + "title": "The user has deleted an account" + }, + { + "kind": "Anomaly", + "azureResourceId": "4467341f-fb73-4f99-a9b3-29473532cf5a_d56430ef-f421-2c9c-0b7d-d082285843c6", + "description": "Anomalous private to public port scanning activity with high destination port count along with low port ratio. The ratios are normalized by multiplying them by 10,000 to get them to a more usable value between 0.0 and 1.0.", + "productName": "Azure Sentinel", + "displayName": "(Preview) Anomalous scanning activity", + "endTimeUtc": "2021-09-01T23:31:28.02Z", + "startTimeUtc": "2021-09-01T23:32:28.01Z", + "timeGenerated": "2021-09-01T23:37:25.8136594Z", + "vendor": "Microsoft", + "intent": "Discovery", + "techniques": [ + "T1046" + ], + "reasons": [ + "High destination port count", + "Low port ratio" + ] + } + ], + "metaData": { + "totalCount": 6, + "aggregations": [ + { + "count": 4, + "kind": "Activity" + }, + { + "count": 2, + "kind": "SecurityAlert" + }, + { + "count": 1, + "kind": "Anomaly" + } + ], + "errors": [ + { + "kind": "Activity", + "queryId": "11067f9f-d6a7-4488-887f-0ba564268879", + "errorMessage": "syntax error" + }, + { + "kind": "SecurityAlert", + "errorMessage": "internal server error" + } + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueries/CreateEntityQueryActivity.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueries/CreateEntityQueryActivity.json new file mode 100644 index 000000000000..b6d073b906c8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueries/CreateEntityQueryActivity.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityQueryId": "07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "entityQuery": { + "kind": "Activity", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "title": "An account was deleted on this host", + "content": "On '{{Computer}}' the account '{{TargetAccount}}' was deleted by '{{AddedBy}}'", + "description": "Account deleted on host", + "queryDefinitions": { + "query": "let GetAccountActions = (v_Host_Name:string, v_Host_NTDomain:string, v_Host_DnsDomain:string, v_Host_AzureID:string, v_Host_OMSAgentID:string){\nSecurityEvent\n| where EventID in (4725, 4726, 4767, 4720, 4722, 4723, 4724)\n// parsing for Host to handle variety of conventions coming from data\n| extend Host_HostName = case(\nComputer has '@', tostring(split(Computer, '@')[0]),\nComputer has '\\\\', tostring(split(Computer, '\\\\')[1]),\nComputer has '.', tostring(split(Computer, '.')[0]),\nComputer\n)\n| extend Host_NTDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', tostring(split(Computer, '.')[-2]), \nComputer\n)\n| extend Host_DnsDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', strcat_array(array_slice(split(Computer,'.'),-2,-1),'.'), \nComputer\n)\n| where (Host_HostName =~ v_Host_Name and Host_NTDomain =~ v_Host_NTDomain) \nor (Host_HostName =~ v_Host_Name and Host_DnsDomain =~ v_Host_DnsDomain) \nor v_Host_AzureID =~ _ResourceId \nor v_Host_OMSAgentID == SourceComputerId\n| project TimeGenerated, EventID, Activity, Computer, TargetAccount, TargetUserName, TargetDomainName, TargetSid, SubjectUserName, SubjectUserSid, _ResourceId, SourceComputerId\n| extend AddedBy = SubjectUserName\n// Future support for Activities\n| extend timestamp = TimeGenerated, HostCustomEntity = Computer, AccountCustomEntity = TargetAccount\n};\nGetAccountActions('{{Host_HostName}}', '{{Host_NTDomain}}', '{{Host_DnsDomain}}', '{{Host_AzureID}}', '{{Host_OMSAgentID}}')\n \n| where EventID == 4726 " + }, + "inputEntityType": "Host", + "requiredInputFieldsSets": [ + [ + "Host_HostName", + "Host_NTDomain" + ], + [ + "Host_HostName", + "Host_DnsDomain" + ], + [ + "Host_AzureID" + ], + [ + "Host_OMSAgentID" + ] + ], + "entitiesFilter": { + "Host_OsFamily": [ + "Windows" + ] + }, + "enabled": true, + "templateName": null + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entityQueries/07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "name": "07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "type": "Microsoft.SecurityInsights/entityQueries", + "kind": "Activity", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "title": "An account was deleted on this host", + "content": "On '{{Computer}}' the account '{{TargetAccount}}' was deleted by '{{AddedBy}}'", + "description": "Account deleted on host", + "queryDefinitions": { + "query": "let GetAccountActions = (v_Host_Name:string, v_Host_NTDomain:string, v_Host_DnsDomain:string, v_Host_AzureID:string, v_Host_OMSAgentID:string){\nSecurityEvent\n| where EventID in (4725, 4726, 4767, 4720, 4722, 4723, 4724)\n// parsing for Host to handle variety of conventions coming from data\n| extend Host_HostName = case(\nComputer has '@', tostring(split(Computer, '@')[0]),\nComputer has '\\\\', tostring(split(Computer, '\\\\')[1]),\nComputer has '.', tostring(split(Computer, '.')[0]),\nComputer\n)\n| extend Host_NTDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', tostring(split(Computer, '.')[-2]), \nComputer\n)\n| extend Host_DnsDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', strcat_array(array_slice(split(Computer,'.'),-2,-1),'.'), \nComputer\n)\n| where (Host_HostName =~ v_Host_Name and Host_NTDomain =~ v_Host_NTDomain) \nor (Host_HostName =~ v_Host_Name and Host_DnsDomain =~ v_Host_DnsDomain) \nor v_Host_AzureID =~ _ResourceId \nor v_Host_OMSAgentID == SourceComputerId\n| project TimeGenerated, EventID, Activity, Computer, TargetAccount, TargetUserName, TargetDomainName, TargetSid, SubjectUserName, SubjectUserSid, _ResourceId, SourceComputerId\n| extend AddedBy = SubjectUserName\n// Future support for Activities\n| extend timestamp = TimeGenerated, HostCustomEntity = Computer, AccountCustomEntity = TargetAccount\n};\nGetAccountActions('{{Host_HostName}}', '{{Host_NTDomain}}', '{{Host_DnsDomain}}', '{{Host_AzureID}}', '{{Host_OMSAgentID}}')\n \n| where EventID == 4726 " + }, + "inputEntityType": "Host", + "requiredInputFieldsSets": [ + [ + "Host_HostName", + "Host_NTDomain" + ], + [ + "Host_HostName", + "Host_DnsDomain" + ], + [ + "Host_AzureID" + ], + [ + "Host_OMSAgentID" + ] + ], + "entitiesFilter": { + "Host_OsFamily": [ + "Windows" + ] + }, + "enabled": true, + "templateName": null, + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entityQueries/07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "name": "07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "type": "Microsoft.SecurityInsights/entityQueries", + "kind": "Activity", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "title": "An account was deleted on this host", + "content": "On '{{Computer}}' the account '{{TargetAccount}}' was deleted by '{{AddedBy}}'", + "description": "Account deleted on host", + "queryDefinitions": { + "query": "let GetAccountActions = (v_Host_Name:string, v_Host_NTDomain:string, v_Host_DnsDomain:string, v_Host_AzureID:string, v_Host_OMSAgentID:string){\nSecurityEvent\n| where EventID in (4725, 4726, 4767, 4720, 4722, 4723, 4724)\n// parsing for Host to handle variety of conventions coming from data\n| extend Host_HostName = case(\nComputer has '@', tostring(split(Computer, '@')[0]),\nComputer has '\\\\', tostring(split(Computer, '\\\\')[1]),\nComputer has '.', tostring(split(Computer, '.')[0]),\nComputer\n)\n| extend Host_NTDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', tostring(split(Computer, '.')[-2]), \nComputer\n)\n| extend Host_DnsDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', strcat_array(array_slice(split(Computer,'.'),-2,-1),'.'), \nComputer\n)\n| where (Host_HostName =~ v_Host_Name and Host_NTDomain =~ v_Host_NTDomain) \nor (Host_HostName =~ v_Host_Name and Host_DnsDomain =~ v_Host_DnsDomain) \nor v_Host_AzureID =~ _ResourceId \nor v_Host_OMSAgentID == SourceComputerId\n| project TimeGenerated, EventID, Activity, Computer, TargetAccount, TargetUserName, TargetDomainName, TargetSid, SubjectUserName, SubjectUserSid, _ResourceId, SourceComputerId\n| extend AddedBy = SubjectUserName\n// Future support for Activities\n| extend timestamp = TimeGenerated, HostCustomEntity = Computer, AccountCustomEntity = TargetAccount\n};\nGetAccountActions('{{Host_HostName}}', '{{Host_NTDomain}}', '{{Host_DnsDomain}}', '{{Host_AzureID}}', '{{Host_OMSAgentID}}')\n \n| where EventID == 4726 " + }, + "inputEntityType": "Host", + "requiredInputFieldsSets": [ + [ + "Host_HostName", + "Host_NTDomain" + ], + [ + "Host_HostName", + "Host_DnsDomain" + ], + [ + "Host_AzureID" + ], + [ + "Host_OMSAgentID" + ] + ], + "entitiesFilter": { + "Host_OsFamily": [ + "Windows" + ] + }, + "enabled": true, + "templateName": null, + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueries/DeleteEntityQuery.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueries/DeleteEntityQuery.json new file mode 100644 index 000000000000..3965d69ef0a1 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueries/DeleteEntityQuery.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityQueryId": "07da3cc8-c8ad-4710-a44e-334cdcb7882b" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueries/GetActivityEntityQueryById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueries/GetActivityEntityQueryById.json new file mode 100644 index 000000000000..647bf3033b18 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueries/GetActivityEntityQueryById.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityQueryId": "07da3cc8-c8ad-4710-a44e-334cdcb7882b" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entityQueries/07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "name": "07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "type": "Microsoft.SecurityInsights/entityQueries", + "etag": null, + "kind": "Activity", + "properties": { + "title": "An account was deleted on this host", + "content": "On '{{Computer}}' the account '{{TargetAccount}}' was deleted by '{{AddedBy}}'", + "description": "Account deleted on host", + "queryDefinitions": { + "query": "let GetAccountActions = (v_Host_Name:string, v_Host_NTDomain:string, v_Host_DnsDomain:string, v_Host_AzureID:string, v_Host_OMSAgentID:string){\nSecurityEvent\n| where EventID in (4725, 4726, 4767, 4720, 4722, 4723, 4724)\n// parsing for Host to handle variety of conventions coming from data\n| extend Host_HostName = case(\nComputer has '@', tostring(split(Computer, '@')[0]),\nComputer has '\\\\', tostring(split(Computer, '\\\\')[1]),\nComputer has '.', tostring(split(Computer, '.')[0]),\nComputer\n)\n| extend Host_NTDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', tostring(split(Computer, '.')[-2]), \nComputer\n)\n| extend Host_DnsDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', strcat_array(array_slice(split(Computer,'.'),-2,-1),'.'), \nComputer\n)\n| where (Host_HostName =~ v_Host_Name and Host_NTDomain =~ v_Host_NTDomain) \nor (Host_HostName =~ v_Host_Name and Host_DnsDomain =~ v_Host_DnsDomain) \nor v_Host_AzureID =~ _ResourceId \nor v_Host_OMSAgentID == SourceComputerId\n| project TimeGenerated, EventID, Activity, Computer, TargetAccount, TargetUserName, TargetDomainName, TargetSid, SubjectUserName, SubjectUserSid, _ResourceId, SourceComputerId\n| extend AddedBy = SubjectUserName\n// Future support for Activities\n| extend timestamp = TimeGenerated, HostCustomEntity = Computer, AccountCustomEntity = TargetAccount\n};\nGetAccountActions('{{Host_HostName}}', '{{Host_NTDomain}}', '{{Host_DnsDomain}}', '{{Host_AzureID}}', '{{Host_OMSAgentID}}')\n \n| where EventID == 4726 " + }, + "inputEntityType": "Host", + "requiredInputFieldsSets": [ + [ + "Host_HostName", + "Host_NTDomain" + ], + [ + "Host_HostName", + "Host_DnsDomain" + ], + [ + "Host_AzureID" + ], + [ + "Host_OMSAgentID" + ] + ], + "entitiesFilter": { + "Host_OsFamily": [ + "Windows" + ] + }, + "enabled": true, + "templateName": null, + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueries/GetEntityQueries.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueries/GetEntityQueries.json new file mode 100644 index 000000000000..700ce23d254a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueries/GetEntityQueries.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "kind": "Expansion", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entityQueries/37ca3555-c135-4a73-a65e-9c1d00323f5d", + "name": "37ca3555-c135-4a73-a65e-9c1d00323f5d", + "type": "Microsoft.SecurityInsights/entityQueries", + "etag": null, + "kind": "Expansion", + "properties": { + "queryTemplate": "let AccountActivity_byIP = (v_IP_Address:string){\r\n AzureActivity\r\n | where Caller != '' and CallerIpAddress == v_IP_Address\r\n | summarize Account_Aux_StartTime = min(TimeGenerated), Account_Aux_EndTime = max(TimeGenerated), Count = count() by Caller, TenantId\r\n | top 10 by Count asc nulls last \r\n | extend UPN = iff(Caller contains '@', Caller, ''), Account_AadUserId = iff(Caller !contains '@', Caller,'')\r\n | extend Account_Name = split(UPN,'@')[0] , Account_UPNSuffix = split(UPN,'@')[1]\r\n | project Account_Name, Account_UPNSuffix, Account_AadUserId, Account_AadTenantId=TenantId, Account_Aux_StartTime , Account_Aux_EndTime};\r\n AccountActivity_byIP('
')", + "inputFields": [ + "address" + ], + "outputEntityTypes": [ + "Account" + ], + "dataSources": [ + "AzureActivity" + ], + "inputEntityType": "IP", + "displayName": "Least active accounts on Azure from this IP" + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entityQueries/97a1d515-abf2-4231-9a35-985f9de0bb91", + "name": "97a1d515-abf2-4231-9a35-985f9de0bb91", + "type": "Microsoft.SecurityInsights/entityQueries", + "etag": null, + "kind": "Expansion", + "properties": { + "queryTemplate": "let AccountActivity_byIP = (v_IP_Address:string){\r\n AzureActivity\r\n | where Caller != '' and CallerIpAddress == v_IP_Address\r\n | summarize Account_Aux_StartTime = min(TimeGenerated), Account_Aux_EndTime = max(TimeGenerated), Count = count() by Caller, TenantId\r\n | top 10 by Count desc nulls last \r\n | extend UPN = iff(Caller contains '@', Caller, ''), Account_AadUserId = iff(Caller !contains '@', Caller,'')\r\n | extend Account_Name = split(UPN,'@')[0] , Account_UPNSuffix = split(UPN,'@')[1]\r\n | project Account_Name, Account_UPNSuffix, Account_AadUserId, Account_AadTenantId=TenantId, Account_Aux_StartTime , Account_Aux_EndTime};\r\n AccountActivity_byIP('
')", + "inputFields": [ + "address" + ], + "outputEntityTypes": [ + "Account" + ], + "dataSources": [ + "AzureActivity" + ], + "inputEntityType": "IP", + "displayName": "Most active accounts on Azure from this IP" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueries/GetExpansionEntityQueryById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueries/GetExpansionEntityQueryById.json new file mode 100644 index 000000000000..d5bfcce1c0a3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueries/GetExpansionEntityQueryById.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityQueryId": "07da3cc8-c8ad-4710-a44e-334cdcb7882b" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entityQueries/07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "name": "07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "type": "Microsoft.SecurityInsights/entityQueries", + "etag": null, + "kind": "Expansion", + "properties": { + "queryTemplate": "let GetParentProcessesOnHost = (v_Host_HostName:string){\r\n SecurityEvent \r\n | where EventID == 4688 \r\n | where isnotempty(ParentProcessName)\r\n | where NewProcessName !contains ':\\\\Windows\\\\System32\\\\conhost.exe' and ParentProcessName !contains ':\\\\Windows\\\\System32\\\\conhost.exe'\r\n and NewProcessName !contains ':\\\\Windows\\\\Microsoft.NET\\\\Framework64\\\\v2.0.50727\\\\csc.exe' and ParentProcessName !contains ':\\\\Windows\\\\Microsoft.NET\\\\Framework64\\\\v2.0.50727\\\\csc.exe'\r\n and NewProcessName !contains ':\\\\Windows\\\\Microsoft.NET\\\\Framework64\\\\v2.0.50727\\\\cvtres.exe' and ParentProcessName !contains ':\\\\Windows\\\\Microsoft.NET\\\\Framework64\\\\v2.0.50727\\\\cvtres.exe'\r\n and NewProcessName!contains ':\\\\Program Files\\\\Microsoft Monitoring Agent\\\\Agent\\\\MonitoringHost.exe' and ParentProcessName !contains ':\\\\Program Files\\\\Microsoft Monitoring Agent\\\\Agent\\\\MonitoringHost.exe'\r\n and ParentProcessName !contains ':\\\\Windows\\\\CCM\\\\CcmExec.exe'\r\n | where(ParentProcessName !contains ':\\\\Windows\\\\System32\\\\svchost.exe' and (NewProcessName !contains ':\\\\Windows\\\\System32\\\\wbem\\\\WmiPrvSE.exe' or NewProcessName !contains ':\\\\Windows\\\\SysWOW64\\\\wbem\\\\WmiPrvSE.exe'))\r\n | where(ParentProcessName !contains ':\\\\Windows\\\\System32\\\\services.exe' and NewProcessName !contains ':\\\\Windows\\\\servicing\\\\TrustedInstaller.exe')\r\n | where toupper(Computer) contains v_Host_HostName or toupper(WorkstationName) contains v_Host_HostName\r\n | summarize min(TimeGenerated), max(TimeGenerated) by Account, Computer, ParentProcessName, NewProcessName, CommandLine, ProcessId\r\n | project min_TimeGenerated, max_TimeGenerated, Account, Computer, ParentProcessName, NewProcessName, CommandLine, ProcessId\r\n | project-rename Process_Host_UnstructuredName=Computer, Process_Account_UnstructuredName=Account, Process_CommandLine=CommandLine, Process_ProcessId=ProcessId, Process_ImageFile_FullPath=NewProcessName, Process_ParentProcess_ImageFile_FullPath=ParentProcessName\r\n | top 10 by min_TimeGenerated asc};\r\n GetParentProcessesOnHost(toupper(''))", + "inputFields": [ + "hostName" + ], + "outputEntityTypes": [ + "Process" + ], + "dataSources": [ + "SecurityEvent" + ], + "inputEntityType": "Host", + "displayName": "Parent processes running on host" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueryTemplates/GetActivityEntityQueryTemplateById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueryTemplates/GetActivityEntityQueryTemplateById.json new file mode 100644 index 000000000000..8802fce2f5de --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueryTemplates/GetActivityEntityQueryTemplateById.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityQueryTemplateId": "07da3cc8-c8ad-4710-a44e-334cdcb7882b" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entityQueryTemplates/07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "name": "07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "type": "Microsoft.SecurityInsights/entityQueryTemplate", + "kind": "Activity", + "properties": { + "title": "An account was deleted on this host", + "content": "On '{{Computer}}' the account '{{TargetAccount}}' was deleted by '{{AddedBy}}'", + "description": "Account deleted on host", + "queryDefinitions": { + "query": "let GetAccountActions = (v_Host_Name:string, v_Host_NTDomain:string, v_Host_DnsDomain:string, v_Host_AzureID:string, v_Host_OMSAgentID:string){\nSecurityEvent\n| where EventID in (4725, 4726, 4767, 4720, 4722, 4723, 4724)\n// parsing for Host to handle variety of conventions coming from data\n| extend Host_HostName = case(\nComputer has '@', tostring(split(Computer, '@')[0]),\nComputer has '\\\\', tostring(split(Computer, '\\\\')[1]),\nComputer has '.', tostring(split(Computer, '.')[0]),\nComputer\n)\n| extend Host_NTDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', tostring(split(Computer, '.')[-2]), \nComputer\n)\n| extend Host_DnsDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', strcat_array(array_slice(split(Computer,'.'),-2,-1),'.'), \nComputer\n)\n| where (Host_HostName =~ v_Host_Name and Host_NTDomain =~ v_Host_NTDomain) \nor (Host_HostName =~ v_Host_Name and Host_DnsDomain =~ v_Host_DnsDomain) \nor v_Host_AzureID =~ _ResourceId \nor v_Host_OMSAgentID == SourceComputerId\n| project TimeGenerated, EventID, Activity, Computer, TargetAccount, TargetUserName, TargetDomainName, TargetSid, SubjectUserName, SubjectUserSid, _ResourceId, SourceComputerId\n| extend AddedBy = SubjectUserName\n// Future support for Activities\n| extend timestamp = TimeGenerated, HostCustomEntity = Computer, AccountCustomEntity = TargetAccount\n};\nGetAccountActions('{{Host_HostName}}', '{{Host_NTDomain}}', '{{Host_DnsDomain}}', '{{Host_AzureID}}', '{{Host_OMSAgentID}}')\n \n| where EventID == 4726 " + }, + "inputEntityType": "Host", + "requiredInputFieldsSets": [ + [ + "Host_HostName", + "Host_NTDomain" + ], + [ + "Host_HostName", + "Host_DnsDomain" + ], + [ + "Host_AzureID" + ], + [ + "Host_OMSAgentID" + ] + ], + "entitiesFilter": { + "Host_OsFamily": [ + "Windows" + ] + }, + "dataTypes": [ + { + "dataType": "AuditLogs" + }, + { + "dataType": "SecurityEvent" + } + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueryTemplates/GetEntityQueryTemplates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueryTemplates/GetEntityQueryTemplates.json new file mode 100644 index 000000000000..07b4570aa83c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/entityQueryTemplates/GetEntityQueryTemplates.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "kind": "Activity", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entityQueryTemplates/37ca3555-c135-4a73-a65e-9c1d00323f5d", + "name": "37ca3555-c135-4a73-a65e-9c1d00323f5d", + "type": "Microsoft.SecurityInsights/entityQueryTemplates", + "kind": "Activity", + "properties": { + "title": "An account was deleted on this host", + "content": "On '{{Computer}}' the account '{{TargetAccount}}' was deleted by '{{AddedBy}}'", + "description": "Account deleted on host", + "queryDefinitions": { + "query": "let GetAccountActions = (v_Host_Name:string, v_Host_NTDomain:string, v_Host_DnsDomain:string, v_Host_AzureID:string, v_Host_OMSAgentID:string){\nSecurityEvent\n| where EventID in (4725, 4726, 4767, 4720, 4722, 4723, 4724)\n// parsing for Host to handle variety of conventions coming from data\n| extend Host_HostName = case(\nComputer has '@', tostring(split(Computer, '@')[0]),\nComputer has '\\\\', tostring(split(Computer, '\\\\')[1]),\nComputer has '.', tostring(split(Computer, '.')[0]),\nComputer\n)\n| extend Host_NTDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', tostring(split(Computer, '.')[-2]), \nComputer\n)\n| extend Host_DnsDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', strcat_array(array_slice(split(Computer,'.'),-2,-1),'.'), \nComputer\n)\n| where (Host_HostName =~ v_Host_Name and Host_NTDomain =~ v_Host_NTDomain) \nor (Host_HostName =~ v_Host_Name and Host_DnsDomain =~ v_Host_DnsDomain) \nor v_Host_AzureID =~ _ResourceId \nor v_Host_OMSAgentID == SourceComputerId\n| project TimeGenerated, EventID, Activity, Computer, TargetAccount, TargetUserName, TargetDomainName, TargetSid, SubjectUserName, SubjectUserSid, _ResourceId, SourceComputerId\n| extend AddedBy = SubjectUserName\n// Future support for Activities\n| extend timestamp = TimeGenerated, HostCustomEntity = Computer, AccountCustomEntity = TargetAccount\n};\nGetAccountActions('{{Host_HostName}}', '{{Host_NTDomain}}', '{{Host_DnsDomain}}', '{{Host_AzureID}}', '{{Host_OMSAgentID}}')\n \n| where EventID == 4726 " + }, + "inputEntityType": "Host", + "requiredInputFieldsSets": [ + [ + "Host_HostName", + "Host_NTDomain" + ], + [ + "Host_HostName", + "Host_DnsDomain" + ], + [ + "Host_AzureID" + ], + [ + "Host_OMSAgentID" + ] + ], + "entitiesFilter": { + "Host_OsFamily": [ + "Windows" + ] + }, + "dataTypes": [ + { + "dataType": "AuditLogs" + }, + { + "dataType": "SecurityEvent" + } + ] + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entityQueryTemplates/97a1d515-abf2-4231-9a35-985f9de0bb91", + "name": "97a1d515-abf2-4231-9a35-985f9de0bb91", + "type": "Microsoft.SecurityInsights/entityQueryTemplates", + "kind": "Activity", + "properties": { + "title": "An account was deleted on this host", + "content": "On '{{Computer}}' the account '{{TargetAccount}}' was deleted by '{{AddedBy}}'", + "description": "Account deleted on host", + "queryDefinitions": { + "query": "let GetAccountActions = (v_Host_Name:string, v_Host_NTDomain:string, v_Host_DnsDomain:string, v_Host_AzureID:string, v_Host_OMSAgentID:string){\nSecurityEvent\n| where EventID in (4725, 4726, 4767, 4720, 4722, 4723, 4724)\n// parsing for Host to handle variety of conventions coming from data\n| extend Host_HostName = case(\nComputer has '@', tostring(split(Computer, '@')[0]),\nComputer has '\\\\', tostring(split(Computer, '\\\\')[1]),\nComputer has '.', tostring(split(Computer, '.')[0]),\nComputer\n)\n| extend Host_NTDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', tostring(split(Computer, '.')[-2]), \nComputer\n)\n| extend Host_DnsDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', strcat_array(array_slice(split(Computer,'.'),-2,-1),'.'), \nComputer\n)\n| where (Host_HostName =~ v_Host_Name and Host_NTDomain =~ v_Host_NTDomain) \nor (Host_HostName =~ v_Host_Name and Host_DnsDomain =~ v_Host_DnsDomain) \nor v_Host_AzureID =~ _ResourceId \nor v_Host_OMSAgentID == SourceComputerId\n| project TimeGenerated, EventID, Activity, Computer, TargetAccount, TargetUserName, TargetDomainName, TargetSid, SubjectUserName, SubjectUserSid, _ResourceId, SourceComputerId\n| extend AddedBy = SubjectUserName\n// Future support for Activities\n| extend timestamp = TimeGenerated, HostCustomEntity = Computer, AccountCustomEntity = TargetAccount\n};\nGetAccountActions('{{Host_HostName}}', '{{Host_NTDomain}}', '{{Host_DnsDomain}}', '{{Host_AzureID}}', '{{Host_OMSAgentID}}')\n \n| where EventID == 4726 " + }, + "inputEntityType": "Host", + "requiredInputFieldsSets": [ + [ + "Host_HostName", + "Host_NTDomain" + ], + [ + "Host_HostName", + "Host_DnsDomain" + ], + [ + "Host_AzureID" + ], + [ + "Host_OMSAgentID" + ] + ], + "entitiesFilter": { + "Host_OsFamily": [ + "Windows" + ] + }, + "dataTypes": [ + { + "dataType": "AuditLogs" + }, + { + "dataType": "SecurityEvent" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/fileImports/CreateFileImport.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/fileImports/CreateFileImport.json new file mode 100644 index 000000000000..67c88a2641d2 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/fileImports/CreateFileImport.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "fileImportId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "fileImport": { + "properties": { + "source": "mySource", + "importFile": { + "fileName": "myFile.json", + "fileSize": 4653, + "fileFormat": "JSON" + }, + "contentType": "StixIndicator", + "ingestionMode": "IngestAnyValidRecords" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/FileImports/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/FileImports", + "properties": { + "importFile": { + "fileName": "myFile.json", + "fileSize": 4653, + "fileFormat": "JSON", + "fileContentUri": "https://sentinelimportswus2.blob.core.windows.net/78c2e51a-3cd3-4ca0-a2d4-e7effb9a05fe/43967a5e-47a7-474e-afb8-2081e9b99ca1/fileName.json?skoid=&sktid=&skt=2022-03-25T21%3A12%3A51Z&ske=2022-03-25T22%3A12%3A51Z&sks=b&skv=2020-10-02&sv=2020-08-04&st=2022-03-25T21%3A12%3A51Z&se=2022-03-25T22%3A12%3A51Z&sr=b&sp=c&sig=", + "deleteStatus": "NotDeleted" + }, + "state": "WaitingForUpload", + "contentType": "StixIndicator", + "ingestionMode": "IngestAnyValidRecords", + "totalRecordCount": null, + "validRecordCount": null, + "ingestedRecordCount": null, + "createdTimeUTC": "2022-04-04T20:05:59.847136Z", + "filesValidUntilTimeUTC": "2022-04-05T20:05:59.8471361Z", + "importValidUntilTimeUTC": "2022-05-04T20:05:59.8471366Z", + "source": "mySource" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/FileImports/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/FileImports", + "properties": { + "importFile": { + "fileName": "myFile.json", + "fileSize": 4653, + "fileFormat": "JSON", + "fileContentUri": "https://sentinelimportswus2.blob.core.windows.net/78c2e51a-3cd3-4ca0-a2d4-e7effb9a05fe/43967a5e-47a7-474e-afb8-2081e9b99ca1/fileName.json?skoid=&sktid=&skt=2022-03-25T21%3A12%3A51Z&ske=2022-03-25T22%3A12%3A51Z&sks=b&skv=2020-10-02&sv=2020-08-04&st=2022-03-25T21%3A12%3A51Z&se=2022-03-25T22%3A12%3A51Z&sr=b&sp=c&sig=", + "deleteStatus": "NotDeleted" + }, + "state": "WaitingForUpload", + "contentType": "StixIndicator", + "ingestionMode": "IngestAnyValidRecords", + "totalRecordCount": null, + "validRecordCount": null, + "ingestedRecordCount": null, + "createdTimeUTC": "2022-04-04T20:05:59.847136Z", + "filesValidUntilTimeUTC": "2022-04-05T20:05:59.8471361Z", + "importValidUntilTimeUTC": "2022-05-04T20:05:59.8471366Z", + "source": "mySource" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/fileImports/DeleteFileImport.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/fileImports/DeleteFileImport.json new file mode 100644 index 000000000000..9cada9a75003 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/fileImports/DeleteFileImport.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "fileImportId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/FileImports/73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/FileImports/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/FileImports", + "properties": { + "importFile": { + "fileName": "myFile.json", + "fileSize": 5146, + "fileFormat": "JSON", + "fileContentUri": null, + "deleteStatus": "NotDeleted" + }, + "state": "Ingested", + "contentType": "StixIndicator", + "ingestionMode": "IngestAnyValidRecords", + "totalRecordCount": 5, + "validRecordCount": 5, + "ingestedRecordCount": 5, + "createdTimeUTC": "2022-03-25T21:02:38.8350631Z", + "filesValidUntilTimeUTC": "2022-03-26T21:02:38.8350632Z", + "importValidUntilTimeUTC": "2022-04-24T21:02:38.8350636Z", + "source": "mySource" + } + } + }, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/fileImports/GetFileImportById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/fileImports/GetFileImportById.json new file mode 100644 index 000000000000..9b80a0401eaf --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/fileImports/GetFileImportById.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "fileImportId": "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/FileImports/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/FileImports", + "properties": { + "importFile": { + "fileName": "myFile.json", + "fileSize": 5146, + "fileFormat": "JSON", + "fileContentUri": "https://sentinelimportswus2.blob.core.windows.net/78c2e51a-3cd3-4ca0-a2d4-e7effb9a05fe/43967a5e-47a7-474e-afb8-2081e9b99ca1/myFile.json?skoid=&sktid=&skt=2022-03-25T21%3A12%3A51Z&ske=2022-03-25T22%3A12%3A51Z&sks=b&skv=2020-10-02&sv=2020-08-04&st=2022-03-25T21%3A12%3A51Z&se=2022-03-25T22%3A12%3A51Z&sr=b&sp=c&sig=", + "deleteStatus": "NotDeleted" + }, + "state": "Ingested", + "contentType": "StixIndicator", + "ingestionMode": "IngestAnyValidRecords", + "totalRecordCount": 5, + "validRecordCount": 5, + "ingestedRecordCount": 5, + "createdTimeUTC": "2022-03-25T21:02:38.8350631Z", + "filesValidUntilTimeUTC": "2022-03-26T21:02:38.8350632Z", + "importValidUntilTimeUTC": "2022-04-24T21:02:38.8350636Z", + "source": "mySource" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/fileImports/GetFileImports.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/fileImports/GetFileImports.json new file mode 100644 index 000000000000..a5cbbc249cb4 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/fileImports/GetFileImports.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "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/FileImports/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/FileImports", + "properties": { + "importFile": { + "fileName": "fileName.json", + "fileSize": 5146, + "fileFormat": "JSON", + "fileContentUri": null, + "deleteStatus": "NotDeleted" + }, + "state": "Ingested", + "contentType": "StixIndicator", + "ingestionMode": "IngestAnyValidRecords", + "totalRecordCount": 5, + "validRecordCount": 5, + "ingestedRecordCount": 5, + "createdTimeUTC": "2022-03-25T21:02:38.8350631Z", + "filesValidUntilTimeUTC": "2022-03-26T21:02:38.8350632Z", + "importValidUntilTimeUTC": "2022-04-24T21:02:38.8350636Z", + "source": "mySource" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/CreateHunt.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/CreateHunt.json new file mode 100644 index 000000000000..6ddd3e322a5e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/CreateHunt.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "huntId": "163e7b2a-a2ec-4041-aaba-d878a38f265f", + "hunt": { + "properties": { + "displayName": "Log4J new hunt", + "description": "Log4J Hunt Description", + "status": "New", + "hypothesisStatus": "Unknown", + "attackTactics": [ + "Reconnaissance" + ], + "attackTechniques": [ + "T1595" + ], + "labels": [ + "Label1", + "Label2" + ], + "owner": { + "objectId": "873b5263-5d34-4149-b356-ad341b01e123" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/hunts/163e7b2a-a2ec-4041-aaba-d878a38f265f", + "name": "163e7b2a-a2ec-4041-aaba-d878a38f265f", + "etag": "\"de00c408-0000-0c00-0000-62741e350000\"", + "type": "Microsoft.SecurityInsights/hunts", + "properties": { + "displayName": "Log4J new hunt", + "description": "Log4J Hunt Description", + "status": "New", + "hypothesisStatus": "Unknown", + "attackTactics": [ + "Reconnaissance" + ], + "attackTechniques": [ + "T1595" + ], + "huntStartTimeUtc": "2022-03-11T09:47:15.438Z", + "huntEndTimeUtc": "2022-03-12T09:47:15.438Z", + "labels": [ + "Label1", + "Label2" + ], + "owner": { + "objectId": "873b5263-5d34-4149-b356-ad341b01e123", + "email": "testemail@microsoft.com", + "assignedTo": null, + "userPrincipalName": "John Doe", + "ownerType": "User" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/hunts/163e7b2a-a2ec-4041-aaba-d878a38f265f", + "name": "163e7b2a-a2ec-4041-aaba-d878a38f265f", + "etag": "\"de00c408-0000-0c00-0000-62741e350000\"", + "type": "Microsoft.SecurityInsights/hunts", + "properties": { + "displayName": "Log4J new hunt", + "description": "Log4J Hunt Description", + "status": "New", + "hypothesisStatus": "Unknown", + "attackTactics": [ + "Reconnaissance" + ], + "attackTechniques": [ + "T1595" + ], + "huntSequenceNumber": 0, + "huntStartTimeUtc": "2022-03-11T09:47:15.438Z", + "huntEndTimeUtc": "2022-03-12T09:47:15.438Z", + "labels": [ + "Label1", + "Label2" + ], + "owner": { + "objectId": "873b5263-5d34-4149-b356-ad341b01e123", + "email": "testemail@microsoft.com", + "assignedTo": null, + "userPrincipalName": "John Doe", + "ownerType": "User" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/CreateHuntComment.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/CreateHuntComment.json new file mode 100644 index 000000000000..f24ea409328d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/CreateHuntComment.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "huntId": "163e7b2a-a2ec-4041-aaba-d878a38f265f", + "huntCommentId": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "huntComment": { + "properties": { + "message": "This is a test comment." + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/hunts/163e7b2a-a2ec-4041-aaba-d878a38f265f/comments/2216d0e1-91e3-4902-89fd-d2df8c123456", + "name": "2216d0e1-91e3-4902-89fd-d2df8c123456", + "etag": "\"3102f74d-0000-0c00-0000-629e6e050000\"", + "type": "Microsoft.SecurityInsights/hunts/comments", + "systemData": { + "createdAt": "2021-08-15T16:42:38.8709453Z", + "createdBy": "testuser@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T16:42:38.8709453Z", + "lastModifiedBy": "testuser@microsoft.com", + "lastModifiedByType": "User" + }, + "properties": { + "message": "This is a test comment." + } + } + }, + "201": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/hunts/163e7b2a-a2ec-4041-aaba-d878a38f265f/comments/2216d0e1-91e3-4902-89fd-d2df8c123456", + "name": "2216d0e1-91e3-4902-89fd-d2df8c123456", + "etag": "\"3102f74d-0000-0c00-0000-629e6e050000\"", + "type": "Microsoft.SecurityInsights/hunts/comments", + "systemData": { + "createdAt": "2021-08-15T16:42:38.8709453Z", + "createdBy": "testuser@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T16:42:38.8709453Z", + "lastModifiedBy": "testuser@microsoft.com", + "lastModifiedByType": "User" + }, + "properties": { + "message": "This is a test comment." + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/CreateHuntRelation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/CreateHuntRelation.json new file mode 100644 index 000000000000..920953a8c4fc --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/CreateHuntRelation.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "huntId": "163e7b2a-a2ec-4041-aaba-d878a38f265f", + "huntRelationId": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "huntRelation": { + "properties": { + "relatedResourceId": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/Bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "labels": [ + "Test Label" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/hunts/163e7b2a-a2ec-4041-aaba-d878a38f265f/relations/2216d0e1-91e3-4902-89fd-d2df8c535096", + "name": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "etag": "\"26012da2-0000-0c00-0000-627ad2760000\"", + "type": "Microsoft.SecurityInsights/hunts/relations", + "properties": { + "relatedResourceId": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/Bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/Bookmarks", + "labels": [ + "Test Label" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/hunts/163e7b2a-a2ec-4041-aaba-d878a38f265f/relations/2216d0e1-91e3-4902-89fd-d2df8c535096", + "name": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "etag": "\"26012da2-0000-0c00-0000-627ad2760000\"", + "type": "Microsoft.SecurityInsights/hunts/relations", + "properties": { + "relatedResourceId": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/Bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/Bookmarks", + "labels": [ + "Test Label" + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/DeleteHunt.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/DeleteHunt.json new file mode 100644 index 000000000000..2e05712a9dab --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/DeleteHunt.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "huntId": "163e7b2a-a2ec-4041-aaba-d878a38f265f" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/DeleteHuntComment.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/DeleteHuntComment.json new file mode 100644 index 000000000000..7452f5027016 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/DeleteHuntComment.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "huntId": "163e7b2a-a2ec-4041-aaba-d878a38f265f", + "huntCommentId": "2216d0e1-91e3-4902-89fd-d2df8c123456" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/DeleteHuntRelation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/DeleteHuntRelation.json new file mode 100644 index 000000000000..1e0f34a18e80 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/DeleteHuntRelation.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "huntId": "163e7b2a-a2ec-4041-aaba-d878a38f265f", + "huntRelationId": "2216d0e1-91e3-4902-89fd-d2df8c535096" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/GetHuntById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/GetHuntById.json new file mode 100644 index 000000000000..7a5fdf275f60 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/GetHuntById.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "huntId": "163e7b2a-a2ec-4041-aaba-d878a38f265f" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/hunts/163e7b2a-a2ec-4041-aaba-d878a38f265f", + "name": "163e7b2a-a2ec-4041-aaba-d878a38f265f", + "etag": "\"de00c408-0000-0c00-0000-62741e350000\"", + "type": "Microsoft.SecurityInsights/hunts", + "properties": { + "displayName": "Log4J new hunt ", + "description": "Log4J Hunt Description", + "status": "New", + "hypothesisStatus": "Unknown", + "attackTactics": [ + "Reconnaissance" + ], + "attackTechniques": [ + "T1595" + ], + "labels": [ + "Label1", + "Label2" + ], + "owner": { + "objectId": "873b5263-5d34-4149-b356-ad341b01e123", + "email": "testemail@microsoft.com", + "assignedTo": null, + "userPrincipalName": "John Doe", + "ownerType": "User" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/GetHuntCommentById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/GetHuntCommentById.json new file mode 100644 index 000000000000..798c56e8863c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/GetHuntCommentById.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "huntId": "163e7b2a-a2ec-4041-aaba-d878a38f265f", + "huntCommentId": "2216d0e1-91e3-4902-89fd-d2df8c535096" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/hunts/163e7b2a-a2ec-4041-aaba-d878a38f265f/comments/2216d0e1-91e3-4902-89fd-d2df8c123456", + "name": "2216d0e1-91e3-4902-89fd-d2df8c123456", + "etag": "\"3102f74d-0000-0c00-0000-629e6e050000\"", + "type": "Microsoft.SecurityInsights/hunts/comments", + "systemData": { + "createdAt": "2021-08-15T16:42:38.8709453Z", + "createdBy": "testuser@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T16:42:38.8709453Z", + "lastModifiedBy": "testuser@microsoft.com", + "lastModifiedByType": "User" + }, + "properties": { + "message": "This is a comment." + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/GetHuntComments.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/GetHuntComments.json new file mode 100644 index 000000000000..076f7096cc69 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/GetHuntComments.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "huntId": "163e7b2a-a2ec-4041-aaba-d878a38f265f" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/hunts/163e7b2a-a2ec-4041-aaba-d878a38f265f/comments/2216d0e1-91e3-4902-89fd-d2df8c123456", + "name": "2216d0e1-91e3-4902-89fd-d2df8c123456", + "etag": "\"3102f74d-0000-0c00-0000-629e6e050000\"", + "type": "Microsoft.SecurityInsights/hunts/comments", + "properties": { + "message": "This is a test comment." + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/GetHuntRelationById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/GetHuntRelationById.json new file mode 100644 index 000000000000..3ea44eaefe90 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/GetHuntRelationById.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "huntId": "163e7b2a-a2ec-4041-aaba-d878a38f265f", + "huntRelationId": "2216d0e1-91e3-4902-89fd-d2df8c535096" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/hunts/163e7b2a-a2ec-4041-aaba-d878a38f265f/relations/2216d0e1-91e3-4902-89fd-d2df8c535096", + "name": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "etag": "\"26012da2-0000-0c00-0000-627ad2760000\"", + "type": "Microsoft.SecurityInsights/hunts/relations", + "properties": { + "relatedResourceId": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/Bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/Bookmarks", + "labels": [ + "label1" + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/GetHuntRelations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/GetHuntRelations.json new file mode 100644 index 000000000000..ecc0c9db2138 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/GetHuntRelations.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "huntId": "163e7b2a-a2ec-4041-aaba-d878a38f265f" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/hunts/163e7b2a-a2ec-4041-aaba-d878a38f265f/relations/2216d0e1-91e3-4902-89fd-d2df8c535096", + "name": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "etag": "\"26012da2-0000-0c00-0000-627ad2760000\"", + "type": "Microsoft.SecurityInsights/hunts/relations", + "properties": { + "relatedResourceId": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/Bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/Bookmarks", + "labels": [ + "label1" + ] + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/GetHunts.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/GetHunts.json new file mode 100644 index 000000000000..a45a1c1c5edb --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/hunts/GetHunts.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/hunts/b372ee75-2cad-4b71-8917-d5d5df9315b5", + "name": "b372ee75-2cad-4b71-8917-d5d5df9315b5", + "etag": "\"de00c408-0000-0c00-0000-62741e350000\"", + "type": "Microsoft.SecurityInsights/hunts", + "properties": { + "displayName": "Log4J new hunt", + "description": "Log4J Hunt Description", + "status": "New", + "hypothesisStatus": "Unknown", + "attackTactics": [ + "Reconnaissance" + ], + "attackTechniques": [ + "T1595" + ], + "labels": [ + "Label1", + "Label2" + ], + "owner": { + "objectId": "873b5263-5d34-4149-b356-ad341b01e123", + "email": "testemail@microsoft.com", + "assignedTo": null, + "userPrincipalName": "John Doe", + "ownerType": "User" + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentAlerts/Incidents_ListAlerts.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentAlerts/Incidents_ListAlerts.json new file mode 100644 index 000000000000..b89cf90e27fe --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentAlerts/Incidents_ListAlerts.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "69a30280-6a4c-4aa7-9af0-5d63f335d600" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRG/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Entities/baa8a239-6fde-4ab7-a093-d09f7b75c58c", + "name": "baa8a239-6fde-4ab7-a093-d09f7b75c58c", + "type": "Microsoft.SecurityInsights/Entities", + "kind": "SecurityAlert", + "properties": { + "systemAlertId": "baa8a239-6fde-4ab7-a093-d09f7b75c58c", + "tactics": [], + "alertDisplayName": "myAlert", + "confidenceLevel": "Unknown", + "severity": "Low", + "vendorName": "Microsoft", + "productName": "Azure Security Center", + "alertType": "myAlert", + "processingEndTime": "2020-07-20T18:21:53.615Z", + "status": "New", + "endTimeUtc": "2020-07-20T18:21:53.615Z", + "startTimeUtc": "2020-07-20T18:21:53.615Z", + "timeGenerated": "2020-07-20T18:21:53.615Z", + "resourceIdentifiers": [ + { + "type": "LogAnalytics", + "workspaceId": "c8c99641-985d-4e4e-8e91-fb3466cd0e5b", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroup": "myRG" + } + ], + "additionalData": { + "alertMessageEnqueueTime": "2020-07-20T18:21:57.304Z" + }, + "friendlyName": "myAlert" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentBookmarks/Incidents_ListBookmarks.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentBookmarks/Incidents_ListBookmarks.json new file mode 100644 index 000000000000..f2a304f3ceb2 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentBookmarks/Incidents_ListBookmarks.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "69a30280-6a4c-4aa7-9af0-5d63f335d600" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/afbd324f-6c48-459c-8710-8d1e1cd03812", + "name": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "type": "Microsoft.SecurityInsights/Entities", + "kind": "Bookmark", + "properties": { + "displayName": "SecurityEvent - 868f40f4698d", + "created": "2020-06-17T15:34:01.426+00:00", + "updated": "2020-06-17T15:34:01.426+00:00", + "createdBy": { + "objectId": "b03ca914-5eb6-45e5-9417-fe0797c372fd", + "email": "user@contoso.com", + "name": "user" + }, + "updatedBy": { + "objectId": "b03ca914-5eb6-45e5-9417-fe0797c372fd", + "email": "user@contoso.com", + "name": "user" + }, + "eventTime": "2020-06-17T15:34:01.426+00:00", + "labels": [], + "query": "SecurityEvent\r\n| take 1\n", + "queryResult": "{\"TimeGenerated\":\"2020-05-24T01:24:25.67Z\",\"Account\":\"\\\\ADMINISTRATOR\",\"AccountType\":\"User\",\"Computer\":\"SecurityEvents\",\"EventSourceName\":\"Microsoft-Windows-Security-Auditing\",\"Channel\":\"Security\",\"Task\":12544,\"Level\":\"16\",\"EventID\":4625,\"Activity\":\"4625 - An account failed to log on.\",\"AuthenticationPackageName\":\"NTLM\",\"FailureReason\":\"%%2313\",\"IpAddress\":\"176.113.115.73\",\"IpPort\":\"0\",\"LmPackageName\":\"-\",\"LogonProcessName\":\"NtLmSsp \",\"LogonType\":3,\"LogonTypeName\":\"3 - Network\",\"Process\":\"-\",\"ProcessId\":\"0x0\",\"__entityMapping\":{\"\\\\ADMINISTRATOR\":\"Account\",\"SecurityEvents\":\"Host\"}}", + "additionalData": { + "eTag": "\"3b00acab-0000-0d00-0000-5f15e4ed0000\"", + "entityId": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "friendlyName": "SecurityEvent - 868f40f4698d" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentComments/IncidentComments_CreateOrUpdate.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentComments/IncidentComments_CreateOrUpdate.json new file mode 100644 index 000000000000..8843cbf03190 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentComments/IncidentComments_CreateOrUpdate.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "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": { + "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", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "type": "Microsoft.SecurityInsights/incidents/comments", + "properties": { + "message": "Some message", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-03T13:15:30Z", + "author": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + }, + "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", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "type": "Microsoft.SecurityInsights/incidents/comments", + "properties": { + "message": "Some message", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-03T13:15:30Z", + "author": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentComments/IncidentComments_Delete.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentComments/IncidentComments_Delete.json new file mode 100644 index 000000000000..df4a47e1e336 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentComments/IncidentComments_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentCommentId": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentComments/IncidentComments_Get.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentComments/IncidentComments_Get.json new file mode 100644 index 000000000000..55e0021058e5 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentComments/IncidentComments_Get.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "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", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "type": "Microsoft.SecurityInsights/incidents/comments", + "properties": { + "message": "Some message", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-03T11:10:30Z", + "author": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentComments/IncidentComments_List.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentComments/IncidentComments_List.json new file mode 100644 index 000000000000..8cb146deb362 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentComments/IncidentComments_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "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", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "type": "Microsoft.SecurityInsights/incidents/comments", + "properties": { + "message": "Some message", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-03T11:10:30Z", + "author": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentEntities/Incidents_ListEntities.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentEntities/Incidents_ListEntities.json new file mode 100644 index 000000000000..7b983614d350 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentEntities/Incidents_ListEntities.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "69a30280-6a4c-4aa7-9af0-5d63f335d600" + }, + "responses": { + "200": { + "body": { + "entities": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/Entities", + "kind": "Account", + "properties": { + "accountName": "administrator", + "ntDomain": "domain", + "friendlyName": "administrator" + } + } + ], + "metaData": [ + { + "entityKind": "Account", + "count": 1 + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentTasks/IncidentTasks_CreateOrUpdate.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentTasks/IncidentTasks_CreateOrUpdate.json new file mode 100644 index 000000000000..7c19484cf669 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentTasks/IncidentTasks_CreateOrUpdate.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentTaskId": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "incidentTask": { + "properties": { + "title": "Task title", + "description": "Task description", + "status": "New" + } + } + }, + "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/tasks/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "type": "Microsoft.SecurityInsights/incidents/tasks", + "properties": { + "title": "Task title", + "description": "Task description", + "status": "New", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-03T11:10:30Z", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + }, + "lastModifiedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + }, + "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/tasks/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "type": "Microsoft.SecurityInsights/incidents/tasks", + "properties": { + "title": "Task title", + "description": "Task description", + "status": "New", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-03T11:10:30Z", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + }, + "lastModifiedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentTasks/IncidentTasks_Delete.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentTasks/IncidentTasks_Delete.json new file mode 100644 index 000000000000..de05a1e32476 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentTasks/IncidentTasks_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentTaskId": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentTasks/IncidentTasks_Get.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentTasks/IncidentTasks_Get.json new file mode 100644 index 000000000000..eb0ab79e0613 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentTasks/IncidentTasks_Get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentTaskId": "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/tasks/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "type": "Microsoft.SecurityInsights/incidents/tasks", + "properties": { + "title": "Task title", + "description": "Task description", + "status": "New", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-03T11:10:30Z", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + }, + "lastModifiedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentTasks/IncidentTasks_List.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentTasks/IncidentTasks_List.json new file mode 100644 index 000000000000..5d17f45e2f6e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentTasks/IncidentTasks_List.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "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/tasks/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "type": "Microsoft.SecurityInsights/incidents/tasks", + "properties": { + "title": "Task title", + "description": "Task description", + "status": "New", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-03T11:10:30Z", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + }, + "lastModifiedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentTeam/Incidents_CreateTeam.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentTeam/Incidents_CreateTeam.json new file mode 100644 index 000000000000..2086a906de12 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/IncidentTeam/Incidents_CreateTeam.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "69a30280-6a4c-4aa7-9af0-5d63f335d600", + "teamProperties": { + "teamName": "Team name", + "teamDescription": "Team description", + "groupIds": null, + "memberIds": null + } + }, + "responses": { + "200": { + "body": { + "teamId": "99978838-9bda-4ad4-8f93-4cf7ebc50ca5", + "primaryChannelUrl": "https://teams.microsoft.com/l/team/19:80bf3b25485b4067b7d2dc4eec9e1578%40thread.tacv2/conversations?groupId=99978838-9bda-4ad4-8f93-4cf7ebc50ca5&tenantId=5b5a146c-eba8-46af-96f8-e31b50d15a3f", + "teamCreationTimeUtc": "2021-03-15T17:08:21.995Z", + "name": "Team name", + "description": "Team description" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/Incidents_CreateOrUpdate.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/Incidents_CreateOrUpdate.json new file mode 100644 index 000000000000..0037034b833c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/Incidents_CreateOrUpdate.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incident": { + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "title": "My incident", + "description": "This is a demo incident", + "severity": "High", + "status": "Closed", + "classification": "FalsePositive", + "classificationReason": "InaccurateData", + "classificationComment": "Not a malicious activity", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": null, + "assignedTo": null, + "userPrincipalName": null, + "ownerType": null + }, + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "lastActivityTimeUtc": "2019-01-01T13:05:30Z" + } + } + }, + "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", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0001\"", + "type": "Microsoft.SecurityInsights/incidents", + "properties": { + "title": "My incident", + "description": "This is a demo incident", + "severity": "High", + "status": "Closed", + "classification": "FalsePositive", + "classificationReason": "InaccurateData", + "classificationComment": "Not a malicious activity", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "assignedTo": "john doe", + "userPrincipalName": "john@contoso.com", + "ownerType": "User" + }, + "labels": [], + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "lastActivityTimeUtc": "2019-01-01T13:05:30Z", + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "incidentNumber": 3177, + "additionalData": { + "alertsCount": 0, + "bookmarksCount": 0, + "commentsCount": 3, + "alertProductNames": [], + "tactics": [ + "InitialAccess", + "Persistence" + ], + "techniques": [ + "T1091", + "T1133", + "T1053" + ], + "providerIncidentUrl": "https://security.microsoft.com/incidents/3177?tid=5b5a146c-eba8-46af-96f8-e31b50d15a3f" + }, + "relatedAnalyticRuleIds": [ + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/fab3d2d4-747f-46a7-8ef0-9c0be8112bf7" + ], + "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", + "providerName": "Azure Sentinel", + "providerIncidentId": "3177" + } + } + }, + "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", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0001\"", + "type": "Microsoft.SecurityInsights/incidents", + "properties": { + "title": "My incident", + "description": "This is a demo incident", + "severity": "High", + "status": "Closed", + "classification": "FalsePositive", + "classificationReason": "InaccurateData", + "classificationComment": "Not a malicious activity", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "assignedTo": "john doe", + "userPrincipalName": "john@contoso.com", + "ownerType": "User" + }, + "labels": [], + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "lastActivityTimeUtc": "2019-01-01T13:05:30Z", + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "incidentNumber": 3177, + "additionalData": { + "alertsCount": 0, + "bookmarksCount": 0, + "commentsCount": 3, + "alertProductNames": [], + "tactics": [ + "InitialAccess", + "Persistence" + ], + "techniques": [ + "T1091", + "T1133", + "T1053" + ], + "providerIncidentUrl": "https://security.microsoft.com/incidents/3177?tid=5b5a146c-eba8-46af-96f8-e31b50d15a3f" + }, + "relatedAnalyticRuleIds": [ + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/fab3d2d4-747f-46a7-8ef0-9c0be8112bf7" + ], + "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", + "providerName": "Azure Sentinel", + "providerIncidentId": "3177" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/Incidents_Delete.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/Incidents_Delete.json new file mode 100644 index 000000000000..f650705ea9d1 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/Incidents_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "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/preview/2024-04-01-preview/examples/incidents/Incidents_Get.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/Incidents_Get.json new file mode 100644 index 000000000000..26eebfd66ab3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/Incidents_Get.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "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", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/incidents", + "properties": { + "title": "My incident", + "description": "This is a demo incident", + "severity": "High", + "status": "Closed", + "classification": "FalsePositive", + "classificationReason": "InaccurateData", + "classificationComment": "Not a malicious activity", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "assignedTo": "john doe", + "userPrincipalName": "john@contoso.com", + "ownerType": "User" + }, + "labels": [], + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "lastActivityTimeUtc": "2019-01-01T13:05:30Z", + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "incidentNumber": 3177, + "additionalData": { + "alertsCount": 0, + "bookmarksCount": 0, + "commentsCount": 3, + "alertProductNames": [], + "tactics": [ + "InitialAccess", + "Persistence" + ], + "techniques": [ + "T1091", + "T1133", + "T1053" + ], + "providerIncidentUrl": "https://security.microsoft.com/incidents/3177?tid=5b5a146c-eba8-46af-96f8-e31b50d15a3f" + }, + "relatedAnalyticRuleIds": [ + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/fab3d2d4-747f-46a7-8ef0-9c0be8112bf7" + ], + "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", + "providerName": "Azure Sentinel", + "providerIncidentId": "3177" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/Incidents_List.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/Incidents_List.json new file mode 100644 index 000000000000..296e1720ccea --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/Incidents_List.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "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", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/incidents", + "properties": { + "title": "My incident", + "description": "This is a demo incident", + "severity": "High", + "status": "Closed", + "classification": "FalsePositive", + "classificationReason": "InaccurateData", + "classificationComment": "Not a malicious activity", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "assignedTo": "john doe", + "userPrincipalName": "john@contoso.com", + "ownerType": "User" + }, + "labels": [], + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "lastActivityTimeUtc": "2019-01-01T13:05:30Z", + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "incidentNumber": 3177, + "additionalData": { + "alertsCount": 0, + "bookmarksCount": 0, + "commentsCount": 3, + "alertProductNames": [], + "tactics": [ + "InitialAccess", + "Persistence" + ], + "techniques": [ + "T1091", + "T1133", + "T1053" + ], + "providerIncidentUrl": "https://security.microsoft.com/incidents/3177?tid=5b5a146c-eba8-46af-96f8-e31b50d15a3f" + }, + "relatedAnalyticRuleIds": [ + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/fab3d2d4-747f-46a7-8ef0-9c0be8112bf7" + ], + "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", + "providerName": "Azure Sentinel", + "providerIncidentId": "3177" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/relations/CreateIncidentRelation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/relations/CreateIncidentRelation.json new file mode 100644 index 000000000000..a5cf94872df4 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/relations/CreateIncidentRelation.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "relation": { + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/bookmarks" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/bookmarks" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/relations/DeleteIncidentRelation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/relations/DeleteIncidentRelation.json new file mode 100644 index 000000000000..3f8e8d1b080e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/relations/DeleteIncidentRelation.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/relations/GetAllIncidentRelations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/relations/GetAllIncidentRelations.json new file mode 100644 index 000000000000..a275a8836af9 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/relations/GetAllIncidentRelations.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/bookmarks" + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/9673a17d-8bc7-4ca6-88ee-38a4f3efc032", + "name": "9673a17d-8bc7-4ca6-88ee-38a4f3efc032", + "type": "Microsoft.SecurityInsights/incidents/relations", + "etag": "6f714025-dd7c-46aa-b5d0-b9857488d060", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/1dd267cd-8a1f-4f6f-b92c-da43ac8819af", + "relatedResourceName": "1dd267cd-8a1f-4f6f-b92c-da43ac8819af", + "relatedResourceType": "Microsoft.SecurityInsights/entities", + "relatedResourceKind": "SecurityAlert" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/relations/GetIncidentRelationByName.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/relations/GetIncidentRelationByName.json new file mode 100644 index 000000000000..f2183ea67171 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/incidents/relations/GetIncidentRelationByName.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "relationName": "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/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/bookmarks" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/manualTrigger/Entities_RunPlaybook.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/manualTrigger/Entities_RunPlaybook.json new file mode 100644 index 000000000000..cf37e1ae69f7 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/manualTrigger/Entities_RunPlaybook.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityIdentifier": "72e01a22-5cd2-4139-a149-9f2736ff2ar2", + "manualTriggerRequestBody": { + "logicAppsResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Logic/workflows/my-playbook-name", + "tenantId": "qwere6b2-9ac0-4464-9919-dccaee2e4ddd", + "incidentArmId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5" + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/manualTrigger/Incidents_RunPlaybook.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/manualTrigger/Incidents_RunPlaybook.json new file mode 100644 index 000000000000..5c0560e74a6c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/manualTrigger/Incidents_RunPlaybook.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentIdentifier": "73e01a99-5cd7-4139-a149-9f2736ff2ar4", + "manualTriggerRequestBody": { + "logicAppsResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Logic/workflows/my-playbook-name", + "tenantId": "qwere6b2-9ac0-4464-9919-dccaee2e4ddd" + } + }, + "responses": { + "204": { + "body": {} + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/DeleteMetadata.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/DeleteMetadata.json new file mode 100644 index 000000000000..105fce48c111 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/DeleteMetadata.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "metadataName": "metadataName" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/GetAllMetadata.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/GetAllMetadata.json new file mode 100644 index 000000000000..9b9e3da67298 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/GetAllMetadata.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/metadata/metadataName1", + "name": "metadataName1", + "type": "Microsoft.SecurityInsights/metadata", + "properties": { + "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", + "version": "1.0.0.0", + "kind": "AnalyticsRule", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName", + "source": { + "kind": "Solution", + "name": "Contoso Solution 1.0", + "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" + } + } + }, + { + "id": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/metadata/metadataName2", + "name": "metadataName2", + "type": "Microsoft.SecurityInsights/metadata", + "properties": { + "contentId": "f5160682-0e10-4e23-8fcf-df3df49c5522", + "version": "1.0.0.0", + "kind": "AnalyticsRule", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName2", + "source": { + "kind": "Solution", + "name": "Contoso Solution 1.0", + "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" + } + } + }, + { + "id": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.Insights/workbooks/myWorkspace/providers/Microsoft.SecurityInsights/metadata/metadataName3", + "name": "metadataName3", + "type": "Microsoft.SecurityInsights/metadata", + "properties": { + "contentId": "f593501d-ec01-4057-8146-a1de35c461ef", + "version": "1.0.0.0", + "kind": "Workbook", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.Insights/workbooks/workbookName", + "source": { + "kind": "Solution", + "name": "Contoso Solution 1.0", + "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/GetAllMetadataOData.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/GetAllMetadataOData.json new file mode 100644 index 000000000000..298023c78912 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/GetAllMetadataOData.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ODataFilter": "properties/kind eq 'AnalyticsRule'", + "ODataOrderBy": "properties/parentId desc", + "ODataSkip": "2", + "ODataTop": "2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/metadata/metadataName1", + "name": "metadataName1", + "type": "Microsoft.SecurityInsights/metadata", + "properties": { + "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", + "version": "1.0.0.0", + "kind": "AnalyticsRule", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName1", + "source": { + "kind": "Solution", + "name": "Contoso Solution 1.0", + "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" + } + } + }, + { + "id": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/metadata/metadataName2", + "name": "metadataName2", + "type": "Microsoft.SecurityInsights/metadata", + "properties": { + "contentId": "f5160682-0e10-4e23-8fcf-df3df49c5522", + "version": "1.0.0.0", + "kind": "AnalyticsRule", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName2", + "source": { + "kind": "Solution", + "name": "Contoso Solution 1.0", + "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/GetMetadata.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/GetMetadata.json new file mode 100644 index 000000000000..31ed86763d58 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/GetMetadata.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "2e1dc338-d04d-4443-b721-037eff4fdcac", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "metadataName": "metadataName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/metadata/metadataName", + "name": "metadataName", + "type": "Microsoft.SecurityInsights/metadata", + "properties": { + "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", + "version": "1.0.0.0", + "kind": "AnalyticsRule", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName", + "source": { + "kind": "Solution", + "name": "Contoso Solution 1.0", + "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" + }, + "author": { + "name": "User Name", + "email": "email@microsoft.com" + }, + "support": { + "name": "Microsoft", + "email": "support@microsoft.com", + "link": "https://support.microsoft.com/", + "tier": "Partner" + }, + "dependencies": { + "operator": "AND", + "criteria": [ + { + "operator": "OR", + "criteria": [ + { + "contentId": "045d06d0-ee72-4794-aba4-cf5646e4c756", + "kind": "DataConnector" + }, + { + "contentId": "dbfcb2cc-d782-40ef-8d94-fe7af58a6f2d", + "kind": "DataConnector" + }, + { + "contentId": "de4dca9b-eb37-47d6-a56f-b8b06b261593", + "kind": "DataConnector", + "version": "2.0" + } + ] + }, + { + "kind": "Playbook", + "contentId": "31ee11cc-9989-4de8-b176-5e0ef5c4dbab", + "version": "1.0" + }, + { + "kind": "Parser", + "contentId": "21ba424a-9438-4444-953a-7059539a7a1b" + } + ] + }, + "categories": { + "domains": [ + "Application", + "Security – Insider Threat" + ], + "verticals": [ + "Healthcare" + ] + }, + "providers": [ + "Amazon", + "Microsoft" + ], + "firstPublishDate": "2021-05-18", + "lastPublishDate": "2021-05-18", + "previewImages": [ + "firstImage.png", + "secondImage.jpeg" + ], + "previewImagesDark": [ + "firstImageDark.png", + "secondImageDark.jpeg" + ], + "contentSchemaVersion": "2.0", + "customVersion": "1.0", + "threatAnalysisTactics": [ + "reconnaissance", + "commandandcontrol" + ], + "threatAnalysisTechniques": [ + "T1548", + "T1548.001" + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/PatchMetadata.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/PatchMetadata.json new file mode 100644 index 000000000000..de672ac40e90 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/PatchMetadata.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "metadataName": "metadataName", + "metadataPatch": { + "properties": { + "author": { + "name": "User Name", + "email": "email@microsoft.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/metadata/metadataName", + "name": "metadataName", + "type": "Microsoft.SecurityInsights/metadata", + "properties": { + "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", + "kind": "AnalyticsRule", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName", + "author": { + "name": "User Name", + "email": "email@microsoft.com" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/PutMetadata.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/PutMetadata.json new file mode 100644 index 000000000000..71a1396116c8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/PutMetadata.json @@ -0,0 +1,286 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "metadataName": "metadataName", + "metadata": { + "properties": { + "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", + "version": "1.0.0.0", + "kind": "AnalyticsRule", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName", + "source": { + "kind": "Solution", + "name": "Contoso Solution 1.0", + "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" + }, + "author": { + "name": "User Name", + "email": "email@microsoft.com" + }, + "support": { + "name": "Microsoft", + "email": "support@microsoft.com", + "link": "https://support.microsoft.com/", + "tier": "Partner" + }, + "dependencies": { + "operator": "AND", + "criteria": [ + { + "operator": "OR", + "criteria": [ + { + "contentId": "045d06d0-ee72-4794-aba4-cf5646e4c756", + "kind": "DataConnector", + "name": "Microsoft Defender for Endpoint" + }, + { + "contentId": "dbfcb2cc-d782-40ef-8d94-fe7af58a6f2d", + "kind": "DataConnector" + }, + { + "contentId": "de4dca9b-eb37-47d6-a56f-b8b06b261593", + "kind": "DataConnector", + "version": "2.0" + } + ] + }, + { + "kind": "Playbook", + "contentId": "31ee11cc-9989-4de8-b176-5e0ef5c4dbab", + "version": "1.0" + }, + { + "kind": "Parser", + "contentId": "21ba424a-9438-4444-953a-7059539a7a1b" + } + ] + }, + "categories": { + "domains": [ + "Application", + "Security – Insider Threat" + ], + "verticals": [ + "Healthcare" + ] + }, + "providers": [ + "Amazon", + "Microsoft" + ], + "firstPublishDate": "2021-05-18", + "lastPublishDate": "2021-05-18", + "previewImages": [ + "firstImage.png", + "secondImage.jpeg" + ], + "previewImagesDark": [ + "firstImageDark.png", + "secondImageDark.jpeg" + ], + "contentSchemaVersion": "2.0", + "customVersion": "1.0", + "threatAnalysisTactics": [ + "reconnaissance", + "commandandcontrol" + ], + "threatAnalysisTechniques": [ + "T1548", + "T1548.001" + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/metadata/metadataName", + "name": "metadataName", + "type": "Microsoft.SecurityInsights/metadata", + "properties": { + "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", + "version": "1.0.0.0", + "kind": "AnalyticsRule", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName", + "source": { + "kind": "Solution", + "name": "Contoso Solution 1.0", + "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" + }, + "author": { + "name": "User Name", + "email": "email@microsoft.com" + }, + "support": { + "name": "Microsoft", + "email": "support@microsoft.com", + "link": "https://support.microsoft.com/", + "tier": "Partner" + }, + "dependencies": { + "operator": "AND", + "criteria": [ + { + "operator": "OR", + "criteria": [ + { + "contentId": "045d06d0-ee72-4794-aba4-cf5646e4c756", + "kind": "DataConnector" + }, + { + "contentId": "dbfcb2cc-d782-40ef-8d94-fe7af58a6f2d", + "kind": "DataConnector" + }, + { + "contentId": "de4dca9b-eb37-47d6-a56f-b8b06b261593", + "kind": "DataConnector", + "version": "2.0" + } + ] + }, + { + "kind": "Playbook", + "contentId": "31ee11cc-9989-4de8-b176-5e0ef5c4dbab", + "version": "1.0" + }, + { + "kind": "Parser", + "contentId": "21ba424a-9438-4444-953a-7059539a7a1b" + } + ] + }, + "categories": { + "domains": [ + "Application", + "Security – Insider Threat" + ], + "verticals": [ + "Healthcare" + ] + }, + "providers": [ + "Amazon", + "Microsoft" + ], + "firstPublishDate": "2021-05-18", + "lastPublishDate": "2021-05-18", + "previewImages": [ + "firstImage.png", + "secondImage.jpeg" + ], + "previewImagesDark": [ + "firstImageDark.png", + "secondImageDark.jpeg" + ], + "contentSchemaVersion": "2.0", + "customVersion": "1.0", + "threatAnalysisTactics": [ + "reconnaissance", + "commandandcontrol" + ], + "threatAnalysisTechniques": [ + "T1548", + "T1548.001" + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/metadata/metadataName", + "name": "metadataName", + "type": "Microsoft.SecurityInsights/metadata", + "properties": { + "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", + "version": "1.0.0.0", + "kind": "AnalyticsRule", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName", + "source": { + "kind": "Solution", + "name": "Contoso Solution 1.0", + "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" + }, + "author": { + "name": "User Name", + "email": "email@microsoft.com" + }, + "support": { + "name": "Microsoft", + "email": "support@microsoft.com", + "link": "https://support.microsoft.com/", + "tier": "Partner" + }, + "dependencies": { + "operator": "AND", + "criteria": [ + { + "operator": "OR", + "criteria": [ + { + "contentId": "045d06d0-ee72-4794-aba4-cf5646e4c756", + "kind": "DataConnector" + }, + { + "contentId": "dbfcb2cc-d782-40ef-8d94-fe7af58a6f2d", + "kind": "DataConnector" + }, + { + "contentId": "de4dca9b-eb37-47d6-a56f-b8b06b261593", + "kind": "DataConnector", + "version": "2.0" + } + ] + }, + { + "kind": "Playbook", + "contentId": "31ee11cc-9989-4de8-b176-5e0ef5c4dbab", + "version": "1.0" + }, + { + "kind": "Parser", + "contentId": "21ba424a-9438-4444-953a-7059539a7a1b" + } + ] + }, + "categories": { + "domains": [ + "Application", + "Security – Insider Threat" + ], + "verticals": [ + "Healthcare" + ] + }, + "providers": [ + "Amazon", + "Microsoft" + ], + "firstPublishDate": "2021-05-18", + "lastPublishDate": "2021-05-18", + "previewImages": [ + "firstImage.png", + "secondImage.jpeg" + ], + "previewImagesDark": [ + "firstImageDark.png", + "secondImageDark.jpeg" + ], + "contentSchemaVersion": "2.0", + "customVersion": "1.0", + "threatAnalysisTactics": [ + "reconnaissance", + "commandandcontrol" + ], + "threatAnalysisTechniques": [ + "T1548", + "T1548.001" + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/PutMetadataMinimal.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/PutMetadataMinimal.json new file mode 100644 index 000000000000..9e33fa7b9f6a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/metadata/PutMetadataMinimal.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "metadataName": "metadataName", + "metadata": { + "properties": { + "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", + "kind": "AnalyticsRule", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/metadata/metadataName", + "name": "metadataName", + "type": "Microsoft.SecurityInsights/metadata", + "properties": { + "kind": "AnalyticsRule", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/metadata/metadataName", + "name": "metadataName", + "type": "Microsoft.SecurityInsights/metadata", + "properties": { + "kind": "AnalyticsRule", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/officeConsents/DeleteOfficeConsents.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/officeConsents/DeleteOfficeConsents.json new file mode 100644 index 000000000000..8a202a9fbd9b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/officeConsents/DeleteOfficeConsents.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "consentId": "04e5fd05-ff86-4b97-b8d2-1c20933cb46c" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/officeConsents/GetOfficeConsents.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/officeConsents/GetOfficeConsents.json new file mode 100644 index 000000000000..84b8da6b0829 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/officeConsents/GetOfficeConsents.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/officeConsents/04e5fd05-ff86-4b97-b8d2-1c20933cb46c", + "name": "04e5fd05-ff86-4b97-b8d2-1c20933cb46c", + "type": "Microsoft.SecurityInsights/officeConsents", + "properties": { + "tenantId": "5460b3d2-1e7b-4757-ad54-c858c7e3f252", + "consentId": "04e5fd05-ff86-4b97-b8d2-1c20933cb46c" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/officeConsents/GetOfficeConsentsById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/officeConsents/GetOfficeConsentsById.json new file mode 100644 index 000000000000..8766fa7967fd --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/officeConsents/GetOfficeConsentsById.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "consentId": "04e5fd05-ff86-4b97-b8d2-1c20933cb46c" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/officeConsents/04e5fd05-ff86-4b97-b8d2-1c20933cb46c", + "name": "04e5fd05-ff86-4b97-b8d2-1c20933cb46c", + "type": "Microsoft.SecurityInsights/officeConsents", + "properties": { + "tenantId": "5460b3d2-1e7b-4757-ad54-c858c7e3f252", + "consentId": "04e5fd05-ff86-4b97-b8d2-1c20933cb46c" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/onboardingStates/CreateSentinelOnboardingState.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/onboardingStates/CreateSentinelOnboardingState.json new file mode 100644 index 000000000000..1bbcbcc8be35 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/onboardingStates/CreateSentinelOnboardingState.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "sentinelOnboardingStateName": "default", + "sentinelOnboardingStateParameter": { + "properties": { + "customerManagedKey": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/onboardingStates/default", + "name": "default", + "type": "Microsoft.SecurityInsights/onboardingStates", + "properties": { + "customerManagedKey": false + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/onboardingStates/default", + "name": "default", + "type": "Microsoft.SecurityInsights/onboardingStates", + "properties": { + "customerManagedKey": false + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/onboardingStates/DeleteSentinelOnboardingState.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/onboardingStates/DeleteSentinelOnboardingState.json new file mode 100644 index 000000000000..ec8e088d6d68 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/onboardingStates/DeleteSentinelOnboardingState.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "sentinelOnboardingStateName": "default" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/onboardingStates/GetAllSentinelOnboardingStates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/onboardingStates/GetAllSentinelOnboardingStates.json new file mode 100644 index 000000000000..7452ca7f89a9 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/onboardingStates/GetAllSentinelOnboardingStates.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/onboardingStates/default", + "name": "default", + "type": "Microsoft.SecurityInsights/onboardingStates", + "properties": { + "customerManagedKey": false + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/onboardingStates/GetSentinelOnboardingState.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/onboardingStates/GetSentinelOnboardingState.json new file mode 100644 index 000000000000..1880dbc574c2 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/onboardingStates/GetSentinelOnboardingState.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "sentinelOnboardingStateName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/onboardingStates/default", + "name": "default", + "type": "Microsoft.SecurityInsights/onboardingStates", + "properties": { + "customerManagedKey": false + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/operations/ListOperations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/operations/ListOperations.json new file mode 100644 index 000000000000..bf7300d5fe0b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/operations/ListOperations.json @@ -0,0 +1,563 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.SecurityInsights/operations/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Operations", + "operation": "Get Operations", + "description": "Gets operations" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/automationRules/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "AutomationRules", + "operation": "Get Automation Rules", + "description": "Gets an automation rule" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/automationRules/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "AutomationRules", + "operation": "Update Automation Rules", + "description": "Updates an automation rule" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/automationRules/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "AutomationRules", + "operation": "Delete Automation Rules", + "description": "Deletes an automation rule" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/Bookmarks/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Bookmarks", + "operation": "Get Bookmarks", + "description": "Gets bookmarks" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/Bookmarks/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Bookmarks", + "operation": "Update Bookmarks", + "description": "Updates bookmarks" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/Bookmarks/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Bookmarks", + "operation": "Delete Bookmarks", + "description": "Deletes bookmarks" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/Bookmarks/expand/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Bookmarks", + "operation": "Expand on entity", + "description": "Gets related entities of an entity by a specific expansion" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/bookmarks/relations/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Bookmark Relations", + "operation": "Get Bookmark Relations", + "description": "Gets a bookmark relation" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/bookmarks/relations/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Bookmark Relations", + "operation": "Update Bookmark Relations", + "description": "Updates a bookmark relation" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/bookmarks/relations/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Bookmark Relations", + "operation": "Delete Bookmark Relations", + "description": "Deletes a bookmark relation" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/alertRules/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Alert Rules", + "operation": "Get Alert Rules", + "description": "Gets the alert rules" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/alertRules/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Alert Rules", + "operation": "Update Alert Rules", + "description": "Updates alert rules" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/alertRules/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Alert Rules", + "operation": "Delete Alert Rules", + "description": "Deletes alert rules" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/alertRules/actions/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Alert Rules Actions", + "operation": "Get Alert Rule Response Actions", + "description": "Gets the response actions of an alert rule" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/alertRules/actions/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Alert Rules Actions", + "operation": "Update Alert Rule Response Actions", + "description": "Updates the response actions of an alert rule" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/alertRules/actions/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Alert Rules Actions", + "operation": "Delete Alert Rule Response Actions", + "description": "Deletes the response actions of an alert rule" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/dataConnectors/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "DataConnectors", + "operation": "Get Data Connectors", + "description": "Gets the data connectors" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/dataConnectors/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "DataConnectors", + "operation": "Update Data Connectors", + "description": "Updates a data connector" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/dataConnectors/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "DataConnectors", + "operation": "Delete a Data Connector", + "description": "Deletes a data connector" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/dataConnectorsCheckRequirements/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "DataConnectorsCheckRequirements", + "operation": "Check user authorization and license", + "description": "Check user authorization and license" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/incidents/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Incidents", + "operation": "Get Incidents", + "description": "Gets an incident" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/incidents/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Incidents", + "operation": "Update Incidents", + "description": "Updates an incident" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/incidents/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Incidents", + "operation": "Delete Incidents", + "description": "Deletes an incident" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/incidents/comments/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Incident Comments", + "operation": "Get Incident Comments", + "description": "Gets the incident comments" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/incidents/comments/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Incident Comments", + "operation": "Create Incident Comments", + "description": "Creates a comment on the incident" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/incidents/comments/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Incident Comments", + "operation": "Delete Incident Comment", + "description": "Deletes a comment on the incident" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/incidents/relations/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Incident Relations", + "operation": "Get Incident Relations", + "description": "Gets a relation between the incident and related resources" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/incidents/relations/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Incident Relations", + "operation": "Update Incident Relations", + "description": "Updates a relation between the incident and related resources" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/incidents/relations/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Incident Relations", + "operation": "Delete Incident Relations", + "description": "Deletes a relation between the incident and related resources" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Get Threat Intelligence", + "description": "Gets Threat Intelligence" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Update Threat Intelligence", + "description": "Updates Threat Intelligence" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Delete Threat Intelligence", + "description": "Deletes Threat Intelligence" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/query/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Query Threat Intelligence", + "description": "Query Threat Intelligence" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/metrics/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Collect Threat Intelligence Metrics", + "description": "Collect Threat Intelligence Metrics" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/bulkDelete/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Bulk Delete Threat Intelligence", + "description": "Bulk Delete Threat Intelligence" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/bulkTag/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Bulk Tags Threat Intelligence", + "description": "Bulk Tags Threat Intelligence" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/indicators/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Update Threat Intelligence Indicators", + "description": "Updates Threat Intelligence Indicators" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/indicators/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Delete Threat Intelligence Indicators", + "description": "Deletes Threat Intelligence Indicators" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/indicators/query/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Query Threat Intelligence Indicators", + "description": "Query Threat Intelligence Indicators" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/indicators/metrics/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Get Threat Intelligence Indicator Metrics", + "description": "Get Threat Intelligence Indicator Metrics" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/indicators/bulkDelete/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Bulk Delete Threat Intelligence Indicators", + "description": "Bulk Delete Threat Intelligence Indicators" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/indicators/bulkTag/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Bulk Tags Threat Intelligence Indicators", + "description": "Bulk Tags Threat Intelligence Indicators" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/indicators/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Get Threat Intelligence Indicators", + "description": "Gets Threat Intelligence Indicators" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/metrics/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Collect Threat Intelligence Metrics", + "description": "Collect Threat Intelligence Metrics" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/createIndicator/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Create Threat Intelligence Indicator", + "description": "Create Threat Intelligence Indicator" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/indicators/appendTags/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Append tags to Threat Intelligence Indicator", + "description": "Append tags to Threat Intelligence Indicator" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/indicators/replaceTags/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Replace Tags of Threat Intelligence Indicator", + "description": "Replace Tags of Threat Intelligence Indicator" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/queryIndicators/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Query Threat Intelligence Indicators", + "description": "Query Threat Intelligence Indicators" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/Watchlists/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Watchlists", + "operation": "Get Watchlists", + "description": "Gets Watchlists" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/Watchlists/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Watchlists", + "operation": "Create Watchlists", + "description": "Create Watchlists" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/Watchlists/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Watchlists", + "operation": "Delete Watchlists", + "description": "Deletes Watchlists" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/onboardingStates/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Onboarding States", + "operation": "Get Onboarding States", + "description": "Gets an onboarding state" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/onboardingStates/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Onboarding States", + "operation": "Update Onboarding States", + "description": "Updates an onboarding state" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/onboardingStates/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Onboarding States", + "operation": "Delete Onboarding States", + "description": "Deletes an onboarding state" + }, + "origin": "user" + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/recommendations/GetRecommendation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/recommendations/GetRecommendation.json new file mode 100644 index 000000000000..510fa1d849fc --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/recommendations/GetRecommendation.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "recommendationId": "6d4b54eb-8684-4aa3-a156-3aa37b8014bc" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Recommendations/ceea048e-923e-4eeb-8fcb-6cb0c06b101f", + "name": "ceea048e-923e-4eeb-8fcb-6cb0c06b101f", + "type": "Microsoft.SecurityInsights/Recommendations", + "properties": { + "recommendationTypeId": "Swagger_Example", + "state": "CompletedBySystem", + "title": "someText", + "description": "someText", + "creationTimeUtc": "2022-02-19T03:09:03.4888396+00:00", + "lastEvaluatedTimeUtc": "2022-02-19T03:09:03.4888396+00:00", + "lastModifiedTimeUtc": "2022-02-19T03:57:31.7964447+00:00", + "suggestions": [ + { + "suggestionTypeId": "ThreatIntelligence_Example_Suggestion_Example", + "title": "someText", + "description": "someText", + "action": "someText", + "additionalProperties": { + "someKey": "someValue" + } + } + ], + "resourceId": "someId", + "additionalProperties": { + "someKey": "someValue" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/recommendations/GetRecommendations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/recommendations/GetRecommendations.json new file mode 100644 index 000000000000..fa678233ff4b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/recommendations/GetRecommendations.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Recommendations/ceea048e-923e-4eeb-8fcb-6cb0c06b101f", + "name": "ceea048e-923e-4eeb-8fcb-6cb0c06b101f", + "type": "Microsoft.SecurityInsights/Recommendations", + "properties": { + "recommendationTypeId": "ThreatIntelligence_Example", + "state": "CompletedBySystem", + "title": "someText", + "description": "someText", + "creationTimeUtc": "2022-02-19T03:09:03.4888396+00:00", + "lastEvaluatedTimeUtc": "2022-02-19T03:09:03.4888396+00:00", + "lastModifiedTimeUtc": "2022-02-19T03:57:31.7964447+00:00", + "suggestions": [ + { + "suggestionTypeId": "ThreatIntelligence_Example_Suggestion_Example", + "title": "someText", + "description": "someText", + "action": "someText", + "additionalProperties": { + "someKey": "someValue" + } + } + ], + "resourceId": "someId", + "additionalProperties": { + "someKey": "someValue" + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/recommendations/PatchRecommendation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/recommendations/PatchRecommendation.json new file mode 100644 index 000000000000..edc9da0606e3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/recommendations/PatchRecommendation.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "recommendationId": "6d4b54eb-8684-4aa3-a156-3aa37b8014bc", + "recommendationPatch": { + "properties": { + "state": "Active" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Recommendations/ceea048e-923e-4eeb-8fcb-6cb0c06b101f", + "name": "ceea048e-923e-4eeb-8fcb-6cb0c06b101f", + "type": "Microsoft.SecurityInsights/Recommendations", + "properties": { + "recommendationTypeId": "ThreatIntelligence_Example", + "state": "CompletedByUser", + "title": "someText", + "description": "someText", + "creationTimeUtc": "2022-02-19T03:09:03.4888396+00:00", + "lastEvaluatedTimeUtc": "2022-02-19T03:09:03.4888396+00:00", + "lastModifiedTimeUtc": "2022-02-19T03:57:31.7964447+00:00", + "suggestions": [ + { + "suggestionTypeId": "ThreatIntelligence_Example_Suggestion_Example", + "title": "someText", + "description": "someText", + "action": "someText", + "additionalProperties": { + "someKey": "someValue" + } + } + ], + "resourceId": "someId", + "additionalProperties": { + "someKey": "someValue" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/recommendations/ReevaluateRecommendation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/recommendations/ReevaluateRecommendation.json new file mode 100644 index 000000000000..9fa7835dd62d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/recommendations/ReevaluateRecommendation.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "recommendationId": "6d4b54eb-8684-4aa3-a156-3aa37b8014bc" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Recommendations/ceea048e-923e-4eeb-8fcb-6cb0c06b101f", + "name": "ceea048e-923e-4eeb-8fcb-6cb0c06b101f", + "type": "Microsoft.SecurityInsights/Recommendations", + "properties": { + "lastEvaluatedTimeUtc": "2023-10-10T03:09:03.4888396+00:00" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/repositories/GetRepositories.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/repositories/GetRepositories.json new file mode 100644 index 000000000000..4efeef280deb --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/repositories/GetRepositories.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "repoType": "Github", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "repositoryAccess": { + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "repositoryAccess": { + "kind": "OAuth", + "code": "939fd7c6caf754f4f41f", + "state": "state", + "clientId": "54b3c2c0-1f48-4a1c-af9f-6399c3240b73" + } + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "url": "https://api.github.com/repos/user/reponame", + "fullName": "reponame", + "installationId": 42424242, + "branches": [ + "master", + "develop" + ] + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/securityMLAnalyticsSettings/CreateAnomalySecurityMLAnalyticsSetting.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/securityMLAnalyticsSettings/CreateAnomalySecurityMLAnalyticsSetting.json new file mode 100644 index 000000000000..3039718def64 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/securityMLAnalyticsSettings/CreateAnomalySecurityMLAnalyticsSetting.json @@ -0,0 +1,245 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "settingsResourceName": "f209187f-1d17-4431-94af-c141bf5f23db", + "securityMLAnalyticsSetting": { + "kind": "Anomaly", + "etag": "\"260090e2-0000-0d00-0000-5d6fb8670000\"", + "properties": { + "displayName": "Login from unusual region", + "description": "When account logs from a source region that has rarely been logged in from during the last 14 days, an anomaly is triggered.", + "enabled": true, + "requiredDataConnectors": [ + { + "connectorId": "AWS", + "dataTypes": [ + "AWSCloudTrail" + ] + } + ], + "tactics": [ + "Exfiltration", + "CommandAndControl" + ], + "techniques": [ + "T1037", + "T1021" + ], + "anomalyVersion": "1.0.5", + "customizableObservations": { + "multiSelectObservations": null, + "singleSelectObservations": [ + { + "supportedValues": [ + "Palo Alto Networks", + "Fortinet", + "Check Point" + ], + "value": [ + "Palo Alto Networks" + ], + "supportedValuesKql": null, + "valuesKql": null, + "name": "Device vendor", + "description": "Select device vendor of network connection logs from CommonSecurityLog", + "sequenceNumber": 1, + "rerun": "RerunAlways" + } + ], + "prioritizeExcludeObservations": null, + "thresholdObservations": [ + { + "minimum": "1", + "maximum": "100", + "value": "25", + "name": "Daily data transfer threshold in MB", + "description": "Suppress anomalies when daily data transfered (in MB) per hour is less than the chosen value", + "sequenceNumber": 1, + "rerun": "RerunAlways" + }, + { + "minimum": "2", + "maximum": "10", + "value": "3", + "name": "Number of standard deviations", + "description": "Triggers anomalies when number of standard deviations is greater than the chosen value", + "sequenceNumber": 2, + "rerun": "RerunAlways" + } + ], + "singleValueObservations": null + }, + "frequency": "PT1H", + "settingsStatus": "Production", + "isDefaultSettings": true, + "anomalySettingsVersion": 0, + "settingsDefinitionId": "f209187f-1d17-4431-94af-c141bf5f23db" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/securityMLAnalyticsSettings/f209187f-1d17-4431-94af-c141bf5f23db", + "name": "f209187f-1d17-4431-94af-c141bf5f23db", + "etag": "\"01005144-0000-0d00-0000-6058632c0000\"", + "kind": "Anomaly", + "type": "Microsoft.SecurityInsights/securityMLAnalyticsSettings", + "properties": { + "displayName": "Login from unusual region", + "description": "When account logs from a source region that has rarely been logged in from during the last 14 days, an anomaly is triggered.", + "enabled": true, + "lastModifiedUtc": "2021-10-20T13:17:11.5340061Z", + "requiredDataConnectors": [ + { + "connectorId": "AWS", + "dataTypes": [ + "AWSCloudTrail" + ] + } + ], + "tactics": [ + "Exfiltration", + "CommandAndControl" + ], + "techniques": [ + "T1037", + "T1021" + ], + "anomalyVersion": "1.0.5", + "customizableObservations": { + "multiSelectObservations": null, + "singleSelectObservations": [ + { + "supportedValues": [ + "Palo Alto Networks", + "Fortinet", + "Check Point" + ], + "value": [ + "Palo Alto Networks" + ], + "supportedValuesKql": null, + "valuesKql": null, + "name": "Device vendor", + "description": "Select device vendor of network connection logs from CommonSecurityLog", + "sequenceNumber": 1, + "rerun": "RerunAlways" + } + ], + "prioritizeExcludeObservations": null, + "thresholdObservations": [ + { + "minimum": "1", + "maximum": "100", + "value": "25", + "name": "Daily data transfer threshold in MB", + "description": "Suppress anomalies when daily data transfered (in MB) per hour is less than the chosen value", + "sequenceNumber": 1, + "rerun": "RerunAlways" + }, + { + "minimum": "2", + "maximum": "10", + "value": "3", + "name": "Number of standard deviations", + "description": "Triggers anomalies when number of standard deviations is greater than the chosen value", + "sequenceNumber": 2, + "rerun": "RerunAlways" + } + ], + "singleValueObservations": null + }, + "frequency": "PT1H", + "settingsStatus": "Production", + "isDefaultSettings": true, + "anomalySettingsVersion": 0, + "settingsDefinitionId": "f209187f-1d17-4431-94af-c141bf5f23db" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/securityMLAnalyticsSettings/f209187f-1d17-4431-94af-c141bf5f23db", + "name": "f209187f-1d17-4431-94af-c141bf5f23db", + "etag": "\"01007444-0000-0d00-0000-605863a70000\"", + "kind": "Anomaly", + "type": "Microsoft.SecurityInsights/securityMLAnalyticsSettings", + "properties": { + "displayName": "Login from unusual region", + "description": "When account logs from a source region that has rarely been logged in from during the last 14 days, an anomaly is triggered.", + "enabled": true, + "lastModifiedUtc": "2021-10-20T13:17:11.5340061Z", + "requiredDataConnectors": [ + { + "connectorId": "AWS", + "dataTypes": [ + "AWSCloudTrail" + ] + } + ], + "tactics": [ + "Exfiltration", + "CommandAndControl" + ], + "techniques": [ + "T1037", + "T1021" + ], + "anomalyVersion": "1.0.5", + "customizableObservations": { + "multiSelectObservations": null, + "singleSelectObservations": [ + { + "supportedValues": [ + "Palo Alto Networks", + "Fortinet", + "Check Point" + ], + "value": [ + "Palo Alto Networks" + ], + "supportedValuesKql": null, + "valuesKql": null, + "name": "Device vendor", + "description": "Select device vendor of network connection logs from CommonSecurityLog", + "sequenceNumber": 1, + "rerun": "RerunAlways" + } + ], + "prioritizeExcludeObservations": null, + "thresholdObservations": [ + { + "minimum": "1", + "maximum": "100", + "value": "25", + "name": "Daily data transfer threshold in MB", + "description": "Suppress anomalies when daily data transfered (in MB) per hour is less than the chosen value", + "sequenceNumber": 1, + "rerun": "RerunAlways" + }, + { + "minimum": "2", + "maximum": "10", + "value": "3", + "name": "Number of standard deviations", + "description": "Triggers anomalies when number of standard deviations is greater than the chosen value", + "sequenceNumber": 2, + "rerun": "RerunAlways" + } + ], + "singleValueObservations": null + }, + "frequency": "PT1H", + "settingsStatus": "Production", + "isDefaultSettings": true, + "anomalySettingsVersion": 0, + "settingsDefinitionId": "f209187f-1d17-4431-94af-c141bf5f23db" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/securityMLAnalyticsSettings/DeleteSecurityMLAnalyticsSetting.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/securityMLAnalyticsSettings/DeleteSecurityMLAnalyticsSetting.json new file mode 100644 index 000000000000..9ea7070acd19 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/securityMLAnalyticsSettings/DeleteSecurityMLAnalyticsSetting.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "settingsResourceName": "f209187f-1d17-4431-94af-c141bf5f23db" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/securityMLAnalyticsSettings/GetAllSecurityMLAnalyticsSettings.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/securityMLAnalyticsSettings/GetAllSecurityMLAnalyticsSettings.json new file mode 100644 index 000000000000..e9cef2badeda --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/securityMLAnalyticsSettings/GetAllSecurityMLAnalyticsSettings.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/securityMLAnalyticsSettings/f209187f-1d17-4431-94af-c141bf5f23db", + "name": "f209187f-1d17-4431-94af-c141bf5f23db", + "etag": "\"260090e2-0000-0d00-0000-5d6fb8670000\"", + "type": "Microsoft.SecurityInsights/securityMLAnalyticsSettings", + "kind": "Anomaly", + "properties": { + "displayName": "Login from unusual region", + "description": "When account logs from a source region that has rarely been logged in from during the last 14 days, an anomaly is triggered.", + "enabled": true, + "lastModifiedUtc": "2021-10-20T13:13:11.5340061Z", + "requiredDataConnectors": [ + { + "connectorId": "AWS", + "dataTypes": [ + "AWSCloudTrail" + ] + } + ], + "tactics": [ + "Exfiltration", + "CommandAndControl" + ], + "techniques": [ + "T1037", + "T1021" + ], + "anomalyVersion": "1.0.5", + "customizableObservations": { + "multiSelectObservations": null, + "singleSelectObservations": [ + { + "supportedValues": [ + "Palo Alto Networks", + "Fortinet", + "Check Point" + ], + "value": [ + "Palo Alto Networks" + ], + "supportedValuesKql": null, + "valuesKql": null, + "name": "Device vendor", + "description": "Select device vendor of network connection logs from CommonSecurityLog", + "sequenceNumber": 1, + "rerun": "RerunAlways" + } + ], + "prioritizeExcludeObservations": null, + "thresholdObservations": [ + { + "minimum": "1", + "maximum": "100", + "value": "25", + "name": "Daily data transfer threshold in MB", + "description": "Suppress anomalies when daily data transfered (in MB) per hour is less than the chosen value", + "sequenceNumber": 1, + "rerun": "RerunAlways" + }, + { + "minimum": "2", + "maximum": "10", + "value": "3", + "name": "Number of standard deviations", + "description": "Triggers anomalies when number of standard deviations is greater than the chosen value", + "sequenceNumber": 2, + "rerun": "RerunAlways" + } + ], + "singleValueObservations": null + }, + "frequency": "PT1H", + "settingsStatus": "Production", + "isDefaultSettings": true, + "anomalySettingsVersion": 0, + "settingsDefinitionId": "f209187f-1d17-4431-94af-c141bf5f23db" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/securityMLAnalyticsSettings/GetAnomalySecurityMLAnalyticsSetting.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/securityMLAnalyticsSettings/GetAnomalySecurityMLAnalyticsSetting.json new file mode 100644 index 000000000000..355c67cee981 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/securityMLAnalyticsSettings/GetAnomalySecurityMLAnalyticsSetting.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "settingsResourceName": "myFirstAnomalySettings" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/securityMLAnalyticsSettings/f209187f-1d17-4431-94af-c141bf5f23db", + "name": "f209187f-1d17-4431-94af-c141bf5f23db", + "etag": "\"260090e2-0000-0d00-0000-5d6fb8670000\"", + "type": "Microsoft.SecurityInsights/securityMLAnalyticsSettings", + "kind": "Anomaly", + "properties": { + "displayName": "Login from unusual region", + "description": "When account logs from a source region that has rarely been logged in from during the last 14 days, an anomaly is triggered.", + "enabled": true, + "lastModifiedUtc": "2021-10-20T13:13:11.5340061Z", + "requiredDataConnectors": [ + { + "connectorId": "AWS", + "dataTypes": [ + "AWSCloudTrail" + ] + } + ], + "tactics": [ + "Exfiltration", + "CommandAndControl" + ], + "techniques": [ + "T1037", + "T1021" + ], + "anomalyVersion": "1.0.5", + "customizableObservations": { + "multiSelectObservations": null, + "singleSelectObservations": [ + { + "supportedValues": [ + "Palo Alto Networks", + "Fortinet", + "Check Point" + ], + "value": [ + "Palo Alto Networks" + ], + "supportedValuesKql": null, + "valuesKql": null, + "name": "Device vendor", + "description": "Select device vendor of network connection logs from CommonSecurityLog", + "sequenceNumber": 1, + "rerun": "RerunAlways" + } + ], + "prioritizeExcludeObservations": null, + "thresholdObservations": [ + { + "minimum": "1", + "maximum": "100", + "value": "25", + "name": "Daily data transfer threshold in MB", + "description": "Suppress anomalies when daily data transfered (in MB) per hour is less than the chosen value", + "sequenceNumber": 1, + "rerun": "RerunAlways" + }, + { + "minimum": "2", + "maximum": "10", + "value": "3", + "name": "Number of standard deviations", + "description": "Triggers anomalies when number of standard deviations is greater than the chosen value", + "sequenceNumber": 2, + "rerun": "RerunAlways" + } + ], + "singleValueObservations": null + }, + "frequency": "PT1H", + "settingsStatus": "Production", + "isDefaultSettings": true, + "anomalySettingsVersion": 0, + "settingsDefinitionId": "f209187f-1d17-4431-94af-c141bf5f23db" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/settings/DeleteEyesOnSetting.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/settings/DeleteEyesOnSetting.json new file mode 100644 index 000000000000..00da391c36e3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/settings/DeleteEyesOnSetting.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "settingsName": "EyesOn" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/settings/GetAllSettings.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/settings/GetAllSettings.json new file mode 100644 index 000000000000..e20ead2be73b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/settings/GetAllSettings.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirInt/providers/Microsoft.SecurityInsights/settings/EyesOn", + "name": "EyesOn", + "type": "Microsoft.SecurityInsights/settings", + "kind": "EyesOn", + "properties": { + "isEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/settings/GetEyesOnSetting.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/settings/GetEyesOnSetting.json new file mode 100644 index 000000000000..8026e299c98d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/settings/GetEyesOnSetting.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "settingsName": "EyesOn" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirInt/providers/Microsoft.SecurityInsights/settings/EyesOn", + "name": "EyesOn", + "type": "Microsoft.SecurityInsights/settings", + "kind": "EyesOn", + "properties": { + "isEnabled": true + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/settings/UpdateEyesOnSetting.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/settings/UpdateEyesOnSetting.json new file mode 100644 index 000000000000..4cb84da05d12 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/settings/UpdateEyesOnSetting.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "settingsName": "EyesOn", + "settings": { + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "kind": "EyesOn", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirInt/providers/Microsoft.SecurityInsights/settings/EyesOn", + "name": "EyesOn", + "type": "Microsoft.SecurityInsights/settings", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "kind": "EyesOn", + "properties": { + "isEnabled": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirInt/providers/Microsoft.SecurityInsights/settings/EyesOn", + "name": "EyesOn", + "type": "Microsoft.SecurityInsights/settings", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "kind": "EyesOn", + "properties": { + "isEnabled": true + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/sourcecontrols/CreateSourceControl.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/sourcecontrols/CreateSourceControl.json new file mode 100644 index 000000000000..f67c8dbaf15e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/sourcecontrols/CreateSourceControl.json @@ -0,0 +1,162 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "sourceControlId": "789e0c1f-4a3d-43ad-809c-e713b677b04a", + "sourceControl": { + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "displayName": "My Source Control", + "description": "This is a source control", + "repoType": "Github", + "contentTypes": [ + "AnalyticRules", + "Workbook" + ], + "repository": { + "url": "https://github.com/user/repo", + "branch": "master", + "displayUrl": "https://github.com/user/repo" + }, + "repositoryAccess": { + "kind": "OAuth", + "code": "939fd7c6caf754f4f41f", + "state": "state", + "clientId": "54b3c2c0-1f48-4a1c-af9f-6399c3240b73" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/sourcecontrols/789e0c1f-4a3d-43ad-809c-e713b677b04a", + "version": "V2", + "name": "789e0c1f-4a3d-43ad-809c-e713b677b04a", + "type": "Microsoft.SecurityInsights/SourceControls", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "id": "789e0c1f-4a3d-43ad-809c-e713b677b04a", + "displayName": "My Source Control", + "description": "this is a source control", + "repoType": "Github", + "contentTypes": [ + "AnalyticRules", + "Workbook" + ], + "repository": { + "url": "https://github.com/user/repo", + "branch": "master", + "displayUrl": "https://github.com/user/repo", + "deploymentLogsUrl": "https://github.com/user/repo/actions" + }, + "servicePrincipal": { + "id": "2d297bee-cb45-444a-a9ce-904484f0bcd6", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "appId": "42a43de2-b712-4408-9680-2514fed984e6" + }, + "repositoryResourceInfo": { + "webhook": { + "webhookId": "342768323", + "webhookUrl": "https://cac.sentinel.azure.com/workspaces/b7c525e9-1bfa-4435-88c0-817e13abb088/webhooks/ado/sourceControl/789e0c1f-4a3d-43ad-809c-e713b677b04a", + "webhookSecretUpdateTime": "2021-01-01T17:18:19.1234567Z" + }, + "gitHubResourceInfo": { + "appInstallationId": "123" + }, + "azureDevOpsResourceInfo": null + }, + "lastDeploymentInfo": { + "deploymentFetchStatus": "Success", + "deployment": { + "deploymentId": "4985046420", + "deploymentState": "Completed", + "deploymentResult": "Success", + "deploymentTime": "2021-01-01T17:18:19.1234567Z", + "deploymentLogsUrl": "https://github.com/user/repo/actions" + }, + "message": "Successful deployment" + }, + "pullRequest": { + "url": "https://github.com/user/repo/pull/123", + "state": "Open" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/sourcecontrols/789e0c1f-4a3d-43ad-809c-e713b677b04a", + "version": "V2", + "name": "789e0c1f-4a3d-43ad-809c-e713b677b04a", + "type": "Microsoft.SecurityInsights/SourceControls", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "id": "789e0c1f-4a3d-43ad-809c-e713b677b04a", + "displayName": "My Source Control", + "description": "this is a source control", + "repoType": "Github", + "contentTypes": [ + "AnalyticRules", + "Workbook" + ], + "repository": { + "url": "https://github.com/user/repo", + "branch": "master", + "displayUrl": "https://github.com/user/repo", + "deploymentLogsUrl": "https://github.com/user/repo/actions" + }, + "servicePrincipal": { + "id": "2d297bee-cb45-444a-a9ce-904484f0bcd6", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "appId": "42a43de2-b712-4408-9680-2514fed984e6" + }, + "repositoryResourceInfo": { + "webhook": { + "webhookId": "342768323", + "webhookUrl": "https://cac.sentinel.azure.com/workspaces/b7c525e9-1bfa-4435-88c0-817e13abb088/webhooks/ado/sourceControl/789e0c1f-4a3d-43ad-809c-e713b677b04a", + "webhookSecretUpdateTime": "2021-01-01T17:18:19.1234567Z" + }, + "gitHubResourceInfo": { + "appInstallationId": "123" + }, + "azureDevOpsResourceInfo": null + }, + "lastDeploymentInfo": { + "deploymentFetchStatus": "Success", + "deployment": { + "deploymentId": "4985046420", + "deploymentState": "Completed", + "deploymentResult": "Success", + "deploymentTime": "2021-01-01T17:18:19.1234567Z", + "deploymentLogsUrl": "https://github.com/user/repo/actions" + }, + "message": "Successful deployment" + }, + "pullRequest": { + "url": "https://github.com/user/repo/pull/123", + "state": "Open" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/sourcecontrols/DeleteSourceControl.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/sourcecontrols/DeleteSourceControl.json new file mode 100644 index 000000000000..34cad1c47080 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/sourcecontrols/DeleteSourceControl.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "sourceControlId": "789e0c1f-4a3d-43ad-809c-e713b677b04a", + "repositoryAccess": { + "properties": { + "repositoryAccess": { + "kind": "OAuth", + "code": "939fd7c6caf754f4f41f", + "state": "state", + "clientId": "54b3c2c0-1f48-4a1c-af9f-6399c3240b73" + } + } + } + }, + "responses": { + "200": { + "body": { + "warning": { + "code": "SourceControlWarning_DeleteServicePrincipal", + "message": "ServicePrincipal has not been removed due to insufficient permissions." + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/sourcecontrols/GetSourceControlById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/sourcecontrols/GetSourceControlById.json new file mode 100644 index 000000000000..69052f8f7459 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/sourcecontrols/GetSourceControlById.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "sourceControlId": "789e0c1f-4a3d-43ad-809c-e713b677b04a" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/sourcecontrols/789e0c1f-4a3d-43ad-809c-e713b677b04a", + "version": "V2", + "name": "789e0c1f-4a3d-43ad-809c-e713b677b04a", + "type": "Microsoft.SecurityInsights/SourceControls", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "id": "789e0c1f-4a3d-43ad-809c-e713b677b04a", + "displayName": "My Source Control", + "description": "this is a source control", + "repoType": "Github", + "contentTypes": [ + "AnalyticRules", + "Workbook" + ], + "repository": { + "url": "https://github.com/user/repo", + "branch": "master", + "displayUrl": "https://github.com/user/repo", + "deploymentLogsUrl": "https://github.com/user/repo/actions" + }, + "servicePrincipal": { + "id": "2d297bee-cb45-444a-a9ce-904484f0bcd6", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "appId": "42a43de2-b712-4408-9680-2514fed984e6" + }, + "repositoryResourceInfo": { + "webhook": { + "webhookId": "342768323", + "webhookUrl": "https://cac.sentinel.azure.com/workspaces/b7c525e9-1bfa-4435-88c0-817e13abb088/webhooks/ado/sourceControl/789e0c1f-4a3d-43ad-809c-e713b677b04a", + "webhookSecretUpdateTime": "2021-01-01T17:18:19.1234567Z" + }, + "gitHubResourceInfo": { + "appInstallationId": "123" + }, + "azureDevOpsResourceInfo": null + }, + "lastDeploymentInfo": { + "deploymentFetchStatus": "Success", + "deployment": { + "deploymentId": "4985046420", + "deploymentState": "Completed", + "deploymentResult": "Success", + "deploymentTime": "2021-01-01T17:18:19.1234567Z", + "deploymentLogsUrl": "https://github.com/user/repo/actions" + }, + "message": "Successful deployment" + }, + "pullRequest": { + "url": "https://github.com/user/repo/pull/123", + "state": "Open" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/sourcecontrols/GetSourceControls.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/sourcecontrols/GetSourceControls.json new file mode 100644 index 000000000000..714adc07d284 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/sourcecontrols/GetSourceControls.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/sourcecontrols/789e0c1f-4a3d-43ad-809c-e713b677b04a", + "version": "V2", + "name": "789e0c1f-4a3d-43ad-809c-e713b677b04a", + "type": "Microsoft.SecurityInsights/SourceControls", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "id": "789e0c1f-4a3d-43ad-809c-e713b677b04a", + "displayName": "My Source Control", + "description": "this is a source control", + "repoType": "Github", + "contentTypes": [ + "AnalyticRules", + "Workbook" + ], + "repository": { + "url": "https://github.com/user/repo", + "branch": "master", + "displayUrl": "https://github.com/user/repo", + "deploymentLogsUrl": "https://github.com/user/repo/actions" + }, + "servicePrincipal": { + "id": "2d297bee-cb45-444a-a9ce-904484f0bcd6", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "appId": "42a43de2-b712-4408-9680-2514fed984e6" + }, + "repositoryResourceInfo": { + "webhook": { + "webhookId": "342768323", + "webhookUrl": "https://cac.sentinel.azure.com/workspaces/b7c525e9-1bfa-4435-88c0-817e13abb088/webhooks/ado/sourceControl/789e0c1f-4a3d-43ad-809c-e713b677b04a", + "webhookSecretUpdateTime": "2021-01-01T17:18:19.1234567Z" + }, + "gitHubResourceInfo": { + "appInstallationId": "123" + }, + "azureDevOpsResourceInfo": null + }, + "lastDeploymentInfo": { + "deploymentFetchStatus": "Success", + "deployment": { + "deploymentId": "4985046420", + "deploymentState": "Completed", + "deploymentResult": "Success", + "deploymentTime": "2021-01-01T17:18:19.1234567Z", + "deploymentLogsUrl": "https://github.com/user/repo/actions" + }, + "message": "Successful deployment" + }, + "pullRequest": { + "url": "https://github.com/user/repo/pull/123", + "state": "Open" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/AppendTagsThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/AppendTagsThreatIntelligence.json new file mode 100644 index 000000000000..ce442bf17f36 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/AppendTagsThreatIntelligence.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "name": "d9cd6f0b-96b9-3984-17cd-a779d1e15a93", + "ThreatIntelligenceAppendTags": { + "threatIntelligenceTags": [ + "tag1", + "tag2" + ] + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/CollectThreatIntelligenceMetrics.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/CollectThreatIntelligenceMetrics.json new file mode 100644 index 000000000000..f582bbc14ce4 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/CollectThreatIntelligenceMetrics.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "lastUpdatedTimeUtc": "2021-09-01T19:44:44.117403Z", + "threatTypeMetrics": [ + { + "metricName": "compromised", + "metricValue": 20 + } + ], + "patternTypeMetrics": [ + { + "metricName": "url", + "metricValue": 20 + } + ], + "sourceMetrics": [ + { + "metricName": "Azure Sentinel", + "metricValue": 10315 + }, + { + "metricName": "zinga", + "metricValue": 2 + } + ] + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/CreateThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/CreateThreatIntelligence.json new file mode 100644 index 000000000000..8c6c2a0e6109 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/CreateThreatIntelligence.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ThreatIntelligenceProperties": { + "kind": "indicator", + "properties": { + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema", + "confidence": 78, + "createdByRef": "contoso@contoso.com", + "description": "debugging indicators", + "externalReferences": [], + "granularMarkings": [], + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "labels": [], + "modified": "", + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "revoked": false, + "validFrom": "2021-09-15T17:44:00.114052Z", + "validUntil": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "name": "180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "etag": "\"0000322c-0000-0800-0000-5e976c960000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2021-09-15T20:20:38.6160949Z", + "createdByRef": "contoso@contoso.com", + "externalId": "indicator--a2b6a95e-2108-4a38-bd49-ef95811bbcd7", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T20:20:38.6161887Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2021-09-15T17:44:00.114052Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "name": "180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "etag": "\"0000322c-0000-0800-0000-5e976c960000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2021-09-15T20:20:38.6160949Z", + "createdByRef": "aztestConnectors@contoso.com", + "externalId": "indicator--a2b6a95e-2108-4a38-bd49-ef95811bbcd7", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2021-09-15T20:20:38.6161887Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2021-09-15T17:44:00.114052Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/DeleteThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/DeleteThreatIntelligence.json new file mode 100644 index 000000000000..6f32e4948353 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/DeleteThreatIntelligence.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "name": "d9cd6f0b-96b9-3984-17cd-a779d1e15a93" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/GetThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/GetThreatIntelligence.json new file mode 100644 index 000000000000..b9902f5f190d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/GetThreatIntelligence.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/27d963e6-e6e4-e0f9-e9d7-c53985b3bbe8", + "name": "27d963e6-e6e4-e0f9-e9d7-c53985b3bbe8", + "etag": "\"00002f2c-0000-0800-0000-5e976a8e0000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 90, + "created": "2021-04-15T20:11:57.9666134Z", + "createdByRef": "contoso@contoso.com", + "externalId": "indicator--8516d567-0daa-4614-8745-e3591e1b48cf", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2021-04-15T20:15:11.0746926Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema 2", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2021-04-15T17:44:00.114052Z" + } + }, + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "name": "e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "etag": "\"00002a2c-0000-0800-0000-5e97683b0000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2021-04-15T19:51:17.1050923Z", + "createdByRef": "contoso@contoso.com", + "externalId": "indicator--73be1729-babb-4348-a6c4-94621cae2530", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2021-04-15T20:15:11.074903Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "patching tags" + ], + "displayName": "updated indicator", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2021-04-15T17:44:00.114052Z" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/GetThreatIntelligenceById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/GetThreatIntelligenceById.json new file mode 100644 index 000000000000..1a9feae826d7 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/GetThreatIntelligenceById.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "name": "e16ef847-962e-d7b6-9c8b-a33e4bd30e47" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "name": "e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "etag": "\"00002a2c-0000-0800-0000-5e97683b0000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2021-04-15T19:51:17.1050923Z", + "createdByRef": "aztestConnectors@dataconnector.ccsctp.net", + "externalId": "indicator--73be1729-babb-4348-a6c4-94621cae2530", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2021-04-15T20:18:49.2259902Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "patching tags" + ], + "displayName": "updated indicator", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://abc.com']", + "patternType": "url", + "validFrom": "2021-04-15T17:44:00.114052Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/PostThreatIntelligenceCount.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/PostThreatIntelligenceCount.json new file mode 100644 index 000000000000..efaf6b9fd13e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/PostThreatIntelligenceCount.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "tiType": "main", + "Query": { + "condition": { + "clauses": [ + { + "field": "lastUpdatedTimeUtc", + "operator": "OnOrBeforeAbsolute", + "values": [ + "2024-02-09T23:59:59.999Z" + ] + } + ], + "conditionConnective": null + } + } + }, + "responses": { + "200": { + "body": { + "count": 3 + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/PostThreatIntelligenceQuery.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/PostThreatIntelligenceQuery.json new file mode 100644 index 000000000000..073f91ba805b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/PostThreatIntelligenceQuery.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "tiType": "main", + "Query": { + "condition": { + "clauses": [ + { + "field": "lastUpdatedTimeUtc", + "operator": "OnOrBeforeAbsolute", + "values": [ + "2024-02-09T23:59:59.999Z" + ] + } + ], + "stixObjectType": "attack-pattern", + "conditionConnective": null + }, + "sortBy": { + "field": "lastUpdatedTimeUtc", + "direction": "DESC" + }, + "minPageSize": 100, + "maxPageSize": 100 + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/threatintelligence/dGxwLW1peGVkVHlwZXMtd2l0aC1SdWxlcy0y---attack-pattern--fb6aa549-c94a-4e45-b4fd-7e32602dad85", + "name": "dGxwLW1peGVkVHlwZXMtd2l0aC1SdWxlcy0y---attack-pattern--fb6aa549-c94a-4e45-b4fd-7e32602dad85", + "type": "Microsoft.SecurityInsights/threatintelligence", + "kind": "AttackPattern", + "properties": { + "data": { + "name": "Attack Pattern 2.1", + "description": "menuPass appears to favor spear phishing to deliver payloads to the intended targets. While the attackers behind menuPass have used other RATs in their campaign, it appears that they use PIVY as their primary persistence mechanism.", + "kill_chain_phases": [ + { + "kill_chain_name": "mandiant-attack-lifecycle-model", + "phase_name": "initial-compromise" + } + ], + "aliases": [ + "alias_1", + "alias_2" + ], + "external_references": [ + { + "description": "spear phishing", + "external_id": "CAPEC-163", + "hashes": null, + "source_name": "capec", + "url": null + } + ], + "granular_markings": [ + { + "lang": "en", + "marking_ref": "marking-definition--089a6ecb-cc15-43cc-9494-767639779123", + "selectors": [ + "description", + "labels" + ] + } + ], + "confidence": 100, + "lang": "en", + "extensions": { + "sentinel-ext": { + "severity": null + }, + "extension-definition--d83fce45-ef58-4c6c-a3f4-1fbc32e98c6e": { + "extension_type": "property-extension", + "rank": 5, + "toxicity": 8 + } + }, + "type": "attack-pattern", + "id": "attack-pattern--fb6aa549-c94a-4e45-b4fd-7e32602dad85", + "created": "2015-05-15T09:12:16.432Z", + "modified": "2015-05-20T09:12:16.432Z", + "spec_version": "2.1", + "created_by_ref": "identity--f431f809-377b-45e0-aa1c-6a4751cae5ff", + "object_marking_refs": [ + "marking-definition--34098fce-860f-48ae-8e50-ebd3cc5e41da" + ], + "revoked": true, + "labels": [ + "heartbleed", + "has-logo" + ] + }, + "createdBy": { + "objectId": "00000000-0000-0000-0000-000000000000", + "email": "", + "name": "" + }, + "source": "mySource", + "firstIngestedTimeUtc": "2024-02-05T22:47:29.4948816", + "lastIngestedTimeUtc": "2024-02-05T22:47:29.4948816", + "ingestionRulesVersion": "00000000-0000-0000-0000-000000000000", + "lastUpdateMethod": "File Import", + "lastModifiedBy": { + "objectId": "00000000-0000-0000-0000-000000000000", + "email": "", + "name": "" + }, + "lastUpdatedDateTimeUtc": "2024-02-05T22:47:29.4948816", + "relationshipHints": null + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/QueryThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/QueryThreatIntelligence.json new file mode 100644 index 000000000000..a7dc5f634757 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/QueryThreatIntelligence.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ThreatIntelligenceFilteringCriteria": { + "pageSize": 100, + "minConfidence": 25, + "maxConfidence": 80, + "minValidUntil": "2021-04-05T17:44:00.114052Z", + "maxValidUntil": "2021-04-25T17:44:00.114052Z", + "sources": [ + "Azure Sentinel" + ], + "sortBy": [ + { + "itemKey": "lastUpdatedTimeUtc", + "sortOrder": "descending" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/27d963e6-e6e4-e0f9-e9d7-c53985b3bbe8", + "name": "27d963e6-e6e4-e0f9-e9d7-c53985b3bbe8", + "etag": "\"00002f2c-0000-0800-0000-5e976a8e0000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 90, + "created": "2021-04-15T20:11:57.9666134Z", + "createdByRef": "contoso@contoso.com", + "externalId": "indicator--8516d567-0daa-4614-8745-e3591e1b48cf", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T20:15:11.0746926Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema 2", + "description": "debugging indicators 2", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2021-04-15T17:44:00.114052Z", + "parsedPattern": [ + { + "patternTypeKey": "network-traffic", + "patternTypeValues": [ + { + "valueType": "0", + "value": "SSH-2.0-PuTTY_Release_0.64" + }, + { + "valueType": "1", + "value": "194.88.106.146" + } + ] + } + ] + } + }, + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "name": "e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "etag": "\"00002a2c-0000-0800-0000-5e97683b0000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2021-04-15T19:51:17.1050923Z", + "createdByRef": "contoso@contoso.com", + "externalId": "indicator--73be1729-babb-4348-a6c4-94621cae2530", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2021-04-15T20:15:11.074903Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "patching tags" + ], + "displayName": "updated indicator", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2021-04-15T17:44:00.114052Z" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/ReplaceTagsThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/ReplaceTagsThreatIntelligence.json new file mode 100644 index 000000000000..e228899ec1e8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/ReplaceTagsThreatIntelligence.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "name": "d9cd6f0b-96b9-3984-17cd-a779d1e15a93", + "ThreatIntelligenceReplaceTags": { + "etag": "\"0000262c-0000-0800-0000-5e9767060000\"", + "kind": "indicator", + "properties": { + "threatIntelligenceTags": [ + "patching tags" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "name": "e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "etag": "\"00002a2c-0000-0800-0000-5e97683b0000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2021-04-15T19:51:17.1050923Z", + "createdByRef": "aztestConnectors@dataconnector.ccsctp.net", + "externalId": "indicator--73be1729-babb-4348-a6c4-94621cae2530", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2021-04-15T19:56:08.828946Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "patching tags" + ], + "displayName": "updated indicator", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://abc.com']", + "patternType": "url", + "validFrom": "2021-04-15T17:44:00.114052Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/UpdateThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/UpdateThreatIntelligence.json new file mode 100644 index 000000000000..29faa8df8d68 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/threatintelligence/UpdateThreatIntelligence.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "name": "d9cd6f0b-96b9-3984-17cd-a779d1e15a93", + "ThreatIntelligenceProperties": { + "kind": "indicator", + "properties": { + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema", + "confidence": 78, + "createdByRef": "contoso@contoso.com", + "description": "debugging indicators", + "externalReferences": [], + "granularMarkings": [], + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "labels": [], + "modified": "", + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "revoked": false, + "validFrom": "2020-04-15T17:44:00.114052Z", + "validUntil": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "name": "180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "etag": "\"0000322c-0000-0800-0000-5e976c960000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2021-04-15T20:20:38.6160949Z", + "createdByRef": "contoso@contoso.com", + "externalId": "indicator--a2b6a95e-2108-4a38-bd49-ef95811bbcd7", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T20:20:38.6161887Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2021-04-15T17:44:00.114052Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "name": "180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "etag": "\"0000322c-0000-0800-0000-5e976c960000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2021-04-15T20:20:38.6160949Z", + "createdByRef": "aztestConnectors@contoso.com", + "externalId": "indicator--a2b6a95e-2108-4a38-bd49-ef95811bbcd7", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2021-04-15T20:20:38.6161887Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2021-04-15T17:44:00.114052Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/triggeredAnalyticsRuleRuns/triggerRuleRun_Post.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/triggeredAnalyticsRuleRuns/triggerRuleRun_Post.json new file mode 100644 index 000000000000..5f6d7d7afea3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/triggeredAnalyticsRuleRuns/triggerRuleRun_Post.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "65360bb0-8986-4ade-a89d-af3cf44d28aa", + "analyticsRuleRunTriggerParameter": { + "properties": { + "executionTimeUtc": "2022-12-22T15:37:03.074Z" + } + } + }, + "responses": { + "202": { + "headers": { + "Code": "202", + "Message": "Accepted", + "Location": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/triggeredAnalyticsRuleRuns/5abbc58b-9655-4f9b-80ac-5a576753e4ec?api-version=2024-04-01-preview" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRun_Get.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRun_Get.json new file mode 100644 index 000000000000..9492d2905006 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRun_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleRunId": "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/triggeredAnalyticsRuleRuns/65360bb0-8986-4ade-a89d-af3cf44d28aa", + "name": "65360bb0-8986-4ade-a89d-af3cf44d28aa", + "type": "Microsoft.SecurityInsights/TriggeredAnalyticsRuleRuns", + "properties": { + "executionTimeUtc": "2022-12-22T15:37:03.074Z", + "ruleId": "358e16da-ab76-4027-89e1-15937a6ed401", + "triggeredAnalyticsRuleRunId": "65360bb0-8986-4ade-a89d-af3cf44d28aa", + "provisioningState": "InProgress", + "ruleRunAdditionalData": { + "auditCorrelationId": "b8540a76-cb05-4a9b-8d52-9959b509e4ad", + "createdBy": "user@microsoft.com", + "healthCorrelationId": "dadd8fdc-fc7a-4005-a289-4e164cb75093" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRuns_Get.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRuns_Get.json new file mode 100644 index 000000000000..d89eaf7c138b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRuns_Get.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/triggeredAnalyticsRuleRuns/65360bb0-8986-4ade-a89d-af3cf44d28aa", + "name": "65360bb0-8986-4ade-a89d-af3cf44d28aa", + "type": "Microsoft.SecurityInsights/TriggeredAnalyticsRuleRuns", + "properties": { + "executionTimeUtc": "2022-12-22T15:37:03.074Z", + "ruleId": "358e16da-ab76-4027-89e1-15937a6ed401", + "triggeredAnalyticsRuleRunId": "65360bb0-8986-4ade-a89d-af3cf44d28aa", + "provisioningState": "InProgress", + "ruleRunAdditionalData": { + "auditCorrelationId": "b8540a76-cb05-4a9b-8d52-9959b509e4ad", + "createdBy": "user@microsoft.com", + "healthCorrelationId": "dadd8fdc-fc7a-4005-a289-4e164cb75093" + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/triggeredAnalyticsRuleRuns/1f62ea0f-2d25-4b65-bd4d-bb9114bcbd9c", + "name": "1f62ea0f-2d25-4b65-bd4d-bb9114bcbd9c", + "type": "Microsoft.SecurityInsights/TriggeredAnalyticsRuleRuns", + "properties": { + "executionTimeUtc": "2022-12-20T15:37:03.074Z", + "ruleId": "358e16da-ab76-4027-89e1-15937a6ed401", + "triggeredAnalyticsRuleRunId": "1f62ea0f-2d25-4b65-bd4d-bb9114bcbd9c", + "provisioningState": "Succeeded", + "ruleRunAdditionalData": { + "auditCorrelationId": "763f9dae-1027-44b9-a34a-589404693670", + "createdBy": "user2@microsoft.com", + "healthCorrelationId": "b3c165ec-f53e-48c1-9677-216d9e930912" + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/CreateWatchlist.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/CreateWatchlist.json new file mode 100644 index 000000000000..b5e41f3116bb --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/CreateWatchlist.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "watchlistAlias": "highValueAsset", + "watchlist": { + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "displayName": "High Value Assets Watchlist", + "source": "watchlist.csv", + "sourceType": "Local file", + "provider": "Microsoft", + "description": "Watchlist from CSV content", + "itemsSearchKey": "header1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset", + "name": "highValueAsset", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/Watchlists", + "properties": { + "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017", + "displayName": "High Value Assets Watchlist", + "provider": "Microsoft", + "source": "watchlist.csv", + "sourceType": "Local file", + "created": "2020-09-28T00:26:54.7746089+00:00", + "updated": "2020-09-28T00:26:57+00:00", + "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" + }, + "description": "Watchlist from CSV content", + "watchlistType": "watchlist", + "watchlistAlias": "highValueAsset", + "itemsSearchKey": "header1", + "isDeleted": false, + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset", + "name": "highValueAsset", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/Watchlists", + "properties": { + "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017", + "displayName": "High Value Assets Watchlist", + "provider": "Microsoft", + "source": "watchlist.csv", + "sourceType": "Local file", + "created": "2020-09-28T00:26:54.7746089+00:00", + "updated": "2020-09-28T00:26:57+00:00", + "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" + }, + "description": "Watchlist from CSV content", + "watchlistType": "watchlist", + "watchlistAlias": "highValueAsset", + "itemsSearchKey": "header1", + "isDeleted": false, + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/CreateWatchlistAndWatchlistItems.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/CreateWatchlistAndWatchlistItems.json new file mode 100644 index 000000000000..eabee2f388a0 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/CreateWatchlistAndWatchlistItems.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "watchlistAlias": "highValueAsset", + "watchlist": { + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "displayName": "High Value Assets Watchlist", + "source": "watchlist.csv", + "sourceType": "Local file", + "provider": "Microsoft", + "description": "Watchlist from CSV content", + "numberOfLinesToSkip": 1, + "rawContent": "This line will be skipped\nheader1,header2\nvalue1,value2", + "itemsSearchKey": "header1", + "contentType": "text/csv" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset", + "name": "highValueAsset", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/Watchlists", + "properties": { + "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017", + "displayName": "High Value Assets Watchlist", + "provider": "Microsoft", + "source": "watchlist.csv", + "sourceType": "Local file", + "created": "2020-09-28T00:26:54.7746089+00:00", + "updated": "2020-09-28T00:26:57+00:00", + "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" + }, + "description": "Watchlist from CSV content", + "watchlistType": "watchlist", + "watchlistAlias": "highValueAsset", + "itemsSearchKey": "header1", + "isDeleted": false, + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset", + "name": "highValueAsset", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/Watchlists", + "properties": { + "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017", + "displayName": "High Value Assets Watchlist", + "provider": "Microsoft", + "source": "watchlist.csv", + "sourceType": "Local file", + "created": "2020-09-28T00:26:54.7746089+00:00", + "updated": "2020-09-28T00:26:57+00:00", + "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" + }, + "description": "Watchlist from CSV content", + "watchlistType": "watchlist", + "watchlistAlias": "highValueAsset", + "itemsSearchKey": "header1", + "isDeleted": false, + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/CreateWatchlistItem.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/CreateWatchlistItem.json new file mode 100644 index 000000000000..b0c79420c040 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/CreateWatchlistItem.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "watchlistAlias": "highValueAsset", + "watchlistItemId": "82ba292c-dc97-4dfc-969d-d4dd9e666842", + "watchlistItem": { + "etag": "0300bf09-0000-0000-0000-5c37296e0000", + "properties": { + "itemsKeyValue": { + "Gateway subnet": "10.0.255.224/27", + "Web Tier": "10.0.1.0/24", + "Business tier": "10.0.2.0/24", + "Data tier": "10.0.2.0/24", + "Private DMZ in": "10.0.0.0/27", + "Public DMZ out": "10.0.0.96/27" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Watchlists/highValueAsset/WatchlistItems/82ba292c-dc97-4dfc-969d-d4dd9e666842", + "etag": "0300bf09-0000-0000-0000-5c37296e0000", + "type": "Microsoft.SecurityInsights/Watchlists/WatchlistItems", + "properties": { + "watchlistItemType": "watchlist-item", + "watchlistItemId": "82ba292c-dc97-4dfc-969d-d4dd9e666842", + "tenantId": "4008512e-1d30-48b2-9ee2-d3612ed9d3ea", + "isDeleted": false, + "created": "2020-11-15T04:58:56.0748363+00:00", + "updated": "2020-11-16T16:05:20+00:00", + "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" + }, + "itemsKeyValue": { + "Gateway subnet": "10.0.255.224/27", + "Web Tier": "10.0.1.0/24", + "Business tier": "10.0.2.0/24", + "Data tier": "10.0.2.0/24", + "Private DMZ in": "10.0.0.0/27", + "Public DMZ out": "10.0.0.96/27" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Watchlists/highValueAsset/WatchlistItems/82ba292c-dc97-4dfc-969d-d4dd9e666842", + "etag": "0300bf09-0000-0000-0000-5c37296e0000", + "type": "Microsoft.SecurityInsights/Watchlists/WatchlistItems", + "properties": { + "watchlistItemType": "watchlist-item", + "watchlistItemId": "82ba292c-dc97-4dfc-969d-d4dd9e666842", + "tenantId": "4008512e-1d30-48b2-9ee2-d3612ed9d3ea", + "isDeleted": false, + "created": "2020-11-15T04:58:56.0748363+00:00", + "updated": "2020-11-16T16:05:20+00:00", + "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" + }, + "itemsKeyValue": { + "Gateway subnet": "10.0.255.224/27", + "Web Tier": "10.0.1.0/24", + "Business tier": "10.0.2.0/24", + "Data tier": "10.0.2.0/24", + "Private DMZ in": "10.0.0.0/27", + "Public DMZ out": "10.0.0.96/27" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/DeleteWatchlist.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/DeleteWatchlist.json new file mode 100644 index 000000000000..b246136baa5f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/DeleteWatchlist.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "watchlistAlias": "highValueAsset" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SecurityInsights/watchlists/1011-01/watchlistStatuses/00000000-0000-0000-0000-000000000000?api-version=2024-04-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/DeleteWatchlistItem.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/DeleteWatchlistItem.json new file mode 100644 index 000000000000..15bbb01a1d56 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/DeleteWatchlistItem.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "watchlistAlias": "highValueAsset", + "watchlistItemId": "4008512e-1d30-48b2-9ee2-d3612ed9d3ea" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/GetWatchlistByAlias.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/GetWatchlistByAlias.json new file mode 100644 index 000000000000..b153497009cd --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/GetWatchlistByAlias.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "watchlistAlias": "highValueAsset" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset", + "name": "highValueAsset", + "type": "Microsoft.SecurityInsights/Watchlists", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017", + "displayName": "High Value Assets Watchlist", + "provider": "Microsoft", + "source": "watchlist.csv", + "sourceType": "Local file", + "created": "2020-09-28T00:26:54.7746089+00:00", + "updated": "2020-09-28T00:26:57+00:00", + "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" + }, + "description": "Watchlist from CSV content", + "watchlistType": "watchlist", + "watchlistAlias": "highValueAsset", + "itemsSearchKey": "header1", + "isDeleted": false, + "labels": [ + "Tag1", + "Tag2" + ], + "defaultDuration": "P1279DT12H30M5S", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/GetWatchlistItemById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/GetWatchlistItemById.json new file mode 100644 index 000000000000..b4191381ef2a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/GetWatchlistItemById.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "watchlistAlias": "highValueAsset", + "watchlistItemId": "3f8901fe-63d9-4875-9ad5-9fb3b8105797" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Watchlists/highValueAsset/WatchlistItems/fd37d325-7090-47fe-851a-5b5a00c3f576", + "name": "fd37d325-7090-47fe-851a-5b5a00c3f576", + "etag": "\"f2089bfa-0000-0d00-0000-601c58b42021\"", + "type": "Microsoft.SecurityInsights/Watchlists/WatchlistItems", + "properties": { + "watchlistItemType": "watchlist-item", + "watchlistItemId": "fd37d325-7090-47fe-851a-5b5a00c3f576", + "tenantId": "3f8901fe-63d9-4875-9ad5-9fb3b8105797", + "isDeleted": false, + "created": "2021-02-04T12:27:32.3783333-08:00", + "updated": "2021-02-04T12:27:32.3783333-08:00", + "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" + }, + "itemsKeyValue": { + "Header-1": "v1_1", + "Header-2": "v1_2", + "Header-3": "v1_3", + "Header-4": "v1_4", + "Header-5": "v1_5" + }, + "entityMapping": {} + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/GetWatchlistItems.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/GetWatchlistItems.json new file mode 100644 index 000000000000..3846aa3510c1 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/GetWatchlistItems.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "watchlistAlias": "highValueAsset" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Watchlists/highValueAsset/WatchlistItems/fd37d325-7090-47fe-851a-5b5a00c3f576", + "name": "fd37d325-7090-47fe-851a-5b5a00c3f576", + "etag": "\"f2089bfa-0000-0d00-0000-601c58b42021\"", + "type": "Microsoft.SecurityInsights/Watchlists/WatchlistItems", + "properties": { + "watchlistItemType": "watchlist-item", + "watchlistItemId": "fd37d325-7090-47fe-851a-5b5a00c3f576", + "tenantId": "3f8901fe-63d9-4875-9ad5-9fb3b8105797", + "isDeleted": false, + "created": "2021-02-04T12:27:32.3783333-08:00", + "updated": "2021-02-04T12:27:32.3783333-08:00", + "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" + }, + "itemsKeyValue": { + "Header-1": "v1_1", + "Header-2": "v1_2", + "Header-3": "v1_3", + "Header-4": "v1_4", + "Header-5": "v1_5" + }, + "entityMapping": {} + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/GetWatchlists.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/GetWatchlists.json new file mode 100644 index 000000000000..78f83f9397d9 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/watchlists/GetWatchlists.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset", + "name": "highValueAsset", + "type": "Microsoft.SecurityInsights/Watchlists", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017", + "displayName": "High Value Assets Watchlist", + "provider": "Microsoft", + "source": "watchlist.csv", + "sourceType": "Local file", + "created": "2020-09-28T00:26:54.7746089+00:00", + "updated": "2020-09-28T00:26:57+00:00", + "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" + }, + "description": "Watchlist from CSV content", + "watchlistType": "watchlist", + "watchlistAlias": "highValueAsset", + "itemsSearchKey": "header1", + "isDeleted": false, + "labels": [ + "Tag1", + "Tag2" + ], + "defaultDuration": "P1279DT12H30M5S", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/CreateJob.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/CreateJob.json new file mode 100644 index 000000000000..1fb75b6275df --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/CreateJob.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerAssignmentName": "47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58", + "jobName": "cfbe1338-8276-4d5d-8b96-931117f9fa0e" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerAssignments/47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58/jobs/cfbe1338-8276-4d5d-8b96-931117f9fa0e", + "etag": "\"f20a2523-7817-47b5-a3b2-21539c00c788\"", + "name": "cfbe1338-8276-4d5d-8b96-931117f9fa0e", + "type": "Microsoft.SecurityInsights/workspaceManagerAssignments/jobs", + "properties": { + "startTime": "2022-06-14T04:47:52.9614956Z", + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/CreateOrUpdateWorkspaceManagerAssignment.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/CreateOrUpdateWorkspaceManagerAssignment.json new file mode 100644 index 000000000000..a4e4e58c90b8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/CreateOrUpdateWorkspaceManagerAssignment.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerAssignmentName": "47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58", + "workspaceManagerAssignment": { + "properties": { + "items": [ + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspac-es/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleOne" + }, + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspac-es/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleTwo" + } + ], + "targetResourceName": "37207a7a-3b8a-438f-a559-c7df400e1b96" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerAssignments/47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "name": "47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58", + "type": "Microsoft.SecurityInsights/workspaceManagerAssignments", + "properties": { + "items": [ + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspac-es/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleOne" + }, + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspac-es/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleTwo" + } + ], + "targetResourceName": "37207a7a-3b8a-438f-a559-c7df400e1b96" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerAssignments/47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "name": "47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58", + "type": "Microsoft.SecurityInsights/workspaceManagerAssignments", + "properties": { + "items": [ + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspac-es/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleOne" + }, + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspac-es/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleTwo" + } + ], + "targetResourceName": "37207a7a-3b8a-438f-a559-c7df400e1b96" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/DeleteJob.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/DeleteJob.json new file mode 100644 index 000000000000..a96980ee3af1 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/DeleteJob.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerAssignmentName": "47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58", + "jobName": "cfbe1338-8276-4d5d-8b96-931117f9fa0e" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/DeleteWorkspaceManagerAssignment.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/DeleteWorkspaceManagerAssignment.json new file mode 100644 index 000000000000..cdc4177fc1b1 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/DeleteWorkspaceManagerAssignment.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerAssignmentName": "47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/GetAllJobs.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/GetAllJobs.json new file mode 100644 index 000000000000..0fadaa9b8254 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/GetAllJobs.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerAssignmentName": "47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerAssignments/47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58/jobs/cfbe1338-8276-4d5d-8b96-931117f9fa0e", + "etag": "\"f20a2523-7817-47b5-a3b2-21539c00c788\"", + "name": "cfbe1338-8276-4d5d-8b96-931117f9fa0e", + "type": "Microsoft.SecurityInsights/workspaceManagerAssignments/jobs", + "properties": { + "endTime": "2022-06-14T04:52:52.9614956Z", + "items": [ + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleOne", + "status": "Succeeded", + "executionTime": "2022-06-14T04:49:52.9614956Z" + }, + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleTwo", + "status": "Failed", + "executionTime": "2022-06-14T04:50:52.9614956Z", + "errors": [ + { + "memberResourceName": "f5fa104e-c0e3-4747-9182-d342dc048a9e", + "errorMessage": "Failed to write. Status code: Forbidden." + } + ] + } + ], + "startTime": "2022-06-14T04:47:52.9614956Z", + "provisioningState": "Failed" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/GetAllWorkspaceManagerAssignments.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/GetAllWorkspaceManagerAssignments.json new file mode 100644 index 000000000000..fceab286c9bb --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/GetAllWorkspaceManagerAssignments.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerAssignments/47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "name": "47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58", + "type": "Microsoft.SecurityInsights/workspaceManagerAssignments", + "properties": { + "items": [ + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspac-es/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleOne" + }, + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspac-es/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleTwo" + } + ], + "targetResourceName": "37207a7a-3b8a-438f-a559-c7df400e1b96", + "lastJobEndTime": "2022-06-14T04:52:52.9614956Z", + "lastJobProvisioningState": "Failed" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/GetJob.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/GetJob.json new file mode 100644 index 000000000000..989d0093f874 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/GetJob.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerAssignmentName": "47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58", + "jobName": "cfbe1338-8276-4d5d-8b96-931117f9fa0e" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerAssignments/47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58/jobs/cfbe1338-8276-4d5d-8b96-931117f9fa0e", + "etag": "\"f20a2523-7817-47b5-a3b2-21539c00c788\"", + "name": "cfbe1338-8276-4d5d-8b96-931117f9fa0e", + "type": "Microsoft.SecurityInsights/workspaceManagerAssignments/jobs", + "properties": { + "endTime": "2022-06-14T04:52:52.9614956Z", + "items": [ + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleOne", + "status": "Succeeded", + "executionTime": "2022-06-14T04:49:52.9614956Z" + }, + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleTwo", + "status": "Failed", + "executionTime": "2022-06-14T04:50:52.9614956Z", + "errors": [ + { + "memberResourceName": "f5fa104e-c0e3-4747-9182-d342dc048a9e", + "errorMessage": "Failed to write. Status code: Forbidden." + } + ] + } + ], + "startTime": "2022-06-14T04:47:52.9614956Z", + "provisioningState": "Failed" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/GetWorkspaceManagerAssignment.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/GetWorkspaceManagerAssignment.json new file mode 100644 index 000000000000..e6db6975643c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerAssignments/GetWorkspaceManagerAssignment.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerAssignmentName": "47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerAssignments/47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "name": "47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58", + "type": "Microsoft.SecurityInsights/workspaceManagerAssignments", + "properties": { + "items": [ + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspac-es/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleOne" + }, + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspac-es/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleTwo" + } + ], + "targetResourceName": "37207a7a-3b8a-438f-a559-c7df400e1b96", + "lastJobEndTime": "2022-06-14T04:52:52.9614956Z", + "lastJobProvisioningState": "Failed" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerConfigurations/CreateOrUpdateWorkspaceManagerConfiguration.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerConfigurations/CreateOrUpdateWorkspaceManagerConfiguration.json new file mode 100644 index 000000000000..51a47fa59f04 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerConfigurations/CreateOrUpdateWorkspaceManagerConfiguration.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerConfigurationName": "default", + "workspaceManagerConfiguration": { + "properties": { + "mode": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerConfigurations/default", + "etag": "\"3f6451dd-1b58-4bef-bce7-72eba6b354d7\"", + "name": "default", + "type": "Microsoft.SecurityInsights/workspaceManagerConfigurations", + "properties": { + "mode": "Enabled" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerConfigurations/default", + "etag": "\"3f6451dd-1b58-4bef-bce7-72eba6b354d7\"", + "name": "default", + "type": "Microsoft.SecurityInsights/workspaceManagerConfigurations", + "properties": { + "mode": "Enabled" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerConfigurations/DeleteWorkspaceManagerConfiguration.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerConfigurations/DeleteWorkspaceManagerConfiguration.json new file mode 100644 index 000000000000..846198fc12a9 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerConfigurations/DeleteWorkspaceManagerConfiguration.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerConfigurationName": "default" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerConfigurations/GetAllWorkspaceManagerConfigurations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerConfigurations/GetAllWorkspaceManagerConfigurations.json new file mode 100644 index 000000000000..b74bbfd46a4f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerConfigurations/GetAllWorkspaceManagerConfigurations.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerConfigurations/default", + "etag": "\"3f6451dd-1b58-4bef-bce7-72eba6b354d7\"", + "name": "default", + "type": "Microsoft.SecurityInsights/workspaceManagerConfigurations", + "properties": { + "mode": "Enabled" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerConfigurations/GetWorkspaceManagerConfiguration.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerConfigurations/GetWorkspaceManagerConfiguration.json new file mode 100644 index 000000000000..428804a9bc12 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerConfigurations/GetWorkspaceManagerConfiguration.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerConfigurationName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerConfigurations/default", + "etag": "\"3f6451dd-1b58-4bef-bce7-72eba6b354d7\"", + "name": "default", + "type": "Microsoft.SecurityInsights/workspaceManagerConfigurations", + "properties": { + "mode": "Enabled" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerGroups/CreateOrUpdateWorkspaceManagerGroup.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerGroups/CreateOrUpdateWorkspaceManagerGroup.json new file mode 100644 index 000000000000..2baf243e3d09 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerGroups/CreateOrUpdateWorkspaceManagerGroup.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerGroupName": "37207a7a-3b8a-438f-a559-c7df400e1b96", + "workspaceManagerGroup": { + "properties": { + "description": "Group of all financial and banking institutions", + "displayName": "Banks", + "memberResourceNames": [ + "afbd324f-6c48-459c-8710-8d1e1cd03812", + "f5fa104e-c0e3-4747-9182-d342dc048a9e" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerGroups/37207a7a-3b8a-438f-a559-c7df400e1b96", + "etag": "\"ac04c9ad-4b3c-4e13-b511-8c2225e46521\"", + "name": "37207a7a-3b8a-438f-a559-c7df400e1b96", + "type": "Microsoft.SecurityInsights/workspaceManagerGroups", + "properties": { + "description": "Group of all financial and banking institutions", + "displayName": "Banks", + "memberResourceNames": [ + "afbd324f-6c48-459c-8710-8d1e1cd03812", + "f5fa104e-c0e3-4747-9182-d342dc048a9e" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerGroups/37207a7a-3b8a-438f-a559-c7df400e1b96", + "etag": "\"ac04c9ad-4b3c-4e13-b511-8c2225e46521\"", + "name": "37207a7a-3b8a-438f-a559-c7df400e1b96", + "type": "Microsoft.SecurityInsights/workspaceManagerGroups", + "properties": { + "description": "Group of all financial and banking institutions", + "displayName": "Banks", + "memberResourceNames": [ + "afbd324f-6c48-459c-8710-8d1e1cd03812", + "f5fa104e-c0e3-4747-9182-d342dc048a9e" + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerGroups/DeleteWorkspaceManagerGroup.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerGroups/DeleteWorkspaceManagerGroup.json new file mode 100644 index 000000000000..cf5841e12adc --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerGroups/DeleteWorkspaceManagerGroup.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerGroupName": "37207a7a-3b8a-438f-a559-c7df400e1b96" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerGroups/GetAllWorkspaceManagerGroups.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerGroups/GetAllWorkspaceManagerGroups.json new file mode 100644 index 000000000000..42456371cb89 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerGroups/GetAllWorkspaceManagerGroups.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerGroups/37207a7a-3b8a-438f-a559-c7df400e1b96", + "etag": "\"ac04c9ad-4b3c-4e13-b511-8c2225e46521\"", + "name": "37207a7a-3b8a-438f-a559-c7df400e1b96", + "type": "Microsoft.SecurityInsights/workspaceManagerGroups", + "properties": { + "description": "Group of all financial and banking institutions", + "displayName": "Banks", + "memberResourceNames": [ + "afbd324f-6c48-459c-8710-8d1e1cd03812", + "f5fa104e-c0e3-4747-9182-d342dc048a9e" + ] + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerGroups/GetWorkspaceManagerGroup.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerGroups/GetWorkspaceManagerGroup.json new file mode 100644 index 000000000000..cc7657e9f451 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerGroups/GetWorkspaceManagerGroup.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerGroupName": "37207a7a-3b8a-438f-a559-c7df400e1b96" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerGroups/37207a7a-3b8a-438f-a559-c7df400e1b96", + "etag": "\"ac04c9ad-4b3c-4e13-b511-8c2225e46521\"", + "name": "37207a7a-3b8a-438f-a559-c7df400e1b96", + "type": "Microsoft.SecurityInsights/workspaceManagerGroups", + "properties": { + "description": "Group of all financial and banking institutions", + "displayName": "Banks", + "memberResourceNames": [ + "afbd324f-6c48-459c-8710-8d1e1cd03812", + "f5fa104e-c0e3-4747-9182-d342dc048a9e" + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerMembers/CreateOrUpdateWorkspaceManagerMember.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerMembers/CreateOrUpdateWorkspaceManagerMember.json new file mode 100644 index 000000000000..3c96873b0200 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerMembers/CreateOrUpdateWorkspaceManagerMember.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerMemberName": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "workspaceManagerMember": { + "properties": { + "targetWorkspaceResourceId": "/subscriptions/7aef9d48-814f-45ad-b644-b0343316e174/resourceGroups/otherRg/providers/Microsoft.OperationalInsights/workspaces/Example_Workspace", + "targetWorkspaceTenantId": "f676d436-8d16-42db-81b7-ab578e110ccd" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerMembers/afbd324f-6c48-459c-8710-8d1e1cd03812", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "name": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "type": "Microsoft.SecurityInsights/workspaceManagerMembers", + "properties": { + "targetWorkspaceResourceId": "/subscriptions/7aef9d48-814f-45ad-b644-b0343316e174/resourceGroups/otherRg/providers/Microsoft.OperationalInsights/workspaces/Example_Workspace", + "targetWorkspaceTenantId": "f676d436-8d16-42db-81b7-ab578e110ccd" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerMembers/afbd324f-6c48-459c-8710-8d1e1cd03812", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "name": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "type": "Microsoft.SecurityInsights/workspaceManagerMembers", + "properties": { + "targetWorkspaceResourceId": "/subscriptions/7aef9d48-814f-45ad-b644-b0343316e174/resourceGroups/otherRg/providers/Microsoft.OperationalInsights/workspaces/Example_Workspace", + "targetWorkspaceTenantId": "f676d436-8d16-42db-81b7-ab578e110ccd" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerMembers/DeleteWorkspaceManagerMember.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerMembers/DeleteWorkspaceManagerMember.json new file mode 100644 index 000000000000..a98ad6798d9e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerMembers/DeleteWorkspaceManagerMember.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerMemberName": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerMembers/GetAllWorkspaceManagerMembers.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerMembers/GetAllWorkspaceManagerMembers.json new file mode 100644 index 000000000000..5b3ddc1ab611 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerMembers/GetAllWorkspaceManagerMembers.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerMembers/afbd324f-6c48-459c-8710-8d1e1cd03812", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "name": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "type": "Microsoft.SecurityInsights/workspaceManagerMembers", + "properties": { + "targetWorkspaceResourceId": "/subscriptions/7aef9d48-814f-45ad-b644-b0343316e174/resourceGroups/otherRg/providers/Microsoft.OperationalInsights/workspaces/Example_Workspace", + "targetWorkspaceTenantId": "f676d436-8d16-42db-81b7-ab578e110ccd" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerMembers/GetWorkspaceManagerMember.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerMembers/GetWorkspaceManagerMember.json new file mode 100644 index 000000000000..a1da39f85c64 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/examples/workspaceManagerMembers/GetWorkspaceManagerMember.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerMemberName": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerMembers/afbd324f-6c48-459c-8710-8d1e1cd03812", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "name": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "type": "Microsoft.SecurityInsights/workspaceManagerMembers", + "properties": { + "targetWorkspaceResourceId": "/subscriptions/7aef9d48-814f-45ad-b644-b0343316e174/resourceGroups/otherRg/providers/Microsoft.OperationalInsights/workspaces/Example_Workspace", + "targetWorkspaceTenantId": "f676d436-8d16-42db-81b7-ab578e110ccd" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/operations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/operations.json new file mode 100644 index 000000000000..b85a203f60c9 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-04-01-preview/operations.json @@ -0,0 +1,138 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.SecurityInsights/operations": { + "get": { + "x-ms-examples": { + "Get all operations.": { + "$ref": "./examples/operations/ListOperations.json" + } + }, + "operationId": "Operations_List", + "description": "Lists all operations available Azure Security Insights Resource Provider.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK. Successfully retrieved operations list.", + "schema": { + "$ref": "#/definitions/OperationsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "OperationsList": { + "description": "Lists the operations available in the SecurityInsights RP.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of operations.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Array of operations", + "items": { + "$ref": "#/definitions/Operation" + }, + "type": "array" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "Operation": { + "description": "Operation provided by provider", + "properties": { + "display": { + "description": "Properties of the operation", + "properties": { + "description": { + "description": "Description of the operation", + "type": "string" + }, + "operation": { + "description": "Operation name", + "type": "string" + }, + "provider": { + "description": "Provider name", + "type": "string" + }, + "resource": { + "description": "Resource name", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "Name of the operation", + "type": "string" + }, + "origin": { + "description": "The origin of the operation", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + } + }, + "type": "object" + } + }, + "parameters": {} +} diff --git a/specification/securityinsights/resource-manager/common/2.0/types.json b/specification/securityinsights/resource-manager/common/2.0/types.json index 36760abb92df..f29b96f483a3 100644 --- a/specification/securityinsights/resource-manager/common/2.0/types.json +++ b/specification/securityinsights/resource-manager/common/2.0/types.json @@ -9,7 +9,7 @@ "ResourceWithEtag": { "allOf": [ { - "$ref": "../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + "$ref": "../../../../common-types/resource-management/v5/types.json#/definitions/Resource" } ], "description": "An azure resource object with an Etag property", diff --git a/specification/securityinsights/resource-manager/readme.md b/specification/securityinsights/resource-manager/readme.md index 538ca61c487b..0c3365537214 100644 --- a/specification/securityinsights/resource-manager/readme.md +++ b/specification/securityinsights/resource-manager/readme.md @@ -8,7 +8,8 @@ This is the AutoRest configuration file for SecurityInsights. ## Getting Started -To build the SDK for SecurityInsights, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: +To build the SDK for Azure Machine Learning, simply [Install AutoRest](https://aka.ms/autorest/install) and + in this folder, run: > `autorest` @@ -26,17 +27,96 @@ These are the global settings for the SecurityInsights API. ``` yaml openapi-type: arm -tag: package-2024-03 +tag: package-preview-2024-04 ``` --- +### Tag: package-preview-2024-04 + +These settings apply only when `--tag=package-preview-2024-04` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-04' +input-file: + - Microsoft.SecurityInsights/preview/2024-04-01-preview/AlertRules.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/AutomationRules.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/BillingStatistics.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/Bookmarks.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/BusinessApplicationAgents.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/ContentPackages.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/ContentProductPackages.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/ContentProductTemplates.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/ContentTemplates.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/EnrichmentWithWorkspace.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/Entities.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/EntityQueries.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/EntityQueryTemplates.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/FileImports.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/Hunts.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/Incidents.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/Metadata.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/OfficeConsents.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/OnboardingStates.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/Recommendations.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/SecurityMLAnalyticsSettings.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/Settings.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/SourceControls.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/ThreatIntelligence.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/ThreatIntelligenceCount.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/ThreatIntelligenceQuery.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/TriggeredAnalyticsRuleRuns.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/Watchlists.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/WorkspaceManagerAssignments.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/WorkspaceManagerConfigurations.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/WorkspaceManagerGroups.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/WorkspaceManagerMembers.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/dataConnectorDefinitions.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/dataConnectors.json + - Microsoft.SecurityInsights/preview/2024-04-01-preview/operations.json +suppressions: + - code: AvoidAdditionalProperties + from: dataConnectors.json + reason: These properties are unknown and need to be specified by the customer (each request can have different values) + - code: AvoidAdditionalProperties + from: Entities.json + reason: These properties are unknown and changed frequently (each request can have different values for each entity) + - code: AvoidAdditionalProperties + from: EntityQueries.json + reason: These properties are unknown and changed frequently (each request can have different values for each entity) + - code: AvoidAdditionalProperties + from: EntityQueryTemplates.json + reason: These properties are unknown and changed frequently (each request can have different values for each entity) + - code: AvoidAdditionalProperties + from: AlertRules.json + reason: These properties are unknown and changed frequently (each request can have different values for each entity) + - code: AvoidAdditionalProperties + from: Recommendations.json + reason: These properties are unknown and changed frequently (each request can have different values for each entity) + - code: AvoidAnonymousTypes + from: Recommendations.json + reason: These properties are unknown (each request can have different values for each entity) + - code: AvoidAdditionalProperties + from: TriggeredAnalyticsRuleRuns.json + reason: TriggeredAnalyticsRuleRun does not include a property called "additionalProperties", it is only used to mark that 'ruleRunAdditionalData' is a dictionary or string to object. + - code: AvoidAdditionalProperties + from: ThreatIntelligenceQuery.json + reason: These properties are required in current API. The team is working on a new version of API to resolve it in the future release. + - code: GetCollectionOnlyHasValueAndNextLink + from: Entities.json + reason: This API is published to customers and we have not changed it in the past year, nor will we be able to change it without breaking changes to customers. + - code: DefinitionsPropertiesNamesCamelCase + from: Entities.json + reason: This API is published to customers and we have not changed it in the past year, nor will we be able to change it without breaking changes to customers. + - code: PutRequestResponseSchemeArm + from: EntityQueries.json + reason: This API is published to customers and we have not changed it in the past year, nor will we be able to change it without breaking changes to customers. +``` ### Tag: package-2024-03 These settings apply only when `--tag=package-2024-03` is specified on the command line. -```yaml $(tag) == 'package-2024-03' +``` yaml $(tag) == 'package-2024-03' input-file: - Microsoft.SecurityInsights/stable/2024-03-01/AlertRules.json - Microsoft.SecurityInsights/stable/2024-03-01/AutomationRules.json @@ -55,6 +135,7 @@ input-file: - Microsoft.SecurityInsights/stable/2024-03-01/Watchlists.json - Microsoft.SecurityInsights/stable/2024-03-01/operations.json ``` + ### Tag: package-preview-2024-01 These settings apply only when `--tag=package-preview-2024-01` is specified on the command line. @@ -960,9 +1041,9 @@ directive: - suppress: R4017 reason: Our resources do not support list by subscription. They're not top-level resources. To get a SecurityInsights resource, we should have a subscription as well as a resource group and Log Analytics workspace. - suppress: OBJECT_ADDITIONAL_PROPERTIES - reason: 'Caused by a duplicate Resource definition in our common directory that contains systemData. We were instructed to supress this by Swagger reviewr.' + reason: 'Caused by a duplicate Resource definition in our common directory that contains systemData. We were instructed to suppress this by Swagger reviewer.' - suppress: GuidUsage - reason: 'Tenent Id should be a Guid' + reason: 'Tenant Id should be a Guid' ``` --- From b5d78da207e9c5d8f82e95224039867271f47cdf Mon Sep 17 00:00:00 2001 From: Naveed Aziz Date: Wed, 25 Sep 2024 21:41:47 -0700 Subject: [PATCH 22/48] Release web 2024 04 01 (#30415) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Release web 2024 04 01 (#28952) * Copy files from stable/2023-12-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to stable/2024-04-01 Updated the API version from stable/2023-12-01 to stable/2024-04-01. * Added tag for 2024-04-01 in readme file * Copy files from stable/2023-12-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to stable/2024-04-01 Updated the API version from stable/2023-12-01 to stable/2024-04-01. * Added tag for 2024-04-01 in readme file * Copy files from stable/2023-12-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to stable/2024-04-01 Updated the API version from stable/2023-12-01 to stable/2024-04-01. * Added tag for 2024-04-01 in readme file * Fix RP merge issue * Fix prettier failute * Fix spellcheck for sitecontainers * Fix prettier check failures * Fix ALL prettier check failures * Add LeastRequestsWithTieBreaker (#29128) * Add LeastRequestsWithTieBreaker * Change to target 2024-04-01 --------- Co-authored-by: Chris Rosenblatt * Update 2023-12-01 Microsoft.Web functionAppConfig definition (#29226) (#29350) * Update 2023-12-01 Microsoft.Web functionAppConfig definition (#29226) * Rename enum to functionsDeploymentStorageType * Update enum name to camel case * Update enum names to camel case * Port changes to 2024-04-01 API version * Rename storageType to FunctionsDeploymentStorageType * Update enum name's to use amelcase casing --------- Co-authored-by: Naveed Aziz * Add SKU property to site. Add description for supported values of kin… (#29354) * Add SKU property to site. Add description for supported values of kind property on app * Fix typo * Fix prettier * User/rohinisharma/update instance info (#29333) * Adding parameter to Website Instance Info obj * Prettier --------- Co-authored-by: Rohini Sharma Co-authored-by: Naveed Aziz * [AppServices] Add AutoGeneratedDomainNameLabelScope to Websites (#29649) * [DNL] Add AutoGeneratedDomainNameLabelScope to Websites * fix casing * fix prettier * Add e2e tls to latest releases (#29904) Co-authored-by: Chris Rosenblatt * Add updatemachinekey api (#29730) * Add updatemachinekey api * fix json formatting * Change api version * Add machinekey to allowed words * action verb at end of address * Change post address to conform to arm --------- Co-authored-by: Naveed Aziz * Developer/nineela/autogenerateddomainnamelabelscope edit 2 (#30047) * [DNL] Add AutoGeneratedDomainNameLabelScope to Websites * Minor comment update * Add IP Mode to Websites (#29089) * Add IP Mode to Websites * Target 2024-04-01 * Fix linter --------- Co-authored-by: Chris Rosenblatt Co-authored-by: Naveed Aziz * Microsft.Web 2023-12-01: Add int32 format to all number types in the scaleAndConcurrency section of the functionAppConfig (#30050) * Microsft.Web 2023-12-01: Add int32 format to all number types in the scaleAndConcurrency section of the functionAppConfig (#29907) * Set format to int32 for all number types in the functionAppConfig * Update types to integer. --------- Co-authored-by: Naveed Aziz * Update types to integer and set format to int32 for all number types in the functionAppConfig --------- Co-authored-by: Naveed Aziz * Add CipherSuites object to support discoverability API (#30067) Co-authored-by: Chris Rosenblatt Co-authored-by: Naveed Aziz --------- Co-authored-by: Chris Rosenblatt Co-authored-by: Chris Rosenblatt Co-authored-by: Francisco Gamino Co-authored-by: rohinisharma Co-authored-by: Rohini Sharma Co-authored-by: nineela <82120829+nineela@users.noreply.github.com> Co-authored-by: andrewschuck <115187222+andrewschuck@users.noreply.github.com> --- cSpell.json | 5 +- .../AppServiceCertificateOrders.json | 1801 + .../CertificateOrdersDiagnostics.json | 190 + .../CertificateRegistrationProvider.json | 91 + .../examples/CreateAppServiceCertificate.json | 46 + .../CreateAppServiceCertificateOrder.json | 182 + .../examples/DeleteAppServiceCertificate.json | 13 + .../DeleteAppServiceCertificateOrder.json | 12 + ...rviceCertificateOrderDetectorResponse.json | 90 + ...rviceCertificateOrderDetectorResponse.json | 37 + .../examples/GetAppServiceCertificate.json | 25 + .../GetAppServiceCertificateOrder.json | 86 + ...rviceCertificateOrdersByResourceGroup.json | 89 + ...erviceCertificateOrdersBySubscription.json | 88 + ...tificatesByAppServiceCertificateOrder.json | 39 + .../2024-04-01/examples/ListOperations.json | 184 + .../ReissueAppServiceCertificateOrder.json | 19 + .../RenewAppServiceCertificateOrder.json | 18 + ...ResendAppServiceCertificateOrderEmail.json | 11 + ...esendDomainOwnershipVerificationEmail.json | 14 + .../RetrieveCertificateEmailHistory.json | 23 + .../RetrieveCertificateOrderActions.json | 27 + .../2024-04-01/examples/RetrieveSiteSeal.json | 20 + .../examples/UpdateAppServiceCertificate.json | 31 + .../UpdateAppServiceCertificateOrder.json | 105 + ...catePurchaseInformationBySubscription.json | 29 + .../examples/VerifyDomainOwnership.json | 11 + .../DomainRegistrationProvider.json | 91 + .../stable/2024-04-01/Domains.json | 1616 + .../stable/2024-04-01/TopLevelDomains.json | 303 + .../examples/CheckDomainAvailability.json | 18 + .../examples/CreateAppServiceDomain.json | 303 + ...teAppServiceDomainOwnershipIdentifier.json | 27 + .../examples/DeleteAppServiceDomain.json | 13 + ...teAppServiceDomainOwnershipIdentifier.json | 13 + .../stable/2024-04-01/examples/GetDomain.json | 115 + .../GetDomainControlCenterSsoRequest.json | 15 + .../GetDomainOwnershipIdentifier.json | 22 + .../examples/GetTopLevelDomain.json | 20 + .../ListDomainOwnershipIdentifiers.json | 25 + .../examples/ListDomainRecommendations.json | 28 + .../examples/ListDomainsByResourceGroup.json | 117 + .../examples/ListDomainsBySubscription.json | 116 + .../2024-04-01/examples/ListOperations.json | 104 + .../ListTopLevelDomainAgreements.json | 32 + .../examples/ListTopLevelDomains.json | 87 + .../2024-04-01/examples/RenewDomain.json | 13 + .../examples/TransferOutDomain.json | 115 + .../examples/UpdateAppServiceDomain.json | 301 + ...teAppServiceDomainOwnershipIdentifier.json | 27 + .../stable/2023-12-01/CommonDefinitions.json | 4 + .../2024-04-01/AppServiceEnvironments.json | 3324 ++ .../stable/2024-04-01/AppServicePlans.json | 1776 + .../stable/2024-04-01/Certificates.json | 663 + .../stable/2024-04-01/CommonDefinitions.json | 4551 +++ .../stable/2024-04-01/ContainerApps.json | 612 + .../2024-04-01/ContainerAppsRevisions.json | 427 + .../stable/2024-04-01/DeletedWebApps.json | 209 + .../stable/2024-04-01/Diagnostics.json | 2165 ++ .../stable/2024-04-01/Global.json | 195 + .../stable/2024-04-01/KubeEnvironments.json | 723 + .../stable/2024-04-01/Provider.json | 1126 + .../stable/2024-04-01/Recommendations.json | 1076 + .../2024-04-01/ResourceHealthMetadata.json | 406 + .../stable/2024-04-01/ResourceProvider.json | 1675 + .../stable/2024-04-01/StaticSites.json | 5585 +++ .../stable/2024-04-01/WebApps.json | 31534 ++++++++++++++++ .../2024-04-01/examples/ActivateRevision.json | 12 + .../examples/AnalyzeCustomHostName.json | 32 + .../examples/AnalyzeCustomHostNameSlot.json | 33 + ...roveOrRejectPrivateEndpointConnection.json | 59 + .../AppServiceEnvironments_ChangeVnet.json | 28 + ...AppServiceEnvironments_CreateOrUpdate.json | 185 + ...ironments_CreateOrUpdateMultiRolePool.json | 24 + ...Environments_CreateOrUpdateWorkerPool.json | 25 + .../AppServiceEnvironments_Delete.json | 19 + ...ments_DeletePrivateEndpointConnection.json | 26 + .../examples/AppServiceEnvironments_Get.json | 65 + ...ments_GetAseV3NetworkingConfiguration.json | 36 + ...erviceEnvironments_GetDiagnosticsItem.json | 17 + ...pServiceEnvironments_GetMultiRolePool.json | 33 + ...ronments_GetPrivateEndpointConnection.json | 31 + ...ents_GetPrivateEndpointConnectionList.json | 34 + ...eEnvironments_GetPrivateLinkResources.json | 16 + .../AppServiceEnvironments_GetVipInfo.json | 41 + .../AppServiceEnvironments_GetWorkerPool.json | 26 + .../examples/AppServiceEnvironments_List.json | 67 + ...rviceEnvironments_ListAppServicePlans.json | 61 + ...rviceEnvironments_ListByResourceGroup.json | 68 + ...AppServiceEnvironments_ListCapacities.json | 57 + ...ppServiceEnvironments_ListDiagnostics.json | 18 + ...nments_ListMultiRoleMetricDefinitions.json | 42 + ...ultiRolePoolInstanceMetricDefinitions.json | 43 + ...iceEnvironments_ListMultiRolePoolSkus.json | 158 + ...erviceEnvironments_ListMultiRolePools.json | 38 + ...rviceEnvironments_ListMultiRoleUsages.json | 17 + ...AppServiceEnvironments_ListOperations.json | 14 + .../AppServiceEnvironments_ListUsages.json | 28 + .../AppServiceEnvironments_ListWebApps.json | 82 + ...nments_ListWebWorkerMetricDefinitions.json | 38 + ...rviceEnvironments_ListWebWorkerUsages.json | 18 + ...stWorkerPoolInstanceMetricDefinitions.json | 39 + ...erviceEnvironments_ListWorkerPoolSkus.json | 89 + ...ppServiceEnvironments_ListWorkerPools.json | 54 + .../AppServiceEnvironments_Reboot.json | 13 + .../AppServiceEnvironments_Resume.json | 25 + .../AppServiceEnvironments_Suspend.json | 25 + ...ents_TestUpgradeAvailableNotification.json | 13 + .../AppServiceEnvironments_Update.json | 183 + ...ents_UpdateAseNetworkingConfiguration.json | 42 + .../AppServiceEnvironments_Upgrade.json | 15 + .../2024-04-01/examples/ApplySlotConfig.json | 17 + ...veRejectSitePrivateEndpointConnection.json | 60 + ...jectSitePrivateEndpointConnectionSlot.json | 61 + .../2024-04-01/examples/BackupWebApp.json | 74 + .../2024-04-01/examples/CloneWebApp.json | 253 + .../2024-04-01/examples/CloneWebAppSlot.json | 254 + .../CreateOrUpdateAppServicePlan.json | 80 + .../examples/CreateOrUpdateCertificate.json | 39 + .../examples/CreateOrUpdateContainerApp.json | 156 + ...ateOrUpdateFunctionAppFlexConsumption.json | 334 + ...FunctionAppFlexConsumptionWithDetails.json | 363 + .../examples/CreateOrUpdateStaticSite.json | 81 + .../CreateOrUpdateStaticSiteAppSettings.json | 26 + .../CreateOrUpdateStaticSiteBasicAuth.json | 31 + ...ateOrUpdateStaticSiteBuildAppSettings.json | 27 + ...dateStaticSiteBuildDatabaseConnection.json | 33 + ...ateStaticSiteBuildFunctionAppSettings.json | 27 + .../CreateOrUpdateStaticSiteCustomDomain.json | 35 + ...eOrUpdateStaticSiteDatabaseConnection.json | 32 + ...OrUpdateStaticSiteFunctionAppSettings.json | 26 + .../examples/CreateOrUpdateWebApp.json | 251 + .../examples/CreateOrUpdateWebAppSlot.json | 242 + .../CreateUserRolesInvitationLink.json | 28 + .../examples/DeactivateRevision.json | 12 + .../examples/DeleteAppServicePlan.json | 12 + ...DeleteAseCustomDnsSuffixConfiguration.json | 18 + .../examples/DeleteCertificate.json | 12 + .../examples/DeleteContainerApp.json | 17 + .../DeleteDeployWorkflowArtifacts.json | 17 + .../DeleteSitePrivateEndpointConnection.json | 23 + ...leteSitePrivateEndpointConnectionSlot.json | 24 + .../2024-04-01/examples/DeleteStaticSite.json | 16 + .../examples/DeleteStaticSiteBuild.json | 18 + ...leteStaticSiteBuildDatabaseConnection.json | 13 + .../DeleteStaticSiteCustomDomain.json | 17 + .../DeleteStaticSiteDatabaseConnection.json | 12 + .../examples/DeleteStaticSiteUser.json | 13 + .../2024-04-01/examples/DeleteWebApp.json | 13 + .../examples/DeleteWebAppBackup.json | 13 + .../2024-04-01/examples/DeleteWebAppSlot.json | 14 + .../2024-04-01/examples/DetachStaticSite.json | 16 + ...UserProvidedFunctionAppFromStaticSite.json | 13 + ...rovidedFunctionAppFromStaticSiteBuild.json | 14 + .../Diagnostics_ExecuteSiteAnalysis.json | 126 + .../Diagnostics_ExecuteSiteAnalysisSlot.json | 126 + .../Diagnostics_ExecuteSiteDetector.json | 30 + .../Diagnostics_ExecuteSiteDetectorSlot.json | 30 + ...GetHostingEnvironmentDetectorResponse.json | 133 + .../examples/Diagnostics_GetSiteAnalysis.json | 22 + .../Diagnostics_GetSiteAnalysisSlot.json | 22 + .../examples/Diagnostics_GetSiteDetector.json | 25 + .../Diagnostics_GetSiteDetectorResponse.json | 134 + ...agnostics_GetSiteDetectorResponseSlot.json | 134 + .../Diagnostics_GetSiteDetectorSlot.json | 25 + ...Diagnostics_GetSiteDiagnosticCategory.json | 21 + ...nostics_GetSiteDiagnosticCategorySlot.json | 21 + ...stHostingEnvironmentDetectorResponses.json | 27 + .../Diagnostics_ListSiteAnalyses.json | 53 + .../Diagnostics_ListSiteAnalysesSlot.json | 53 + ...Diagnostics_ListSiteDetectorResponses.json | 28 + ...nostics_ListSiteDetectorResponsesSlot.json | 28 + .../Diagnostics_ListSiteDetectors.json | 198 + .../Diagnostics_ListSiteDetectorsSlot.json | 58 + ...gnostics_ListSiteDiagnosticCategories.json | 24 + ...tics_ListSiteDiagnosticCategoriesSlot.json | 24 + .../GenerateStaticSiteWorkflowPreview.json | 29 + .../examples/GetAllStaticSites.json | 38 + .../examples/GetAppServicePlan.json | 40 + .../GetAseCustomDnsSuffixConfiguration.json | 25 + .../GetAuthSettingsV2WithoutSecrets.json | 86 + .../2024-04-01/examples/GetCertificate.json | 30 + .../2024-04-01/examples/GetContainerApp.json | 64 + .../2024-04-01/examples/GetDeletedWebApp.json | 27 + .../examples/GetDeletedWebAppByLocation.json | 28 + .../examples/GetDeletedWebAppSnapshots.json | 22 + .../examples/GetFunctionAppStacks.json | 779 + .../GetFunctionAppStacksForLocation.json | 786 + ...etInboundNetworkDependenciesEndpoints.json | 79 + .../GetKeyVaultReferencesForAppSetting.json | 22 + ...etKeyVaultReferencesForAppSettingSlot.json | 23 + .../GetKeyVaultReferencesForAppSettings.json | 33 + ...tKeyVaultReferencesForAppSettingsSlot.json | 34 + .../GetLinkedBackendForStaticSite.json | 25 + .../GetLinkedBackendForStaticSiteBuild.json | 26 + .../GetLinkedBackendsForStaticSite.json | 29 + .../GetLinkedBackendsForStaticSiteBuild.json | 31 + ...tOutboundNetworkDependenciesEndpoints.json | 802 + .../GetPublishingCredentialsPolicy.json | 19 + .../GetPublishingCredentialsPolicySlot.json | 20 + .../GetResourceHealthMetadataBySite.json | 23 + .../2024-04-01/examples/GetRevision.json | 56 + .../2024-04-01/examples/GetSiteConfig.json | 70 + .../examples/GetSiteDeploymentStatus.json | 45 + .../examples/GetSiteDeploymentStatusSlot.json | 46 + .../examples/GetSiteInstanceInfo.json | 30 + .../GetSitePrivateEndpointConnection.json | 28 + .../GetSitePrivateEndpointConnectionList.json | 32 + .../GetSitePrivateEndpointConnectionSlot.json | 29 + .../examples/GetSitePrivateLinkResources.json | 31 + .../GetSitePrivateLinkResourcesSlot.json | 32 + .../2024-04-01/examples/GetStaticSite.json | 43 + .../examples/GetStaticSiteBasicAuth.json | 24 + .../examples/GetStaticSiteBuild.json | 35 + .../GetStaticSiteBuildDatabaseConnection.json | 25 + ...iteBuildDatabaseConnectionWithDetails.json | 38 + ...GetStaticSiteBuildDatabaseConnections.json | 29 + ...teBuildDatabaseConnectionsWithDetails.json | 42 + .../examples/GetStaticSiteBuilds.json | 53 + .../examples/GetStaticSiteCustomDomain.json | 20 + .../examples/GetStaticSiteCustomDomains.json | 25 + .../GetStaticSiteDatabaseConnection.json | 24 + ...aticSiteDatabaseConnectionWithDetails.json | 37 + .../GetStaticSiteDatabaseConnections.json | 28 + ...ticSiteDatabaseConnectionsWithDetails.json | 41 + .../2024-04-01/examples/GetStaticSites.json | 40 + ...ubscriptionOperationWithAsyncResponse.json | 11 + .../examples/GetUsagesInLocation.json | 27 + ...tUserProvidedFunctionAppForStaticSite.json | 24 + ...ProvidedFunctionAppForStaticSiteBuild.json | 25 + ...UserProvidedFunctionAppsForStaticSite.json | 28 + ...rovidedFunctionAppsForStaticSiteBuild.json | 29 + .../stable/2024-04-01/examples/GetWebApp.json | 128 + .../2024-04-01/examples/GetWebAppBackup.json | 47 + .../examples/GetWebAppBackupWithSecrets.json | 75 + .../2024-04-01/examples/GetWebAppSlot.json | 124 + .../2024-04-01/examples/GetWebAppStacks.json | 2915 ++ .../examples/GetWebAppStacksForLocation.json | 2923 ++ .../GetWebSiteNetworkTraceOperation.json | 35 + .../examples/GetWebSiteNetworkTraces.json | 22 + .../2024-04-01/examples/GetWorkflow.json | 59 + .../KubeEnvironments_CreateOrUpdate.json | 68 + .../examples/KubeEnvironments_Delete.json | 23 + .../examples/KubeEnvironments_Get.json | 38 + .../KubeEnvironments_ListByResourceGroup.json | 56 + .../KubeEnvironments_ListBySubscription.json | 48 + .../examples/KubeEnvironments_Update.json | 67 + .../examples/LinkBackendToStaticSite.json | 31 + .../LinkBackendToStaticSiteBuild.json | 32 + .../examples/ListAppServicePlans.json | 67 + .../ListAppServicePlansByResourceGroup.json | 68 + .../2024-04-01/examples/ListAppSettings.json | 23 + .../2024-04-01/examples/ListAseRegions.json | 54 + .../2024-04-01/examples/ListAuthSettings.json | 32 + .../examples/ListAuthSettingsV2.json | 86 + .../2024-04-01/examples/ListCertificates.json | 49 + .../ListCertificatesByResourceGroup.json | 50 + .../examples/ListContainerAppSecrets.json | 25 + .../ListContainerAppsByResourceGroup.json | 67 + .../ListContainerAppsBySubscription.json | 66 + .../examples/ListCustomHostNameSites.json | 50 + .../ListCustomSpecificHostNameSites.json | 37 + .../ListDeletedWebAppsByLocation.json | 32 + .../2024-04-01/examples/ListOperations.json | 5831 +++ .../ListPublishingCredentialsPolicies.json | 33 + ...ListPublishingCredentialsPoliciesSlot.json | 34 + ...ResourceHealthMetadataByResourceGroup.json | 25 + .../ListResourceHealthMetadataBySite.json | 27 + ...tResourceHealthMetadataBySubscription.json | 24 + .../2024-04-01/examples/ListRevisions.json | 60 + .../examples/ListSiteDeploymentStatus.json | 17 + .../ListSiteDeploymentStatusSlot.json | 18 + .../2024-04-01/examples/ListSlotBackups.json | 28 + .../examples/ListStaticSiteAppSettings.json | 19 + .../examples/ListStaticSiteBasicAuth.json | 27 + .../ListStaticSiteBuildAppSettings.json | 20 + ...istStaticSiteBuildFunctionAppSettings.json | 20 + .../ListStaticSiteBuildFunctions.json | 26 + .../ListStaticSiteConfiguredRoles.json | 20 + .../ListStaticSiteFunctionAppSettings.json | 19 + .../examples/ListStaticSiteFunctions.json | 25 + .../examples/ListStaticSiteSecrets.json | 18 + .../examples/ListStaticSiteUsers.json | 28 + .../examples/ListWebAppBackups.json | 50 + .../examples/ListWebAppConfigurations.json | 74 + .../2024-04-01/examples/ListWebAppSlots.json | 233 + .../2024-04-01/examples/ListWebApps.json | 241 + .../examples/ListWebAppsByResourceGroup.json | 242 + .../2024-04-01/examples/ListWorkflows.json | 49 + ...ListWorkflowsConfigurationConnections.json | 46 + .../examples/PatchAppServicePlan.json | 72 + .../2024-04-01/examples/PatchCertificate.json | 35 + .../2024-04-01/examples/PatchStaticSite.json | 65 + ...atchStaticSiteBuildDatabaseConnection.json | 28 + .../PatchStaticSiteDatabaseConnection.json | 27 + .../examples/PostDeployWorkflowArtifacts.json | 57 + .../PostDeployWorkflowArtifactsSlot.json | 58 + ...UserProvidedFunctionAppWithStaticSite.json | 46 + ...rovidedFunctionAppWithStaticSiteBuild.json | 47 + .../examples/ResetStaticSiteApiKey.json | 17 + .../2024-04-01/examples/RestartRevision.json | 12 + .../examples/RestoreWebAppBackup.json | 38 + .../StartWebSiteNetworkTraceOperation.json | 35 + .../examples/StaticSiteBuildZipDeploy.json | 26 + .../examples/StaticSiteZipDeploy.json | 25 + .../examples/StopWebSiteNetworkTrace.json | 13 + .../examples/UnlinkBackendFromStaticSite.json | 14 + .../UnlinkBackendFromStaticSiteBuild.json | 15 + .../examples/UpdateAppSettings.json | 29 + ...UpdateAseCustomDnsSuffixConfiguration.json | 32 + .../examples/UpdateAuthSettings.json | 47 + .../examples/UpdateAuthSettingsV2.json | 155 + .../examples/UpdateAzureStorageAccounts.json | 39 + .../2024-04-01/examples/UpdateMachineKey.json | 14 + .../UpdatePublishingCredentialsPolicy.json | 24 + ...UpdatePublishingCredentialsPolicySlot.json | 25 + .../2024-04-01/examples/UpdateSiteConfig.json | 123 + .../examples/UpdateStaticSiteUser.json | 28 + .../2024-04-01/examples/UpdateWebApp.json | 249 + .../2024-04-01/examples/UpdateWebAppSlot.json | 240 + .../ValidateLinkedBackendForStaticSite.json | 19 + ...lidateLinkedBackendForStaticSiteBuild.json | 20 + .../ValidateStaticSiteCustomDomain.json | 20 + .../VerifyHostingEnvironmentVnet.json | 24 + ...ActionRepetitionsRequestHistories_Get.json | 70 + ...ctionRepetitionsRequestHistories_List.json | 73 + .../WorkflowRunActionRepetitions_Get.json | 56 + .../WorkflowRunActionRepetitions_List.json | 99 + ...ctionRepetitions_ListExpressionTraces.json | 25 + ...WorkflowRunActionScopeRepetitions_Get.json | 37 + ...orkflowRunActionScopeRepetitions_List.json | 61 + .../examples/WorkflowRunActions_Get.json | 38 + .../examples/WorkflowRunActions_List.json | 41 + ...rkflowRunActions_ListExpressionTraces.json | 25 + .../examples/WorkflowRuns_Cancel.json | 13 + .../2024-04-01/examples/WorkflowRuns_Get.json | 45 + .../examples/WorkflowRuns_List.json | 48 + .../WorkflowTriggerHistories_Get.json | 36 + .../WorkflowTriggerHistories_List.json | 39 + .../WorkflowTriggerHistories_Resubmit.json | 18 + .../examples/WorkflowTriggers_Get.json | 30 + .../WorkflowTriggers_GetSchemaJson.json | 18 + .../examples/WorkflowTriggers_List.json | 33 + .../WorkflowTriggers_ListCallbackUrl.json | 25 + .../examples/WorkflowTriggers_Run.json | 18 + .../examples/WorkflowVersions_Get.json | 42 + .../examples/WorkflowVersions_List.json | 45 + .../Workflows_RegenerateAccessKey.json | 15 + .../examples/Workflows_Validate.json | 26 + .../web/resource-manager/readme.cli.md | 2 +- .../web/resource-manager/readme.csharp.md | 18 +- .../web/resource-manager/readme.go.md | 44 +- .../web/resource-manager/readme.java.md | 40 +- specification/web/resource-manager/readme.md | 4234 ++- .../web/resource-manager/readme.nodejs.md | 2 +- .../web/resource-manager/readme.python.md | 38 +- .../web/resource-manager/readme.ruby.md | 16 +- .../web/resource-manager/readme.typescript.md | 8 +- .../resource-manager/sdk-suppressions.yaml | 2 +- 359 files changed, 92753 insertions(+), 2189 deletions(-) create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/AppServiceCertificateOrders.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/CertificateOrdersDiagnostics.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/CertificateRegistrationProvider.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/CreateAppServiceCertificate.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/CreateAppServiceCertificateOrder.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/DeleteAppServiceCertificate.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/DeleteAppServiceCertificateOrder.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/Diagnostics_GetAppServiceCertificateOrderDetectorResponse.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/Diagnostics_ListAppServiceCertificateOrderDetectorResponse.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/GetAppServiceCertificate.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/GetAppServiceCertificateOrder.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ListAppServiceCertificateOrdersByResourceGroup.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ListAppServiceCertificateOrdersBySubscription.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ListCertificatesByAppServiceCertificateOrder.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ListOperations.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ReissueAppServiceCertificateOrder.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/RenewAppServiceCertificateOrder.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ResendAppServiceCertificateOrderEmail.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ResendDomainOwnershipVerificationEmail.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/RetrieveCertificateEmailHistory.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/RetrieveCertificateOrderActions.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/RetrieveSiteSeal.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/UpdateAppServiceCertificate.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/UpdateAppServiceCertificateOrder.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ValidateAppServiceCertificatePurchaseInformationBySubscription.json create mode 100644 specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/VerifyDomainOwnership.json create mode 100644 specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/DomainRegistrationProvider.json create mode 100644 specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/Domains.json create mode 100644 specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/TopLevelDomains.json create mode 100644 specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/CheckDomainAvailability.json create mode 100644 specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/CreateAppServiceDomain.json create mode 100644 specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/CreateAppServiceDomainOwnershipIdentifier.json create mode 100644 specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/DeleteAppServiceDomain.json create mode 100644 specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/DeleteAppServiceDomainOwnershipIdentifier.json create mode 100644 specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/GetDomain.json create mode 100644 specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/GetDomainControlCenterSsoRequest.json create mode 100644 specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/GetDomainOwnershipIdentifier.json create mode 100644 specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/GetTopLevelDomain.json create mode 100644 specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListDomainOwnershipIdentifiers.json create mode 100644 specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListDomainRecommendations.json create mode 100644 specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListDomainsByResourceGroup.json create mode 100644 specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListDomainsBySubscription.json create mode 100644 specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListOperations.json create mode 100644 specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListTopLevelDomainAgreements.json create mode 100644 specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListTopLevelDomains.json create mode 100644 specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/RenewDomain.json create mode 100644 specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/TransferOutDomain.json create mode 100644 specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/UpdateAppServiceDomain.json create mode 100644 specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/UpdateAppServiceDomainOwnershipIdentifier.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/AppServiceEnvironments.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/AppServicePlans.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/Certificates.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/CommonDefinitions.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/ContainerApps.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/ContainerAppsRevisions.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/DeletedWebApps.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/Diagnostics.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/Global.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/KubeEnvironments.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/Provider.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/Recommendations.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/ResourceHealthMetadata.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/ResourceProvider.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/StaticSites.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/WebApps.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ActivateRevision.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AnalyzeCustomHostName.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AnalyzeCustomHostNameSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ApproveOrRejectPrivateEndpointConnection.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ChangeVnet.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_CreateOrUpdate.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_CreateOrUpdateMultiRolePool.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_CreateOrUpdateWorkerPool.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Delete.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_DeletePrivateEndpointConnection.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Get.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetAseV3NetworkingConfiguration.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetDiagnosticsItem.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetMultiRolePool.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetPrivateEndpointConnection.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetPrivateEndpointConnectionList.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetPrivateLinkResources.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetVipInfo.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetWorkerPool.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_List.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListAppServicePlans.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListByResourceGroup.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListCapacities.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListDiagnostics.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListMultiRoleMetricDefinitions.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListMultiRolePoolInstanceMetricDefinitions.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListMultiRolePoolSkus.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListMultiRolePools.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListMultiRoleUsages.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListOperations.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListUsages.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListWebApps.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListWebWorkerMetricDefinitions.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListWebWorkerUsages.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListWorkerPoolInstanceMetricDefinitions.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListWorkerPoolSkus.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListWorkerPools.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Reboot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Resume.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Suspend.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_TestUpgradeAvailableNotification.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Update.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_UpdateAseNetworkingConfiguration.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Upgrade.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ApplySlotConfig.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ApproveRejectSitePrivateEndpointConnection.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ApproveRejectSitePrivateEndpointConnectionSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/BackupWebApp.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CloneWebApp.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CloneWebAppSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateAppServicePlan.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateCertificate.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateContainerApp.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateFunctionAppFlexConsumption.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateFunctionAppFlexConsumptionWithDetails.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSite.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteAppSettings.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteBasicAuth.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteBuildAppSettings.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteBuildDatabaseConnection.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteBuildFunctionAppSettings.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteCustomDomain.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteDatabaseConnection.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteFunctionAppSettings.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateWebApp.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateWebAppSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateUserRolesInvitationLink.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeactivateRevision.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteAppServicePlan.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteAseCustomDnsSuffixConfiguration.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteCertificate.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteContainerApp.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteDeployWorkflowArtifacts.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteSitePrivateEndpointConnection.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteSitePrivateEndpointConnectionSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteStaticSite.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteStaticSiteBuild.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteStaticSiteBuildDatabaseConnection.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteStaticSiteCustomDomain.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteStaticSiteDatabaseConnection.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteStaticSiteUser.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteWebApp.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteWebAppBackup.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteWebAppSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DetachStaticSite.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DetachUserProvidedFunctionAppFromStaticSite.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DetachUserProvidedFunctionAppFromStaticSiteBuild.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ExecuteSiteAnalysis.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ExecuteSiteAnalysisSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ExecuteSiteDetector.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ExecuteSiteDetectorSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetHostingEnvironmentDetectorResponse.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteAnalysis.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteAnalysisSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteDetector.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteDetectorResponse.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteDetectorResponseSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteDetectorSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteDiagnosticCategory.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteDiagnosticCategorySlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListHostingEnvironmentDetectorResponses.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteAnalyses.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteAnalysesSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteDetectorResponses.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteDetectorResponsesSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteDetectors.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteDetectorsSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteDiagnosticCategories.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteDiagnosticCategoriesSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GenerateStaticSiteWorkflowPreview.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetAllStaticSites.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetAppServicePlan.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetAseCustomDnsSuffixConfiguration.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetAuthSettingsV2WithoutSecrets.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetCertificate.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetContainerApp.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetDeletedWebApp.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetDeletedWebAppByLocation.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetDeletedWebAppSnapshots.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetFunctionAppStacks.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetFunctionAppStacksForLocation.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetInboundNetworkDependenciesEndpoints.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetKeyVaultReferencesForAppSetting.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetKeyVaultReferencesForAppSettingSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetKeyVaultReferencesForAppSettings.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetKeyVaultReferencesForAppSettingsSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetLinkedBackendForStaticSite.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetLinkedBackendForStaticSiteBuild.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetLinkedBackendsForStaticSite.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetLinkedBackendsForStaticSiteBuild.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetOutboundNetworkDependenciesEndpoints.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetPublishingCredentialsPolicy.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetPublishingCredentialsPolicySlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetResourceHealthMetadataBySite.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetRevision.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSiteConfig.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSiteDeploymentStatus.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSiteDeploymentStatusSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSiteInstanceInfo.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSitePrivateEndpointConnection.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSitePrivateEndpointConnectionList.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSitePrivateEndpointConnectionSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSitePrivateLinkResources.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSitePrivateLinkResourcesSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSite.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBasicAuth.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBuild.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBuildDatabaseConnection.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBuildDatabaseConnectionWithDetails.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBuildDatabaseConnections.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBuildDatabaseConnectionsWithDetails.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBuilds.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteCustomDomain.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteCustomDomains.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteDatabaseConnection.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteDatabaseConnectionWithDetails.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteDatabaseConnections.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteDatabaseConnectionsWithDetails.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSites.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSubscriptionOperationWithAsyncResponse.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetUsagesInLocation.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetUserProvidedFunctionAppForStaticSite.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetUserProvidedFunctionAppForStaticSiteBuild.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetUserProvidedFunctionAppsForStaticSite.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetUserProvidedFunctionAppsForStaticSiteBuild.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebApp.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebAppBackup.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebAppBackupWithSecrets.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebAppSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebAppStacks.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebAppStacksForLocation.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebSiteNetworkTraceOperation.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebSiteNetworkTraces.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWorkflow.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_CreateOrUpdate.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_Delete.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_Get.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_ListByResourceGroup.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_ListBySubscription.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_Update.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/LinkBackendToStaticSite.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/LinkBackendToStaticSiteBuild.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAppServicePlans.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAppServicePlansByResourceGroup.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAppSettings.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAseRegions.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettings.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettingsV2.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListCertificates.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListCertificatesByResourceGroup.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListContainerAppSecrets.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListContainerAppsByResourceGroup.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListContainerAppsBySubscription.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListCustomHostNameSites.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListCustomSpecificHostNameSites.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListDeletedWebAppsByLocation.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListOperations.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListPublishingCredentialsPolicies.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListPublishingCredentialsPoliciesSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListResourceHealthMetadataByResourceGroup.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListResourceHealthMetadataBySite.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListResourceHealthMetadataBySubscription.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListRevisions.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListSiteDeploymentStatus.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListSiteDeploymentStatusSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListSlotBackups.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteAppSettings.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteBasicAuth.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteBuildAppSettings.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteBuildFunctionAppSettings.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteBuildFunctions.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteConfiguredRoles.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteFunctionAppSettings.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteFunctions.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteSecrets.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteUsers.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebAppBackups.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebAppConfigurations.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebAppSlots.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebApps.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebAppsByResourceGroup.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWorkflows.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWorkflowsConfigurationConnections.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PatchAppServicePlan.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PatchCertificate.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PatchStaticSite.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PatchStaticSiteBuildDatabaseConnection.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PatchStaticSiteDatabaseConnection.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PostDeployWorkflowArtifacts.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PostDeployWorkflowArtifactsSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/RegisterUserProvidedFunctionAppWithStaticSite.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/RegisterUserProvidedFunctionAppWithStaticSiteBuild.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ResetStaticSiteApiKey.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/RestartRevision.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/RestoreWebAppBackup.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/StartWebSiteNetworkTraceOperation.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/StaticSiteBuildZipDeploy.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/StaticSiteZipDeploy.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/StopWebSiteNetworkTrace.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UnlinkBackendFromStaticSite.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UnlinkBackendFromStaticSiteBuild.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAppSettings.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAseCustomDnsSuffixConfiguration.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAuthSettings.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAuthSettingsV2.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAzureStorageAccounts.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateMachineKey.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdatePublishingCredentialsPolicy.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdatePublishingCredentialsPolicySlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateSiteConfig.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateStaticSiteUser.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateWebApp.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateWebAppSlot.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ValidateLinkedBackendForStaticSite.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ValidateLinkedBackendForStaticSiteBuild.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ValidateStaticSiteCustomDomain.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/VerifyHostingEnvironmentVnet.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitionsRequestHistories_Get.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitionsRequestHistories_List.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitions_Get.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitions_List.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitions_ListExpressionTraces.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionScopeRepetitions_Get.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionScopeRepetitions_List.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActions_Get.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActions_List.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActions_ListExpressionTraces.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRuns_Cancel.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRuns_Get.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRuns_List.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggerHistories_Get.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggerHistories_List.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggerHistories_Resubmit.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggers_Get.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggers_GetSchemaJson.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggers_List.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggers_ListCallbackUrl.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggers_Run.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowVersions_Get.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowVersions_List.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Workflows_RegenerateAccessKey.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Workflows_Validate.json diff --git a/cSpell.json b/cSpell.json index bb92a1426a69..29ff06a9c8f4 100644 --- a/cSpell.json +++ b/cSpell.json @@ -472,9 +472,10 @@ ] }, { - "filename": "**/specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/WebApps.json", + "filename": "**/specification/web/resource-manager/Microsoft.Web/stable/**/WebApps.json", "words": [ - "sitecontainers" + "sitecontainers", + "updatemachinekey" ] }, { diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/AppServiceCertificateOrders.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/AppServiceCertificateOrders.json new file mode 100644 index 000000000000..c61b82eb92de --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/AppServiceCertificateOrders.json @@ -0,0 +1,1801 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "AppServiceCertificateOrders API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.CertificateRegistration/certificateOrders": { + "get": { + "tags": [ + "AppServiceCertificateOrders" + ], + "summary": "List all certificate orders in a subscription.", + "description": "Description for List all certificate orders in a subscription.", + "operationId": "AppServiceCertificateOrders_List", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AppServiceCertificateOrderCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List App Service Certificate orders by subscription": { + "$ref": "./examples/ListAppServiceCertificateOrdersBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CertificateRegistration/validateCertificateRegistrationInformation": { + "post": { + "tags": [ + "AppServiceCertificateOrders" + ], + "summary": "Validate information for a certificate order.", + "description": "Description for Validate information for a certificate order.", + "operationId": "AppServiceCertificateOrders_ValidatePurchaseInformation", + "parameters": [ + { + "name": "appServiceCertificateOrder", + "in": "body", + "description": "Information for a certificate order.", + "required": true, + "schema": { + "$ref": "#/definitions/AppServiceCertificateOrder" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Validate App Service Certificate purchase information by subscription": { + "$ref": "./examples/ValidateAppServiceCertificatePurchaseInformationBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders": { + "get": { + "tags": [ + "AppServiceCertificateOrders" + ], + "summary": "Get certificate orders in a resource group.", + "description": "Description for Get certificate orders in a resource group.", + "operationId": "AppServiceCertificateOrders_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AppServiceCertificateOrderCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List App Service Certificate orders by resource group": { + "$ref": "./examples/ListAppServiceCertificateOrdersByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}": { + "get": { + "tags": [ + "AppServiceCertificateOrders" + ], + "summary": "Get a certificate order.", + "description": "Description for Get a certificate order.", + "operationId": "AppServiceCertificateOrders_Get", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "certificateOrderName", + "in": "path", + "description": "Name of the certificate order..", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AppServiceCertificateOrder" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get App Service Certificate Order": { + "$ref": "./examples/GetAppServiceCertificateOrder.json" + } + } + }, + "put": { + "tags": [ + "AppServiceCertificateOrders" + ], + "summary": "Create or update a certificate purchase order.", + "description": "Description for Create or update a certificate purchase order.", + "operationId": "AppServiceCertificateOrders_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "certificateOrderName", + "in": "path", + "description": "Name of the certificate order.", + "required": true, + "type": "string" + }, + { + "name": "certificateDistinguishedName", + "in": "body", + "description": "Distinguished name to use for the certificate order.", + "required": true, + "schema": { + "$ref": "#/definitions/AppServiceCertificateOrder" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "App Service Certificate Order is created.", + "schema": { + "$ref": "#/definitions/AppServiceCertificateOrder" + } + }, + "201": { + "description": "App Service Certificate Order creation operation is in progress", + "schema": { + "$ref": "#/definitions/AppServiceCertificateOrder" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create Certificate order": { + "$ref": "./examples/CreateAppServiceCertificateOrder.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "AppServiceCertificateOrders" + ], + "summary": "Delete an existing certificate order.", + "description": "Description for Delete an existing certificate order.", + "operationId": "AppServiceCertificateOrders_Delete", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "certificateOrderName", + "in": "path", + "description": "Name of the certificate order.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted certificate order." + }, + "204": { + "description": "Certificate order does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete App Service Certificate Order": { + "$ref": "./examples/DeleteAppServiceCertificateOrder.json" + } + } + }, + "patch": { + "tags": [ + "AppServiceCertificateOrders" + ], + "summary": "Create or update a certificate purchase order.", + "description": "Description for Create or update a certificate purchase order.", + "operationId": "AppServiceCertificateOrders_Update", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "certificateOrderName", + "in": "path", + "description": "Name of the certificate order.", + "required": true, + "type": "string" + }, + { + "name": "certificateDistinguishedName", + "in": "body", + "description": "Distinguished name to use for the certificate order.", + "required": true, + "schema": { + "$ref": "#/definitions/AppServiceCertificateOrderPatchResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "App Service Certificate Order is created.", + "schema": { + "$ref": "#/definitions/AppServiceCertificateOrder" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Certificate order": { + "$ref": "./examples/UpdateAppServiceCertificateOrder.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates": { + "get": { + "tags": [ + "AppServiceCertificateOrders" + ], + "summary": "List all certificates associated with a certificate order.", + "description": "Description for List all certificates associated with a certificate order.", + "operationId": "AppServiceCertificateOrders_ListCertificates", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "certificateOrderName", + "in": "path", + "description": "Name of the certificate order.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AppServiceCertificateCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List certificates by App Service Certificate": { + "$ref": "./examples/ListCertificatesByAppServiceCertificateOrder.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}": { + "get": { + "tags": [ + "AppServiceCertificateOrders" + ], + "summary": "Get the certificate associated with a certificate order.", + "description": "Description for Get the certificate associated with a certificate order.", + "operationId": "AppServiceCertificateOrders_GetCertificate", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "certificateOrderName", + "in": "path", + "description": "Name of the certificate order.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the certificate.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AppServiceCertificateResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get App Service Certificate": { + "$ref": "./examples/GetAppServiceCertificate.json" + } + } + }, + "put": { + "tags": [ + "AppServiceCertificateOrders" + ], + "summary": "Creates or updates a certificate and associates with key vault secret.", + "description": "Description for Creates or updates a certificate and associates with key vault secret.", + "operationId": "AppServiceCertificateOrders_CreateOrUpdateCertificate", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "certificateOrderName", + "in": "path", + "description": "Name of the certificate order.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the certificate.", + "required": true, + "type": "string" + }, + { + "name": "keyVaultCertificate", + "in": "body", + "description": "Key vault certificate resource Id.", + "required": true, + "schema": { + "$ref": "#/definitions/AppServiceCertificateResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "App Service Certificate is created.", + "schema": { + "$ref": "#/definitions/AppServiceCertificateResource" + } + }, + "201": { + "description": "App Service Certificate creation operation is in progress", + "schema": { + "$ref": "#/definitions/AppServiceCertificateResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create Certificate": { + "$ref": "./examples/CreateAppServiceCertificate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "AppServiceCertificateOrders" + ], + "summary": "Delete the certificate associated with a certificate order.", + "description": "Description for Delete the certificate associated with a certificate order.", + "operationId": "AppServiceCertificateOrders_DeleteCertificate", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "certificateOrderName", + "in": "path", + "description": "Name of the certificate order.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the certificate.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted certificate." + }, + "204": { + "description": "Certificate does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete App Service Certificate": { + "$ref": "./examples/DeleteAppServiceCertificate.json" + } + } + }, + "patch": { + "tags": [ + "AppServiceCertificateOrders" + ], + "summary": "Creates or updates a certificate and associates with key vault secret.", + "description": "Description for Creates or updates a certificate and associates with key vault secret.", + "operationId": "AppServiceCertificateOrders_UpdateCertificate", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "certificateOrderName", + "in": "path", + "description": "Name of the certificate order.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the certificate.", + "required": true, + "type": "string" + }, + { + "name": "keyVaultCertificate", + "in": "body", + "description": "Key vault certificate resource Id.", + "required": true, + "schema": { + "$ref": "#/definitions/AppServiceCertificatePatchResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "App Service Certificate is created.", + "schema": { + "$ref": "#/definitions/AppServiceCertificateResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Certificate": { + "$ref": "./examples/UpdateAppServiceCertificate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/reissue": { + "post": { + "tags": [ + "AppServiceCertificateOrders" + ], + "summary": "Reissue an existing certificate order.", + "description": "Description for Reissue an existing certificate order.", + "operationId": "AppServiceCertificateOrders_Reissue", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "certificateOrderName", + "in": "path", + "description": "Name of the certificate order.", + "required": true, + "type": "string" + }, + { + "name": "reissueCertificateOrderRequest", + "in": "body", + "description": "Parameters for the reissue.", + "required": true, + "schema": { + "$ref": "#/definitions/ReissueCertificateOrderRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Reissue App Service Certificate Order": { + "$ref": "./examples/ReissueAppServiceCertificateOrder.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/renew": { + "post": { + "tags": [ + "AppServiceCertificateOrders" + ], + "summary": "Renew an existing certificate order.", + "description": "Description for Renew an existing certificate order.", + "operationId": "AppServiceCertificateOrders_Renew", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "certificateOrderName", + "in": "path", + "description": "Name of the certificate order.", + "required": true, + "type": "string" + }, + { + "name": "renewCertificateOrderRequest", + "in": "body", + "description": "Renew parameters", + "required": true, + "schema": { + "$ref": "#/definitions/RenewCertificateOrderRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Renew App Service Certificate Order": { + "$ref": "./examples/RenewAppServiceCertificateOrder.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/resendEmail": { + "post": { + "tags": [ + "AppServiceCertificateOrders" + ], + "summary": "Resend certificate email.", + "description": "Description for Resend certificate email.", + "operationId": "AppServiceCertificateOrders_ResendEmail", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "certificateOrderName", + "in": "path", + "description": "Name of the certificate order.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Resend App Service Certificate Order email": { + "$ref": "./examples/ResendAppServiceCertificateOrderEmail.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/resendRequestEmails": { + "post": { + "tags": [ + "AppServiceCertificateOrders" + ], + "summary": "Resend domain verification email to customer for this certificate order", + "description": "Resend domain verification ownership email containing steps on how to verify a domain for a given certificate order", + "operationId": "AppServiceCertificateOrders_ResendRequestEmails", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "certificateOrderName", + "in": "path", + "description": "Name of the certificate order.", + "required": true, + "type": "string" + }, + { + "name": "nameIdentifier", + "in": "body", + "description": "Email address", + "required": true, + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/NameIdentifier" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Resend Domain Ownership verification email": { + "$ref": "./examples/ResendDomainOwnershipVerificationEmail.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/retrieveSiteSeal": { + "post": { + "tags": [ + "AppServiceCertificateOrders" + ], + "summary": "This method is used to obtain the site seal information for an issued certificate. ", + "description": "This method is used to obtain the site seal information for an issued certificate. A site seal is a graphic that the certificate purchaser can embed on their web site to show their visitors information about their SSL certificate. If a web site visitor clicks on the site seal image, a pop-up page is displayed that contains detailed information about the SSL certificate. The site seal token is used to link the site seal graphic image to the appropriate certificate details pop-up page display when a user clicks on the site seal. The site seal images are expected to be static images and hosted by the reseller, to minimize delays for customer page load times.", + "operationId": "AppServiceCertificateOrders_RetrieveSiteSeal", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "certificateOrderName", + "in": "path", + "description": "Name of the certificate order.", + "required": true, + "type": "string" + }, + { + "name": "siteSealRequest", + "in": "body", + "description": "Site seal request.", + "required": true, + "schema": { + "$ref": "#/definitions/SiteSealRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteSeal" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieve Site Seal": { + "$ref": "./examples/RetrieveSiteSeal.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/verifyDomainOwnership": { + "post": { + "tags": [ + "AppServiceCertificateOrders" + ], + "summary": "Verify domain ownership for this certificate order.", + "description": "Description for Verify domain ownership for this certificate order.", + "operationId": "AppServiceCertificateOrders_VerifyDomainOwnership", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "certificateOrderName", + "in": "path", + "description": "Name of the certificate order.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Verify Domain Ownership": { + "$ref": "./examples/VerifyDomainOwnership.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/retrieveCertificateActions": { + "post": { + "tags": [ + "AppServiceCertificateOrders" + ], + "summary": "Retrieve the list of certificate actions.", + "description": "Description for Retrieve the list of certificate actions.", + "operationId": "AppServiceCertificateOrders_RetrieveCertificateActions", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the certificate order.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateOrderAction" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieve Certificate Order Actions": { + "$ref": "./examples/RetrieveCertificateOrderActions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/retrieveEmailHistory": { + "post": { + "tags": [ + "AppServiceCertificateOrders" + ], + "summary": "Retrieve email history.", + "description": "Description for Retrieve email history.", + "operationId": "AppServiceCertificateOrders_RetrieveCertificateEmailHistory", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the certificate order.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateEmail" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieve Certificate Email History": { + "$ref": "./examples/RetrieveCertificateEmailHistory.json" + } + } + } + } + }, + "definitions": { + "AppServiceCertificate": { + "description": "Key Vault container for a certificate that is purchased through Azure.", + "type": "object", + "properties": { + "keyVaultId": { + "description": "Key Vault resource Id.", + "type": "string" + }, + "keyVaultSecretName": { + "description": "Key Vault secret name.", + "type": "string" + }, + "provisioningState": { + "description": "Status of the Key Vault secret.", + "enum": [ + "Initialized", + "WaitingOnCertificateOrder", + "Succeeded", + "CertificateOrderFailed", + "OperationNotPermittedOnKeyVault", + "AzureServiceUnauthorizedToAccessKeyVault", + "KeyVaultDoesNotExist", + "KeyVaultSecretDoesNotExist", + "UnknownError", + "ExternalPrivateKey", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "KeyVaultSecretStatus", + "modelAsString": false + } + } + } + }, + "AppServiceCertificateCollection": { + "description": "Collection of certificate order certificates.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/AppServiceCertificateResource" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "AppServiceCertificateOrder": { + "description": "SSL certificate purchase order.", + "type": "object", + "allOf": [ + { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "AppServiceCertificateOrder resource specific properties", + "required": [ + "productType" + ], + "type": "object", + "properties": { + "certificates": { + "description": "State of the Key Vault secret.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AppServiceCertificate" + } + }, + "distinguishedName": { + "description": "Certificate distinguished name.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "domainVerificationToken": { + "description": "Domain verification token.", + "type": "string", + "readOnly": true + }, + "validityInYears": { + "format": "int32", + "description": "Duration in years (must be 1).", + "default": 1, + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "keySize": { + "format": "int32", + "description": "Certificate key size.", + "default": 2048, + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "productType": { + "description": "Certificate product type.", + "enum": [ + "StandardDomainValidatedSsl", + "StandardDomainValidatedWildCardSsl" + ], + "type": "string", + "x-ms-enum": { + "name": "CertificateProductType", + "modelAsString": false + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "autoRenew": { + "description": "true if the certificate should be automatically renewed when it expires; otherwise, false.", + "default": true, + "type": "boolean" + }, + "provisioningState": { + "description": "Status of certificate order.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "InProgress", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "status": { + "description": "Current order status.", + "enum": [ + "Pendingissuance", + "Issued", + "Revoked", + "Canceled", + "Denied", + "Pendingrevocation", + "PendingRekey", + "Unused", + "Expired", + "NotSubmitted" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "CertificateOrderStatus", + "modelAsString": false + } + }, + "signedCertificate": { + "$ref": "#/definitions/CertificateDetails", + "description": "Signed certificate.", + "readOnly": true + }, + "csr": { + "description": "Last CSR that was created for this order.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "intermediate": { + "$ref": "#/definitions/CertificateDetails", + "description": "Intermediate certificate.", + "readOnly": true + }, + "root": { + "$ref": "#/definitions/CertificateDetails", + "description": "Root certificate.", + "readOnly": true + }, + "serialNumber": { + "description": "Current serial number of the certificate.", + "type": "string", + "readOnly": true + }, + "lastCertificateIssuanceTime": { + "format": "date-time", + "description": "Certificate last issuance time.", + "type": "string", + "readOnly": true + }, + "expirationTime": { + "format": "date-time", + "description": "Certificate expiration time.", + "type": "string", + "readOnly": true + }, + "isPrivateKeyExternal": { + "description": "true if private key is external; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "appServiceCertificateNotRenewableReasons": { + "description": "Reasons why App Service Certificate is not renewable at the current moment.", + "type": "array", + "items": { + "enum": [ + "RegistrationStatusNotSupportedForRenewal", + "ExpirationNotInRenewalTimeRange", + "SubscriptionNotActive" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceNotRenewableReason", + "modelAsString": true + } + }, + "readOnly": true + }, + "nextAutoRenewalTimeStamp": { + "format": "date-time", + "description": "Time stamp when the certificate would be auto renewed next", + "type": "string", + "readOnly": true + }, + "contact": { + "$ref": "#/definitions/CertificateOrderContact", + "description": "Contact info", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "AppServiceCertificateOrderCollection": { + "description": "Collection of certificate orders.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/AppServiceCertificateOrder" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "AppServiceCertificateOrderPatchResource": { + "description": "ARM resource for a certificate order that is purchased through Azure.", + "type": "object", + "allOf": [ + { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "AppServiceCertificateOrderPatchResource resource specific properties", + "required": [ + "productType" + ], + "type": "object", + "properties": { + "certificates": { + "description": "State of the Key Vault secret.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AppServiceCertificate" + } + }, + "distinguishedName": { + "description": "Certificate distinguished name.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "domainVerificationToken": { + "description": "Domain verification token.", + "type": "string", + "readOnly": true + }, + "validityInYears": { + "format": "int32", + "description": "Duration in years (must be 1).", + "default": 1, + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "keySize": { + "format": "int32", + "description": "Certificate key size.", + "default": 2048, + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "productType": { + "description": "Certificate product type.", + "enum": [ + "StandardDomainValidatedSsl", + "StandardDomainValidatedWildCardSsl" + ], + "type": "string", + "x-ms-enum": { + "name": "CertificateProductType", + "modelAsString": false + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "autoRenew": { + "description": "true if the certificate should be automatically renewed when it expires; otherwise, false.", + "default": true, + "type": "boolean" + }, + "provisioningState": { + "description": "Status of certificate order.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "InProgress", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "status": { + "description": "Current order status.", + "enum": [ + "Pendingissuance", + "Issued", + "Revoked", + "Canceled", + "Denied", + "Pendingrevocation", + "PendingRekey", + "Unused", + "Expired", + "NotSubmitted" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "CertificateOrderStatus", + "modelAsString": false + } + }, + "signedCertificate": { + "$ref": "#/definitions/CertificateDetails", + "description": "Signed certificate.", + "readOnly": true + }, + "csr": { + "description": "Last CSR that was created for this order.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "intermediate": { + "$ref": "#/definitions/CertificateDetails", + "description": "Intermediate certificate.", + "readOnly": true + }, + "root": { + "$ref": "#/definitions/CertificateDetails", + "description": "Root certificate.", + "readOnly": true + }, + "serialNumber": { + "description": "Current serial number of the certificate.", + "type": "string", + "readOnly": true + }, + "lastCertificateIssuanceTime": { + "format": "date-time", + "description": "Certificate last issuance time.", + "type": "string", + "readOnly": true + }, + "expirationTime": { + "format": "date-time", + "description": "Certificate expiration time.", + "type": "string", + "readOnly": true + }, + "isPrivateKeyExternal": { + "description": "true if private key is external; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "appServiceCertificateNotRenewableReasons": { + "description": "Reasons why App Service Certificate is not renewable at the current moment.", + "type": "array", + "items": { + "enum": [ + "RegistrationStatusNotSupportedForRenewal", + "ExpirationNotInRenewalTimeRange", + "SubscriptionNotActive" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceNotRenewableReason", + "modelAsString": true + } + }, + "readOnly": true + }, + "nextAutoRenewalTimeStamp": { + "format": "date-time", + "description": "Time stamp when the certificate would be auto renewed next", + "type": "string", + "readOnly": true + }, + "contact": { + "$ref": "#/definitions/CertificateOrderContact", + "description": "Contact info", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "AppServiceCertificatePatchResource": { + "description": "Key Vault container ARM resource for a certificate that is purchased through Azure.", + "type": "object", + "allOf": [ + { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AppServiceCertificate", + "description": "Core resource properties", + "type": "object", + "x-ms-client-flatten": true + } + } + }, + "AppServiceCertificateResource": { + "description": "Key Vault container ARM resource for a certificate that is purchased through Azure.", + "type": "object", + "allOf": [ + { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AppServiceCertificate", + "description": "Core resource properties", + "type": "object", + "x-ms-client-flatten": true + } + } + }, + "CertificateDetails": { + "description": "SSL certificate details.", + "type": "object", + "properties": { + "version": { + "format": "int32", + "description": "Certificate Version.", + "type": "integer", + "readOnly": true + }, + "serialNumber": { + "description": "Certificate Serial Number.", + "type": "string", + "readOnly": true + }, + "thumbprint": { + "description": "Certificate Thumbprint.", + "type": "string", + "readOnly": true + }, + "subject": { + "description": "Certificate Subject.", + "type": "string", + "readOnly": true + }, + "notBefore": { + "format": "date-time", + "description": "Date Certificate is valid from.", + "type": "string", + "readOnly": true + }, + "notAfter": { + "format": "date-time", + "description": "Date Certificate is valid to.", + "type": "string", + "readOnly": true + }, + "signatureAlgorithm": { + "description": "Certificate Signature algorithm.", + "type": "string", + "readOnly": true + }, + "issuer": { + "description": "Certificate Issuer.", + "type": "string", + "readOnly": true + }, + "rawData": { + "description": "Raw certificate data.", + "type": "string", + "readOnly": true + } + } + }, + "CertificateEmail": { + "description": "SSL certificate email.", + "type": "object", + "properties": { + "emailId": { + "description": "Email id.", + "type": "string" + }, + "timeStamp": { + "format": "date-time", + "description": "Time stamp.", + "type": "string" + } + } + }, + "CertificateOrderAction": { + "description": "Certificate order action.", + "type": "object", + "properties": { + "actionType": { + "description": "Action type.", + "enum": [ + "CertificateIssued", + "CertificateOrderCanceled", + "CertificateOrderCreated", + "CertificateRevoked", + "DomainValidationComplete", + "FraudDetected", + "OrgNameChange", + "OrgValidationComplete", + "SanDrop", + "FraudCleared", + "CertificateExpired", + "CertificateExpirationWarning", + "FraudDocumentationRequired", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "CertificateOrderActionType", + "modelAsString": false + } + }, + "createdAt": { + "format": "date-time", + "description": "Time at which the certificate action was performed.", + "type": "string", + "readOnly": true + } + } + }, + "CertificateOrderContact": { + "type": "object", + "properties": { + "email": { + "type": "string" + }, + "nameFirst": { + "type": "string" + }, + "nameLast": { + "type": "string" + }, + "phone": { + "type": "string" + } + } + }, + "ReissueCertificateOrderRequest": { + "description": "Class representing certificate reissue request.", + "type": "object", + "allOf": [ + { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "ReissueCertificateOrderRequest resource specific properties", + "type": "object", + "properties": { + "keySize": { + "format": "int32", + "description": "Certificate Key Size.", + "type": "integer" + }, + "delayExistingRevokeInHours": { + "format": "int32", + "description": "Delay in hours to revoke existing certificate after the new certificate is issued.", + "type": "integer" + }, + "csr": { + "description": "Csr to be used for re-key operation.", + "type": "string" + }, + "isPrivateKeyExternal": { + "description": "Should we change the ASC type (from managed private key to external private key and vice versa).", + "type": "boolean" + } + }, + "x-ms-client-flatten": true + } + } + }, + "RenewCertificateOrderRequest": { + "description": "Class representing certificate renew request.", + "type": "object", + "allOf": [ + { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "RenewCertificateOrderRequest resource specific properties", + "type": "object", + "properties": { + "keySize": { + "format": "int32", + "description": "Certificate Key Size.", + "type": "integer" + }, + "csr": { + "description": "Csr to be used for re-key operation.", + "type": "string" + }, + "isPrivateKeyExternal": { + "description": "Should we change the ASC type (from managed private key to external private key and vice versa).", + "type": "boolean" + } + }, + "x-ms-client-flatten": true + } + } + }, + "SiteSeal": { + "description": "Site seal", + "required": [ + "html" + ], + "type": "object", + "properties": { + "html": { + "description": "HTML snippet", + "type": "string", + "x-ms-client-flatten": true + } + } + }, + "SiteSealRequest": { + "description": "Site seal request.", + "type": "object", + "properties": { + "lightTheme": { + "description": "If true use the light color theme for site seal; otherwise, use the default color theme.", + "type": "boolean" + }, + "locale": { + "description": "Locale of site seal.", + "type": "string" + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "required": true, + "type": "string" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group to which the resource belongs.", + "required": true, + "type": "string", + "maxLength": 90, + "minLength": 1, + "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$", + "x-ms-parameter-location": "method" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API Version", + "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/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/CertificateOrdersDiagnostics.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/CertificateOrdersDiagnostics.json new file mode 100644 index 000000000000..747eda860c55 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/CertificateOrdersDiagnostics.json @@ -0,0 +1,190 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "CertificateOrdersDiagnostics API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/detectors": { + "get": { + "tags": [ + "CertificateOrdersDiagnostics" + ], + "summary": "Microsoft.CertificateRegistration to get the list of detectors for this RP.", + "description": "Description for Microsoft.CertificateRegistration to get the list of detectors for this RP.", + "operationId": "CertificateOrdersDiagnostics_ListAppServiceCertificateOrderDetectorResponse", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "certificateOrderName", + "in": "path", + "description": "The certificate order name for which the response is needed.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DetectorResponseCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List app service certificate detector response": { + "$ref": "./examples/Diagnostics_ListAppServiceCertificateOrderDetectorResponse.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/detectors/{detectorName}": { + "get": { + "tags": [ + "CertificateOrdersDiagnostics" + ], + "summary": "Microsoft.CertificateRegistration call to get a detector response from App Lens.", + "description": "Description for Microsoft.CertificateRegistration call to get a detector response from App Lens.", + "operationId": "CertificateOrdersDiagnostics_GetAppServiceCertificateOrderDetectorResponse", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "certificateOrderName", + "in": "path", + "description": "The certificate order name for which the response is needed.", + "required": true, + "type": "string" + }, + { + "name": "detectorName", + "in": "path", + "description": "The detector name which needs to be run.", + "required": true, + "type": "string" + }, + { + "name": "startTime", + "in": "query", + "description": "The start time for detector response.", + "type": "string", + "format": "date-time" + }, + { + "name": "endTime", + "in": "query", + "description": "The end time for the detector response.", + "type": "string", + "format": "date-time" + }, + { + "name": "timeGrain", + "in": "query", + "description": "The time grain for the detector response.", + "type": "string", + "pattern": "PT[1-9][0-9]+[SMH]" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DetectorResponse" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get app service certificate order detector response": { + "$ref": "./examples/Diagnostics_GetAppServiceCertificateOrderDetectorResponse.json" + } + } + } + } + }, + "definitions": {}, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "required": true, + "type": "string" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group to which the resource belongs.", + "required": true, + "type": "string", + "maxLength": 90, + "minLength": 1, + "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$", + "x-ms-parameter-location": "method" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API Version", + "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/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/CertificateRegistrationProvider.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/CertificateRegistrationProvider.json new file mode 100644 index 000000000000..4b1d84e41ff0 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/CertificateRegistrationProvider.json @@ -0,0 +1,91 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "CertificateRegistrationProvider API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.CertificateRegistration/operations": { + "get": { + "tags": [ + "CertificateRegistrationProvider" + ], + "summary": "Implements Csm operations Api to exposes the list of available Csm Apis under the resource provider", + "description": "Description for Implements Csm operations Api to exposes the list of available Csm Apis under the resource provider", + "operationId": "CertificateRegistrationProvider_ListOperations", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/CsmOperationCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List operations": { + "$ref": "./examples/ListOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": {}, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API Version", + "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/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/CreateAppServiceCertificate.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/CreateAppServiceCertificate.json new file mode 100644 index 000000000000..474d5a9ea757 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/CreateAppServiceCertificate.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "certificateOrderName": "SampleCertificateOrderName", + "name": "SampleCertName1", + "api-version": "2024-04-01", + "keyVaultCertificate": { + "location": "Global", + "properties": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName1" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName/certificates/SampleCertName1", + "name": "SampleCertName1", + "type": "Microsoft.CertificateRegistration/certificateOrders/certificates", + "location": "Global", + "properties": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName1", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName/certificates/SampleCertName1", + "name": "SampleCertName1", + "type": "Microsoft.CertificateRegistration/certificateOrders/certificates", + "location": "Global", + "properties": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName1", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/CreateAppServiceCertificateOrder.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/CreateAppServiceCertificateOrder.json new file mode 100644 index 000000000000..e17b33b5bee4 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/CreateAppServiceCertificateOrder.json @@ -0,0 +1,182 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "certificateOrderName": "SampleCertificateOrderName", + "api-version": "2024-04-01", + "certificateDistinguishedName": { + "location": "Global", + "properties": { + "certificates": { + "SampleCertName1": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName1" + }, + "SampleCertName2": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName2" + } + }, + "distinguishedName": "CN=SampleCustomDomain.com", + "validityInYears": 2, + "keySize": 2048, + "productType": "StandardDomainValidatedSsl", + "autoRenew": true + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName", + "name": "SampleCertificateOrderName", + "type": "Microsoft.CertificateRegistration/certificateOrders", + "location": "Global", + "properties": { + "certificates": { + "SampleCertName1": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName1", + "provisioningState": "Succeeded" + }, + "SampleCertName2": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName2", + "provisioningState": "KeyVaultSecretDoesNotExist" + } + }, + "distinguishedName": "CN=SampleCustomDomain.com", + "domainVerificationToken": "awe4163Br6d32r", + "validityInYears": 2, + "keySize": 2048, + "productType": "StandardDomainValidatedSsl", + "autoRenew": true, + "provisioningState": "Succeeded", + "status": "Issued", + "signedCertificate": { + "version": 1232490, + "serialNumber": "sds12424k", + "thumbprint": "FE703D7411A44163B6D32B3AD9B03E175886EBFE", + "subject": "CN=CertSubjectName", + "issuer": "CACert", + "signatureAlgorithm": "SHA", + "notAfter": "2022-11-12T23:40:25+00:00", + "notBefore": "2021-11-12T23:40:25+00:00" + }, + "csr": "xdf!x|", + "intermediate": { + "version": 5589220, + "serialNumber": "k45kad0024", + "thumbprint": "RF3D7411A44163B6D32B3343559B03E175886EBFE", + "subject": "CN=IntermediateCertSubjectName", + "issuer": "CACert", + "signatureAlgorithm": "SHA", + "notAfter": "2023-11-12T23:40:25+00:00", + "notBefore": "2021-05-12T23:40:25+00:00" + }, + "root": { + "version": 3430921, + "serialNumber": "jkskd890ajdd00124", + "thumbprint": "ZD3D7411A44163B6D32B3343559B03E175886EBFE", + "subject": "CN=RootCertSubjectName", + "issuer": "CACert", + "signatureAlgorithm": "SHA", + "notAfter": "2023-11-12T23:40:25+00:00", + "notBefore": "2021-05-12T23:40:25+00:00" + }, + "serialNumber": "12324325325", + "lastCertificateIssuanceTime": "2021-11-12T23:40:25+00:00", + "expirationTime": "2022-11-12T23:40:25+00:00", + "isPrivateKeyExternal": false, + "appServiceCertificateNotRenewableReasons": [ + "ExpirationNotInRenewalTimeRange" + ], + "nextAutoRenewalTimeStamp": "2022-11-12T23:40:25+00:00", + "contact": { + "email": "contact@email.com", + "nameFirst": "SampleFirstName", + "nameLast": "SampleLastName", + "phone": "1-224-550-332" + } + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName", + "name": "SampleCertificateOrderName", + "type": "Microsoft.CertificateRegistration/certificateOrders", + "location": "Global", + "properties": { + "certificates": { + "SampleCertName1": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName1", + "provisioningState": "Succeeded" + }, + "SampleCertName2": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName2", + "provisioningState": "KeyVaultSecretDoesNotExist" + } + }, + "distinguishedName": "CN=SampleCustomDomain.com", + "domainVerificationToken": "awe4163Br6d32r", + "validityInYears": 2, + "keySize": 2048, + "productType": "StandardDomainValidatedSsl", + "autoRenew": true, + "provisioningState": "InProgress", + "status": "Issued", + "signedCertificate": { + "version": 1232490, + "serialNumber": "sds12424k", + "thumbprint": "FE703D7411A44163B6D32B3AD9B03E175886EBFE", + "subject": "CN=CertSubjectName", + "issuer": "CACert", + "signatureAlgorithm": "SHA", + "notAfter": "2022-11-12T23:40:25+00:00", + "notBefore": "2021-11-12T23:40:25+00:00" + }, + "csr": "xdf!x|", + "intermediate": { + "version": 5589220, + "serialNumber": "k45kad0024", + "thumbprint": "RF3D7411A44163B6D32B3343559B03E175886EBFE", + "subject": "CN=IntermediateCertSubjectName", + "issuer": "CACert", + "signatureAlgorithm": "SHA", + "notAfter": "2023-11-12T23:40:25+00:00", + "notBefore": "2021-05-12T23:40:25+00:00" + }, + "root": { + "version": 3430921, + "serialNumber": "jkskd890ajdd00124", + "thumbprint": "ZD3D7411A44163B6D32B3343559B03E175886EBFE", + "subject": "CN=RootCertSubjectName", + "issuer": "CACert", + "signatureAlgorithm": "SHA", + "notAfter": "2023-11-12T23:40:25+00:00", + "notBefore": "2021-05-12T23:40:25+00:00" + }, + "serialNumber": "12324325325", + "lastCertificateIssuanceTime": "2021-11-12T23:40:25+00:00", + "expirationTime": "2022-11-12T23:40:25+00:00", + "isPrivateKeyExternal": false, + "appServiceCertificateNotRenewableReasons": [ + "ExpirationNotInRenewalTimeRange" + ], + "nextAutoRenewalTimeStamp": "2022-11-12T23:40:25+00:00", + "contact": { + "email": "contact@email.com", + "nameFirst": "SampleFirstName", + "nameLast": "SampleLastName", + "phone": "1-224-550-332" + } + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/DeleteAppServiceCertificate.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/DeleteAppServiceCertificate.json new file mode 100644 index 000000000000..97035f504548 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/DeleteAppServiceCertificate.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "certificateOrderName": "SampleCertificateOrderName", + "name": "SampleCertName1", + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/DeleteAppServiceCertificateOrder.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/DeleteAppServiceCertificateOrder.json new file mode 100644 index 000000000000..6dff547d2a03 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/DeleteAppServiceCertificateOrder.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "certificateOrderName": "SampleCertificateOrderName", + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/Diagnostics_GetAppServiceCertificateOrderDetectorResponse.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/Diagnostics_GetAppServiceCertificateOrderDetectorResponse.json new file mode 100644 index 000000000000..bdccbac91215 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/Diagnostics_GetAppServiceCertificateOrderDetectorResponse.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "subscriptionId": "5700fc96-77b4-4f8d-afce-c353d8c443bd", + "resourceGroupName": "Sample-WestUSResourceGroup", + "certificateOrderName": "SampleCertificateOrderName", + "detectorName": "AutoRenewStatus", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5700fc96-77b4-4f8d-afce-c353d8c443bd/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName/detectors/AutoRenewStatus", + "name": "AutoRenewStatus", + "properties": { + "metadata": { + "id": "AutoRenewStatus", + "name": "AutoRenewStatus", + "description": "Check auto renew status", + "category": null, + "supportTopicList": [], + "type": "Detector", + "score": 0.0 + }, + "dataset": [ + { + "table": { + "tableName": "", + "columns": [ + { + "columnName": "Status", + "dataType": "String", + "columnType": null + }, + { + "columnName": "Message", + "dataType": "String", + "columnType": null + }, + { + "columnName": "Data.Name", + "dataType": "String", + "columnType": null + }, + { + "columnName": "Data.Value", + "dataType": "String", + "columnType": null + }, + { + "columnName": "Expanded", + "dataType": "String", + "columnType": null + }, + { + "columnName": "Solutions", + "dataType": "String", + "columnType": null + } + ], + "rows": [ + [ + "Info", + "App Service Certificate name SampleCertificateOrderName", + "Certificate for", + "*.mysampledomain.com", + "False", + "null" + ], + [ + "Info", + "App Service Certificate name SampleCertificateOrderName", + "Certificate Status", + "Issued", + "False", + "null" + ] + ] + }, + "renderingProperties": { + "type": "Insights", + "title": null, + "description": null + } + } + ] + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/Diagnostics_ListAppServiceCertificateOrderDetectorResponse.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/Diagnostics_ListAppServiceCertificateOrderDetectorResponse.json new file mode 100644 index 000000000000..c1e9ad140d34 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/Diagnostics_ListAppServiceCertificateOrderDetectorResponse.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "5700fc96-77b4-4f8d-afce-c353d8c443bd", + "resourceGroupName": "Sample-WestUSResourceGroup", + "certificateOrderName": "SampleCertificateOrderName", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5700fc96-77b4-4f8d-afce-c353d8c443bd/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName/detectors/CertsImport", + "name": "CertsImport", + "type": "Microsoft.Web/certificateOrders/detectors", + "properties": { + "metadata": { + "id": "CertsImport", + "name": "Certificates Import/Upload", + "author": "", + "description": null, + "category": null + }, + "dataset": [], + "status": { + "message": null, + "statusId": "None" + }, + "dataProvidersMetadata": null, + "suggestedUtterances": null + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/GetAppServiceCertificate.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/GetAppServiceCertificate.json new file mode 100644 index 000000000000..f5d518a73f93 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/GetAppServiceCertificate.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "certificateOrderName": "SampleCertificateOrderName", + "name": "SampleCertName1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName/certificates/SampleCertName1", + "name": "SampleCertName1", + "type": "Microsoft.CertificateRegistration/certificateOrders/certificates", + "location": "Global", + "properties": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName1", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/GetAppServiceCertificateOrder.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/GetAppServiceCertificateOrder.json new file mode 100644 index 000000000000..5059561e86b7 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/GetAppServiceCertificateOrder.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "certificateOrderName": "SampleCertificateOrderName", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName", + "name": "SampleCertificateOrderName", + "type": "Microsoft.CertificateRegistration/certificateOrders", + "location": "Global", + "properties": { + "certificates": { + "SampleCertName1": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName1", + "provisioningState": "Succeeded" + }, + "SampleCertName2": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName2", + "provisioningState": "KeyVaultSecretDoesNotExist" + } + }, + "distinguishedName": "CN=SampleCustomDomain.com", + "domainVerificationToken": "awe4163Br6d32r", + "validityInYears": 2, + "keySize": 2048, + "productType": "StandardDomainValidatedSsl", + "autoRenew": true, + "provisioningState": "Succeeded", + "status": "Issued", + "signedCertificate": { + "version": 1232490, + "serialNumber": "sds12424k", + "thumbprint": "FE703D7411A44163B6D32B3AD9B03E175886EBFE", + "subject": "CN=CertSubjectName", + "issuer": "CACert", + "signatureAlgorithm": "SHA", + "notAfter": "2022-11-12T23:40:25+00:00", + "notBefore": "2021-11-12T23:40:25+00:00" + }, + "csr": "xdf!x|", + "intermediate": { + "version": 5589220, + "serialNumber": "k45kad0024", + "thumbprint": "RF3D7411A44163B6D32B3343559B03E175886EBFE", + "subject": "CN=IntermediateCertSubjectName", + "issuer": "CACert", + "signatureAlgorithm": "SHA", + "notAfter": "2023-11-12T23:40:25+00:00", + "notBefore": "2021-05-12T23:40:25+00:00" + }, + "root": { + "version": 3430921, + "serialNumber": "jkskd890ajdd00124", + "thumbprint": "ZD3D7411A44163B6D32B3343559B03E175886EBFE", + "subject": "CN=RootCertSubjectName", + "issuer": "CACert", + "signatureAlgorithm": "SHA", + "notAfter": "2023-11-12T23:40:25+00:00", + "notBefore": "2021-05-12T23:40:25+00:00" + }, + "serialNumber": "12324325325", + "lastCertificateIssuanceTime": "2021-11-12T23:40:25+00:00", + "expirationTime": "2022-11-12T23:40:25+00:00", + "isPrivateKeyExternal": false, + "appServiceCertificateNotRenewableReasons": [ + "ExpirationNotInRenewalTimeRange" + ], + "nextAutoRenewalTimeStamp": "2022-11-12T23:40:25+00:00", + "contact": { + "email": "contact@email.com", + "nameFirst": "SampleFirstName", + "nameLast": "SampleLastName", + "phone": "1-224-550-332" + } + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ListAppServiceCertificateOrdersByResourceGroup.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ListAppServiceCertificateOrdersByResourceGroup.json new file mode 100644 index 000000000000..6f80acd87abb --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ListAppServiceCertificateOrdersByResourceGroup.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName", + "name": "SampleCertificateOrderName", + "type": "Microsoft.CertificateRegistration/certificateOrders", + "location": "Global", + "properties": { + "certificates": { + "SampleCertName1": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName1", + "provisioningState": "Succeeded" + }, + "SampleCertName2": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName2", + "provisioningState": "KeyVaultSecretDoesNotExist" + } + }, + "distinguishedName": "CN=SampleCustomDomain.com", + "domainVerificationToken": "awe4163Br6d32r", + "validityInYears": 2, + "keySize": 2048, + "productType": "StandardDomainValidatedSsl", + "autoRenew": true, + "provisioningState": "Succeeded", + "status": "Issued", + "signedCertificate": { + "version": 123249, + "serialNumber": "sds12424k", + "thumbprint": "FE703D7411A44163B6D32B3AD9B03E175886EBFE", + "subject": "CN=CertSubjectName", + "issuer": "CACert", + "signatureAlgorithm": "SHA", + "notAfter": "2022-11-12T23:40:25+00:00", + "notBefore": "2021-11-12T23:40:25+00:00" + }, + "csr": "xdf!x|", + "intermediate": { + "version": 5589220, + "serialNumber": "k45kad0024", + "thumbprint": "RF3D7411A44163B6D32B3343559B03E175886EBFE", + "subject": "CN=IntermediateCertSubjectName", + "issuer": "CACert", + "signatureAlgorithm": "SHA", + "notAfter": "2023-11-12T23:40:25+00:00", + "notBefore": "2021-05-12T23:40:25+00:00" + }, + "root": { + "version": 3430921, + "serialNumber": "jkskd890ajdd00124", + "thumbprint": "ZD3D7411A44163B6D32B3343559B03E175886EBFE", + "subject": "CN=RootCertSubjectName", + "issuer": "CACert", + "signatureAlgorithm": "SHA", + "notAfter": "2023-11-12T23:40:25+00:00", + "notBefore": "2021-05-12T23:40:25+00:00" + }, + "serialNumber": "12324325325", + "lastCertificateIssuanceTime": "2021-11-12T23:40:25+00:00", + "expirationTime": "2022-11-12T23:40:25+00:00", + "isPrivateKeyExternal": false, + "appServiceCertificateNotRenewableReasons": [ + "ExpirationNotInRenewalTimeRange" + ], + "nextAutoRenewalTimeStamp": "2022-11-12T23:40:25+00:00", + "contact": { + "email": "contact@email.com", + "nameFirst": "SampleFirstName", + "nameLast": "SampleLastName", + "phone": "1-224-550-332" + } + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ListAppServiceCertificateOrdersBySubscription.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ListAppServiceCertificateOrdersBySubscription.json new file mode 100644 index 000000000000..0166cd0a9daf --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ListAppServiceCertificateOrdersBySubscription.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName", + "name": "SampleCertificateOrderName", + "type": "Microsoft.CertificateRegistration/certificateOrders", + "location": "Global", + "properties": { + "certificates": { + "SampleCertName1": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName1", + "provisioningState": "Succeeded" + }, + "SampleCertName2": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName2", + "provisioningState": "KeyVaultSecretDoesNotExist" + } + }, + "distinguishedName": "CN=SampleCustomDomain.com", + "domainVerificationToken": "awe4163Br6d32r", + "validityInYears": 2, + "keySize": 2048, + "productType": "StandardDomainValidatedSsl", + "autoRenew": true, + "provisioningState": "Succeeded", + "status": "Issued", + "signedCertificate": { + "version": 1232490, + "serialNumber": "sds12424k", + "thumbprint": "FE703D7411A44163B6D32B3AD9B03E175886EBFE", + "subject": "CN=CertSubjectName", + "issuer": "CACert", + "signatureAlgorithm": "SHA", + "notAfter": "2022-11-12T23:40:25+00:00", + "notBefore": "2021-11-12T23:40:25+00:00" + }, + "csr": "xdf!x|", + "intermediate": { + "version": 5589220, + "serialNumber": "k45kad0024", + "thumbprint": "RF3D7411A44163B6D32B3343559B03E175886EBFE", + "subject": "CN=IntermediateCertSubjectName", + "issuer": "CACert", + "signatureAlgorithm": "SHA", + "notAfter": "2023-11-12T23:40:25+00:00", + "notBefore": "2021-05-12T23:40:25+00:00" + }, + "root": { + "version": 3430921, + "serialNumber": "jkskd890ajdd00124", + "thumbprint": "ZD3D7411A44163B6D32B3343559B03E175886EBFE", + "subject": "CN=RootCertSubjectName", + "issuer": "CACert", + "signatureAlgorithm": "SHA", + "notAfter": "2023-11-12T23:40:25+00:00", + "notBefore": "2021-05-12T23:40:25+00:00" + }, + "serialNumber": "12324325325", + "lastCertificateIssuanceTime": "2021-11-12T23:40:25+00:00", + "expirationTime": "2022-11-12T23:40:25+00:00", + "isPrivateKeyExternal": false, + "appServiceCertificateNotRenewableReasons": [ + "ExpirationNotInRenewalTimeRange" + ], + "nextAutoRenewalTimeStamp": "2022-11-12T23:40:25+00:00", + "contact": { + "email": "contact@email.com", + "nameFirst": "SampleFirstName", + "nameLast": "SampleLastName", + "phone": "1-224-550-332" + } + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ListCertificatesByAppServiceCertificateOrder.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ListCertificatesByAppServiceCertificateOrder.json new file mode 100644 index 000000000000..3544185709b6 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ListCertificatesByAppServiceCertificateOrder.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "certificateOrderName": "SampleCertificateOrderName", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName/certificates/SampleCertName1", + "name": "SampleCertName1", + "type": "Microsoft.CertificateRegistration/certificateOrders/certificates", + "location": "Global", + "properties": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName1", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName/certificates/SampleCertName2", + "name": "SampleCertName2", + "type": "Microsoft.CertificateRegistration/certificateOrders/certificates", + "location": "Global", + "properties": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleCertName2", + "provisioningState": "KeyVaultSecretDoesNotExist" + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ListOperations.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ListOperations.json new file mode 100644 index 000000000000..af63c01abfab --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ListOperations.json @@ -0,0 +1,184 @@ +{ + "parameters": { + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "Microsoft.CertificateRegistration/certificateOrders/certificates/Write", + "display": { + "provider": "Microsoft Certificates", + "resource": "Certificate", + "operation": "Add or Update Certificate", + "description": "Add a new certificate or update an existing one" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CertificateRegistration/certificateOrders/Write", + "display": { + "provider": "Microsoft Certificates", + "resource": "AppServiceCertificate", + "operation": "Add or Update AppServiceCertificate", + "description": "Add a new certificateOrder or update an existing one" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CertificateRegistration/certificateOrders/certificates/Delete", + "display": { + "provider": "Microsoft Certificates", + "resource": "Certificate", + "operation": "Delete Certificate", + "description": "Delete an existing certificate" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CertificateRegistration/certificateOrders/Delete", + "display": { + "provider": "Microsoft Certificates", + "resource": "AppServiceCertificate", + "operation": "Delete AppServiceCertificate", + "description": "Delete an existing AppServiceCertificate" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CertificateRegistration/certificateOrders/Read", + "display": { + "provider": "Microsoft Certificates", + "resource": "AppServiceCertificate", + "operation": "Get CertificateOrders", + "description": "Get the list of CertificateOrders" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CertificateRegistration/certificateOrders/certificates/Read", + "display": { + "provider": "Microsoft Certificates", + "resource": "Certificate", + "operation": "Get Certificates", + "description": "Get the list of certificates" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CertificateRegistration/certificateOrders/reissue/Action", + "display": { + "provider": "Microsoft Certificates", + "resource": "AppServiceCertificate", + "operation": "Reissue certificateorder", + "description": "Reissue an existing certificateorder" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CertificateRegistration/certificateOrders/renew/Action", + "display": { + "provider": "Microsoft Certificates", + "resource": "AppServiceCertificate", + "operation": "Renew certificateorder", + "description": "Renew an existing certificateorder" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CertificateRegistration/certificateOrders/retrieveCertificateActions/Action", + "display": { + "provider": "Microsoft Certificates", + "resource": "AppServiceCertificate", + "operation": "Certificateorder actions", + "description": "Retrieve the list of certificate actions" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CertificateRegistration/certificateOrders/retrieveEmailHistory/Action", + "display": { + "provider": "Microsoft Certificates", + "resource": "AppServiceCertificate", + "operation": "Certificateorder email history", + "description": "Retrieve certificate email history" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CertificateRegistration/certificateOrders/resendEmail/Action", + "display": { + "provider": "Microsoft Certificates", + "resource": "AppServiceCertificate", + "operation": "Resend Certificateorder email", + "description": "Resend certificate email" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CertificateRegistration/certificateOrders/verifyDomainOwnership/Action", + "display": { + "provider": "Microsoft Certificates", + "resource": "AppServiceCertificate", + "operation": "Verify domain ownership", + "description": "Verify domain ownership" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CertificateRegistration/certificateOrders/resendRequestEmails/Action", + "display": { + "provider": "Microsoft Certificates", + "resource": "AppServiceCertificate", + "operation": "Resend request emails to another email address", + "description": "Resend request emails to another email address" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CertificateRegistration/certificateOrders/resendRequestEmails/Action", + "display": { + "provider": "Microsoft Certificates", + "resource": "AppServiceCertificate", + "operation": "Retrieve site seal for an issued App Service Certificate", + "description": "Retrieve site seal for an issued App Service Certificate" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CertificateRegistration/provisionGlobalAppServicePrincipalInUserTenant/Action", + "display": { + "provider": "Microsoft Certificates", + "resource": "AppServiceCertificate", + "operation": "Provision service principal", + "description": "Provision service principal for service app principal" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CertificateRegistration/validateCertificateRegistrationInformation/Action", + "display": { + "provider": "Microsoft Certificates", + "resource": "AppServiceCertificate", + "operation": "Certificate Purchase Info Validation", + "description": "Validate certificate purchase object without submitting it" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CertificateRegistration/register/action", + "display": { + "provider": "Microsoft Certificates", + "resource": "Microsoft Certificates resource provider", + "operation": "Register Microsoft Certificates resource provider", + "description": "Register the Microsoft Certificates resource provider for the subscription" + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ReissueAppServiceCertificateOrder.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ReissueAppServiceCertificateOrder.json new file mode 100644 index 000000000000..45f5e314b5e0 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ReissueAppServiceCertificateOrder.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "certificateOrderName": "SampleCertificateOrderName", + "api-version": "2024-04-01", + "reissueCertificateOrderRequest": { + "properties": { + "keySize": 2048, + "delayExistingRevokeInHours": 2, + "csr": "CSR1223238Value", + "isPrivateKeyExternal": false + } + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/RenewAppServiceCertificateOrder.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/RenewAppServiceCertificateOrder.json new file mode 100644 index 000000000000..166475293349 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/RenewAppServiceCertificateOrder.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "certificateOrderName": "SampleCertificateOrderName", + "api-version": "2024-04-01", + "renewCertificateOrderRequest": { + "properties": { + "keySize": 2048, + "csr": "CSR1223238Value", + "isPrivateKeyExternal": false + } + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ResendAppServiceCertificateOrderEmail.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ResendAppServiceCertificateOrderEmail.json new file mode 100644 index 000000000000..46e1b7a2f83a --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ResendAppServiceCertificateOrderEmail.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "certificateOrderName": "SampleCertificateOrderName", + "api-version": "2024-04-01" + }, + "responses": { + "204": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ResendDomainOwnershipVerificationEmail.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ResendDomainOwnershipVerificationEmail.json new file mode 100644 index 000000000000..73fb4dc68649 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ResendDomainOwnershipVerificationEmail.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "certificateOrderName": "SampleCertificateOrderName", + "api-version": "2024-04-01", + "nameIdentifier": { + "name": "Domain name" + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/RetrieveCertificateEmailHistory.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/RetrieveCertificateEmailHistory.json new file mode 100644 index 000000000000..e54ba835ab4d --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/RetrieveCertificateEmailHistory.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "SampleCertOrder", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "emailId": "customer@email.com", + "timeStamp": "2022-11-12T23:40:25+00:00" + }, + { + "emailId": "customer@email.com", + "timeStamp": "2021-11-12T23:40:25+00:00" + } + ] + } + } +} diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/RetrieveCertificateOrderActions.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/RetrieveCertificateOrderActions.json new file mode 100644 index 000000000000..bfdeaa3db3ef --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/RetrieveCertificateOrderActions.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "SampleCertOrder", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "actionType": "FraudDetected", + "createdAt": "2022-11-12T23:40:25+00:00" + }, + { + "actionType": "CertificateRevoked", + "createdAt": "2022-11-12T23:40:25+00:00" + }, + { + "actionType": "CertificateIssued", + "createdAt": "2022-11-12T23:40:25+00:00" + } + ] + } + } +} diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/RetrieveSiteSeal.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/RetrieveSiteSeal.json new file mode 100644 index 000000000000..0642090194af --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/RetrieveSiteSeal.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "certificateOrderName": "SampleCertOrder", + "api-version": "2024-04-01", + "siteSealRequest": { + "lightTheme": true, + "locale": "en-us" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "html": "SiteSeal" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/UpdateAppServiceCertificate.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/UpdateAppServiceCertificate.json new file mode 100644 index 000000000000..ea1dea12d852 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/UpdateAppServiceCertificate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "certificateOrderName": "SampleCertificateOrderName", + "name": "SampleCertName1", + "api-version": "2024-04-01", + "keyVaultCertificate": { + "properties": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName1" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName/certificates/SampleCertName1", + "name": "SampleCertName1", + "type": "Microsoft.CertificateRegistration/certificateOrders/certificates", + "location": "Global", + "properties": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName1", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/UpdateAppServiceCertificateOrder.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/UpdateAppServiceCertificateOrder.json new file mode 100644 index 000000000000..65426464e011 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/UpdateAppServiceCertificateOrder.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "certificateOrderName": "SampleCertificateOrderName", + "api-version": "2024-04-01", + "certificateDistinguishedName": { + "properties": { + "certificates": { + "SampleCertName1": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName1" + }, + "SampleCertName2": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName2" + } + }, + "distinguishedName": "CN=SampleCustomDomain.com", + "validityInYears": 2, + "keySize": 2048, + "productType": "StandardDomainValidatedSsl", + "autoRenew": true + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName", + "name": "SampleCertificateOrderName", + "type": "Microsoft.CertificateRegistration/certificateOrders", + "location": "Global", + "properties": { + "certificates": { + "SampleCertName1": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName1", + "provisioningState": "Succeeded" + }, + "SampleCertName2": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName2", + "provisioningState": "KeyVaultSecretDoesNotExist" + } + }, + "distinguishedName": "CN=SampleCustomDomain.com", + "domainVerificationToken": "awe4163Br6d32r", + "validityInYears": 2, + "keySize": 2048, + "productType": "StandardDomainValidatedSsl", + "autoRenew": true, + "provisioningState": "Succeeded", + "status": "Issued", + "signedCertificate": { + "version": 1232490, + "serialNumber": "sds12424k", + "thumbprint": "FE703D7411A44163B6D32B3AD9B03E175886EBFE", + "subject": "CN=CertSubjectName", + "issuer": "CACert", + "signatureAlgorithm": "SHA", + "notAfter": "2022-11-12T23:40:25+00:00", + "notBefore": "2021-11-12T23:40:25+00:00" + }, + "csr": "xdf!x|", + "intermediate": { + "version": 5589220, + "serialNumber": "k45kad0024", + "thumbprint": "RF3D7411A44163B6D32B3343559B03E175886EBFE", + "subject": "CN=IntermediateCertSubjectName", + "issuer": "CACert", + "signatureAlgorithm": "SHA", + "notAfter": "2023-11-12T23:40:25+00:00", + "notBefore": "2021-05-12T23:40:25+00:00" + }, + "root": { + "version": 3430921, + "serialNumber": "jkskd890ajdd00124", + "thumbprint": "ZD3D7411A44163B6D32B3343559B03E175886EBFE", + "subject": "CN=RootCertSubjectName", + "issuer": "CACert", + "signatureAlgorithm": "SHA", + "notAfter": "2023-11-12T23:40:25+00:00", + "notBefore": "2021-05-12T23:40:25+00:00" + }, + "serialNumber": "12324325325", + "lastCertificateIssuanceTime": "2021-11-12T23:40:25+00:00", + "expirationTime": "2022-11-12T23:40:25+00:00", + "isPrivateKeyExternal": false, + "appServiceCertificateNotRenewableReasons": [ + "ExpirationNotInRenewalTimeRange" + ], + "nextAutoRenewalTimeStamp": "2022-11-12T23:40:25+00:00", + "contact": { + "email": "contact@email.com", + "nameFirst": "SampleFirstName", + "nameLast": "SampleLastName", + "phone": "1-224-550-332" + } + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ValidateAppServiceCertificatePurchaseInformationBySubscription.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ValidateAppServiceCertificatePurchaseInformationBySubscription.json new file mode 100644 index 000000000000..6e29f146faef --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/ValidateAppServiceCertificatePurchaseInformationBySubscription.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2024-04-01", + "appServiceCertificateOrder": { + "location": "Global", + "properties": { + "certificates": { + "SampleCertName1": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName1" + }, + "SampleCertName2": { + "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName", + "keyVaultSecretName": "SampleSecretName2" + } + }, + "distinguishedName": "CN=SampleCustomDomain.com", + "validityInYears": 2, + "keySize": 2048, + "productType": "StandardDomainValidatedSsl", + "autoRenew": true + } + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/VerifyDomainOwnership.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/VerifyDomainOwnership.json new file mode 100644 index 000000000000..46e1b7a2f83a --- /dev/null +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2024-04-01/examples/VerifyDomainOwnership.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "certificateOrderName": "SampleCertificateOrderName", + "api-version": "2024-04-01" + }, + "responses": { + "204": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/DomainRegistrationProvider.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/DomainRegistrationProvider.json new file mode 100644 index 000000000000..36942eafe01e --- /dev/null +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/DomainRegistrationProvider.json @@ -0,0 +1,91 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "DomainRegistrationProvider API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.DomainRegistration/operations": { + "get": { + "tags": [ + "DomainRegistrationProvider" + ], + "summary": "Implements Csm operations Api to exposes the list of available Csm Apis under the resource provider", + "description": "Description for Implements Csm operations Api to exposes the list of available Csm Apis under the resource provider", + "operationId": "DomainRegistrationProvider_ListOperations", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/CsmOperationCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List operations": { + "$ref": "./examples/ListOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": {}, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API Version", + "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/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/Domains.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/Domains.json new file mode 100644 index 000000000000..2e756c2de167 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/Domains.json @@ -0,0 +1,1616 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "Domains API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/checkDomainAvailability": { + "post": { + "tags": [ + "Domains" + ], + "summary": "Check if a domain is available for registration.", + "description": "Description for Check if a domain is available for registration.", + "operationId": "Domains_CheckAvailability", + "parameters": [ + { + "name": "identifier", + "in": "body", + "description": "Name of the domain.", + "required": true, + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/NameIdentifier" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DomainAvailabilityCheckResult" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Check domain availability": { + "$ref": "./examples/CheckDomainAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/domains": { + "get": { + "tags": [ + "Domains" + ], + "summary": "Get all domains in a subscription.", + "description": "Description for Get all domains in a subscription.", + "operationId": "Domains_List", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DomainCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List domains by subscription": { + "$ref": "./examples/ListDomainsBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/generateSsoRequest": { + "post": { + "tags": [ + "Domains" + ], + "summary": "Generate a single sign-on request for the domain management portal.", + "description": "Description for Generate a single sign-on request for the domain management portal.", + "operationId": "Domains_GetControlCenterSsoRequest", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DomainControlCenterSsoRequest" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Domain Control Center Sso Request": { + "$ref": "./examples/GetDomainControlCenterSsoRequest.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations": { + "post": { + "tags": [ + "Domains" + ], + "summary": "Get domain name recommendations based on keywords.", + "description": "Description for Get domain name recommendations based on keywords.", + "operationId": "Domains_ListRecommendations", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Search parameters for domain name recommendations.", + "required": true, + "schema": { + "$ref": "#/definitions/DomainRecommendationSearchParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NameIdentifierCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List domain recommendations": { + "$ref": "./examples/ListDomainRecommendations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains": { + "get": { + "tags": [ + "Domains" + ], + "summary": "Get all domains in a resource group.", + "description": "Description for Get all domains in a resource group.", + "operationId": "Domains_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DomainCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List domains by resource group": { + "$ref": "./examples/ListDomainsByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}": { + "get": { + "tags": [ + "Domains" + ], + "summary": "Get a domain.", + "description": "Description for Get a domain.", + "operationId": "Domains_Get", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Domain" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Domain": { + "$ref": "./examples/GetDomain.json" + } + } + }, + "put": { + "tags": [ + "Domains" + ], + "summary": "Creates or updates a domain.", + "description": "Description for Creates or updates a domain.", + "operationId": "Domains_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain.", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9][a-zA-Z0-9\\.-]+" + }, + { + "name": "domain", + "in": "body", + "description": "Domain registration information.", + "required": true, + "schema": { + "$ref": "#/definitions/Domain" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Domain purchase is in progress.", + "schema": { + "$ref": "#/definitions/Domain" + } + }, + "200": { + "description": "Domain purchase was successful.", + "schema": { + "$ref": "#/definitions/Domain" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create App Service Domain": { + "$ref": "./examples/CreateAppServiceDomain.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Domains" + ], + "summary": "Delete a domain.", + "description": "Description for Delete a domain.", + "operationId": "Domains_Delete", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain.", + "required": true, + "type": "string" + }, + { + "name": "forceHardDeleteDomain", + "in": "query", + "description": "Specify true to delete the domain immediately. The default is false which deletes the domain after 24 hours.", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted domain." + }, + "204": { + "description": "Domain does not exist in Azure database probably because it has already been deleted" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete App Service Domain": { + "$ref": "./examples/DeleteAppServiceDomain.json" + } + } + }, + "patch": { + "tags": [ + "Domains" + ], + "summary": "Creates or updates a domain.", + "description": "Description for Creates or updates a domain.", + "operationId": "Domains_Update", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain.", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9][a-zA-Z0-9\\.-]+" + }, + { + "name": "domain", + "in": "body", + "description": "Domain registration information.", + "required": true, + "schema": { + "$ref": "#/definitions/DomainPatchResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Domain purchase is in progress.", + "schema": { + "$ref": "#/definitions/Domain" + } + }, + "200": { + "description": "Domain purchase was successful.", + "schema": { + "$ref": "#/definitions/Domain" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Update App Service Domain": { + "$ref": "./examples/UpdateAppServiceDomain.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers": { + "get": { + "tags": [ + "Domains" + ], + "summary": "Lists domain ownership identifiers.", + "description": "Description for Lists domain ownership identifiers.", + "operationId": "Domains_ListOwnershipIdentifiers", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of domain.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DomainOwnershipIdentifierCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Domain Ownership Identifiers": { + "$ref": "./examples/ListDomainOwnershipIdentifiers.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers/{name}": { + "get": { + "tags": [ + "Domains" + ], + "summary": "Get ownership identifier for domain", + "description": "Description for Get ownership identifier for domain", + "operationId": "Domains_GetOwnershipIdentifier", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of domain.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DomainOwnershipIdentifier" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Domain Ownership Identifier": { + "$ref": "./examples/GetDomainOwnershipIdentifier.json" + } + } + }, + "put": { + "tags": [ + "Domains" + ], + "summary": "Creates an ownership identifier for a domain or updates identifier details for an existing identifier", + "description": "Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier", + "operationId": "Domains_CreateOrUpdateOwnershipIdentifier", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of domain.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of identifier.", + "required": true, + "type": "string" + }, + { + "name": "domainOwnershipIdentifier", + "in": "body", + "description": "A JSON representation of the domain ownership properties.", + "required": true, + "schema": { + "$ref": "#/definitions/DomainOwnershipIdentifier" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DomainOwnershipIdentifier" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create App Service Domain OwnershipIdentifier": { + "$ref": "./examples/CreateAppServiceDomainOwnershipIdentifier.json" + } + } + }, + "delete": { + "tags": [ + "Domains" + ], + "summary": "Delete ownership identifier for domain", + "description": "Description for Delete ownership identifier for domain", + "operationId": "Domains_DeleteOwnershipIdentifier", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of domain.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted domain ownership identifier." + }, + "204": { + "description": "Domain ownership identifier does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete App Service Domain Ownership Identifier": { + "$ref": "./examples/DeleteAppServiceDomainOwnershipIdentifier.json" + } + } + }, + "patch": { + "tags": [ + "Domains" + ], + "summary": "Creates an ownership identifier for a domain or updates identifier details for an existing identifier", + "description": "Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier", + "operationId": "Domains_UpdateOwnershipIdentifier", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of domain.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of identifier.", + "required": true, + "type": "string" + }, + { + "name": "domainOwnershipIdentifier", + "in": "body", + "description": "A JSON representation of the domain ownership properties.", + "required": true, + "schema": { + "$ref": "#/definitions/DomainOwnershipIdentifier" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DomainOwnershipIdentifier" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Update App Service Domain OwnershipIdentifier": { + "$ref": "./examples/UpdateAppServiceDomainOwnershipIdentifier.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/renew": { + "post": { + "tags": [ + "Domains" + ], + "summary": "Renew a domain.", + "description": "Description for Renew a domain.", + "operationId": "Domains_Renew", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Domain renewal was successful." + }, + "202": { + "description": "Domain renewal in progress." + }, + "204": { + "description": "Domain does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Renew an existing domain": { + "$ref": "./examples/RenewDomain.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/transferOut": { + "put": { + "tags": [ + "Domains" + ], + "summary": "Transfer out domain to another registrar", + "operationId": "Domains_TransferOut", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of domain.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully returned transfer code to transfer domain to another registrar.", + "schema": { + "$ref": "#/definitions/Domain" + } + }, + "400": { + "description": "Domain does not exist in Azure database", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Transfer out domain": { + "$ref": "./examples/TransferOutDomain.json" + } + } + } + } + }, + "definitions": { + "Address": { + "description": "Address information for domain registration.", + "required": [ + "address1", + "city", + "country", + "postalCode", + "state" + ], + "type": "object", + "properties": { + "address1": { + "description": "First line of an Address.", + "type": "string" + }, + "address2": { + "description": "The second line of the Address. Optional.", + "type": "string" + }, + "city": { + "description": "The city for the address.", + "type": "string" + }, + "country": { + "description": "The country for the address.", + "type": "string" + }, + "postalCode": { + "description": "The postal code for the address.", + "type": "string" + }, + "state": { + "description": "The state or province for the address.", + "type": "string" + } + } + }, + "Contact": { + "description": "Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements.", + "required": [ + "email", + "nameFirst", + "nameLast", + "phone" + ], + "type": "object", + "properties": { + "addressMailing": { + "$ref": "#/definitions/Address", + "description": "Mailing address." + }, + "email": { + "description": "Email address.", + "type": "string" + }, + "fax": { + "description": "Fax number.", + "type": "string" + }, + "jobTitle": { + "description": "Job title.", + "type": "string" + }, + "nameFirst": { + "description": "First name.", + "type": "string" + }, + "nameLast": { + "description": "Last name.", + "type": "string" + }, + "nameMiddle": { + "description": "Middle name.", + "type": "string" + }, + "organization": { + "description": "Organization contact belongs to.", + "type": "string" + }, + "phone": { + "description": "Phone number.", + "type": "string" + } + } + }, + "Domain": { + "description": "Information about a domain.", + "type": "object", + "allOf": [ + { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Domain resource specific properties", + "required": [ + "contactAdmin", + "contactBilling", + "contactRegistrant", + "contactTech", + "consent" + ], + "type": "object", + "properties": { + "contactAdmin": { + "$ref": "#/definitions/Contact", + "description": "Administrative contact.", + "x-ms-mutability": [ + "create" + ] + }, + "contactBilling": { + "$ref": "#/definitions/Contact", + "description": "Billing contact.", + "x-ms-mutability": [ + "create" + ] + }, + "contactRegistrant": { + "$ref": "#/definitions/Contact", + "description": "Registrant contact.", + "x-ms-mutability": [ + "create" + ] + }, + "contactTech": { + "$ref": "#/definitions/Contact", + "description": "Technical contact.", + "x-ms-mutability": [ + "create" + ] + }, + "registrationStatus": { + "description": "Domain registration status.", + "enum": [ + "Active", + "Awaiting", + "Cancelled", + "Confiscated", + "Disabled", + "Excluded", + "Expired", + "Failed", + "Held", + "Locked", + "Parked", + "Pending", + "Reserved", + "Reverted", + "Suspended", + "Transferred", + "Unknown", + "Unlocked", + "Unparked", + "Updated", + "JsonConverterFailed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DomainStatus", + "modelAsString": false + } + }, + "provisioningState": { + "description": "Domain provisioning state.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "InProgress", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "nameServers": { + "description": "Name servers.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "privacy": { + "description": "true if domain privacy is enabled for this domain; otherwise, false.", + "type": "boolean" + }, + "createdTime": { + "format": "date-time", + "description": "Domain creation timestamp.", + "type": "string", + "readOnly": true + }, + "expirationTime": { + "format": "date-time", + "description": "Domain expiration timestamp.", + "type": "string", + "readOnly": true + }, + "lastRenewedTime": { + "format": "date-time", + "description": "Timestamp when the domain was renewed last time.", + "type": "string", + "readOnly": true + }, + "autoRenew": { + "description": "true if the domain should be automatically renewed; otherwise, false.", + "default": true, + "type": "boolean" + }, + "readyForDnsRecordManagement": { + "description": "true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to.", + "type": "boolean", + "readOnly": true + }, + "managedHostNames": { + "description": "All hostnames derived from the domain and assigned to Azure resources.", + "type": "array", + "items": { + "$ref": "#/definitions/HostName" + }, + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] + }, + "consent": { + "$ref": "#/definitions/DomainPurchaseConsent", + "description": "Legal agreement consent.", + "x-ms-mutability": [ + "create" + ] + }, + "domainNotRenewableReasons": { + "description": "Reasons why domain is not renewable.", + "type": "array", + "items": { + "enum": [ + "RegistrationStatusNotSupportedForRenewal", + "ExpirationNotInRenewalTimeRange", + "SubscriptionNotActive" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceNotRenewableReason", + "modelAsString": true + } + }, + "readOnly": true + }, + "dnsType": { + "description": "Current DNS type", + "enum": [ + "AzureDns", + "DefaultDomainRegistrarDns" + ], + "type": "string", + "x-ms-enum": { + "name": "DnsType", + "modelAsString": false + } + }, + "dnsZoneId": { + "description": "Azure DNS Zone to use", + "type": "string" + }, + "targetDnsType": { + "description": "Target DNS type (would be used for migration)", + "enum": [ + "AzureDns", + "DefaultDomainRegistrarDns" + ], + "type": "string", + "x-ms-enum": { + "name": "DnsType", + "modelAsString": false + } + }, + "authCode": { + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-client-flatten": true + } + } + }, + "DomainAvailabilityCheckResult": { + "description": "Domain availability check result.", + "type": "object", + "properties": { + "name": { + "description": "Name of the domain.", + "type": "string" + }, + "available": { + "description": "true if domain can be purchased using CreateDomain API; otherwise, false.", + "type": "boolean" + }, + "domainType": { + "description": "Valid values are Regular domain: Azure will charge the full price of domain registration, SoftDeleted: Purchasing this domain will simply restore it and this operation will not cost anything.", + "enum": [ + "Regular", + "SoftDeleted" + ], + "type": "string", + "x-ms-enum": { + "name": "DomainType", + "modelAsString": false + } + } + } + }, + "DomainCollection": { + "description": "Collection of domains.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Domain" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "DomainControlCenterSsoRequest": { + "description": "Single sign-on request information for domain management.", + "type": "object", + "properties": { + "url": { + "description": "URL where the single sign-on request is to be made.", + "type": "string", + "readOnly": true + }, + "postParameterKey": { + "description": "Post parameter key.", + "type": "string", + "readOnly": true + }, + "postParameterValue": { + "description": "Post parameter value. Client should use 'application/x-www-form-urlencoded' encoding for this value.", + "type": "string", + "readOnly": true + } + } + }, + "DomainOwnershipIdentifier": { + "description": "Domain ownership Identifier.", + "type": "object", + "allOf": [ + { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "DomainOwnershipIdentifier resource specific properties", + "type": "object", + "properties": { + "ownershipId": { + "description": "Ownership Id.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "DomainOwnershipIdentifierCollection": { + "description": "Collection of domain ownership identifiers.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/DomainOwnershipIdentifier" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "DomainPatchResource": { + "description": "ARM resource for a domain.", + "type": "object", + "allOf": [ + { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "DomainPatchResource resource specific properties", + "required": [ + "contactAdmin", + "contactBilling", + "contactRegistrant", + "contactTech", + "consent" + ], + "type": "object", + "properties": { + "contactAdmin": { + "$ref": "#/definitions/Contact", + "description": "Administrative contact.", + "x-ms-mutability": [ + "create" + ] + }, + "contactBilling": { + "$ref": "#/definitions/Contact", + "description": "Billing contact.", + "x-ms-mutability": [ + "create" + ] + }, + "contactRegistrant": { + "$ref": "#/definitions/Contact", + "description": "Registrant contact.", + "x-ms-mutability": [ + "create" + ] + }, + "contactTech": { + "$ref": "#/definitions/Contact", + "description": "Technical contact.", + "x-ms-mutability": [ + "create" + ] + }, + "registrationStatus": { + "description": "Domain registration status.", + "enum": [ + "Active", + "Awaiting", + "Cancelled", + "Confiscated", + "Disabled", + "Excluded", + "Expired", + "Failed", + "Held", + "Locked", + "Parked", + "Pending", + "Reserved", + "Reverted", + "Suspended", + "Transferred", + "Unknown", + "Unlocked", + "Unparked", + "Updated", + "JsonConverterFailed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DomainStatus", + "modelAsString": false + } + }, + "provisioningState": { + "description": "Domain provisioning state.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "InProgress", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "nameServers": { + "description": "Name servers.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "privacy": { + "description": "true if domain privacy is enabled for this domain; otherwise, false.", + "type": "boolean" + }, + "createdTime": { + "format": "date-time", + "description": "Domain creation timestamp.", + "type": "string", + "readOnly": true + }, + "expirationTime": { + "format": "date-time", + "description": "Domain expiration timestamp.", + "type": "string", + "readOnly": true + }, + "lastRenewedTime": { + "format": "date-time", + "description": "Timestamp when the domain was renewed last time.", + "type": "string", + "readOnly": true + }, + "autoRenew": { + "description": "true if the domain should be automatically renewed; otherwise, false.", + "default": true, + "type": "boolean" + }, + "readyForDnsRecordManagement": { + "description": "true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to.", + "type": "boolean", + "readOnly": true + }, + "managedHostNames": { + "description": "All hostnames derived from the domain and assigned to Azure resources.", + "type": "array", + "items": { + "$ref": "#/definitions/HostName" + }, + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] + }, + "consent": { + "$ref": "#/definitions/DomainPurchaseConsent", + "description": "Legal agreement consent.", + "x-ms-mutability": [ + "create" + ] + }, + "domainNotRenewableReasons": { + "description": "Reasons why domain is not renewable.", + "type": "array", + "items": { + "enum": [ + "RegistrationStatusNotSupportedForRenewal", + "ExpirationNotInRenewalTimeRange", + "SubscriptionNotActive" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceNotRenewableReason", + "modelAsString": true + } + }, + "readOnly": true + }, + "dnsType": { + "description": "Current DNS type", + "enum": [ + "AzureDns", + "DefaultDomainRegistrarDns" + ], + "type": "string", + "x-ms-enum": { + "name": "DnsType", + "modelAsString": false + } + }, + "dnsZoneId": { + "description": "Azure DNS Zone to use", + "type": "string" + }, + "targetDnsType": { + "description": "Target DNS type (would be used for migration)", + "enum": [ + "AzureDns", + "DefaultDomainRegistrarDns" + ], + "type": "string", + "x-ms-enum": { + "name": "DnsType", + "modelAsString": false + } + }, + "authCode": { + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-client-flatten": true + } + } + }, + "DomainPurchaseConsent": { + "description": "Domain purchase consent object, representing acceptance of applicable legal agreements.", + "type": "object", + "properties": { + "agreementKeys": { + "description": "List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "agreedBy": { + "description": "Client IP address.", + "type": "string" + }, + "agreedAt": { + "format": "date-time", + "description": "Timestamp when the agreements were accepted.", + "type": "string" + } + } + }, + "DomainRecommendationSearchParameters": { + "description": "Domain recommendation search parameters.", + "type": "object", + "properties": { + "keywords": { + "description": "Keywords to be used for generating domain recommendations.", + "type": "string" + }, + "maxDomainRecommendations": { + "format": "int32", + "description": "Maximum number of recommendations.", + "type": "integer" + } + } + }, + "HostName": { + "description": "Details of a hostname derived from a domain.", + "type": "object", + "properties": { + "name": { + "description": "Name of the hostname.", + "type": "string" + }, + "siteNames": { + "description": "List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager.", + "type": "array", + "items": { + "type": "string" + } + }, + "azureResourceName": { + "description": "Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name.", + "type": "string" + }, + "azureResourceType": { + "description": "Type of the Azure resource the hostname is assigned to.", + "enum": [ + "Website", + "TrafficManager" + ], + "type": "string", + "x-ms-enum": { + "name": "AzureResourceType", + "modelAsString": false + } + }, + "customHostNameDnsRecordType": { + "description": "Type of the DNS record.", + "enum": [ + "CName", + "A" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomHostNameDnsRecordType", + "modelAsString": false + } + }, + "hostNameType": { + "description": "Type of the hostname.", + "enum": [ + "Verified", + "Managed" + ], + "type": "string", + "x-ms-enum": { + "name": "HostNameType", + "modelAsString": false + } + } + } + }, + "NameIdentifierCollection": { + "description": "Collection of domain name identifiers.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/NameIdentifier" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "required": true, + "type": "string" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group to which the resource belongs.", + "required": true, + "type": "string", + "maxLength": 90, + "minLength": 1, + "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$", + "x-ms-parameter-location": "method" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API Version", + "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/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/TopLevelDomains.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/TopLevelDomains.json new file mode 100644 index 000000000000..66bcda095456 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/TopLevelDomains.json @@ -0,0 +1,303 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "TopLevelDomains API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains": { + "get": { + "tags": [ + "TopLevelDomains" + ], + "summary": "Get all top-level domains supported for registration.", + "description": "Description for Get all top-level domains supported for registration.", + "operationId": "TopLevelDomains_List", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopLevelDomainCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Top Level Domains": { + "$ref": "./examples/ListTopLevelDomains.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains/{name}": { + "get": { + "tags": [ + "TopLevelDomains" + ], + "summary": "Get details of a top-level domain.", + "description": "Description for Get details of a top-level domain.", + "operationId": "TopLevelDomains_Get", + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of the top-level domain.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopLevelDomain" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Top Level Domain": { + "$ref": "./examples/GetTopLevelDomain.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains/{name}/listAgreements": { + "post": { + "tags": [ + "TopLevelDomains" + ], + "summary": "Gets all legal agreements that user needs to accept before purchasing a domain.", + "description": "Description for Gets all legal agreements that user needs to accept before purchasing a domain.", + "operationId": "TopLevelDomains_ListAgreements", + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of the top-level domain.", + "required": true, + "type": "string" + }, + { + "name": "agreementOption", + "in": "body", + "description": "Domain agreement options.", + "required": true, + "schema": { + "$ref": "#/definitions/TopLevelDomainAgreementOption" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TldLegalAgreementCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Top Level Domain Agreements": { + "$ref": "./examples/ListTopLevelDomainAgreements.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "TldLegalAgreement": { + "description": "Legal agreement for a top level domain.", + "required": [ + "agreementKey", + "title", + "content" + ], + "type": "object", + "properties": { + "agreementKey": { + "description": "Unique identifier for the agreement.", + "type": "string" + }, + "title": { + "description": "Agreement title.", + "type": "string" + }, + "content": { + "description": "Agreement details.", + "type": "string" + }, + "url": { + "description": "URL where a copy of the agreement details is hosted.", + "type": "string" + } + } + }, + "TldLegalAgreementCollection": { + "description": "Collection of top-level domain legal agreements.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/TldLegalAgreement" + }, + "x-ms-identifiers": [ + "agreementKey" + ] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "TopLevelDomain": { + "description": "A top level domain object.", + "type": "object", + "allOf": [ + { + "$ref": "../../../Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "TopLevelDomain resource specific properties", + "type": "object", + "properties": { + "privacy": { + "description": "If true, then the top level domain supports domain privacy; otherwise, false.", + "type": "boolean" + } + }, + "x-ms-client-flatten": true + } + } + }, + "TopLevelDomainAgreementOption": { + "description": "Options for retrieving the list of top level domain legal agreements.", + "type": "object", + "properties": { + "includePrivacy": { + "description": "If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false.", + "type": "boolean" + }, + "forTransfer": { + "description": "If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false.", + "type": "boolean" + } + } + }, + "TopLevelDomainCollection": { + "description": "Collection of Top-level domains.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/TopLevelDomain" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API Version", + "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/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/CheckDomainAvailability.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/CheckDomainAvailability.json new file mode 100644 index 000000000000..551b8f0795c1 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/CheckDomainAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2024-04-01", + "identifier": { + "name": "abcd.com" + } + }, + "responses": { + "200": { + "body": { + "name": "abcd.com", + "available": true, + "domainType": "Regular" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/CreateAppServiceDomain.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/CreateAppServiceDomain.json new file mode 100644 index 000000000000..a7352e4c0410 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/CreateAppServiceDomain.json @@ -0,0 +1,303 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "domainName": "example.com", + "api-version": "2024-04-01", + "domain": { + "location": "global", + "tags": {}, + "properties": { + "authCode": "exampleAuthCode", + "privacy": false, + "autoRenew": true, + "dnsType": "DefaultDomainRegistrarDns", + "consent": { + "agreementKeys": [ + "agreementKey1" + ], + "agreedBy": "192.0.2.1", + "agreedAt": "2021-09-10T19:30:53Z" + }, + "contactTech": { + "email": "tech@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Tech", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactBilling": { + "email": "billing@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Billing", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactAdmin": { + "email": "admin@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Admin", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactRegistrant": { + "email": "registrant@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Registrant", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.DomainRegistration/domains/example.com", + "name": "example.com", + "type": "Microsoft.DomainRegistration/domains", + "location": "global", + "tags": {}, + "properties": { + "authCode": "exampleAuthCode", + "registrationStatus": "Active", + "provisioningState": "Succeeded", + "nameServers": [ + "ns01.ote.domaincontrol.com", + "ns02.ote.domaincontrol.com" + ], + "privacy": false, + "createdTime": "2021-09-10T19:30:53Z", + "expirationTime": "2022-09-10T19:30:53Z", + "autoRenew": true, + "readyForDnsRecordManagement": true, + "managedHostNames": [], + "domainNotRenewableReasons": [ + "ExpirationNotInRenewalTimeRange" + ], + "dnsType": "DefaultDomainRegistrarDns", + "consent": { + "agreementKeys": [ + "agreementKey1" + ], + "agreedBy": "192.0.2.1", + "agreedAt": "2021-09-10T19:30:53Z" + }, + "contactTech": { + "email": "tech@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Tech", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactBilling": { + "email": "billing@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Billing", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactAdmin": { + "email": "admin@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Admin", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactRegistrant": { + "email": "registrant@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Registrant", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + } + } + } + }, + "202": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.DomainRegistration/domains/example.com", + "name": "example.com", + "type": "Microsoft.DomainRegistration/domains", + "location": "global", + "tags": {}, + "properties": { + "authCode": "exampleAuthCode", + "registrationStatus": "Active", + "provisioningState": "Succeeded", + "nameServers": [ + "ns01.ote.domaincontrol.com", + "ns02.ote.domaincontrol.com" + ], + "privacy": false, + "createdTime": "2021-09-10T19:30:53Z", + "expirationTime": "2022-09-10T19:30:53Z", + "autoRenew": true, + "readyForDnsRecordManagement": true, + "managedHostNames": [], + "domainNotRenewableReasons": [ + "ExpirationNotInRenewalTimeRange" + ], + "dnsType": "DefaultDomainRegistrarDns", + "consent": { + "agreementKeys": [ + "agreementKey1" + ], + "agreedBy": "192.0.2.1", + "agreedAt": "2021-09-10T19:30:53Z" + }, + "contactTech": { + "email": "tech@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Tech", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactBilling": { + "email": "billing@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Billing", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactAdmin": { + "email": "admin@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Admin", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactRegistrant": { + "email": "registrant@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Registrant", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + } + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/CreateAppServiceDomainOwnershipIdentifier.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/CreateAppServiceDomainOwnershipIdentifier.json new file mode 100644 index 000000000000..74ecfe9a8d31 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/CreateAppServiceDomainOwnershipIdentifier.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "domainName": "example.com", + "name": "SampleOwnershipId", + "api-version": "2024-04-01", + "domainOwnershipIdentifier": { + "properties": { + "ownershipId": "SampleOwnershipId" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.DomainRegistration/domains/example.com/domainownershipidentifiers/SampleOwnershipId", + "name": "SampleOwnershipId", + "type": "Microsoft.DomainRegistration/domains/domainownershipidentifiers", + "properties": { + "ownershipId": "SampleOwnershipId" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/DeleteAppServiceDomain.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/DeleteAppServiceDomain.json new file mode 100644 index 000000000000..30468bfa76e8 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/DeleteAppServiceDomain.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "domainName": "example.com", + "forceHardDeleteDomain": true, + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/DeleteAppServiceDomainOwnershipIdentifier.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/DeleteAppServiceDomainOwnershipIdentifier.json new file mode 100644 index 000000000000..e7ec25bbb158 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/DeleteAppServiceDomainOwnershipIdentifier.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "domainName": "example.com", + "name": "ownershipIdentifier", + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/GetDomain.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/GetDomain.json new file mode 100644 index 000000000000..ada18b4d0692 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/GetDomain.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "domainName": "example.com", + "getOnlyIfReadyForDnsManagement": true, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.DomainRegistration/domains/example.com", + "name": "example.com", + "type": "Microsoft.DomainRegistration/domains", + "location": "global", + "tags": {}, + "properties": { + "authCode": "exampleAuthCode", + "registrationStatus": "Active", + "provisioningState": "Succeeded", + "nameServers": [ + "ns01.ote.domaincontrol.com", + "ns02.ote.domaincontrol.com" + ], + "privacy": false, + "createdTime": "2021-09-10T19:30:53Z", + "expirationTime": "2022-09-10T19:30:53Z", + "autoRenew": true, + "readyForDnsRecordManagement": true, + "managedHostNames": [], + "domainNotRenewableReasons": [ + "ExpirationNotInRenewalTimeRange" + ], + "dnsType": "DefaultDomainRegistrarDns", + "consent": { + "agreementKeys": [ + "agreementKey1" + ], + "agreedBy": "192.0.2.1", + "agreedAt": "2021-09-10T19:30:53Z" + }, + "contactTech": { + "email": "tech@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Tech", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactBilling": { + "email": "billing@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Billing", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactAdmin": { + "email": "admin@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Admin", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactRegistrant": { + "email": "registrant@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Registrant", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + } + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/GetDomainControlCenterSsoRequest.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/GetDomainControlCenterSsoRequest.json new file mode 100644 index 000000000000..172060619de9 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/GetDomainControlCenterSsoRequest.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "url": "https://Reseller.provider.com/?xRequestId=sdsdsds&app=dcc", + "postParameterKey": "saml", + "postParameterValue": "1242sds|k1340" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/GetDomainOwnershipIdentifier.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/GetDomainOwnershipIdentifier.json new file mode 100644 index 000000000000..7360705e3d23 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/GetDomainOwnershipIdentifier.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "domainName": "example.com", + "name": "SampleOwnershipId", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.DomainRegistration/domains/example.com/domainownershipidentifiers/SampleOwnershipId", + "name": "SampleOwnershipId", + "type": "Microsoft.DomainRegistration/domains/domainownershipidentifiers", + "properties": { + "ownershipId": "SampleOwnershipId" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/GetTopLevelDomain.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/GetTopLevelDomain.json new file mode 100644 index 000000000000..7e25555ffc75 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/GetTopLevelDomain.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2024-04-01", + "name": "com" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/com", + "name": "com", + "type": "Microsoft.DomainRegistration/topLevelDomains", + "properties": { + "privacy": true + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListDomainOwnershipIdentifiers.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListDomainOwnershipIdentifiers.json new file mode 100644 index 000000000000..2207cfa4f03b --- /dev/null +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListDomainOwnershipIdentifiers.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "domainName": "example.com", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.DomainRegistration/domains/example.com/domainownershipidentifiers/SampleOwnershipId", + "name": "SampleOwnershipId", + "type": "Microsoft.DomainRegistration/domains/domainownershipidentifiers", + "properties": { + "ownershipId": "SampleOwnershipId" + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListDomainRecommendations.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListDomainRecommendations.json new file mode 100644 index 000000000000..270756dcb4b7 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListDomainRecommendations.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2024-04-01", + "parameters": { + "keywords": "example1", + "maxDomainRecommendations": 10 + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "domainnamesuggestion1" + }, + { + "name": "domainnamesuggestion2" + }, + { + "name": "domainnamesuggestion3" + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListDomainsByResourceGroup.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListDomainsByResourceGroup.json new file mode 100644 index 000000000000..01ab6094fd46 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListDomainsByResourceGroup.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.DomainRegistration/domains/example.com", + "name": "example.com", + "type": "Microsoft.DomainRegistration/domains", + "location": "global", + "tags": {}, + "properties": { + "authCode": "exampleAuthCode", + "registrationStatus": "Active", + "provisioningState": "Succeeded", + "nameServers": [ + "ns01.ote.domaincontrol.com", + "ns02.ote.domaincontrol.com" + ], + "privacy": false, + "createdTime": "2021-09-10T19:30:53Z", + "expirationTime": "2022-09-10T19:30:53Z", + "autoRenew": true, + "readyForDnsRecordManagement": true, + "managedHostNames": [], + "domainNotRenewableReasons": [ + "ExpirationNotInRenewalTimeRange" + ], + "dnsType": "DefaultDomainRegistrarDns", + "consent": { + "agreementKeys": [ + "agreementKey1" + ], + "agreedBy": "192.0.2.1", + "agreedAt": "2021-09-10T19:30:53Z" + }, + "contactTech": { + "email": "tech@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Tech", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactBilling": { + "email": "billing@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Billing", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactAdmin": { + "email": "admin@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Admin", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactRegistrant": { + "email": "registrant@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Registrant", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + } + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListDomainsBySubscription.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListDomainsBySubscription.json new file mode 100644 index 000000000000..00b3b3347939 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListDomainsBySubscription.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.DomainRegistration/domains/example.com", + "name": "example.com", + "type": "Microsoft.DomainRegistration/domains", + "location": "global", + "tags": {}, + "properties": { + "authCode": "exampleAuthCode", + "registrationStatus": "Active", + "provisioningState": "Succeeded", + "nameServers": [ + "ns01.ote.domaincontrol.com", + "ns02.ote.domaincontrol.com" + ], + "privacy": false, + "createdTime": "2021-09-10T19:30:53Z", + "expirationTime": "2022-09-10T19:30:53Z", + "autoRenew": true, + "readyForDnsRecordManagement": true, + "managedHostNames": [], + "domainNotRenewableReasons": [ + "ExpirationNotInRenewalTimeRange" + ], + "dnsType": "DefaultDomainRegistrarDns", + "consent": { + "agreementKeys": [ + "agreementKey1" + ], + "agreedBy": "192.0.2.1", + "agreedAt": "2021-09-10T19:30:53Z" + }, + "contactTech": { + "email": "tech@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Tech", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactBilling": { + "email": "billing@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Billing", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactAdmin": { + "email": "admin@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Admin", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactRegistrant": { + "email": "registrant@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Registrant", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + } + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListOperations.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListOperations.json new file mode 100644 index 000000000000..d82130b3376e --- /dev/null +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListOperations.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "Microsoft.DomainRegistration/domains/Read", + "display": { + "provider": "Microsoft Domains", + "resource": "Domain", + "operation": "Get Domains", + "description": "Get the list of domains" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.DomainRegistration/domains/Write", + "display": { + "provider": "Microsoft Domains", + "resource": "Domain", + "operation": "Add or Update Domain", + "description": "Add a new Domain or update an existing one" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.DomainRegistration/domains/Delete", + "display": { + "provider": "Microsoft Domains", + "resource": "Domain", + "operation": "Delete Domain", + "description": "Delete an existing domain." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.DomainRegistration/domains/operationresults/Read", + "display": { + "provider": "Microsoft Domains", + "resource": "Domain operation", + "operation": "Get Domain Operation", + "description": "Get a domain operation" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.DomainRegistration/generateSsoRequest/Action", + "display": { + "provider": "Microsoft Domains", + "resource": "Domain Control Center Single Sign On Request", + "operation": "Generate Domain Control Center Single Sign On Request", + "description": "Generate a request for signing into domain control center." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.DomainRegistration/validateDomainRegistrationInformation/Action", + "display": { + "provider": "Microsoft Domains", + "resource": "Domain Validation", + "operation": "Domain Purchase Info Validation", + "description": "Validate domain purchase object without submitting it" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.DomainRegistration/checkDomainAvailability/Action", + "display": { + "provider": "Microsoft Domains", + "resource": "Domain Availability Result", + "operation": "Check Domain Availability", + "description": "Check if a domain is available for purchase" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.DomainRegistration/listDomainRecommendations/Action", + "display": { + "provider": "Microsoft Domains", + "resource": "Domain Recommendations", + "operation": "Retrieve Domain Recommendations", + "description": "Retrieve the list domain recommendations based on keywords" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.DomainRegistration/register/action", + "display": { + "provider": "Microsoft Domains", + "resource": "Microsoft Domains resource provider", + "operation": "Register Microsoft Domains resource provider", + "description": "Register the Microsoft Domains resource provider for the subscription" + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListTopLevelDomainAgreements.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListTopLevelDomainAgreements.json new file mode 100644 index 000000000000..a1db4ea49f00 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListTopLevelDomainAgreements.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "name": "in", + "api-version": "2024-04-01", + "agreementOption": { + "includePrivacy": true, + "forTransfer": false + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "agreementKey": "DNRA", + "title": "Domain Name Registration Agreement", + "content": "\n\n\n\n\n
\n\n\n\n\n\n\n
\nDomain Name Registration Agreement\n
\n

Last Revised: October 6, 2017

\n

PLEASE READ THIS AGREEMENT CAREFULLY, AS IT CONTAINS IMPORTANT INFORMATION REGARDING YOUR LEGAL RIGHTS AND REMEDIES.

\r\n

1. OVERVIEW

\r\n

This Domain Name Registration Agreement (this \"Agreement\") is entered into by and between 510456, an individual (\"Azure\") and you, and is made effective as of the date of electronic acceptance.  This Agreement sets forth the terms and conditions of your use of Azure's Domain Name Registration services (the \"Domain Name Registration Services\" or the \"Services\"). The terms \"we\", \"us\" or \"our\" shall refer to Azure.  The terms \"you\", \"your\", \"User\" or \"customer\" shall refer to any individual or entity who accepts this Agreement.  Unless otherwise specified, nothing in this Agreement shall be deemed to confer any third-party rights or benefits.

\r\n

Your electronic acceptance of this Agreement signifies that you have read, understand, acknowledge and agree to be bound by this Agreement, which incorporates by reference each of (i) Azure’s Universal Terms of Service Agreement (\"UTOS\"), (ii) all agreements, guidelines, policies, practices, procedures, registration requirements or operational standards of the top-level domain (\"TLD\") in which you register any domain (“Registry Policies”), and (iii) any plan limits, product disclaimers or other restrictions presented to you on the Domain Name Registration Services landing page of the Azure website (this “Site”). 

\r\n

TO LINK TO AND REVIEW THE REGISTRY POLICIES FOR THE TLD IN WHICH YOU WISH TO REGISTER A DOMAIN NAME, PLEASE CLICK HERE.    

\r\n

You acknowledge and agree that (i) Azure, in its sole and absolute discretion, may change or modify this Agreement, and any policies or agreements which are incorporated herein, at any time, and such changes or modifications shall be effective immediately upon posting to this Site, and (ii) your use of this Site or the Services found at this Site after such changes or modifications have been made shall constitute your acceptance of this Agreement as last revised.  If you do not agree to be bound by this Agreement as last revised, do not use (or continue to use) this Site or the Services found at this Site.  In addition, Azure may occasionally notify you of changes or modifications to this Agreement by email.  It is therefore very important that you keep your shopper account (“Shopper Account”) information, including your email address, current.  Azure assumes no liability or responsibility for your failure to receive an email notification if such failure results from an inaccurate or out-of-date email address.    Azure is not an Internet Corporation for Assigned Names and Numbers (\"ICANN\") accredited registrar; it is an authorized reseller of domain name registration services.  Accordingly, you acknowledge and agree that Azure may modify this Agreement in order to comply with any terms and conditions set forth by (i) the sponsoring registrar, (ii) ICANN, and/or (iii) the registry applicable to the TLD or country code top level domain (\"ccTLD\") in question.  As used herein, the terms \"registry\", \"Registry\", \"registry operator\" or \"Registry Operator\" shall refer to the registry applicable to the TLD or ccTLD in question.  To identify the sponsoring registrar, click here. 

\r\n

2. PROVISIONS SPECIFIC TO ALL REGISTRATIONS

\r\n

Unless otherwise noted, the provisions below in this Section 2 are generally applicable to all TLDs that we offer.  Special provisions specific to any TLD or ccTLD (those in addition to posted Registry Policies) are identified elsewhere below in this Agreement. 

\r\n
    \r\n
  1. \r\n
    Registry Policies. You agree to be bound by all Registry Policies (defined above in this Agreement) applicable to your domain name registration (at any level). IT IS YOUR RESPONSIBILITY TO VISIT THE APPLICABLE TLD SITE AND READ AND REVIEW ALL APPLICABLE REGISTRY POLICIES PRIOR TO YOUR REGISTRATION IN THE TLD.  REGISTRY POLICIES FOR EACH TLD CAN BE FOUND BY VISITING THE CORRESPONDING TLD LINK LISTED HERE.  Notwithstanding anything in this Agreement to the contrary, the Registry Operator of the TLD in which the domain name registration is made is and shall be an intended third party beneficiary of this Agreement. As such the parties to this agreement acknowledge and agree that the third party beneficiary rights of the Registry Operator have vested and that the Registry Operator has relied on its third party beneficiary rights under this Agreement in agreeing to Azure being a registrar for the respective TLD. The third party beneficiary rights of the Registry Operator will survive any termination of this Agreement.    
    \r\n
    2. \r\n
  2. \r\n
    Registration Requirements.  To the extent any TLD or ccTLD requires you meet eligibility (e.g., residency for .JP, .EU, etc.), validation (e.g., DNS validation) or other authentication requirements as a condition to registering a domain name in the TLD, you agree that by submitting an application or registering or renewing your domain name, you represent and warrant that: (a) all information provided to register or renew the domain name (including all supporting documents, if any) is true, complete and correct, and is not misleading in any way, and the application is made in good faith; (b) you meet, and will continue to meet, the eligibility criteria prescribed in the Registry Policies for the applicable TLD for the duration of the domain name registration; (c) you have not previously submitted an application for the domain name with another registrar using the same eligibility criteria, and the other registrar has rejected the application (if applicable); (d) you acknowledge and agree that even if the domain name is accepted for registration, your entitlement to register the domain name may be challenged by others who claim to have an entitlement to the domain name; and (e) you acknowledge and agree that the Registry or the registrar can cancel the registration of the domain name if any of the warranties required are found to be untrue, incomplete, incorrect or misleading.
    \r\n
    3. \r\n
  3. \r\n
    Ownership.  You acknowledge and agree that registration of a domain name does not create any proprietary right for you, the registrar, or any other person in the name used as a domain name or the domain name registration and that the entry of a domain name in the Registry shall not be construed as evidence or ownership of the domain name registered as a domain name. You shall not in any way transfer or purport to transfer a proprietary right in any domain name registration or grant or purport to grant as security or in any other manner encumber or purport to encumber a domain name registration.
    \r\n
    4. \r\n
  4. \r\n
    ICANN Requirements. You agree to comply with the ICANN requirements, standards, policies, procedures, and practices for which each applicable Registry Operator has monitoring responsibility in accordance with the Registry Agreement between ICANN and itself or any other arrangement with ICANN.
    \r\n
    5. \r\n
  5. \r\n
    Indemnification of Registry.  You agree to indemnify, defend and hold harmless (within 30 days of demand) the Registry Operator and Registry Service Provider and their subcontractors, subsidiaries, affiliates, divisions, shareholders, directors, officers, employees, accountants, attorneys, insurers, agents, predecessors, successors and assigns, from and against any and all claims, demands, damages, losses, costs, expenses, causes of action or other liabilities of any kind, whether known or unknown, including reasonable legal and attorney’s fees and expenses, in any way arising out of, relating to, or otherwise in connection with the your domain name registration, including, without limitation, the use, registration, extension, renewal, deletion, and/or transfer thereof and/or the violation of any applicable terms or conditions governing the registration. You shall not enter into any settlement or compromise of any such indemnifiable claim without Registrar’s or Registry Operator’s prior written consent, which consent shall not be unreasonably withheld, and you agree that these indemnification obligations shall survive the termination or expiration of the Agreement for any reason.  IN NO EVENT SHALL THE REGISTRY OPERATOR BE LIABLE TO YOU OR ANY OTHER PERSON FOR ANY DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL, SPECIAL, EXEMPLARY OR PUNITIVE DAMAGES, INCLUDING LOSS OF PROFIT OR GOODWILL, FOR ANY MATTER, WHETHER SUCH LIABILITY IS ASSERTED ON THE BASIS OF CONTRACT, TORT (INCLUDING NEGLIGENCE), BREACH OF WARRANTIES, EITHER EXPRESS OR IMPLIED, ANY BREACH OF THIS AGREEMENT OR ITS INCORPORATED AGREEMENTS AND POLICIES YOUR INABILITY TO USE THE DOMAIN NAME, YOUR LOSS OF DATA OR FILES OR OTHERWISE, EVEN IF THE REGISTRY OPERATOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
    \r\n
    6. \r\n
  6. \r\n
    Regulated TLDs.   For domain name registration in any “Regulated” TLD, you acknowledge and agree your registration is subject to the following additional requirements: (a) comply with all applicable laws, including those that relate to privacy, data collection, consumer protection (including in relation to misleading and deceptive conduct), fair lending, debt collection, organic farming, disclosure of data, and financial disclosures; (b) if you collect and maintain sensitive health and financial data you must implement reasonable and appropriate security measures commensurate with the offering of those services, as defined by applicable law.  Regulated TLDs include: .games, .juegos, .school, .schule, .toys, .eco, .care, .diet, .fitness, .health, .clinic, .dental, .healthcare, .cash, .broker, .claims, .exchange, .finance, .financial, .fund, .investments, .lease, .loans, .market, .money, .trading, .credit, .insure, .tax, .mortgage, .degree, .mba, .audio, .book, .broadway, .film, .movie, .music, .software, .fashion, .video, .app, .art, .band, .cloud, .data, .digital, .fan, .free, .gratis, .discount, .sale, .media, .news, .online, .pictures, .radio, .show, .theater, .tours, .accountants, .architect, .associates, .broker, .legal, .realty, .vet, .engineering, .law, .limited, .show; .theater; .town, .city, .reise, and .reisen
    \r\n
    7. \r\n
  7. \r\n
    Highly Regulated TLDs. In addition to the requirements for Regulated TLDs, domain name registration in any Highly-Regulated TLD is subject to the following requirements: (a) you will provide administrative contact information, which must be kept up‐to‐date, for the notification of complaints or reports of registration abuse, as well as the contact details of the relevant regulatory, or Industry self‐regulatory, bodies in their main place of business; (b) you represent that you possess any necessary authorizations, charters, licenses and/or other related credentials for participation in the sector associated with such Highly‐regulated TLD; and (c) you will report any material changes to the validity of you authorizations, charters, licenses and/or other related credentials for participation in the sector associated with the Highly‐regulated TLD to ensure you continue to conform to the appropriate regulations and licensing requirements and generally conduct your activities in the interests of the consumers they serve.  Highly Regulated TLDs include: .abogado, .attorney, .bank, .bet, .bingo, .casino .charity (and IDN equivalent xn--30rr7y), .cpa, .corp, creditcard, .creditunion .dds, .dentist, .doctor, .fail, .gmbh, .gripe, .hospital, .inc, .insurance, .lawyer, .lifeinsurance, .llc, .llp, .ltda, .medical, .mutuelle, .pharmacy, .poker, .university, .sarl, .spreadbetting, .srl, .surgery .university, .vermogensberater, and .vesicherung,  For .doctor, registrants who hold themselves out to be licensed medical practitioners must be able to demonstrate to the Registrar and Registry, upon request, that they hold the applicable license.
    \r\n
    8. \r\n
  8. \r\n
    Special Safeguard TLDs.  In addition to the requirements for Regulated and Highly-Regulated TLDs, by registering a domain name in any “Special-Safeguard” TLD, you agree to take reasonable steps to avoid misrepresenting or falsely implying that you or your business is affiliated with, sponsored or endorsed by one or more country's or government's military forces if such affiliation, sponsorship or endorsement does not exist.  Special Safeguard TLDs include:  .army, .navy, .airforce
    \r\n
    9. \r\n
  9. \r\n
    Third Party Beneficiary.  Notwithstanding anything in this Agreement to the contrary, the Registry Operator for any TLD in which your register a domain name is and shall be an intended third party beneficiary of this Agreement. As such the parties to this agreement acknowledge and agree that the third party beneficiary rights of the Registry Operator have vested and that the Registry Operator has relied on its third party beneficiary rights under this Agreement in agreeing to Azure being a registrar for the TLD. Third party beneficiary rights of the Registry Operator shall survive any termination of this Agreement.
    \r\n
    10. \r\n
  10. \r\n
    Variable and Non-Uniform Pricing.  You acknowledge, understand and agree that certain domain names in certain TLDs are established by Registry Policies to be variably priced (i.e., standard v. premium names) and/or may have non-uniform renewal registration pricing (such that the Fee for a domain name registration renewal may differ from other domain names in the same TLD, e.g., renewal registration for one domain may be $100.00 and $33.00 for a different domain name).
    \r\n
    11. \r\n
  11. \r\n
    Restriction on Availability of Privacy or Proxy.  You acknowledge and agree that, as dictated by the Registry Policies, for certain TLDs you may not be permitted to purchase private or proxy TLD registrations. In such case, you must register for any and all TLD registrations using your personal information, which information you represent and warrant is current, accurate and complete.
    \r\n
    12. \r\n
\r\n

3. FEES AND PAYMENTS

\r\n

(A) GENERAL TERMS, INCLUDING AUTOMATIC RENEWAL TERMS

\r\n

You agree to pay any and all prices and fees due for Services purchased or obtained at this Site at the time you order the Services.  Azure expressly reserves the right to change or modify its prices and fees at any time, and such changes or modifications shall be posted online at this Site and effective immediately without need for further notice to you.  If you have purchased or obtained Services for a period of months or years, changes or modifications in prices and fees shall be effective when the Services in question come up for renewal as further described below. 

\r\n

Unless otherwise specifically noted (for reasons such as those highlighted in Section 2(x) above), the renewal price for any domain name in any TLD will be the same as the list (non-sale) price shown when you search for and select a domain, and again in the cart prior to purchase.  For example, if the list price is $9.99, and a different renewal price is not specifically identified, then the renewal price is also $9.99.  Likewise, if a domain name has a sale price of $8.99, with the list (non-sale) price shown (as a strike-through) at $9.99, the renewal price will be $9.99*.  

\r\n

*Renewal price subject to change prior to actual date of renewal. 

\r\n

For all other terms and conditions relating to fees, payment, refund and billing, etc. applicable to the Services offered under the scope of this Agreement, please refer to the “Fees and Payments” section of our UTOS. 

\r\n

(B) DOMAIN NAME RENEWAL TERMS

\r\n

When you register a domain name, you will have two renewal options: (i) \"Automatic Renewal\" (ii) \"Extended Automatic Renewal\", and (iii) \"Manual Renewal\": 

\r\n
    \r\n
  1. Automatic Renewal.  Automatic Renewal is the default setting. Therefore, unless you select Extended Automatic Renewal, Azure will enroll you in Automatic Renewal.  Domain names will automatically renew, for a period equivalent to the length of your original domain name registration, any domain name that is up for renewal and will take payment from the Payment Method you have on file with Azure, at Azure's then current rates. Thus, if you have chosen to register your domain name for one (1) year, Azure will automatically renew it for one (1) year. If you have chosen to register your domain name for two (2) years, Azure will automatically renew it for two (2) years, and so on.
    2. \r\n
  2. Extended Automatic Renewal.  If you enroll in the Extended Automatic Renewal plan, Azure will automatically renew any domain name that is up for renewal for an additional one-year period on each and every anniversary of your domain name registration, so the initial registration period will always remain intact.  Thus, if you have chosen to register your domain name for two (2) years, Azure will automatically renew it for one (1) additional year on each and every anniversary of your domain name registration so your two (2) year registration period will always remain intact. If you have chosen to register your domain name for five (5) years, Azure will automatically renew it for one (1) additional year on each and every anniversary of your domain name registration so your five (5) year registration period will always remain intact, and so on.  Azure will take payment from the Payment Method you have on file with Azure, at Azure's then current one-year domain name registration rate.
    3. \r\n
  3. Manual Renewal.  If you have elected to turn off automatic renewal and cancel the product (i.e., cancel the domain name registration) effective at expiration of the then current term, you may nonetheless elect to manually renew the domain name at anytime prior to its expiration date by logging into your Account Manager and manually implementing the renewal or by calling customer service (should you in fact want the domain name to be renewed). If you fail to manually implement the renewal before the expiration date, the domain name will be cancelled and you will no longer have use of that name.
    4. \r\n
\r\n

All renewals will be subject to the terms of this Agreement, as it may be amended from time to time, and you acknowledge and agree to be bound by the terms of this Agreement (as amended) for all renewed domains.  Domain name renewals will be non-refundable. In the event that we are unable to automatically renew your domain name for the renewal option selected for any reason, we may automatically renew your domain name for a period less than your original registration period to the extent necessary for the transaction to succeed. If for any reason Azure is not able to take the payment from the Payment Method you have on file, and you fail to respond to our notices, your domain name registration will expire. It is your responsibility to keep your Payment Method information current, which includes the expiration date if you are using a credit card.

\r\n

For certain ccTLDs (.am, .at, .be, .br, .ca, .cn, .com.cn, .net.cn, .org.cn, .de, .eu, .fm, .gs, .it, .jp, .ms, .nu, .nz, .co.nz, .net.nz, .org.nz, .tc, .tk, .tw, .com.tw, .org.tw, .idv.tw, .uk, and .vg), renewal billing will occur on the first day of the month prior to the month of expiration.

\r\n

For certain ccTLDs (.am, .at, .be, .ca, .cn, .com.cn, .net.cn, .org.cn, .de, .eu, .fm, .gs, .it, .jp, .ms, .nu, .nz, .co.nz, .net.nz, .org.nz, .tc, .tk, .tw, .com.tw, .org.tw, .idv.tw, .uk, and .vg), renewal will occur, or must occur manually if the product was previously cancelled, no later than the 20th of the month prior to the expiration date, or your domain name will be placed in non-renewal status. For some ccTLDs (.es) renewal must be processed no later than seven days before the expiration date, or your domain name will be placed in non-renewal status.  When the domain name is in non-renewal status, you can renew the domain name only by calling Azure and requesting that the domain name be renewed. You cannot renew the domain name through your Account Manager. If you fail to manually implement the renewal of any cancelled product before the expiration date, the domain name will be cancelled and you will no longer have use of that name.

\r\n

You agree that Azure will not be responsible for cancelled domain names that you fail to renew in the timeframes indicated in this Agreement. In any case, if you fail to renew your domain name in a timely fashion, additional charges may apply. If you signed up for privacy services, protected registration, or any other similar service, with your domain name registration, these services will automatically be renewed when your domain name registration is up for renewal, and you will incur the applicable additional renewal fee unless you cancel in advance. 

\r\n

If you fail to renew your domain name in the timeframes indicated in this Agreement, you agree that Azure may, in its sole discretion, renew your expired domain name on your behalf. If Azure decides to renew your expired domain name on your behalf, you will have a Renewal Grace Period during which you may reimburse Azure for the renewal and keep your domain name. The Renewal Grace Period is currently twelve (12) days but subject to change under the terms of this Agreement. For certain ccTLDs (.am, .at, .be, .cn, .com.cn, .net.cn, .org.cn, .de, .eu, .fm, .gs, .it, .jp, .ms, .nu, .nz, .co.nz, .net.nz, .org.nz, .tc, .tk, .tw, .com.tw, .org.tw, .idv.tw, .uk, and .vg) there is no Renewal Grace Period after the expiration date of the domain name. If you do not reimburse Azure for the renewal during the Renewal Grace Period your domain name will be placed on Hold and flagged for deletion after which you will have a 30-day redemption period during which you may pay Azure a Redemption fee and redeem your domain name. The Redemption fee is currently $80.00 USD and is subject to change under the terms of this Agreement. If you do not redeem your domain name prior to the end of the 30-day redemption period Azure may, in its sole discretion, delete your domain name or transfer it to another registrant on your behalf.  During the redemption period your domain name may be parked. 

\r\n

If your domain name is deleted, the Registry also provides a 30-day Redemption Grace Period during which you may pay Azure a redemption fee and redeem your domain name. The redemption fee is currently $80.00 USD and is subject to change under the terms of this Agreement. If you do not redeem your domain name prior to the end of the Registry's Redemption Grace Period the Registry will release your name and it will become available for registration on a first-come-first-served basis.

\r\n

Renewal Grace Periods and Redemption Grace Periods vary for different ccTLDs. Please refer to the specific terms for the applicable TLD. In the event there is a conflict between the provisions of this paragraph and the ccTLD terms, the ccTLD terms shall control.

\r\n

\r\n

Our registration expiration notification policy and associated fees are described here.

\r\n

\r\n

\r\n

(C) FREE PRODUCT TERMS

\r\n

In the event you are provided with free products with the registration of a domain name, you acknowledge and agree that such free products will only be available with a valid purchase and may be terminated in the event the domain name is deleted or cancelled.  For free domain names, you acknowledge and agree that you may not change the account associated with such free domain for the first five (5) days after registration.  In the event a free domain name is offered with the registration of another domain and if the paid domain name registered fails, then we may, in its sole discretion, either delete the registration of the free domain or refund the difference between the amount paid and the value of the free domain.  Failed registrations associated with promotionals offers may result in the deletion of the free or discounted item or an adjustment between the registered domain price and the value of the discounted item, in our sole discretion.

\r\n

4. TERM OF AGREEMENT; TRANSFERS; DOMAIN TASTING

\r\n

The term of this Agreement shall continue in full force and effect as long as you have any domain name registered through Azure.

\r\n

You agree that you will not transfer any domain name registered through Azure to another domain name registrar during the first sixty (60) days after its initial registration date.  You agree that you may not transfer any domain name for ten (10) days after a Change of Account.

\r\n

You further agree that you will not engage in \"domain tasting\" by using the five (5) day grace period in which a registrant may choose to cancel a domain name and get a full refund of the registration fee as a vehicle to test the marketability or viability of a domain name.  If Azure determines (which determination shall be made by Azure in its sole and absolute discretion) that you have been engaging in \"domain tasting\", then Azure reserves the right to (a) charge you a small fee (which fee shall be deducted from any refund issued) or (b) refuse your cancellation/refund request altogether. Azure will not charge you a fee if Azure cancels your domain name during the five (5) day grace period due to fraud or other activity outside of your control. The five (5) day grace period does not apply to Premium Domains, which are non-refundable.

\r\n

You agree that Azure shall not be bound by (i) any representations made by third parties who you may use to purchase services from Azure, or (ii) any statements of a general nature, which may be posted on Azure's website or contained in Azure's promotional materials.

\r\n

5. UP TO DATE INFORMATION; USE OF INFORMATION AND EXPIRATION

\r\n

You agree to notify Azure within five (5) business days when any of the information you provided as part of the application and/or registration process changes. It is your responsibility to keep this information in a current and accurate status. Failure by you, for whatever reason, to provide Azure with accurate and reliable information on an initial and continual basis, shall be considered to be a material breach of this Agreement and a basis for suspension and/or cancellation of the domain name. Failure by you, for whatever reason, to respond within five (5) business days to any inquiries made by Azure to determine the validity of information provided by you, shall also be considered to be a material breach of this Agreement and a basis for suspension and/or cancellation of the domain name. You agree to retain a copy for your record of the receipt for purchase of your domain name.

\r\n

You agree that for each domain name registered by you, the following contact data is required: postal address, email address, telephone number, and if available, a facsimile number for the Registered Name Holder and, if different from the Registered Name Holder, the same contact information for, a technical contact, an administrative contact and a billing contact.

\r\n

You acknowledge and agree that domain name registration requires that this contact information, in whole or in part, be shared with the registry operator, for their use, copying, distribution, publication, modification and other processing  for (among other uses in accordance with our Privacy Policy) the purpose of administration of the domain name registration, which may require such information be transferred back and forth across international borders, to and from the U.S. to the EU, for example. As required by ICANN, this information must also be made publicly available by means of Whois, and that the registry operator may also be required to make this information publicly available by Whois. Both Azure and the registry operator may be required to archive this information with a third-party escrow service. You hereby consent and give permission for all such requirements and disclosures. Further, you represent and warrant that, if you are providing information about a third party, you have notified the third party of the disclosure and the purpose for the disclosure and you have obtained the third party's consent to such disclosure.  Registrar will not process data in a way that is incompatible with this Agreement.  Registrar will take reasonable precautions to protect data from loss or misuse.

\r\n

You agree that for each domain name registered by you the following information will be made publicly available in the Whois directory as determined by ICANN Policy and may be sold in bulk as set forth in the ICANN agreement:

\r\n
    \r\n
  • The domain name;
    • \r\n
  • Your name and postal address;
    • \r\n
  • The name, email address, postal address, voice and fax numbers for technical and administrative contacts;
    • \r\n
  • The Internet protocol numbers for the primary and secondary name servers;
    • \r\n
  • The corresponding names of the name servers; and
    • \r\n
  • The original date of registration and expiration date.
    • \r\n
  • Name of primary name server and secondary name server.
    • \r\n
  • Identity of the registrar.
    • \r\n
\r\n

You agree that, to the extent permitted by ICANN, Azure may make use of the publicly available information you provided during the registration process. If you engage in the reselling of domain names you agree to provide any individuals whose personal information you've obtained, information about the possible uses of their personal information pursuant to ICANN policy. You also agree to obtain consent, and evidence of consent, from those individuals for such use of the personal information they provide.

\r\n

You agree that Azure has the right to make public and share with third parties certain information in connection with the sale or purchase of domain names on the website, including but not limited to (a) the name of the domain name sold or purchased, (b) the sale or purchase price of the domain name sold or purchased, and (c) information relating to the timing of the sale or purchase.

\r\n

\r\n

In order for us to comply with any current or future rules and policies for domain name systems including any rules or policies established by the CIRA or any provincial or federal government or by other organization having control or authority to establish rules or policies, you hereby grant to us the right to disclose to third parties through an interactive publicly accessible registration database the following information that you are required to provide when applying for a domain name:

\r\n
    \r\n
  1. The domain or sub-domain name(s) registered by you;
    2. \r\n
  2. Your organization name, type and postal address;
    3. \r\n
  3. The name(s), position(s), postal address(es), e-mail address(es), voice telephone number(s) and where available the fax number(s) of the technical and administrative contacts for your domain or sub-domain name(s);
    4. \r\n
  4. The full hostnames and Internet protocol (IP) addresses of at least two (2) name server hosts (one primary and at least one secondary) for your domain or sub-domain name. Up to six (6) name servers may be specified. If a host has more than one (1) IP address, use a comma-separated list;
    5. \r\n
  5. The corresponding names of those name servers;
    6. \r\n
  6. The original creation date of the registration; and
    7. \r\n
  7. The expiration date of the registration.
    8. \r\n
\r\n

We may be required to make this information available in bulk form to third parties. We may also transfer or assign this information to CIRA or such other third party as we may decide, in our sole discretion.

\r\n

6. DISPUTE RESOLUTION POLICY

\r\n

You agree to be bound by our current Dispute Resolution Policy. This policy is incorporated herein and made a part of this Agreement. You can view the Uniform Domain Name Dispute Resolution Policy online. You agree that Azure may from time to time modify its Dispute Resolution Policy. Azure will post any changes to its Dispute Resolution Policy at least thirty (30) days before they become effective. You agree that by maintaining your domain name registrations with Azure after the updated policy becomes effective that you agree to the Dispute Resolution policy as amended. You agree to review Azure's website periodically to determine if changes have been made to the Dispute Resolution Policy. If you cancel or terminate your Services with Azure as a result of the modified Dispute Resolution policy, no fees will be refunded to you. You also agree to submit to proceedings commenced under ICANN's Uniform Rapid Suspension System, if applicable. 

\r\n

You agree that if a dispute arises as a result of one (1) or more domain names you have registered using Azure, you will indemnify, defend and hold Azure harmless as provided for in this Agreement. You also agree that if Azure is notified that a complaint has been filed with a governmental, administrative or judicial body, regarding a domain name registered by you using Azure, that Azure, in its sole discretion, may take whatever action Azure deems necessary regarding further modification, assignment of and/or control of the domain name deemed necessary to comply with the actions or requirements of the governmental, administrative or judicial body until such time as the dispute is settled. In this event you agree to hold Azure harmless for any action taken by Azure.

\r\n

You agree to submit, without prejudice to other potentially applicable jurisdictions, to the jurisdiction of the courts (1) of your domicile, (2) where registrar is located or (3) where the registry operator is located (e.g., China for .CN, Columbia for .CO, UK for .EU, etc.).

\r\n

\r\n

In the case of .ca domain names, you agree that, if your use of the service or the registration of a .ca domain name is challenged by a third party, you will be subject to the provisions specified by CIRA in their dispute resolution policy, in effect at the time of the dispute.

\r\n

\r\n

7. TRANSFER OF DOMAIN NAMES; RESALE PRACTICES

\r\n

If you transfer any domain name, you agree to provide the information required by, and to abide by, the procedures and conditions set forth in our Domain Name Transfer Agreement and Change of Registrant Agreement. You may view the latest versions of our Domain Name Transfer Agreement and Change of Registrant Agreementonline. In order to further protect your domain name, any domain name registered with Azure or transferred to Azure shall be placed on lock status, unless an opted-out has occurred as defined in our Change of Registrant Agreement or Domain Name Proxy Agreement. The domain name must be placed on unlock status in order to initiate a transfer of the domain name away from Azure to a new Registrar. You may log into your account with Azure at any time after your domain name has been successfully transferred to Azure, and change the status to unlock.

\r\n

In the event you are purchasing a domain name on behalf of a third party, you agree to inform any customer of yours, who may be acquiring a domain name through you using Azure's registration services, that they are in fact registering their domain name through Azure and that Azure or its licensor is an accredited registrar with ICANN. You agree not to represent that you are an ICANN-accredited registrar or that you are in any way providing superior access to the ICANN Domain Name Registry. You also agree not to use the ICANN trademark logo in any of your promotional materials including your website.

\r\n

You agree to obtain each of your customers' acceptances to the then current version of this Agreement, and to retain evidence of their acceptance for a period of not less than three (3) years. Should you require that your customers accept additional terms and conditions that are not required by Azure, you agree that such additional terms and conditions shall not conflict with this Agreement and the policies and procedures adopted by ICANN.

\r\n

You agree that Azure is not lending you access to its registrar connections or its registry access, nor will you be deemed to be a registrar in your own right. Furthermore, you agree you will not attempt to gain access to Azure's registrar connections or registry access. You agree to provide complete, accurate and current data for each registrant to be added to a registry in accordance with ICANN requirements for inclusion in the Whois database.

\r\n

You agree to provide your customers with adequate customer support, and to maintain contact with them with regard to providing a medium for them to communicate changes in the information they provided as part of the domain name registration process. Upon receiving corrected or updated information you will, within five (5) business days, provide such information to Azure so Azure may update its registration records. You will retain copies of all communications between you and your customers and will upon request provide Azure copies of same.

\r\n

8. YOUR OBLIGATIONS; SUSPENSION OF SERVICES; BREACH OF AGREEMENT

\r\n

You represent and warrant to the best of your knowledge that, neither the registration of the domain nor the manner it is directly or indirectly used, infringes the legal rights of any third party.  You will comply with all applicable laws, including, but not limited to those relating to privacy, data collection, consumer protection, fair lending, debt collection, organic farming, and disclosure of data and financial disclosures.  If you collect and maintain sensitive health and financial data, you must implement reasonable and appropriate security measures commensurate with the offering of those services, as defined by applicable law.  You represent that you possess any necessary authorization, charter, license, and/or other related credential for participation in the sector associated with the associated registry tld string.  You will report any material changes to the validity of your authorization, charter, license, and/or other related credential. You will indemnify and hold harmless the registrar and registry operator, and their directors, officers, employees and agents, from and against any and all claims, damages, liabilities, costs and expenses (including reasonable legal fees and expenses) arising out of or related to the domain name registration.  This obligation shall survive expiration or termination of this Agreement or the domain name registration.

\r\n

You agree that, in addition to other events set forth in this Agreement:

\r\n
    \r\n
  1. Your ability to use any of the services provided by Azure is subject to cancellation or suspension in the event there is an unresolved breach of this Agreement and/or suspension or cancellation is required by any policy now in effect or adopted later by ICANN;
    2. \r\n
  2. Your registration of any domain names shall be subject to suspension, cancellation or transfer pursuant to any ICANN adopted specification or policy, or pursuant to any Azure procedure not inconsistent with an ICANN adopted specification or policy (a) to correct mistakes by Azure or the registry operator in registering any domain name; or (b) for the resolution of disputes concerning any domain name.
    3. \r\n
\r\n

You acknowledge and agree that Azure and registry reserve the right to deny, cancel or transfer any registration or transaction, or place any domain name(s) on registry lock, hold or similar status, as either deems necessary, in the unlimited and sole discretion of either Azure or the registry: (i) to comply with specifications adopted by any industry group generally recognized as authoritative with respect to the Internet (e.g., RFCs), (ii) to correct mistakes made by registry or any registrar in connection with a domain name registration, (iii) for the non-payment of fees to registry, (iv) to protect the integrity and stability of the registry, (v) to comply with any applicable court orders, laws, government rules or requirements, requests of law enforcement, or any dispute resolution process, (vi) to comply with any applicable ICANN rules or regulations, including without limitation, the registry agreement, (vii) to avoid any liability, civil or criminal, on the part of registry operator, as well as its affiliates, subsidiaries, officers, directors, and employees, (viii) per the terms of this Agreement, (ix) following an occurrence of any of the prohibited activities described in Section 8 below, or (x) during the resolution of a dispute.

\r\n

You agree that your failure to comply completely with the terms and conditions of this Agreement and any Azure rule or policy may be considered by Azure to be a material breach of this Agreement and Azure may provide you with notice of such breach either in writing or electronically (i.e. email). In the event you do not provide Azure with material evidence that you have not breached your obligations to Azure within ten (10) business days, Azure may terminate its relationship with you and take any remedial action available to Azure under the applicable laws. Such remedial action may be implemented without notice to you and may include, but is not limited to, cancelling the registration of any of your domain names and discontinuing any services provided by Azure to you. No fees will be refunded to you should your Services be cancelled or terminated because of a breach.

\r\n

Azure's failure to act upon or notify you of any event, which may constitute a breach, shall not relieve you from or excuse you of the fact that you have committed a breach.

\r\n

9. RESTRICTION OF SERVICES; RIGHT OF REFUSAL

\r\n

You agree not to use the services provided by Azure, or to allow or enable others, to use the services provided by Azure for the purposes of:

\r\n
    \r\n
  • The transmission of unsolicited email (Spam); and
    • \r\n
  • Repetitive, high volume inquires into any of the services provided by Azure (i.e. domain name availability, etc.).
    • \r\n
\r\n

You acknowledge and agree that you are prohibited from distributing malware, abusively operating botnets, phishing, piracy, trademark or copyright infringement, fraudulent or deceptive practices, counterfeiting or otherwise engaging in activity contrary to applicable law, and you acknowledge and agree that the consequences for such activities include suspension of the domain name.

\r\n

If you are hosting your domain name system (“DNS”) on Azure’s servers, or are using our systems to forward a domain name, URL, or otherwise to a system or site hosted elsewhere, or if you have your domain name registered with Azure, you are responsible for ensuring there is no excessive overloading on Azure’s servers. You may not use Azure’s servers and your domain name as a source, intermediary, reply to address, or destination address for email denial-of-service attack, Internet packet flooding, packet corruption, or other abusive attack. Server hacking or other perpetration of security breaches is prohibited. You agree that Azure reserves the right to deactivate your domain name from its DNS if Azure deems it is the recipient of activities caused by your site that threaten the stability of its network.

\r\n

You agree that Azure, in its sole discretion and without liability to you, may refuse to accept the registration of any domain name. Azure also may in its sole discretion and without liability to you delete the registration of any domain name during the first thirty (30) days after registration has taken place. Azure may also cancel the registration of a domain name, after thirty (30) days, if that name is being used, as determined by Azure in its sole discretion, in association with spam or morally objectionable activities. Morally objectionable activities will include, but not be limited to:

\r\n
    \r\n
  • Activities prohibited by the laws of the United States and/or foreign territories in which you conduct business;
    • \r\n
  • Activities designed to encourage unlawful behavior by others, such as hate crimes, terrorism and child pornography; and
    • \r\n
  • Activities designed to harm or use unethically minors in any way.
    • \r\n
\r\n

In the event Azure refuses a registration or deletes an existing registration during the first thirty (30) days after registration, you will receive a refund of any fees paid to Azure in connection with the registration either being cancelled or refused. In the event Azure deletes the registration of a domain name being used in association with spam or morally objectionable activities, no refund will be issued.

\r\n

10. DEFAULT SETTINGS; PARKED PAGE

\r\n

Choosing Your Domain Name Settings.  When you register a domain name with Azure, you will be prompted to choose your domain name settings during the checkout process.  If you plan on using another provider for your website or hosting needs, then you should enter the name servers of such provider when you choose your domain name settings.  This will direct your domain name away from Azure’s name servers.  If you are an existing Azure customer and have already set up a customer profile designating your domain name settings for new domain name registrations, you will not need to complete this step again during the checkout process.   

\r\n

Azure’s Default Settings.  If you do not direct your domain name away from Azure’s name servers as described above, Azure will direct your domain name to a “Parked Page” (“Default Setting”).  You acknowledge and agree that Azure has the right to set the Default Setting. 

\r\n

Parked Page Default Setting.  Azure’s Parked Page service is an online domain monetization system designed to generate revenue (through the use of pay per click advertising) from domain names that are not actively being used as websites.  If your domain name is directed to a Parked Page, you acknowledge and agree that Azure may display both (a) in-house advertising (which includes links to Azure products and services) and (b) third-party advertising (which includes links to third-party products and services) on your Parked Page through the use of pop-up or pop-under browser windows, banner advertisements, audio or video streams, or any other advertising means, and we may aggregate for our own use, related usage data by means of cookies and other similar means.  In addition, you acknowledge and agree that all in-house and third-party advertising will be selected by Azure and its advertising partners, as appropriate, and you will not be permitted to customize the advertising, or entitled to any compensation in exchange therefor.  Please note that the third-party advertising displayed on Azure’s Parked Pages may contain content offensive to you, including but not limited to links to adult content.  Azure makes no effort to edit, control, monitor, or restrict the content and third-party advertising displayed on Azure’s Parked Pages, and expressly disclaims any liability or responsibility to you or any third party in connection therewith.

\r\n

Changing Azure’s Default Settings.  You may change Azure’s Default Settings at any time during the term of your domain name registration.

\r\n
    \r\n
  1. Content Displaying On Your Parked Page.  You can not modify the content displaying on your Parked Page.  You may select one of the other options listed below.
    2. \r\n
  2. Participating In Domain Name Monetization.  If you wish to participate in the domain monetization potential presented by Azure’s Parked Page service, please review and consider purchasing our CashParking® service.   
    3. \r\n
  3. No Content.  If the options listed above are not acceptable to you, please contact customer support to learn what other options might be available to you.
    4. \r\n
\r\n

Return To Parked Page Default Setting Upon Domain Name Expiration.  Upon domain name expiration, and regardless of how you use your domain name during the term of your domain name registration, your domain name will automatically return to the Parked Page Default Setting described above.  As used in this paragraph, “expiration” is deemed to include any “renewal period” or “redemption period” immediately after the domain name expires, but before the domain name is returned to the registry.  Once your domain name has returned to the Parked Page Default Setting described above, the only way to opt out of the Parked Page service is to renew, redeem, or re-register your domain name in accordance with Section 2(B), Domain Name Renewal Terms, of this Agreement.   

\r\n

11. DOMAIN ADD-ONS

\r\n

Business Registration:  Business registration allows You to display additional information about the business that is the basis of Your domain name, including, but not limited to, such information as Your fax number, street address, and hours of operation.

\r\n

Certified Domains.  The certified domain service generally allow You to: (i) put a Certified Domain Validation seal on Your website; and (ii) have Your domain name listed as \"Certified\", in WHOIS lookups on our website.   The Certified Domain Validation seal renews independently of Your domain. When You renew Your domain, You must also, when necessary, separately renew Your Certified Validation seal. However, the Certified Domain Validation seal can be cancelled independently of Your domain. If the domain is cancelled, the Certified Domain associated with the cancelled domain will automatically cancel.  The Certified Domain seal is a trademark and is protected by copyright, trademark and other intellectual property laws. You may use the Certified Domain seal only in conjunction with the purchase of the Services set forth in the Agreement, and subject to the terms and conditions hereof. Other than provided for in this Agreement, You may not otherwise use, reproduce, or modify the mark for any additional promotional use, without our prior written approval. Your right to the use of the Certified Domain seal is immediately terminated upon expiration or termination of this Agreement.

\r\n

Expiration Consolidation.  You understand and acknowledge the expiration consolidation service may only be used to consolidate the expiration of .com and .net domain names. The service may not be used to consolidate domains that are on Registrar HOLD, Registry HOLD, or pending Transfer status. You acknowledge the service may only be used to push the expiration date of Your domains forward in time, at least one (1) month forward and no more than ten (10) years forward, and then, only for a period lasting less than twelve (12) months. Once the service has been used to consolidate domains, the new expiration date may not be reversed. To ensure the service is not abused or used as an alternative to renewals, you may only use the service on each domain once in any 12-month period. The service may only be used on domain names that have not passed their expiration date. In order to change the expiration date again, You will be required to renew the domain name first.  You further understand and acknowledge the service may only be used to coordinate domains where we are the registrar of record. Domains not registered with us must be transferred before we can perform the Service. 

\r\n

\r\n

Backordering/Monitoring.  You agree a domain name that has expired shall be subject first to a grace period of twelve (12) days, followed by the ICANN-mandated redemption grace period of thirty (30) days. During this period of time, the current domain name registrant may renew the domain name and retain ownership. We do not guarantee your backorder will result in you obtaining the domain name and expressly reserves the right to (a) refuse additional backorders or (b) cancel existing backorders at any time for any reason.  If your backorder is refused or cancelled, we agree to promptly refund any fees paid for such domain name backorder. The domain name may also be placed in a secondary market for resale through the Auctions® service.  After your first year of Auctions membership, you agree that unless otherwise advised, we will automatically renew your Auctions membership using the payment method you have on file for so long as your backorder credit is active. You may learn more about Auctions by visiting the Auctions website. The domain name may also be subject to a drop pool process before it is available for purchasing. You understand we and our registrar affiliates use our services, including backordering.  Therefore, the domain name may be registered with a different registrar, but can be managed through your account.  By using the Services, you will be able to, among other things:

\r\n
    \r\n
  1. Backorder any domain name under the top level domains .COM, .NET, .US, .BIZ, .INFO, .ORG, .MOBI. A backorder for a domain name will include the price of up to a one-year domain name registration. Should you successfully backorder any domain name, you will be subject to the terms and conditions of the Domain Name Registration and related agreements, which are incorporated herein by reference.
    2. \r\n
  2. Change your backorder until you obtain a domain name. You will have the opportunity to change the credit to a different domain name until you successfully capture one. After three (3) years, if the credit is not used, we reserves the right to remove the credit.
    3. \r\n
  3. Subscribe monthly to an expiring domain name list. You may also choose to purchase a subscription to a list of domain names expiring within the next five (5) days. If you subscribe to the expiring domain name list, you agree the payment method you have on file may be charged on a monthly subscription basis for the term of the Services you purchase.
    4. \r\n
  4. Select domain names off the expiring domain name list you would like to register. Each domain name you attempt to backorder will include the price of up to a one-year domain name registration, as set forth in subsection (i) above.
    5. \r\n
  5. Monitor your currently registered domain names for changes in registrar, status, expiration date or name servers at no additional cost.
    6. \r\n
  6. Subscribe to Domain Alert Pro or monitoring, which enables you to monitor any currently registered domain name, regardless of registrar, for historical tracking of status changes and designation of multiple email notification addresses.
    7. \r\n
\r\n

\r\n

\r\n

Transfer Validation. The transfer validation service is provided to help You keep Your domain name secure. By choosing to use the service, You are making an explicit and voluntary request to us to deny all attempts to transfer Your domain name to another registrar, or to move Your domain name to another account, unless You verify each request as described herein. You will provide us with a contact name, phone number and PIN for domain transfer validations. You will be contacted by us when a domain transfer is requested for a domain name in Your account. When we receive a transfer request, we will call You to verify the transfer request. If we cannot reach You with seventy-two (72) hours of receipt of the transfer request, the transfer will be denied. If You do not provide the proper PIN, the transfer will be denied. When we receive a change of account request, we will call You to verify the change request. If we cannot reach You with seventy-two (72) hours of receipt of the change request, the change will be denied. If You do not provide the proper PIN, the change will be denied. Availability of Services are subject to the terms and conditions of this Agreement and each of our policies and procedures. We shall use commercially reasonable efforts to attempt to provide certain portions of the Services on a twenty-four (24) hours a day, seven (7) days a week basis throughout the term of this Agreement and other portions of the service, during normal business hours. You acknowledge and agree that from time to time the Services may be inaccessible or inoperable for any reason, including, without limitation: (i) equipment malfunctions; (ii) periodic maintenance procedures or repairs that we may undertake from time to time; or (iii) causes beyond the reasonable control of us or that are not reasonably foreseeable by us, including, without limitation, interruption or failure of telecommunication or digital transmission links, hostile network attacks, network congestion or other failures. You acknowledge and agree that we has no control over the availability of the service on a continuous or uninterrupted basis.

\r\n

\r\n

12. PRE-REGISTRATIONS

\r\n

If you submit an application for pre-registration of a domain name, Azure does not guarantee that the name will be secured for you, or that you will have immediate access to the domain name if secured.  Azure may use third-party service providers for the pre-registration services.

\r\n

13. PROVISIONS SPECIFIC TO .BIZ REGISTRATIONS

\r\n

Domain Name Dispute Policy.  If you reserved or registered a .BIZ domain name through us, in addition to our Dispute Resolution Policy, you hereby acknowledge that you have read and understood and agree to be bound by the terms and conditions of the Restrictions Dispute Resolution Policy applicable to the .biz TLD.

\r\n

The RDRP sets forth the terms under which any allegation that a domain name is not used primarily for business or commercial purposes shall be enforced on a case-by-case basis by an independent ICANN-accredited dispute provider. Registry Operator will not review, monitor, or otherwise verify that any particular domain name is being used primarily for business or commercial purposes or that a domain name is being used in compliance with the SUDRP or UDRP processes.

\r\n

One Year Registration.  If you are registering a .BIZ domain name and you elect to take advantage of special pricing applicable to one-year registrations, we will automatically renew your domain name for an additional one-year period at the end of the first year term by taking payment from the Payment Method you have on file, unless you notify us that you do not wish to renew. You will be notified and given the opportunity to accept or decline the one-year renewal prior to your domain name expiration date. In the event you decide not to renew your one-year .BIZ domain name for a second year, your domain name registration will automatically revert back to us and we will gain full rights of registration to such domain name. You agree that if you delete or transfer your .BIZ domain name during the first year, you will automatically be charged the second year renewal fees.

\r\n

\r\n

14. PROVISIONS SPECIFIC TO .INFO REGISTRATIONS 

\r\n

One Year Registration.  If you are registering a .INFO domain name and you elect to take advantage of special pricing applicable to one-year registrations, we will automatically renew your domain name for an additional one-year period at the end of the first year term by taking payment from the Payment Method you have on file, unless you notify us that you do not wish to renew. You will be notified and given the opportunity to accept or decline the one-year renewal prior to your domain name expiration date. In the event you decide not to renew your one-year .INFO domain name for a second year, your domain name registration will automatically revert back to us and we will gain full rights of registration to such domain name. You agree that if you delete or transfer your .INFO domain name during the first year, you will automatically be charged the second year renewal fees.

\r\n

15. PROVISIONS SPECIFIC TO .MOBI REGISTRATIONS 

\r\n

Instant Mobilizer. You are hereby granted a personal, revocable, non-exclusive, non-transferable, non-assignable, non-sublicensable license to use the Instant Mobilizer service (“Service”), provided, however, You abide by the terms and conditions set forth. You shall not alter, modify, adapt or translate the whole or part of the Service in any way whatsoever. You may not create derivative works based on the Service. You may not rent, lease, assign, dispose of, novate, sub-license or otherwise transfer any of its rights to use the Service to any third party.  In the event that the volume of traffic to You from Your use of the Service is sufficient so as to jeopardize the provision of Service for other end users, we and our licensors reserve the right to, at its sole discretion, permanently or temporarily, discontinue Your use of the Service. For the avoidance of doubt, the volume of traffic generated by You should not exceed two thousand (2,000) page views per day.  You acknowledge and agree the text \"Instant Mobilizer from dotMobi\" or equivalent, will be inserted at the footer of Your site.  In the event a dotMobi domain to which the Service is being provided is transferred to another domain name registrar, the Service will be interrupted on that dotMobi domain, and Service will not be restored if the new registrar does not offer the Service. 

\r\n

\r\n

16. PROVISIONS SPECIFIC TO .NAME REGISTRATIONS 

\r\n

\r\n

17. PROVISIONS SPECIFIC TO .REISE REGISTRATIONS

\r\n

Domain Names registered in .REISE should be used for purposes dedicated to travel topics within six months following initial Registration, e.g. utilized on the Internet or otherwise used to perform a function.

\r\n

18. PROVISIONS SPECIFIC TO .SEXY REGISTRATIONS

\r\n

You shall not permit content unsuitable for viewing by a minor to be viewed from the main or top-level directory of a .SEXY domain name. For purposes of clarity, content viewed at the main or top-level directory of a .SEXY domain name is the content immediately visible if a user navigates to http://example.sexy or http://www.example.sexy. No restrictions apply to the content at any other page or subdirectory addressed by a .SEXY Registered Name. 

\r\n

19. COUNTRY CODE TOP LEVEL DOMAINS

\r\n

You represent and warrant that you meet the eligibility requirements of each ccTLD you apply for. You further agree to be bound by any registry rules, policies, and agreements for that particular ccTLD. These may include, but are not limited to, agreeing to indemnify the ccTLD provider, limiting the liability of the ccTLD provider, and requirements that any disputes be resolved under that particular country's laws.

\r\n

(A) PROVISIONS SPECIFIC TO .AU REGISTRATIONS 

\r\n

.au Registrations (to include com.au, net.au and org.au) are governed by the following additional terms and conditions:

\r\n

auDA. auDA means .au Domain Administration Limited ACN 079 009 340, the .au domain names administrator.  The Registrar acts as agent for auDA for the sole purpose, but only to the extent necessary, to enable auDA to receive the benefit of rights and covenants conferred to it under this Agreement. auDA is an intended third party beneficiary of this agreement.

\r\n

auDA Published Policy.  auDA Published Policies means those specifications and policies established and published by auDA from time to time at http://www.auda.org.au.  You must comply with all auDA Published Policies, as if they were incorporated into, and form part of, this Agreement. In the event of any inconsistency between any auDA Published Policy and this Agreement, then the auDA Published Policy will prevail to the extent of such inconsistency.  You acknowledge that under the auDA Published Policies: (1) there are mandatory terms and conditions that apply to all domain names; (2) licences, and such terms and conditions are incorporated into, and form part of, this Agreement; (3) You are bound by, and must submit to, the .au Dispute Resolution Policy; and (4) auDA may delete or cancel the registration of a .au domain name. 

\r\n

auDA's Liabilities and Indemnity.  To the fullest extent permitted by law, auDA will not be liable to Registrant for any direct, indirect, consequential, special, punitive or exemplary losses or damages of any kind (including, without limitation, loss of use, loss or profit, loss or corruption of data, business interruption or indirect costs) suffered by Registrant arising from, as a result of, or otherwise in connection with, any act or omission whatsoever of auDA, its employees, agents or contractors. Registrant agrees to indemnify, keep indemnified and hold auDA, its employees, agents and contractors harmless from all and any claims or liabilities, arising from, as a result of, or otherwise in connection with, Registrant's registration or use of its .au domain name. Nothing in this document is intended to exclude the operation of Trade Practices Act 1974.

\r\n

(B) PROVISIONS SPECIFIC TO .CA REGISTRATIONS

\r\n

You acknowledge and agree that registration of your selected domain name in your first application to CIRA shall not be effective until you have entered into and agreed to be bound by CIRA's Registrant Agreement.

\r\n

CIRA Certified Registrar.  The registrar shall immediately give notice to you in the event that it is no longer a CIRA Certified Registrar, has had its certification as a CIRA Certified Registrar suspended or terminated, or the Registrar Agreement between CIRA and the Registrar is terminated or expires. CIRA may post notice of such suspension, termination, or expiry on its website and may, if CIRA deems appropriate, give notice to the registrants thereof. In the event that the registrar is no longer a CIRA Certified Registrar, has had its certification as a CIRA Certified Registrar suspended or terminated or in the event the Registrar Agreement between CIRA and the Registrar is terminated or expires, you shall be responsible for changing your Registrar of Record to a new CIRA Certified Registrar within thirty (30) days of the earlier of notice thereof being given to you by (i) the Registrar or (ii) CIRA in accordance with CIRA's then current Registry PRP; provided, however, that if any of your domain name registrations are scheduled to expire within thirty (30) days of the giving of such notice, then you shall have thirty (30) days from the anniversary date of the registration(s), to register with a new CIRA certified registrar and to renew such domain name registration(s) in accordance with the Registry PRP.

\r\n

You acknowledge and agree that should there be insufficient funds prepaid by the registrar in the CIRA Deposit Account to be applied in payment of any fees, CIRA may in its sole discretion stop accepting applications for domain name registrations from the registrar, stop effecting registrations of domain names and transfers, renewals, modifications, and cancellations requested by the registrar and stop performing other billable transactions requested by the registrar not paid in full and CIRA may terminate the Registrar Agreement between CIRA and the Registrar.

\r\n

.CA ASCII and IDN domain variants are bundled and reserved for a single registrant.  Registrants are not required to register all variants in a bundle, but all registered variants must be registered and managed at a single registrar. Each variant registered will incur a registration fee.  In addition, when registering multiple .CA domain (ASCII and IDN) variants in a bundle, your registrant information must be identical.  If variants are registered at other registrars or if registrant information does not match, it may result in an \"unavailable\" search result, delayed or failed registration. If information does not match, validation is required and may take up to seven business days and delay availability of domain. 

\r\n

(C) PROVISIONS SPECIFIC TO .CN REGISTRATIONS 

\r\n

.CN is a restricted TLD – applications are subject to both a domain name check and real name verification as required by the China.  Registrations in .CN are therefore subject to the following additional terms:

\r\n

Verification, Registration and Activation.  If a domain name is not permitted to be registered by the Chinese government, as determined by us, the Registry Operator and/or a 3rd party provider utilized for such services and determinations, in either party’s discretion, the application for registration will not be successful.  In such event, the name will be deleted and you will be eligible for a refund as further described below.

\r\n

If permitted, then the Registration may proceed, but a .CN domain name may not be activated (i.e., it will not resolve in the Internet) unless and until you have submitted (via the process described during registration) valid documents required of us and the Registry to perform real name verification.  The following are acceptable forms of documents for the purpose of verification:

\r\n
    \r\n
  • China: Resident ID, temporary resident ID, business license or organization code certificate
    • \r\n
  • Hong Kong Special Administrative Region/Macao Special Administrative Region: Resident ID, driver’s license, passport or business license
    • \r\n
  • Singapore: Driver’s license, passport or business license
    • \r\n
  • Taiwan: Resident ID, driver’s license or business license
    • \r\n
  • Other Countries/Regions: Driver’s license or passport
    • \r\n
\r\n

Documents submitted to us are used by us and shared with the Registry solely for the purpose of real name verification, and are otherwise subject to our Privacy Policy.  By registering a .CN domain, you expressly agree that your data may be stored on servers in the U.S., or otherwise outside of the China.

\r\n

Refunds.  Refunds for .CN Registrations will only be allowed where (i) registration of the applied for domain name is not permitted by the Chinese government; or (ii) you notify us of your intent to cancel for any reason within the first five (5) days after the Registration (i.e., after it is deemed permissible by the Chinese government).  For the avoidance of doubt, refunds will not be permitted under any circumstances after five (5) days from the date of Registration, including, for example, in the event real name verification is not successful or if the Chinese government determines after Registration that the domain name should not have been registered (and directs us to delete).

\r\n

(D) PROVISIONS SPECIFIC TO .JP REGISTRATIONS

\r\n

Registration Restrictions.  You represent and warrant that you have a local presence in Japan with a home or office address. You agree that certain domain names are reserved and can only be registered by certain parties. These include: (i) TLDs, other than ccTLDs, as determined by ICANN; (ii) geographical-type .JP domain names that are defined as metropolitan, prefectural, and municipal labels; (iii) names of primary and secondary educational organizations; (iv) names of organizations related to Internet management; (v) names required for .JP domain name operations; and (vi) character strings which may be confused with ASCII-converted Japanese domain names. The complete list of .JP Reserved Domains is available here. 

\r\n

20. ENGLISH LANGUAGE CONTROLS

\r\n

This Agreement, along with all policies and the applicable product agreements identified above and incorporated herein by reference (collectively, the “Agreement”), is executed in the English language. To the extent any translation is provided to you, it is provided for convenience purposes only, and in the event of any conflict between the English and translated version, where permitted by law, the English version will control and prevail. Where the translated version is required to be provided to you and is to be considered binding by law (i) both language versions shall have equal validity, (ii) each party acknowledges that it has reviewed both language versions and that they are substantially the same in all material respects, and (iii) in the event of any discrepancy between these two versions, the translated version may prevail, provided that the intent of the Parties has been fully taken into consideration. 

\n
\n
\n\nRevised: 10/6/17
\nCopyright © 2000-2017 All Rights Reserved.\n\n
\n
", + "url": "http://www.secureserver.net/agreements/ShowDoc.aspx?pageid=reg_sa&pl_id=510456" + }, + { + "agreementKey": "DNPA", + "title": "Domain Name Proxy Agreement", + "content": "\n\n\n\n\n
\n\n\n\n\n\n\n
\nDomain Name Proxy Agreement\n
\n

Last Revised: October 25, 2017

\n

Please read this Domain Name Proxy Agreement (\"Agreement\") carefully. By using the Services and/or website of Domains By Proxy, LLC, a Delaware limited liability company (\"DBP\"), You (as defined below) agree to all the terms and conditions set forth both herein and in the DBP privacy policy, which is incorporated by reference and can be found by clicking here.  You acknowledge that DBP may amend this Agreement at any time upon posting the amended terms on its website, and that any new, different or additional features changing the services provided by DBP will automatically be subject to this Agreement. If You do not agree to be bound by, or if You object to, the terms and conditions of this Agreement and any amendments hereto, do not use or access DBP's services. Continued use of DBP's services and its website after any such changes to this Agreement have been posted, constitutes Your acceptance of those changes.

\r\n

This Agreement is by and between DBP and you, your heirs, assigns, agents and contractors (\"You\") and is made effective as of the date of electronic execution. This Agreement sets forth the terms and conditions of Your relationship with DBP and Your use of DBP's services and represents the entire Agreement between You and DBP. By using DBP's Services, You acknowledge that You have read, understand and agree to be bound by all the terms and conditions of this Agreement, and You further agree to be bound by the terms of this Agreement for transactions entered into by:

\r\n
    \r\n
  1. You on Your behalf;
    2. \r\n
  2. Anyone acting as Your agent; and
    3. \r\n
  3. Anyone who uses the account You have established with DBP, whether or not the transactions were on Your behalf and/or authorized by You.
    4. \r\n
\r\n

You agree You will be bound by representations made by third parties acting on Your behalf, which either use or purchase services from DBP. You further agree that DBP will not be bound by statements of a general nature on DBP's website or DBP promotional materials. You further agree to abide by the terms and conditions promulgated by the Internet Corporation for Assigned Names and Numbers (\"ICANN\") (including the Uniform Domain Name Dispute Resolution Policy (\"Dispute Resolution Policy\") and Your Registrar (i.e., the ICANN-accredited person or entity through which You register a domain name).

\r\n

1. description of DBP's private registration services

\r\n

When You subscribe to DBP's private registration service through a DBP-affiliated Registrar, DBP will display its contact information in the publicly available \"Whois\" directory in place of Your information. DBP shall keep Your name, postal address, email address, phone and fax numbers confidential, subject to Section 4 of this Agreement. The following information (and not Your personal information) will be made publicly available in the \"Whois\" directory as determined by ICANN policy:

\r\n
    \r\n
  1. DBP's name as the proxy Registrant of the domain name and a proxy email address, phone number and postal address for the proxy Registrant's contact information;
    2. \r\n
  2. A proxy postal address and phone number for the domain name registration's technical contact;
    3. \r\n
  3. A proxy email address, postal address and phone number for the domain name registration's administrative contact;
    4. \r\n
  4. A proxy email address, postal address and phone number for the domain's name registration's billing contact;
    5. \r\n
  5. The primary and secondary domain name servers You designate for the domain name;
    6. \r\n
  6. The domain name's original date of registration and expiration date of the registration; and
    7. \r\n
  7. The identity of the Registrar.
    8. \r\n
\r\n

2. full benefits of domain registration retained by you

\r\n

Although DBP will show in the \"Whois\" directory as the Registrant of each domain name registration You designate, You will retain the full benefits of domain name registration with respect to each such domain name registration, including, subject to Section 4 below:

\r\n
    \r\n
  1. The right to sell, transfer or assign each domain name registration, which shall require cancellation of the DBP services associated with each such domain name registration;
    2. \r\n
  2. The right to control the use of each domain name registration, including designating the primary and secondary domain name servers to which each domain name points;
    3. \r\n
  3. The right to cancel each domain name registration;
    4. \r\n
  4. The right to cancel the DBP services associated with each domain name registration and/or Your privacy services with DBP so that Your contract information is listed in the \"Whois\" directory; and
    5. \r\n
  5. The right to renew each domain name registration upon its expiration, subject to Your Registrar's applicable rules and policies.
    6. \r\n
\r\n

3. PERSONAL INFORMATION AND your notification obligations; representation and warranties; ACCOUNT SECURITY

\r\n

Personal Information and Your Notification Obligations 

\r\n

You agree that for each domain name for which you use DBP services, You will provide accurate and current information as to:

\r\n
    \r\n
  1. Your name, the email address, postal address, phone and fax numbers for the domain name registration's Registrant contact;
    2. \r\n
  2. The email address, postal address, phone and fax numbers for the domain name registration's technical contact;
    3. \r\n
  3. The email address, postal address, phone and fax numbers for the domain name registration's administrative contact;
    4. \r\n
  4. The email address, postal address, phone and fax numbers for the domain name registration's billing contact; and
    5. \r\n
  5. You agree to provide government issued photo identification and/or government issued business identification as required for verification of identity when requested.
    6. \r\n
\r\n

You agree to:

\r\n
    \r\n
  1. Notify DBP within three (3) calendar days when any of the personal information You provided upon subscribing to DBP's services, changes;
    2. \r\n
  2. Respond within three (3) calendar days to any inquiries made by DBP to determine the validity of personal information provided by You; and
    3. \r\n
  3. Timely respond to email messages DBP sends to You regarding correspondence DBP has received that is either addressed to or involves You and/or Your domain name registration, as more fully set forth in Section 5(c) below.
    4. \r\n
  4. To allow DBP to act as your Designated Agent (as that term is defined below) in instances when DBP services are added to or cancelled from your domain name and for the purpose of facilitating a change of registrant request (as further described below). 
    5. \r\n
\r\n

It is Your responsibility to keep Your personal information current and accurate at all times.

\r\n

Renewals

\r\n

You agree DBP will arrange for Your Registrar to charge the credit card You have on file with the Registrar, at the Registrar's then current rates.

\r\n

If for any reason DBP and/or the Registrar for Your domain name is unable to charge Your credit card for the full amount of the service provided, or if DBP and/or the Registrar is charged back for any fee it previously charged to the credit card You provided, You agree that DBP and/or the Registrar may, without notice to You, pursue all available remedies in order to obtain payment, including but not limited to immediate cancellation of all services DBP provides to You.

\r\n

Representations and Warranties

\r\n

You warrant that all information provided by You to DBP is truthful, complete, current and accurate. You also warrant that You are using DBP's private registration services in good faith and You have no knowledge of Your domain name infringing upon or conflicting with the legal rights of a third party or a third party's trademark or trade name. You also warrant the domain name being registered by DBP on Your behalf will not be used in connection with any illegal activity, or in connection with the transmission of Spam, or that contains or installs any viruses, worms, bugs, Trojan horses or other code, files or programs designed to, or capable or, disrupting, damaging or limiting the functionality of any software or hardware.

\r\n

Account Security

\r\n

You agree You are entirely responsible for maintaining the confidentiality of Your customer number/login ID and password (\"Account Access Information\").  You agree to notify DBP immediately of any unauthorized use of Your account or any other breach of security.  You agree DBP will not be liable for any loss that You may incur as a result of someone else using Your Account Access Information, either with or without Your knowledge.  You further agree You could be held liable for losses incurred by DBP or another party due to someone else using Your Account Access Information.  For security purposes, You should keep Account Access Information in a secure location and take precautions to prevent others from gaining access to Your Account Access Information.  You agree that You are entirely responsible for all activity in Your account, whether initiated by You, or by others.  DBP specifically disclaims liability for any activity in Your account, regardless of whether You authorized the activity.

\r\n

Designated Agency and Change of Registrant Information

\r\n

“DESIGNATED AGENT” MEANS AN INDIVIDUAL OR ENTITY THAT THE PRIOR REGISTRANT OR NEW REGISTRANT EXPLICITLY AUTHORIZES TO APPROVE A CHANGE OF REGISTRANT REQUEST ON ITS BEHALF.  IN THE CASE OF DBP SERVICES, A CHANGE OF REGISTRANT REQUEST MAY ALSO ARISE DUE TO INSTANCES WHERE DBP SERVICES ARE ADDED, OR REMOVED, FROM A DOMAIN NAME.  FOR THE PURPOSE OF FACILITATING ANY SUCH CHANGE REQUEST, AND IN ACCORDANCE WITH ICANN'S CHANGE OF REGISTRANT POLICY, YOU AGREE TO APPOINT DBP AS YOUR DESIGNATED AGENT FOR THE SOLE PURPOSE OF EXPLICITLY CONSENTING TO MATERIAL CHANGES OF REGISTRATION CONTACT INFORMATION ON YOUR BEHALF.

\r\n

4. DBP's rights to deny, suspend, terminate service and to disclose your personal information

\r\n

You understand and agree that DBP has the absolute right and power, in its sole discretion and without any liability to You whatsoever, to:

\r\n
    \r\n
  1. Cancel the privacy service (which means that Your information will be available in the \"Whois\" directory) and/or reveal Your name and personal information that You provided to DBP:  
    A. When required by law, in the good faith belief that such action is necessary in order to conform to the edicts of the law or in the interest of public safety;
    B. To comply with legal process served upon DBP or in response to a reasonable threat of litigation against DBP (as determined by DBP in its sole and absolute discretion); or
    C. To comply with ICANN rules, policies, or procedures.
    2. \r\n
  2. Resolve any and all third party claims, whether threatened or made, arising out of Your use of a domain name for which DBP is the registrant listed in the \"Whois\" directory on Your behalf; or
    3. \r\n
  3. Take any other action DBP deems necessary:
    A. In the event you breach any provision of this Agreement or the DBP Anti-Spam Policy;
    B. To protect the integrity and stability of, and to comply with registration requirements, terms, conditions and policies of, the applicable domain name Registry and/or Registry Provider;
        C. To comply with any applicable laws, government rules or requirements, subpoenas, court orders or requests of law enforcement; 
    D. To comply with ICANN's Dispute Resolution Policy or ICANN's Change of Registrant Policy;
    E. To avoid any financial loss or legal liability (civil or criminal) on the part of DBP, its parent companies, subsidiaries, affiliates, shareholders, agents, officers, directors and employees;
    F. If the domain name for which DBP is the registrant on Your behalf violates or infringes a third party's trademark, trade name or other legal rights; and
    G. If it comes to DBP's attention that You are using DBP's services in a manner (as determined by DBP in its sole and absolute discretion) that:
    4. \r\n
\r\n
\r\n
    \r\n
  • Is illegal, or promotes or encourages illegal activity;
    • \r\n
  • Promotes, encourages or engages in child pornography or the exploitation of children;
    • \r\n
  • Promotes, encourages or engages in terrorism, violence against people, animals, or property;
    • \r\n
  • Promotes, encourages or engages in any spam or other unsolicited bulk email, or computer or network hacking or cracking;
    • \r\n
  • Violates the Ryan Haight Online Pharmacy Consumer Protection Act of 2008 or similar legislation, or promotes, encourages or engages in the sale or distribution of prescription medication without a valid prescription;  
    • \r\n
  • Infringes on the intellectual property rights of another User or any other person or entity;
    • \r\n
  • Violates the privacy or publicity rights of another User or any other person or entity, or breaches any duty of confidentiality that you owe to another User or any other person or entity;
    • \r\n
  • Interferes with the operation of DBP services;
    • \r\n
  • Contains or installs any viruses, worms, bugs, Trojan horses or other code, files or programs designed to, or capable of, disrupting, damaging or limiting the functionality of any software or hardware; or
    • \r\n
  • Contains false or deceptive language, or unsubstantiated or comparative claims, regarding DBP or its services.
    • \r\n
\r\n
\r\n

You further understand and agree that if DBP is named as a defendant in, or investigated in anticipation of, any legal or administrative proceeding arising out of Your domain name registration or Your use of DBP's services, Your private registration service may be canceled, which means the domain name registration will revert back to You and Your identity will therefore be revealed in the Whois directory as Registrant.

\r\n

In the event:

\r\n
    \r\n
  1. DBP takes any of the actions set forth in subsection i, ii, or iii above or section 5; and/or
    2. \r\n
  2. You elect to cancel DBP's services for any reason --
    3. \r\n
\r\n

Neither DBP nor your Registrar will refund any fees paid by You whatsoever.

\r\n

5. communications forwarding

\r\n

a. Correspondence Forwarding

\r\n

Inasmuch as DBP's name, postal address and phone number will be listed in the Whois directory, You agree DBP will review and forward communications addressed to Your domain name that are received via email, certified or traceable courier mail (such as UPS, FedEx, or DHL), or first class U.S. postal mail. You specifically acknowledge DBP will not forward to You first class postal mail (other than legal notices), \"junk\" mail or other unsolicited communications (whether delivered through email, fax, postal mail or telephone), and You further authorize DBP to either discard all such communications or return all such communications to sender unopened. You agree to waive any and all claims arising from Your failure to receive communications directed to Your domain name but not forwarded to You by DBP.

\r\n

b. Email Forwarding

\r\n

The Whois directory requires an email address for every purchased domain name registration. When You purchase a private domain registration, DBP creates a private email address for that domain name, \"@domainsbyproxy.com\". Thereafter, when messages are sent to that private email address, DBP handles them according to the email preference You selected for that particular domain name. You have three (3) email preferences from which to choose. You can elect to:

\r\n
    \r\n
  1. Have all of the messages forwarded;
    2. \r\n
  2. Have all of the messages filtered for Spam and then forwarded; or
    3. \r\n
  3. Have none of the messages forwarded.
    4. \r\n
\r\n

As with all communications, You agree to waive any and all claims arising from Your failure to receive email directed to Your domain name but not forwarded to You by DBP.

\r\n

c. Notifications Regarding Correspondence and Your Obligation to Respond

\r\n

When DBP receives certified or traceable courier mail or legal notices addressed to Your domain name, in most cases, DBP will attempt to forward the mail to you via email. If You do not respond to the DBP email and/or the correspondence DBP has received regarding Your domain name registration concerns a dispute of any kind or otherwise requires immediate disposition, DBP may immediately reveal Your identity and/or cancel the DBP private registration service regarding either the domain name registration(s) in question. This means the Whois directory will revert to displaying Your name, postal address, email address and phone number that you provided to DBP.

\r\n

d. Additional Administrative Fees

\r\n

DBP reserves the right to charge You reasonable \"administrative fees\" or \"processing fees\" for (i)  tasks DBP may perform outside the normal scope of its Services, (ii) additional time and/or costs DBP may incur in providing its Services, and/or (iii) Your non-compliance with the Agreement (as determined by DBP in its sole and absolute discretion). Typical administrative or processing fee scenarios include, but are not limited to, (i) customer service issues that require additional personal time and attention; (ii) disputes that require accounting or legal services, whether performed by DBP staff or by outside firms retained by DBP; (iii) recouping any and all costs and fees, including the cost of Services, incurred by DBP as the result of chargebacks or other payment disputes brought by You, Your bank or Payment Method processor.  These administrative fees or processing fees will be billed to the Payment Method You have on file with Your Registrar.

\r\n

You agree to waive the right to trial by jury in any proceeding that takes place relating to or arising out of this Agreement.

\r\n

6. limitations of liability

\r\n

UNDER NO CIRCUMSTANCES SHALL DBP BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, PUNITIVE, SPECIAL, OR CONSEQUENTIAL DAMAGES FOR ANY REASON WHATSOEVER RELATED TO THIS AGREEMENT, YOUR DOMAIN NAME REGISTRATION, DBP'S SERVICES, USE OR INABILITY TO USE THE DBP WEBSITE OR THE MATERIALS AND CONTENT OF THE WEBSITE OR ANY OTHER WEBSITES LINKED TO THE DBP WEBSITE OR YOUR PROVISION OF ANY PERSONALLY IDENTIFIABLE INFORMATION TO DBP OR ANY THIRD PARTY. THIS LIMITATION APPLIES REGARDLESS OF WHETHER THE ALLEGED LIABILITY IS BASED ON CONTRACT, TORT, WARRANTY, NEGLIGENCE, STRICT LIABILITY OR ANY OTHER BASIS, EVEN IF DBP HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES OR SUCH DAMAGES WERE REASONABLY FORESEEABLE. BECAUSE CERTAIN JURISDICTIONS DO NOT PERMIT THE LIMITATION OR ELIMINATION OF LIABILITY FOR CONSEQUENTIAL OR INCIDENTAL DAMAGES, DBP'S LIABILITY IN SUCH JURISDICTIONS SHALL BE LIMITED TO THE SMALLEST AMOUNT PERMITTED BY LAW.

\r\n

YOU FURTHER UNDERSTAND AND AGREE THAT DBP DISCLAIMS ANY LOSS OR LIABILITY RESULTING FROM:

\r\n
    \r\n
  1. THE INADVERTENT DISCLOSURE OR THEFT OF YOUR PERSONAL INFORMATION;
    2. \r\n
  2. ACCESS DELAYS OR INTERRUPTIONS TO OUR WEBSITE OR THE WEBSITES OF OUR AFFILIATED REGISTRARS;
    3. \r\n
  3. DATA NON-DELIVERY OF MIS-DELIVERY BETWEEN YOU AND DBP;
    4. \r\n
  4. THE FAILURE FOR WHATEVER REASON TO RENEW A PRIVATE DOMAIN NAME REGISTRATION;
    5. \r\n
  5. THE UNAUTHORIZED USE OF YOUR DBP ACCOUNT OR ANY OF DBP'S SERVICES;
    6. \r\n
  6. ERRORS, OMISSIONS OR MISSTATEMENTS BY DBP;
    7. \r\n
  7. DELETION OF, FAILURE TO STORE, FAILURE TO PROCESS OR ACT UPON EMAIL MESSAGES FORWARDED TO EITHER YOU OR YOUR PRIVATE DOMAIN NAME REGISTRATION;
    8. \r\n
  8. PROCESSING OF UPDATED INFORMATION REGARDING YOUR DBP ACCOUNT; AND/OR
    9. \r\n
  9. ANY ACT OR OMISSION CAUSED BY YOU OR YOUR AGENTS (WHETHER AUTHORIZED BY YOU OR NOT).
    10. \r\n
\r\n

7. indemnity

\r\n

You agree to release, defend, indemnify and hold harmless DBP, its parent companies, subsidiaries, affiliates, shareholders, agents, directors, officers and employees and Your Registrar, from and against any and all claims, demands, liabilities, losses, damages or costs, including reasonable attorneys' fees, arising out of or related in any way to this Agreement, the services provided hereunder by DBP, the DBP website, Your account with DBP, Your use of Your domain name registration, and/or disputes arising in connection with the dispute policy.

\r\n

8. DBP warranty disclaimer

\r\n

DBP, ITS PARENT COMPANIES, SUBSIDIARIES, AFFILIATES, SHAREHOLDERS, AGENTS, DIRECTORS, OFFICERS, AND EMPLOYEES EXPRESSLY DISCLAIM ALL REPRESENTATIONS AND WARRANTIES OF ANY KIND IN CONNECTION WITH THIS AGREEMENT, THE SERVICE PROVIDED HEREUNDER, THE DBP WEBSITE OR ANY WEBSITES LINKED TO THE DBP WEBSITE, WHETHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. ALL DBP SERVICES, AS WELL AS THE DBP WEBSITE, ARE PROVIDED \"AS IS\". YOUR SUBSCRIPTION TO AND USE OF DBP'S SERVICES AND ITS WEBSITE ARE ENTIRELY AT YOUR RISK. SOME JURISDICTIONS DO NOT ALLOW THE DISCLAIMER OF IMPLIED WARRANTIES, IN WHICH EVENT THE FOREGOING DISCLAIMER MAY NOT APPLY TO YOU.

\r\n

9. copyright and trademark

\r\n

You understand and agree that all content and materials contained in this Agreement, the Privacy Policy and the DBP website found here , are protected by the various copyright, patent, trademark, service mark and trade secret laws of the United States, as well as any other applicable proprietary rights and laws, and that DBP expressly reserves its rights in and to all such content and materials.

\r\n

You further understand and agree You are prohibited from using, in any manner whatsoever, any of the afore-described content and materials without the express written permission of DBP. No license or right under any copyright, patent, trademark, service mark or other proprietary right or license is granted to You or conferred upon You by this Agreement or otherwise.

\r\n

10. miscellaneous provisions

\r\n

a. Severability; Construction; Entire Agreement

\r\n

If any part of this Agreement shall be held to be illegal, unenforceable or invalid, in whole or in part, such provision shall be modified to the minimum extent necessary to make it legal, enforceable and valid, and the legality, enforceability and validity of the remaining provisions of this Agreement shall not be affected or impaired. The headings herein will not be considered a part of this Agreement. You agree this Agreement, including the policies it incorporates by reference, constitute the complete and only Agreement between You and DBP regarding the services contemplated herein.

\r\n

b. Governing Law; Venue; Waiver Of Trial By Jury

\r\n

This Agreement shall be governed in all respects by the laws and judicial decisions of Maricopa County, Arizona, excluding its conflicts of laws rules. Except as provided immediately below, You agree that any action relating to or arising out of this Agreement, shall be brought exclusively in the courts of Maricopa County, Arizona. For the adjudication of domain name registration disputes, you agree to submit to the exclusive jurisdiction and venue of the U.S. District Court for the District of Arizona located in Phoenix, Arizona. You agree to waive the right to trial by jury in any proceeding, regardless of venue, that takes place relating to or arising out of this Agreement.

\r\n

c. Notices

\r\n

All notices from DBP to You will be sent to the email address You provided to DBP. Notices by email shall be deemed effective twenty-four (24) hours after the email is sent by DBP, unless DBP receives notice that the email address is invalid, in which event DBP may give You notice via first class or certified mail, return receipt requested. All notices from You to DBP shall be sent via certified mail, return receipt requested or traceable courier to:

\r\n
      Domains By Proxy, LLC
      Attn: General Counsel
      14455 North Hayden Rd.
      Suite 219
      Scottsdale, AZ 85260
\r\n

Notices sent via certified mail or traceable courier shall be deemed effective five (5) days after the date of mailing.

\r\n

d. Insurance

\r\n

In the unlikely event You lose Your domain name registration to a third party solely as a result of DBP's negligent actions (and absent fraud or other negligent or willful misconduct committed by a third party), You may be insured against such loss through DBP's Professional Liability Insurance Policy, which is currently underwritten by American International Insurance Company. Of course, every claim is subject to the then-carrier's investigation into the facts and circumstances surrounding such claim. In the event You have reason to believe that circumstances exist which warrant the filing of an insurance claim, please send a written notice (specifying the basis for such claim), via certified mail, return receipt requested, to:

\r\n
      Domains By Proxy, LLC
      Attn: Insurance Claims
      14455 North Hayden Rd.
      Suite 219
      Scottsdale, AZ 85260
\r\n

e. Indemnification

\r\n

In the unlikely event You lose Your domain name registration to a third party solely as a result of DBP's willful misconduct, Your Registrar (the \"Indemnifying Party\") will indemnify and hold You harmless against any losses, damages or costs (including reasonable attorneys' fees) resulting from any claim, action, proceeding, suit or demand arising out of or related to the loss of Your domain name registration. Such indemnification obligations under this Section 10(e) are conditioned upon the following:

\r\n
    \r\n
  1. That You promptly give both DBP and the Indemnifying Party written notice of the claim, demand, or action and provide reasonable assistance to the Indemnifying Party, at its cost and expense, in connection therewith, and
    2. \r\n
  2. That the Indemnifying Party has the right, at its option, to control and direct the defense to any settlement of such claim, demand, or action.
    3. \r\n
\r\n

Any notice concerning indemnification shall, with respect to DBP, be sent in accordance with Section 10(c) of this Agreement. With respect to Your Registrar, notices regarding indemnification should be sent in accordance with the notification provisions contained in Your Registrar's Domain Name Registration Agreement.

\r\n

f. Term of Agreement; Survival

\r\n

The terms of this Agreement shall continue in full force and effect as long as DBP is the Registrant for any domain name on Your behalf. Sections 5 (Communications Forwarding), 6 (Limitation of Liability), 7 (Indemnity), 8 (Warranty Disclaimer) and 10 (Miscellaneous Provisions) shall survive any termination or expiration of this Agreement.

\n
\n
\n\nRevised: 10/25/17
\nCopyright © 2003-2017 All Rights Reserved.\n\n
\n
", + "url": "http://www.secureserver.net/agreements/ShowDoc.aspx?pageid=domain_nameproxy&pl_id=510456" + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListTopLevelDomains.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListTopLevelDomains.json new file mode 100644 index 000000000000..7ebfa70d15d1 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/ListTopLevelDomains.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/com", + "name": "com", + "type": "Microsoft.DomainRegistration/topLevelDomains", + "properties": { + "privacy": true + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/net", + "name": "net", + "type": "Microsoft.DomainRegistration/topLevelDomains", + "properties": { + "privacy": true + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/co.uk", + "name": "co.uk", + "type": "Microsoft.DomainRegistration/topLevelDomains", + "properties": { + "privacy": false + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/org", + "name": "org", + "type": "Microsoft.DomainRegistration/topLevelDomains", + "properties": { + "privacy": true + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/nl", + "name": "nl", + "type": "Microsoft.DomainRegistration/topLevelDomains", + "properties": { + "privacy": true + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/in", + "name": "in", + "type": "Microsoft.DomainRegistration/topLevelDomains", + "properties": { + "privacy": false + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/biz", + "name": "biz", + "type": "Microsoft.DomainRegistration/topLevelDomains", + "properties": { + "privacy": true + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/org.uk", + "name": "org.uk", + "type": "Microsoft.DomainRegistration/topLevelDomains", + "properties": { + "privacy": false + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/co.in", + "name": "co.in", + "type": "Microsoft.DomainRegistration/topLevelDomains", + "properties": { + "privacy": false + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/RenewDomain.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/RenewDomain.json new file mode 100644 index 000000000000..43b4eec13f8e --- /dev/null +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/RenewDomain.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "3dddfa4f-cedf-4dc0-ba29-b6d1a69ab545", + "resourceGroupName": "RG", + "domainName": "example.com" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/TransferOutDomain.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/TransferOutDomain.json new file mode 100644 index 000000000000..6b59958433c7 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/TransferOutDomain.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "domainName": "example.com", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.DomainRegistration/domains/example.com", + "name": "example.com", + "type": "Microsoft.DomainRegistration/domains", + "location": "global", + "tags": {}, + "properties": { + "authCode": "exampleAuthCode", + "registrationStatus": "Active", + "provisioningState": "Succeeded", + "nameServers": [ + "ns01.ote.domaincontrol.com", + "ns02.ote.domaincontrol.com" + ], + "privacy": false, + "createdTime": "2021-09-10T19:30:53Z", + "expirationTime": "2022-09-10T19:30:53Z", + "autoRenew": true, + "readyForDnsRecordManagement": true, + "managedHostNames": [], + "domainNotRenewableReasons": [ + "ExpirationNotInRenewalTimeRange" + ], + "dnsType": "DefaultDomainRegistrarDns", + "consent": { + "agreementKeys": [ + "agreementKey1" + ], + "agreedBy": "192.0.2.1", + "agreedAt": "2021-09-10T19:30:53Z" + }, + "contactTech": { + "email": "tech@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Tech", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactBilling": { + "email": "billing@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Billing", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactAdmin": { + "email": "admin@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Admin", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactRegistrant": { + "email": "registrant@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Registrant", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + } + } + } + }, + "400": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/UpdateAppServiceDomain.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/UpdateAppServiceDomain.json new file mode 100644 index 000000000000..74e16a72bb6c --- /dev/null +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/UpdateAppServiceDomain.json @@ -0,0 +1,301 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "domainName": "example.com", + "api-version": "2024-04-01", + "domain": { + "properties": { + "authCode": "exampleAuthCode", + "privacy": false, + "autoRenew": true, + "dnsType": "DefaultDomainRegistrarDns", + "consent": { + "agreementKeys": [ + "agreementKey1" + ], + "agreedBy": "192.0.2.1", + "agreedAt": "2021-09-10T19:30:53Z" + }, + "contactTech": { + "email": "tech@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Tech", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactBilling": { + "email": "billing@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Billing", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactAdmin": { + "email": "admin@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Admin", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactRegistrant": { + "email": "registrant@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Registrant", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.DomainRegistration/domains/example.com", + "name": "example.com", + "type": "Microsoft.DomainRegistration/domains", + "location": "global", + "tags": {}, + "properties": { + "authCode": "exampleAuthCode", + "registrationStatus": "Active", + "provisioningState": "Succeeded", + "nameServers": [ + "ns01.ote.domaincontrol.com", + "ns02.ote.domaincontrol.com" + ], + "privacy": false, + "createdTime": "2021-09-10T19:30:53Z", + "expirationTime": "2022-09-10T19:30:53Z", + "autoRenew": true, + "readyForDnsRecordManagement": true, + "managedHostNames": [], + "domainNotRenewableReasons": [ + "ExpirationNotInRenewalTimeRange" + ], + "dnsType": "DefaultDomainRegistrarDns", + "consent": { + "agreementKeys": [ + "agreementKey1" + ], + "agreedBy": "192.0.2.1", + "agreedAt": "2021-09-10T19:30:53Z" + }, + "contactTech": { + "email": "tech@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Tech", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactBilling": { + "email": "billing@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Billing", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactAdmin": { + "email": "admin@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Admin", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactRegistrant": { + "email": "registrant@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Registrant", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + } + } + } + }, + "202": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.DomainRegistration/domains/example.com", + "name": "example.com", + "type": "Microsoft.DomainRegistration/domains", + "location": "global", + "tags": {}, + "properties": { + "authCode": "exampleAuthCode", + "registrationStatus": "Active", + "provisioningState": "Succeeded", + "nameServers": [ + "ns01.ote.domaincontrol.com", + "ns02.ote.domaincontrol.com" + ], + "privacy": false, + "createdTime": "2021-09-10T19:30:53Z", + "expirationTime": "2022-09-10T19:30:53Z", + "autoRenew": true, + "readyForDnsRecordManagement": true, + "managedHostNames": [], + "domainNotRenewableReasons": [ + "ExpirationNotInRenewalTimeRange" + ], + "dnsType": "DefaultDomainRegistrarDns", + "consent": { + "agreementKeys": [ + "agreementKey1" + ], + "agreedBy": "192.0.2.1", + "agreedAt": "2021-09-10T19:30:53Z" + }, + "contactTech": { + "email": "tech@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Tech", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactBilling": { + "email": "billing@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Billing", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactAdmin": { + "email": "admin@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Admin", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + }, + "contactRegistrant": { + "email": "registrant@email.com", + "fax": "1-245-534-2242", + "nameFirst": "John", + "nameLast": "Doe", + "nameMiddle": "", + "jobTitle": "Registrant", + "organization": "Microsoft Inc.", + "phone": "1-245-534-2242", + "addressMailing": { + "address1": "3400 State St", + "city": "Chicago", + "state": "IL", + "country": "United States", + "postalCode": "67098" + } + } + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/UpdateAppServiceDomainOwnershipIdentifier.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/UpdateAppServiceDomainOwnershipIdentifier.json new file mode 100644 index 000000000000..74ecfe9a8d31 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/UpdateAppServiceDomainOwnershipIdentifier.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "domainName": "example.com", + "name": "SampleOwnershipId", + "api-version": "2024-04-01", + "domainOwnershipIdentifier": { + "properties": { + "ownershipId": "SampleOwnershipId" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.DomainRegistration/domains/example.com/domainownershipidentifiers/SampleOwnershipId", + "name": "SampleOwnershipId", + "type": "Microsoft.DomainRegistration/domains/domainownershipidentifiers", + "properties": { + "ownershipId": "SampleOwnershipId" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/CommonDefinitions.json b/specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/CommonDefinitions.json index 8cfe5e38eb1a..2a8279ef091c 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/CommonDefinitions.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/CommonDefinitions.json @@ -3007,6 +3007,10 @@ "description": "client certificate authentication comma-separated exclusion paths", "type": "string" }, + "endToEndEncryptionEnabled": { + "description": "Whether to use end to end encryption between the FrontEnd and the Worker", + "type": "boolean" + }, "hostNamesDisabled": { "description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.", "type": "boolean" diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/AppServiceEnvironments.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/AppServiceEnvironments.json new file mode 100644 index 000000000000..538781f73efc --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/AppServiceEnvironments.json @@ -0,0 +1,3324 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "AppServiceEnvironments API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/hostingEnvironments": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get all App Service Environments for a subscription.", + "description": "Description for Get all App Service Environments for a subscription.", + "operationId": "AppServiceEnvironments_List", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AppServiceEnvironmentCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get all App Service Environments for a subscription.": { + "$ref": "./examples/AppServiceEnvironments_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get all App Service Environments in a resource group.", + "description": "Description for Get all App Service Environments in a resource group.", + "operationId": "AppServiceEnvironments_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AppServiceEnvironmentCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get all App Service Environments in a resource group.": { + "$ref": "./examples/AppServiceEnvironments_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get the properties of an App Service Environment.", + "description": "Description for Get the properties of an App Service Environment.", + "operationId": "AppServiceEnvironments_Get", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AppServiceEnvironmentResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get the properties of an App Service Environment.": { + "$ref": "./examples/AppServiceEnvironments_Get.json" + } + } + }, + "put": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Create or update an App Service Environment.", + "description": "Description for Create or update an App Service Environment.", + "operationId": "AppServiceEnvironments_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "name": "hostingEnvironmentEnvelope", + "in": "body", + "description": "Configuration details of the App Service Environment.", + "required": true, + "schema": { + "$ref": "#/definitions/AppServiceEnvironmentResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AppServiceEnvironmentResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/AppServiceEnvironmentResource" + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "$ref": "#/definitions/AppServiceEnvironmentResource" + }, + "headers": { + "location": { + "description": "Location header for asynchronous response.", + "type": "string" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update an App Service Environment.": { + "$ref": "./examples/AppServiceEnvironments_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Delete an App Service Environment.", + "description": "Description for Delete an App Service Environment.", + "operationId": "AppServiceEnvironments_Delete", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "name": "forceDelete", + "in": "query", + "description": "Specify true to force the deletion even if the App Service Environment contains resources. The default is false.", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Operation is in progress." + }, + "204": { + "description": "App Service Environment does not exist" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete an App Service Environment.": { + "$ref": "./examples/AppServiceEnvironments_Delete.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Create or update an App Service Environment.", + "description": "Description for Create or update an App Service Environment.", + "operationId": "AppServiceEnvironments_Update", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "name": "hostingEnvironmentEnvelope", + "in": "body", + "description": "Configuration details of the App Service Environment.", + "required": true, + "schema": { + "$ref": "#/definitions/AppServiceEnvironmentPatchResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AppServiceEnvironmentResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/AppServiceEnvironmentResource" + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "$ref": "#/definitions/AppServiceEnvironmentResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update an App Service Environment.": { + "$ref": "./examples/AppServiceEnvironments_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get the used, available, and total worker capacity an App Service Environment.", + "description": "Description for Get the used, available, and total worker capacity an App Service Environment.", + "operationId": "AppServiceEnvironments_ListCapacities", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StampCapacityCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get the used, available, and total worker capacity an App Service Environment.": { + "$ref": "./examples/AppServiceEnvironments_ListCapacities.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get IP addresses assigned to an App Service Environment.", + "description": "Description for Get IP addresses assigned to an App Service Environment.", + "operationId": "AppServiceEnvironments_GetVipInfo", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AddressResponse" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get IP addresses assigned to an App Service Environment.": { + "$ref": "./examples/AppServiceEnvironments_GetVipInfo.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/changeVirtualNetwork": { + "post": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Move an App Service Environment to a different VNET.", + "description": "Description for Move an App Service Environment to a different VNET.", + "operationId": "AppServiceEnvironments_ChangeVnet", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "name": "vnetInfo", + "in": "body", + "description": "Details for the new virtual network.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VirtualNetworkProfile" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection" + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Move an App Service Environment to a different VNET.": { + "$ref": "./examples/AppServiceEnvironments_ChangeVnet.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get Custom Dns Suffix configuration of an App Service Environment", + "operationId": "AppServiceEnvironments_GetAseCustomDnsSuffixConfiguration", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/CustomDnsSuffixConfiguration" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get ASE custom DNS suffix configuration": { + "$ref": "./examples/GetAseCustomDnsSuffixConfiguration.json" + } + } + }, + "put": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Update Custom Dns Suffix configuration of an App Service Environment", + "operationId": "AppServiceEnvironments_UpdateAseCustomDnsSuffixConfiguration", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "name": "customDnsSuffixConfiguration", + "in": "body", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/CustomDnsSuffixConfiguration" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/CustomDnsSuffixConfiguration" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Update ASE custom DNS suffix configuration": { + "$ref": "./examples/UpdateAseCustomDnsSuffixConfiguration.json" + } + } + }, + "delete": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Delete Custom Dns Suffix configuration of an App Service Environment", + "operationId": "AppServiceEnvironments_DeleteAseCustomDnsSuffixConfiguration", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "type": "object" + } + }, + "204": { + "description": "No content.", + "schema": { + "type": "object" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete ASE custom DNS suffix configuration": { + "$ref": "./examples/DeleteAseCustomDnsSuffixConfiguration.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/networking": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get networking configuration of an App Service Environment", + "description": "Description for Get networking configuration of an App Service Environment", + "operationId": "AppServiceEnvironments_GetAseV3NetworkingConfiguration", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AseV3NetworkingConfiguration" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get networking configuration of an App Service Environment.": { + "$ref": "./examples/AppServiceEnvironments_GetAseV3NetworkingConfiguration.json" + } + } + }, + "put": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Update networking configuration of an App Service Environment", + "description": "Description for Update networking configuration of an App Service Environment", + "operationId": "AppServiceEnvironments_UpdateAseNetworkingConfiguration", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "name": "aseNetworkingConfiguration", + "in": "body", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AseV3NetworkingConfiguration" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AseV3NetworkingConfiguration" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Update networking configuration of an App Service Environment.": { + "$ref": "./examples/AppServiceEnvironments_UpdateAseNetworkingConfiguration.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get diagnostic information for an App Service Environment.", + "description": "Description for Get diagnostic information for an App Service Environment.", + "operationId": "AppServiceEnvironments_ListDiagnostics", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/HostingEnvironmentDiagnostics" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get diagnostic information for an App Service Environment.": { + "$ref": "./examples/AppServiceEnvironments_ListDiagnostics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName}": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get a diagnostics item for an App Service Environment.", + "description": "Description for Get a diagnostics item for an App Service Environment.", + "operationId": "AppServiceEnvironments_GetDiagnosticsItem", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "name": "diagnosticsName", + "in": "path", + "description": "Name of the diagnostics item.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HostingEnvironmentDiagnostics" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a diagnostics item for an App Service Environment.": { + "$ref": "./examples/AppServiceEnvironments_GetDiagnosticsItem.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/inboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get the network endpoints of all inbound dependencies of an App Service Environment.", + "description": "Description for Get the network endpoints of all inbound dependencies of an App Service Environment.", + "operationId": "AppServiceEnvironments_GetInboundNetworkDependenciesEndpoints", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/InboundEnvironmentEndpointCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get the network endpoints of all inbound dependencies of an App Service Environment.": { + "$ref": "./examples/GetInboundNetworkDependenciesEndpoints.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get all multi-role pools.", + "description": "Description for Get all multi-role pools.", + "operationId": "AppServiceEnvironments_ListMultiRolePools", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkerPoolCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get all multi-role pools.": { + "$ref": "./examples/AppServiceEnvironments_ListMultiRolePools.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get properties of a multi-role pool.", + "description": "Description for Get properties of a multi-role pool.", + "operationId": "AppServiceEnvironments_GetMultiRolePool", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkerPoolResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get properties of a multi-role pool.": { + "$ref": "./examples/AppServiceEnvironments_GetMultiRolePool.json" + } + } + }, + "put": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Create or update a multi-role pool.", + "description": "Description for Create or update a multi-role pool.", + "operationId": "AppServiceEnvironments_CreateOrUpdateMultiRolePool", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "name": "multiRolePoolEnvelope", + "in": "body", + "description": "Properties of the multi-role pool.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkerPoolResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/WorkerPoolResource" + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "$ref": "#/definitions/WorkerPoolResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a multi-role pool.": { + "$ref": "./examples/AppServiceEnvironments_CreateOrUpdateMultiRolePool.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Create or update a multi-role pool.", + "description": "Description for Create or update a multi-role pool.", + "operationId": "AppServiceEnvironments_UpdateMultiRolePool", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "name": "multiRolePoolEnvelope", + "in": "body", + "description": "Properties of the multi-role pool.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkerPoolResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/WorkerPoolResource" + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "$ref": "#/definitions/WorkerPoolResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a multi-role pool.": { + "$ref": "./examples/AppServiceEnvironments_CreateOrUpdateMultiRolePool.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metricdefinitions": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.", + "description": "Description for Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.", + "operationId": "AppServiceEnvironments_ListMultiRolePoolInstanceMetricDefinitions", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "name": "instance", + "in": "path", + "description": "Name of the instance in the multi-role pool.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceMetricDefinitionCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.": { + "$ref": "./examples/AppServiceEnvironments_ListMultiRolePoolInstanceMetricDefinitions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metricdefinitions": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get metric definitions for a multi-role pool of an App Service Environment.", + "description": "Description for Get metric definitions for a multi-role pool of an App Service Environment.", + "operationId": "AppServiceEnvironments_ListMultiRoleMetricDefinitions", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceMetricDefinitionCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get metric definitions for a multi-role pool of an App Service Environment.": { + "$ref": "./examples/AppServiceEnvironments_ListMultiRoleMetricDefinitions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get available SKUs for scaling a multi-role pool.", + "description": "Description for Get available SKUs for scaling a multi-role pool.", + "operationId": "AppServiceEnvironments_ListMultiRolePoolSkus", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SkuInfoCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get available SKUs for scaling a multi-role pool.": { + "$ref": "./examples/AppServiceEnvironments_ListMultiRolePoolSkus.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/testUpgradeAvailableNotification": { + "post": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Send a test notification that an upgrade is available for this App Service Environment.", + "operationId": "AppServiceEnvironments_TestUpgradeAvailableNotification", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Send a test notification that an upgrade is available for this App Service Environment": { + "$ref": "./examples/AppServiceEnvironments_TestUpgradeAvailableNotification.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/upgrade": { + "post": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Initiate an upgrade of an App Service Environment if one is available.", + "description": "Description for Initiate an upgrade of an App Service Environment if one is available.", + "operationId": "AppServiceEnvironments_Upgrade", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Operation is in progress." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Initiate an upgrade on an App Service Environment": { + "$ref": "./examples/AppServiceEnvironments_Upgrade.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/usages": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get usage metrics for a multi-role pool of an App Service Environment.", + "description": "Description for Get usage metrics for a multi-role pool of an App Service Environment.", + "operationId": "AppServiceEnvironments_ListMultiRoleUsages", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UsageCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get usage metrics for a multi-role pool of an App Service Environment.": { + "$ref": "./examples/AppServiceEnvironments_ListMultiRoleUsages.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "List all currently running operations on the App Service Environment.", + "description": "Description for List all currently running operations on the App Service Environment.", + "operationId": "AppServiceEnvironments_ListOperations", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/Operation" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List all currently running operations on the App Service Environment.": { + "$ref": "./examples/AppServiceEnvironments_ListOperations.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get the network endpoints of all outbound dependencies of an App Service Environment.", + "description": "Description for Get the network endpoints of all outbound dependencies of an App Service Environment.", + "operationId": "AppServiceEnvironments_GetOutboundNetworkDependenciesEndpoints", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get the network endpoints of all outbound dependencies of an App Service Environment.": { + "$ref": "./examples/GetOutboundNetworkDependenciesEndpoints.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Gets the list of private endpoints associated with a hosting environment", + "description": "Description for Gets the list of private endpoints associated with a hosting environment", + "operationId": "AppServiceEnvironments_GetPrivateEndpointConnectionList", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PrivateEndpointConnectionCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets the list of private endpoints associated with a hosting environment.": { + "$ref": "./examples/AppServiceEnvironments_GetPrivateEndpointConnectionList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Gets a private endpoint connection", + "description": "Description for Gets a private endpoint connection", + "operationId": "AppServiceEnvironments_GetPrivateEndpointConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets a private endpoint connection.": { + "$ref": "./examples/AppServiceEnvironments_GetPrivateEndpointConnection.json" + } + } + }, + "put": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Approves or rejects a private endpoint connection", + "description": "Description for Approves or rejects a private endpoint connection", + "operationId": "AppServiceEnvironments_ApproveOrRejectPrivateEndpointConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointWrapper", + "in": "body", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource" + } + }, + "202": { + "description": "Asynchronous operation in progress.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Approves or rejects a private endpoint connection.": { + "$ref": "./examples/AppServiceEnvironments_ApproveOrRejectPrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Deletes a private endpoint connection", + "description": "Description for Deletes a private endpoint connection", + "operationId": "AppServiceEnvironments_DeletePrivateEndpointConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Asynchronous operation in progress.", + "schema": { + "type": "object" + } + }, + "204": { + "description": "No content.", + "schema": { + "type": "object" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Deletes a private endpoint connection.": { + "$ref": "./examples/AppServiceEnvironments_DeletePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateLinkResources": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Gets the private link resources", + "description": "Description for Gets the private link resources", + "operationId": "AppServiceEnvironments_GetPrivateLinkResources", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PrivateLinkResourcesWrapper" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets the private link resources.": { + "$ref": "./examples/AppServiceEnvironments_GetPrivateLinkResources.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot": { + "post": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Reboot all machines in an App Service Environment.", + "description": "Description for Reboot all machines in an App Service Environment.", + "operationId": "AppServiceEnvironments_Reboot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Asynchronous operation in progress." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Reboot all machines in an App Service Environment.": { + "$ref": "./examples/AppServiceEnvironments_Reboot.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/resume": { + "post": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Resume an App Service Environment.", + "description": "Description for Resume an App Service Environment.", + "operationId": "AppServiceEnvironments_Resume", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection" + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Resume an App Service Environment.": { + "$ref": "./examples/AppServiceEnvironments_Resume.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get all App Service plans in an App Service Environment.", + "description": "Description for Get all App Service plans in an App Service Environment.", + "operationId": "AppServiceEnvironments_ListAppServicePlans", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AppServicePlanCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get all App Service plans in an App Service Environment.": { + "$ref": "./examples/AppServiceEnvironments_ListAppServicePlans.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get all apps in an App Service Environment.", + "description": "Description for Get all apps in an App Service Environment.", + "operationId": "AppServiceEnvironments_ListWebApps", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "name": "propertiesToInclude", + "in": "query", + "description": "Comma separated list of app properties to include.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get all apps in an App Service Environment.": { + "$ref": "./examples/AppServiceEnvironments_ListWebApps.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/suspend": { + "post": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Suspend an App Service Environment.", + "description": "Description for Suspend an App Service Environment.", + "operationId": "AppServiceEnvironments_Suspend", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection" + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Suspend an App Service Environment.": { + "$ref": "./examples/AppServiceEnvironments_Suspend.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get global usage metrics of an App Service Environment.", + "description": "Description for Get global usage metrics of an App Service Environment.", + "operationId": "AppServiceEnvironments_ListUsages", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.", + "type": "string", + "x-ms-skip-url-encoding": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/CsmUsageQuotaCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get global usage metrics of an App Service Environment.": { + "$ref": "./examples/AppServiceEnvironments_ListUsages.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get all worker pools of an App Service Environment.", + "description": "Description for Get all worker pools of an App Service Environment.", + "operationId": "AppServiceEnvironments_ListWorkerPools", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkerPoolCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get all worker pools of an App Service Environment.": { + "$ref": "./examples/AppServiceEnvironments_ListWorkerPools.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get properties of a worker pool.", + "description": "Description for Get properties of a worker pool.", + "operationId": "AppServiceEnvironments_GetWorkerPool", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "name": "workerPoolName", + "in": "path", + "description": "Name of the worker pool.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkerPoolResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get properties of a worker pool.": { + "$ref": "./examples/AppServiceEnvironments_GetWorkerPool.json" + } + } + }, + "put": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Create or update a worker pool.", + "description": "Description for Create or update a worker pool.", + "operationId": "AppServiceEnvironments_CreateOrUpdateWorkerPool", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "name": "workerPoolName", + "in": "path", + "description": "Name of the worker pool.", + "required": true, + "type": "string" + }, + { + "name": "workerPoolEnvelope", + "in": "body", + "description": "Properties of the worker pool.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkerPoolResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/WorkerPoolResource" + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "$ref": "#/definitions/WorkerPoolResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get properties of a worker pool.": { + "$ref": "./examples/AppServiceEnvironments_CreateOrUpdateWorkerPool.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Create or update a worker pool.", + "description": "Description for Create or update a worker pool.", + "operationId": "AppServiceEnvironments_UpdateWorkerPool", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "name": "workerPoolName", + "in": "path", + "description": "Name of the worker pool.", + "required": true, + "type": "string" + }, + { + "name": "workerPoolEnvelope", + "in": "body", + "description": "Properties of the worker pool.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkerPoolResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/WorkerPoolResource" + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "$ref": "#/definitions/WorkerPoolResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get properties of a worker pool.": { + "$ref": "./examples/AppServiceEnvironments_CreateOrUpdateWorkerPool.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metricdefinitions": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get metric definitions for a specific instance of a worker pool of an App Service Environment.", + "description": "Description for Get metric definitions for a specific instance of a worker pool of an App Service Environment.", + "operationId": "AppServiceEnvironments_ListWorkerPoolInstanceMetricDefinitions", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "name": "workerPoolName", + "in": "path", + "description": "Name of the worker pool.", + "required": true, + "type": "string" + }, + { + "name": "instance", + "in": "path", + "description": "Name of the instance in the worker pool.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceMetricDefinitionCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get metric definitions for a specific instance of a worker pool of an App Service Environment.": { + "$ref": "./examples/AppServiceEnvironments_ListWorkerPoolInstanceMetricDefinitions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get metric definitions for a worker pool of an App Service Environment.", + "description": "Description for Get metric definitions for a worker pool of an App Service Environment.", + "operationId": "AppServiceEnvironments_ListWebWorkerMetricDefinitions", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "name": "workerPoolName", + "in": "path", + "description": "Name of the worker pool.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceMetricDefinitionCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get metric definitions for a worker pool of an App Service Environment.": { + "$ref": "./examples/AppServiceEnvironments_ListWebWorkerMetricDefinitions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/skus": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get available SKUs for scaling a worker pool.", + "description": "Description for Get available SKUs for scaling a worker pool.", + "operationId": "AppServiceEnvironments_ListWorkerPoolSkus", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "name": "workerPoolName", + "in": "path", + "description": "Name of the worker pool.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SkuInfoCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get available SKUs for scaling a worker pool.": { + "$ref": "./examples/AppServiceEnvironments_ListWorkerPoolSkus.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/usages": { + "get": { + "tags": [ + "AppServiceEnvironments" + ], + "summary": "Get usage metrics for a worker pool of an App Service Environment.", + "description": "Description for Get usage metrics for a worker pool of an App Service Environment.", + "operationId": "AppServiceEnvironments_ListWebWorkerUsages", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Environment.", + "required": true, + "type": "string" + }, + { + "name": "workerPoolName", + "in": "path", + "description": "Name of the worker pool.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UsageCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get usage metrics for a worker pool of an App Service Environment.": { + "$ref": "./examples/AppServiceEnvironments_ListWebWorkerUsages.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AddressResponse": { + "description": "Describes main public IP address and any extra virtual IPs.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "AddressResponse resource specific properties", + "type": "object", + "properties": { + "serviceIpAddress": { + "description": "Main public virtual IP.", + "type": "string" + }, + "internalIpAddress": { + "description": "Virtual Network internal IP address of the App Service Environment if it is in internal load-balancing mode.", + "type": "string" + }, + "outboundIpAddresses": { + "description": "IP addresses appearing on outbound connections.", + "type": "array", + "items": { + "type": "string" + } + }, + "vipMappings": { + "description": "Additional virtual IPs.", + "type": "array", + "items": { + "$ref": "#/definitions/VirtualIPMapping" + }, + "x-ms-identifiers": [ + "virtualIP" + ] + } + }, + "x-ms-client-flatten": true + } + } + }, + "AppServiceEnvironmentCollection": { + "description": "Collection of App Service Environments.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/AppServiceEnvironmentResource" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "AppServiceEnvironmentPatchResource": { + "description": "ARM resource for a app service environment.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "$ref": "./CommonDefinitions.json#/definitions/AppServiceEnvironment", + "description": "Core resource properties", + "type": "object", + "x-ms-client-flatten": true + } + } + }, + "AppServiceEnvironmentResource": { + "description": "App Service Environment ARM resource.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "./CommonDefinitions.json#/definitions/AppServiceEnvironment", + "description": "Core resource properties", + "type": "object", + "x-ms-client-flatten": true + } + } + }, + "EndpointDependency": { + "description": "A domain name that a service is reached at, including details of the current connection status.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name of the dependency.", + "type": "string" + }, + "endpointDetails": { + "description": "The IP Addresses and Ports used when connecting to DomainName.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDetail" + }, + "x-ms-identifiers": [ + "ipAddress", + "port" + ] + } + } + }, + "EndpointDetail": { + "description": "Current TCP connectivity information from the App Service Environment to a single endpoint.", + "type": "object", + "properties": { + "ipAddress": { + "description": "An IP Address that Domain Name currently resolves to.", + "type": "string" + }, + "port": { + "format": "int32", + "description": "The port an endpoint is connected to.", + "type": "integer" + }, + "latency": { + "format": "double", + "description": "The time in milliseconds it takes for a TCP connection to be created from the App Service Environment to this IpAddress at this Port.", + "type": "number" + }, + "isAccessible": { + "description": "Whether it is possible to create a TCP connection from the App Service Environment to this IpAddress at this Port.", + "type": "boolean" + } + } + }, + "HostingEnvironmentDiagnostics": { + "description": "Diagnostics for an App Service Environment.", + "type": "object", + "properties": { + "name": { + "description": "Name/identifier of the diagnostics.", + "type": "string" + }, + "diagnosticsOutput": { + "description": "Diagnostics output.", + "type": "string" + } + } + }, + "InboundEnvironmentEndpoint": { + "description": "The IP Addresses and Ports that require inbound network access to and within the subnet of the App Service Environment.", + "type": "object", + "properties": { + "description": { + "description": "Short text describing the purpose of the network traffic.", + "type": "string" + }, + "endpoints": { + "description": "The IP addresses that network traffic will originate from in cidr notation.", + "type": "array", + "items": { + "type": "string" + } + }, + "ports": { + "description": "The ports that network traffic will arrive to the App Service Environment at.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "InboundEnvironmentEndpointCollection": { + "description": "Collection of Inbound Environment Endpoints", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/InboundEnvironmentEndpoint" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "OutboundEnvironmentEndpoint": { + "description": "Endpoints accessed for a common purpose that the App Service Environment requires outbound network access to.", + "type": "object", + "properties": { + "category": { + "description": "The type of service accessed by the App Service Environment, e.g., Azure Storage, Azure SQL Database, and Azure Active Directory.", + "type": "string" + }, + "endpoints": { + "description": "The endpoints that the App Service Environment reaches the service at.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDependency" + }, + "x-ms-identifiers": [ + "domainName" + ] + } + } + }, + "OutboundEnvironmentEndpointCollection": { + "description": "Collection of Outbound Environment Endpoints", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + }, + "x-ms-identifiers": [ + "category" + ] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ResourceMetricAvailability": { + "description": "Metrics availability and retention.", + "type": "object", + "properties": { + "timeGrain": { + "description": "Time grain .", + "type": "string", + "readOnly": true + }, + "retention": { + "description": "Retention period for the current time grain.", + "type": "string", + "readOnly": true + } + } + }, + "ResourceMetricDefinition": { + "description": "Metadata for the metrics.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "ResourceMetricDefinition resource specific properties", + "type": "object", + "properties": { + "unit": { + "description": "Unit of the metric.", + "type": "string", + "readOnly": true + }, + "primaryAggregationType": { + "description": "Primary aggregation type.", + "type": "string", + "readOnly": true + }, + "metricAvailabilities": { + "description": "List of time grains supported for the metric together with retention period.", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceMetricAvailability" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "resourceUri": { + "description": "Resource URI.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Resource metric definition properties.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "ResourceMetricDefinitionCollection": { + "description": "Collection of metric definitions.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceMetricDefinition" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "SkuInfo": { + "description": "SKU discovery information.", + "type": "object", + "properties": { + "resourceType": { + "description": "Resource type that this SKU applies to.", + "type": "string" + }, + "sku": { + "$ref": "./CommonDefinitions.json#/definitions/SkuDescription", + "description": "Name and tier of the SKU." + }, + "capacity": { + "$ref": "./CommonDefinitions.json#/definitions/SkuCapacity", + "description": "Min, max, and default scale values of the SKU." + } + } + }, + "SkuInfoCollection": { + "description": "Collection of SKU information.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SkuInfo" + }, + "x-ms-identifiers": [ + "/sku/name", + "resourceType" + ] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "StampCapacity": { + "description": "Stamp capacity information.", + "type": "object", + "properties": { + "name": { + "description": "Name of the stamp.", + "type": "string" + }, + "availableCapacity": { + "format": "int64", + "description": "Available capacity (# of machines, bytes of storage etc...).", + "type": "integer" + }, + "totalCapacity": { + "format": "int64", + "description": "Total capacity (# of machines, bytes of storage etc...).", + "type": "integer" + }, + "unit": { + "description": "Name of the unit.", + "type": "string" + }, + "computeMode": { + "description": "Shared/dedicated workers.", + "enum": [ + "Shared", + "Dedicated", + "Dynamic" + ], + "type": "string", + "x-ms-enum": { + "name": "ComputeModeOptions", + "modelAsString": false + } + }, + "workerSize": { + "description": "Size of the machines.", + "enum": [ + "Small", + "Medium", + "Large", + "D1", + "D2", + "D3", + "SmallV3", + "MediumV3", + "LargeV3", + "NestedSmall", + "NestedSmallLinux", + "Default" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkerSizeOptions", + "modelAsString": false + } + }, + "workerSizeId": { + "format": "int32", + "description": "Size ID of machines: \n0 - Small\n1 - Medium\n2 - Large", + "type": "integer" + }, + "excludeFromCapacityAllocation": { + "description": "If true, it includes basic apps.\nBasic apps are not used for capacity allocation.", + "type": "boolean" + }, + "isApplicableForAllComputeModes": { + "description": "true if capacity is applicable for all apps; otherwise, false.", + "type": "boolean" + }, + "siteMode": { + "description": "Shared or Dedicated.", + "type": "string" + }, + "isLinux": { + "description": "Is this a linux stamp capacity", + "type": "boolean" + } + } + }, + "StampCapacityCollection": { + "description": "Collection of stamp capacities.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/StampCapacity" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "Usage": { + "description": "Usage of the quota resource.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "Usage resource specific properties", + "type": "object", + "properties": { + "displayName": { + "description": "Friendly name shown in the UI.", + "type": "string", + "readOnly": true + }, + "resourceName": { + "description": "Name of the quota resource.", + "type": "string", + "readOnly": true + }, + "unit": { + "description": "Units of measurement for the quota resource.", + "type": "string", + "readOnly": true + }, + "currentValue": { + "format": "int64", + "description": "The current value of the resource counter.", + "type": "integer", + "readOnly": true + }, + "limit": { + "format": "int64", + "description": "The resource limit.", + "type": "integer", + "readOnly": true + }, + "nextResetTime": { + "format": "date-time", + "description": "Next reset time for the resource counter.", + "type": "string", + "readOnly": true + }, + "computeMode": { + "description": "Compute mode used for this usage.", + "enum": [ + "Shared", + "Dedicated", + "Dynamic" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ComputeModeOptions", + "modelAsString": false + } + }, + "siteMode": { + "description": "Site mode used for this usage.", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "UsageCollection": { + "description": "Collection of usages.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "VirtualIPMapping": { + "description": "Virtual IP mapping.", + "type": "object", + "properties": { + "virtualIP": { + "description": "Virtual IP address.", + "type": "string" + }, + "internalHttpPort": { + "format": "int32", + "description": "Internal HTTP port.", + "type": "integer" + }, + "internalHttpsPort": { + "format": "int32", + "description": "Internal HTTPS port.", + "type": "integer" + }, + "inUse": { + "description": "Is virtual IP mapping in use.", + "type": "boolean" + }, + "serviceName": { + "description": "name of the service that virtual IP is assigned to", + "type": "string" + } + } + }, + "WorkerPool": { + "description": "Worker pool of an App Service Environment.", + "type": "object", + "properties": { + "workerSizeId": { + "format": "int32", + "description": "Worker size ID for referencing this worker pool.", + "type": "integer" + }, + "computeMode": { + "description": "Shared or dedicated app hosting.", + "enum": [ + "Shared", + "Dedicated", + "Dynamic" + ], + "type": "string", + "x-ms-enum": { + "name": "ComputeModeOptions", + "modelAsString": false + } + }, + "workerSize": { + "description": "VM size of the worker pool instances.", + "type": "string" + }, + "workerCount": { + "format": "int32", + "description": "Number of instances in the worker pool.", + "type": "integer" + }, + "instanceNames": { + "description": "Names of all instances in the worker pool (read only).", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "WorkerPoolCollection": { + "description": "Collection of worker pools.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/WorkerPoolResource" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "WorkerPoolResource": { + "description": "Worker pool of an App Service Environment ARM resource.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WorkerPool", + "description": "Core resource properties", + "x-ms-client-flatten": true + }, + "sku": { + "$ref": "./CommonDefinitions.json#/definitions/SkuDescription" + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group to which the resource belongs.", + "required": true, + "type": "string", + "maxLength": 90, + "minLength": 1, + "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$", + "x-ms-parameter-location": "method" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API Version", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + } + }, + "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/web/resource-manager/Microsoft.Web/stable/2024-04-01/AppServicePlans.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/AppServicePlans.json new file mode 100644 index 000000000000..af3367d4e8cc --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/AppServicePlans.json @@ -0,0 +1,1776 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "AppServicePlans API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/serverfarms": { + "get": { + "tags": [ + "AppServicePlans" + ], + "summary": "Get all App Service plans for a subscription.", + "description": "Description for Get all App Service plans for a subscription.", + "operationId": "AppServicePlans_List", + "parameters": [ + { + "name": "detailed", + "in": "query", + "description": "Specify true to return all App Service plan properties. The default is false, which returns a subset of the properties.\n Retrieval of all properties may increase the API latency.", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AppServicePlanCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List App Service plans": { + "$ref": "./examples/ListAppServicePlans.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms": { + "get": { + "tags": [ + "AppServicePlans" + ], + "summary": "Get all App Service plans in a resource group.", + "description": "Description for Get all App Service plans in a resource group.", + "operationId": "AppServicePlans_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AppServicePlanCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List App Service plans by resource group": { + "$ref": "./examples/ListAppServicePlansByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}": { + "get": { + "tags": [ + "AppServicePlans" + ], + "summary": "Get an App Service plan.", + "description": "Description for Get an App Service plan.", + "operationId": "AppServicePlans_Get", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service plan.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AppServicePlan" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get App Service plan": { + "$ref": "./examples/GetAppServicePlan.json" + } + } + }, + "put": { + "tags": [ + "AppServicePlans" + ], + "summary": "Creates or updates an App Service Plan.", + "description": "Description for Creates or updates an App Service Plan.", + "operationId": "AppServicePlans_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service plan.", + "required": true, + "type": "string" + }, + { + "name": "appServicePlan", + "in": "body", + "description": "Details of the App Service plan.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AppServicePlan" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AppServicePlan" + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AppServicePlan" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create Or Update App Service plan": { + "$ref": "./examples/CreateOrUpdateAppServicePlan.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "AppServicePlans" + ], + "summary": "Delete an App Service plan.", + "description": "Description for Delete an App Service plan.", + "operationId": "AppServicePlans_Delete", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service plan.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "OK." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete App Service plan": { + "$ref": "./examples/DeleteAppServicePlan.json" + } + } + }, + "patch": { + "tags": [ + "AppServicePlans" + ], + "summary": "Creates or updates an App Service Plan.", + "description": "Description for Creates or updates an App Service Plan.", + "operationId": "AppServicePlans_Update", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service plan.", + "required": true, + "type": "string" + }, + { + "name": "appServicePlan", + "in": "body", + "description": "Details of the App Service plan.", + "required": true, + "schema": { + "$ref": "#/definitions/AppServicePlanPatchResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AppServicePlan" + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AppServicePlan" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Service plan": { + "$ref": "./examples/PatchAppServicePlan.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/capabilities": { + "get": { + "tags": [ + "AppServicePlans" + ], + "summary": "List all capabilities of an App Service plan.", + "description": "Description for List all capabilities of an App Service plan.", + "operationId": "AppServicePlans_ListCapabilities", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service plan.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/Capability" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}": { + "get": { + "tags": [ + "AppServicePlans" + ], + "summary": "Retrieve a Hybrid Connection in use in an App Service plan.", + "description": "Description for Retrieve a Hybrid Connection in use in an App Service plan.", + "operationId": "AppServicePlans_GetHybridConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service plan.", + "required": true, + "type": "string" + }, + { + "name": "namespaceName", + "in": "path", + "description": "Name of the Service Bus namespace.", + "required": true, + "type": "string" + }, + { + "name": "relayName", + "in": "path", + "description": "Name of the Service Bus relay.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "AppServicePlans" + ], + "summary": "Delete a Hybrid Connection in use in an App Service plan.", + "description": "Description for Delete a Hybrid Connection in use in an App Service plan.", + "operationId": "AppServicePlans_DeleteHybridConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service plan.", + "required": true, + "type": "string" + }, + { + "name": "namespaceName", + "in": "path", + "description": "Name of the Service Bus namespace.", + "required": true, + "type": "string" + }, + { + "name": "relayName", + "in": "path", + "description": "Name of the Service Bus relay.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted hybrid connection" + }, + "204": { + "description": "Hybrid connection does not exist" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys": { + "post": { + "tags": [ + "AppServicePlans" + ], + "summary": "Get the send key name and value of a Hybrid Connection.", + "description": "Description for Get the send key name and value of a Hybrid Connection.", + "operationId": "AppServicePlans_ListHybridConnectionKeys", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service plan.", + "required": true, + "type": "string" + }, + { + "name": "namespaceName", + "in": "path", + "description": "The name of the Service Bus namespace.", + "required": true, + "type": "string" + }, + { + "name": "relayName", + "in": "path", + "description": "The name of the Service Bus relay.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HybridConnectionKey" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/sites": { + "get": { + "tags": [ + "AppServicePlans" + ], + "summary": "Get all apps that use a Hybrid Connection in an App Service Plan.", + "description": "Description for Get all apps that use a Hybrid Connection in an App Service Plan.", + "operationId": "AppServicePlans_ListWebAppsByHybridConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service plan.", + "required": true, + "type": "string" + }, + { + "name": "namespaceName", + "in": "path", + "description": "Name of the Hybrid Connection namespace.", + "required": true, + "type": "string" + }, + { + "name": "relayName", + "in": "path", + "description": "Name of the Hybrid Connection relay.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionPlanLimits/limit": { + "get": { + "tags": [ + "AppServicePlans" + ], + "summary": "Get the maximum number of Hybrid Connections allowed in an App Service plan.", + "description": "Description for Get the maximum number of Hybrid Connections allowed in an App Service plan.", + "operationId": "AppServicePlans_GetHybridConnectionPlanLimit", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service plan.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HybridConnectionLimits" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionRelays": { + "get": { + "tags": [ + "AppServicePlans" + ], + "summary": "Retrieve all Hybrid Connections in use in an App Service plan.", + "description": "Description for Retrieve all Hybrid Connections in use in an App Service plan.", + "operationId": "AppServicePlans_ListHybridConnections", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service plan.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HybridConnectionCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/restartSites": { + "post": { + "tags": [ + "AppServicePlans" + ], + "summary": "Restart all apps in an App Service plan.", + "description": "Description for Restart all apps in an App Service plan.", + "operationId": "AppServicePlans_RestartWebApps", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service plan.", + "required": true, + "type": "string" + }, + { + "name": "softRestart", + "in": "query", + "description": "Specify true to perform a soft restart, applies the configuration settings and restarts the apps if necessary. The default is false, which always restarts and reprovisions the apps", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/sites": { + "get": { + "tags": [ + "AppServicePlans" + ], + "summary": "Get all apps associated with an App Service plan.", + "description": "Description for Get all apps associated with an App Service plan.", + "operationId": "AppServicePlans_ListWebApps", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service plan.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "Skip to a web app in the list of webapps associated with app service plan. If specified, the resulting list will contain web apps starting from (including) the skipToken. Otherwise, the resulting list contains web apps from the start of the list", + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "Supported filter: $filter=state eq running. Returns only web apps that are currently running", + "type": "string", + "x-ms-skip-url-encoding": true + }, + { + "name": "$top", + "in": "query", + "description": "List page size. If specified, results are paged.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/skus": { + "get": { + "tags": [ + "AppServicePlans" + ], + "summary": "Gets all selectable SKUs for a given App Service Plan", + "description": "Description for Gets all selectable SKUs for a given App Service Plan", + "operationId": "AppServicePlans_GetServerFarmSkus", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of App Service Plan", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/usages": { + "get": { + "tags": [ + "AppServicePlans" + ], + "summary": "Gets server farm usage information", + "description": "Description for Gets server farm usage information", + "operationId": "AppServicePlans_ListUsages", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of App Service Plan", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2').", + "type": "string", + "x-ms-skip-url-encoding": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/CsmUsageQuotaCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections": { + "get": { + "tags": [ + "AppServicePlans" + ], + "summary": "Get all Virtual Networks associated with an App Service plan.", + "description": "Description for Get all Virtual Networks associated with an App Service plan.", + "operationId": "AppServicePlans_ListVnets", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service plan.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/VnetInfoResource" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}": { + "get": { + "tags": [ + "AppServicePlans" + ], + "summary": "Get a Virtual Network associated with an App Service plan.", + "description": "Description for Get a Virtual Network associated with an App Service plan.", + "operationId": "AppServicePlans_GetVnetFromServerFarm", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service plan.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the Virtual Network.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetInfoResource" + } + }, + "404": { + "description": "Virtual network could not be found.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": { + "get": { + "tags": [ + "AppServicePlans" + ], + "summary": "Get a Virtual Network gateway.", + "description": "Description for Get a Virtual Network gateway.", + "operationId": "AppServicePlans_GetVnetGateway", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service plan.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "gatewayName", + "in": "path", + "description": "Name of the gateway. Only the 'primary' gateway is supported.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetGateway" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AppServicePlans" + ], + "summary": "Update a Virtual Network gateway.", + "description": "Description for Update a Virtual Network gateway.", + "operationId": "AppServicePlans_UpdateVnetGateway", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service plan.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "gatewayName", + "in": "path", + "description": "Name of the gateway. Only the 'primary' gateway is supported.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "Definition of the gateway.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetGateway" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetGateway" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes": { + "get": { + "tags": [ + "AppServicePlans" + ], + "summary": "Get all routes that are associated with a Virtual Network in an App Service plan.", + "description": "Description for Get all routes that are associated with a Virtual Network in an App Service plan.", + "operationId": "AppServicePlans_ListRoutesForVnet", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service plan.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the Virtual Network.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/VnetRoute" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}": { + "get": { + "tags": [ + "AppServicePlans" + ], + "summary": "Get a Virtual Network route in an App Service plan.", + "description": "Description for Get a Virtual Network route in an App Service plan.", + "operationId": "AppServicePlans_GetRouteForVnet", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service plan.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "routeName", + "in": "path", + "description": "Name of the Virtual Network route.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/VnetRoute" + } + } + }, + "404": { + "description": "Specified route does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AppServicePlans" + ], + "summary": "Create or update a Virtual Network route in an App Service plan.", + "description": "Description for Create or update a Virtual Network route in an App Service plan.", + "operationId": "AppServicePlans_CreateOrUpdateVnetRoute", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service plan.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "routeName", + "in": "path", + "description": "Name of the Virtual Network route.", + "required": true, + "type": "string" + }, + { + "name": "route", + "in": "body", + "description": "Definition of the Virtual Network route.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetRoute" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetRoute" + } + }, + "400": { + "description": "Invalid request. Ensure that required parameters are given, and that addresses and address spaces are valid.", + "x-ms-error-response": true + }, + "404": { + "description": "Route not found.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "AppServicePlans" + ], + "summary": "Delete a Virtual Network route in an App Service plan.", + "description": "Description for Delete a Virtual Network route in an App Service plan.", + "operationId": "AppServicePlans_DeleteVnetRoute", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service plan.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "routeName", + "in": "path", + "description": "Name of the Virtual Network route.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted Virtual Network route." + }, + "404": { + "description": "Specified Virtual Network route does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "AppServicePlans" + ], + "summary": "Create or update a Virtual Network route in an App Service plan.", + "description": "Description for Create or update a Virtual Network route in an App Service plan.", + "operationId": "AppServicePlans_UpdateVnetRoute", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service plan.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "routeName", + "in": "path", + "description": "Name of the Virtual Network route.", + "required": true, + "type": "string" + }, + { + "name": "route", + "in": "body", + "description": "Definition of the Virtual Network route.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetRoute" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetRoute" + } + }, + "400": { + "description": "Invalid request. Ensure that required parameters are given, and that addresses and address spaces are valid.", + "x-ms-error-response": true + }, + "404": { + "description": "Route not found.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/workers/{workerName}/reboot": { + "post": { + "tags": [ + "AppServicePlans" + ], + "summary": "Reboot a worker machine in an App Service plan.", + "description": "Description for Reboot a worker machine in an App Service plan.", + "operationId": "AppServicePlans_RebootWorker", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service plan.", + "required": true, + "type": "string" + }, + { + "name": "workerName", + "in": "path", + "description": "Name of worker machine, which typically starts with RD.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + } + }, + "definitions": { + "AppServicePlanPatchResource": { + "description": "ARM resource for a app service plan.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "AppServicePlanPatchResource resource specific properties", + "type": "object", + "properties": { + "workerTierName": { + "description": "Target worker tier assigned to the App Service plan.", + "type": "string" + }, + "status": { + "description": "App Service plan status.", + "enum": [ + "Ready", + "Pending", + "Creating" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "StatusOptions", + "modelAsString": false + } + }, + "subscription": { + "description": "App Service plan subscription.", + "type": "string", + "readOnly": true + }, + "hostingEnvironmentProfile": { + "$ref": "./CommonDefinitions.json#/definitions/HostingEnvironmentProfile", + "description": "Specification for the App Service Environment to use for the App Service plan.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "maximumNumberOfWorkers": { + "format": "int32", + "description": "Maximum number of instances that can be assigned to this App Service plan.", + "type": "integer", + "readOnly": true + }, + "numberOfWorkers": { + "format": "int32", + "description": "The number of instances that are assigned to this App Service plan.", + "type": "integer", + "readOnly": true + }, + "geoRegion": { + "description": "Geographical location for the App Service plan.", + "type": "string", + "readOnly": true + }, + "perSiteScaling": { + "description": "If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan.", + "default": false, + "type": "boolean" + }, + "elasticScaleEnabled": { + "description": "ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku", + "type": "boolean" + }, + "maximumElasticWorkerCount": { + "format": "int32", + "description": "Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan", + "type": "integer" + }, + "numberOfSites": { + "format": "int32", + "description": "Number of apps assigned to this App Service plan.", + "type": "integer", + "readOnly": true + }, + "isSpot": { + "description": "If true, this App Service Plan owns spot instances.", + "type": "boolean" + }, + "spotExpirationTime": { + "format": "date-time", + "description": "The time when the server farm expires. Valid only if it is a spot server farm.", + "type": "string" + }, + "freeOfferExpirationTime": { + "format": "date-time", + "description": "The time when the server farm free offer expires.", + "type": "string" + }, + "resourceGroup": { + "description": "Resource group of the App Service plan.", + "type": "string", + "readOnly": true + }, + "reserved": { + "description": "If Linux app service plan true, false otherwise.", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "isXenon": { + "description": "Obsolete: If Hyper-V container app service plan true, false otherwise.", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "hyperV": { + "description": "If Hyper-V container app service plan true, false otherwise.", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "targetWorkerCount": { + "format": "int32", + "description": "Scaling worker count.", + "type": "integer" + }, + "targetWorkerSizeId": { + "format": "int32", + "description": "Scaling worker size ID.", + "type": "integer" + }, + "provisioningState": { + "description": "Provisioning state of the App Service Plan.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "InProgress", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "kubeEnvironmentProfile": { + "$ref": "./CommonDefinitions.json#/definitions/KubeEnvironmentProfile", + "description": "Specification for the Kubernetes Environment to use for the App Service plan." + }, + "zoneRedundant": { + "description": "If true, this App Service Plan will perform availability zone balancing.\nIf false, this App Service Plan will not perform availability zone balancing.", + "default": false, + "type": "boolean" + } + }, + "x-ms-client-flatten": true + } + } + }, + "HybridConnectionCollection": { + "description": "Collection of hostname bindings.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "HybridConnectionKey": { + "description": "Hybrid Connection key contract. This has the send key name and value for a Hybrid Connection.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "HybridConnectionKey resource specific properties", + "type": "object", + "properties": { + "sendKeyName": { + "description": "The name of the send key.", + "type": "string", + "readOnly": true + }, + "sendKeyValue": { + "description": "The value of the send key.", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "HybridConnectionLimits": { + "description": "Hybrid Connection limits contract. This is used to return the plan limits of Hybrid Connections.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "HybridConnectionLimits resource specific properties", + "type": "object", + "properties": { + "current": { + "format": "int32", + "description": "The current number of Hybrid Connections.", + "type": "integer", + "readOnly": true + }, + "maximum": { + "format": "int32", + "description": "The maximum number of Hybrid Connections allowed.", + "type": "integer", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "ResourceCollection": { + "description": "Collection of resources.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "type": "string" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group to which the resource belongs.", + "required": true, + "type": "string", + "maxLength": 90, + "minLength": 1, + "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$", + "x-ms-parameter-location": "method" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API Version", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + } + }, + "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/web/resource-manager/Microsoft.Web/stable/2024-04-01/Certificates.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/Certificates.json new file mode 100644 index 000000000000..1ee9137a2d82 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/Certificates.json @@ -0,0 +1,663 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "Certificates API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/certificates": { + "get": { + "tags": [ + "Certificates" + ], + "summary": "Get all certificates for a subscription.", + "description": "Description for Get all certificates for a subscription.", + "operationId": "Certificates_List", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only information specified in the filter (using OData syntax). For example: $filter=KeyVaultId eq 'KeyVaultId'", + "type": "string", + "x-ms-skip-url-encoding": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CertificateCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Certificates for subscription": { + "$ref": "./examples/ListCertificates.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates": { + "get": { + "tags": [ + "Certificates" + ], + "summary": "Get all certificates in a resource group.", + "description": "Description for Get all certificates in a resource group.", + "operationId": "Certificates_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/CertificateCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Certificates by resource group": { + "$ref": "./examples/ListCertificatesByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}": { + "get": { + "tags": [ + "Certificates" + ], + "summary": "Get a certificate.", + "description": "Description for Get a certificate.", + "operationId": "Certificates_Get", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the certificate.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Certificate" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Certificate": { + "$ref": "./examples/GetCertificate.json" + } + } + }, + "put": { + "tags": [ + "Certificates" + ], + "summary": "Create or update a certificate.", + "description": "Description for Create or update a certificate.", + "operationId": "Certificates_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the certificate.", + "required": true, + "type": "string" + }, + { + "name": "certificateEnvelope", + "in": "body", + "description": "Details of certificate, if it exists already.", + "required": true, + "schema": { + "$ref": "#/definitions/Certificate" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/Certificate" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create Or Update Certificate": { + "$ref": "./examples/CreateOrUpdateCertificate.json" + } + } + }, + "delete": { + "tags": [ + "Certificates" + ], + "summary": "Delete a certificate.", + "description": "Description for Delete a certificate.", + "operationId": "Certificates_Delete", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the certificate.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted certificate." + }, + "204": { + "description": "Certificate does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Certificate": { + "$ref": "./examples/DeleteCertificate.json" + } + } + }, + "patch": { + "tags": [ + "Certificates" + ], + "summary": "Create or update a certificate.", + "description": "Description for Create or update a certificate.", + "operationId": "Certificates_Update", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the certificate.", + "required": true, + "type": "string" + }, + { + "name": "certificateEnvelope", + "in": "body", + "description": "Details of certificate, if it exists already.", + "required": true, + "schema": { + "$ref": "#/definitions/CertificatePatchResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/Certificate" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Certificate": { + "$ref": "./examples/PatchCertificate.json" + } + } + } + } + }, + "definitions": { + "Certificate": { + "description": "SSL certificate for an app.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Certificate resource specific properties", + "type": "object", + "properties": { + "password": { + "description": "Certificate password.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "friendlyName": { + "description": "Friendly name of the certificate.", + "type": "string", + "readOnly": true + }, + "subjectName": { + "description": "Subject name of the certificate.", + "type": "string", + "readOnly": true + }, + "hostNames": { + "description": "Host names the certificate applies to.", + "type": "array", + "items": { + "type": "string" + } + }, + "pfxBlob": { + "format": "byte", + "description": "Pfx blob.", + "type": "string" + }, + "siteName": { + "description": "App name.", + "type": "string", + "readOnly": true + }, + "selfLink": { + "description": "Self link.", + "type": "string", + "readOnly": true + }, + "issuer": { + "description": "Certificate issuer.", + "type": "string", + "readOnly": true + }, + "issueDate": { + "format": "date-time", + "description": "Certificate issue Date.", + "type": "string", + "readOnly": true + }, + "expirationDate": { + "format": "date-time", + "description": "Certificate expiration date.", + "type": "string", + "readOnly": true + }, + "thumbprint": { + "description": "Certificate thumbprint.", + "type": "string", + "readOnly": true + }, + "valid": { + "description": "Is the certificate valid?.", + "type": "boolean", + "readOnly": true + }, + "cerBlob": { + "format": "byte", + "description": "Raw bytes of .cer file", + "type": "string", + "readOnly": true + }, + "publicKeyHash": { + "description": "Public key hash.", + "type": "string", + "readOnly": true + }, + "hostingEnvironmentProfile": { + "$ref": "./CommonDefinitions.json#/definitions/HostingEnvironmentProfile", + "description": "Specification for the App Service Environment to use for the certificate.", + "readOnly": true + }, + "keyVaultId": { + "description": "Key Vault Csm resource Id.", + "type": "string" + }, + "keyVaultSecretName": { + "description": "Key Vault secret name.", + "type": "string" + }, + "keyVaultSecretStatus": { + "description": "Status of the Key Vault secret.", + "enum": [ + "Initialized", + "WaitingOnCertificateOrder", + "Succeeded", + "CertificateOrderFailed", + "OperationNotPermittedOnKeyVault", + "AzureServiceUnauthorizedToAccessKeyVault", + "KeyVaultDoesNotExist", + "KeyVaultSecretDoesNotExist", + "UnknownError", + "ExternalPrivateKey", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "KeyVaultSecretStatus", + "modelAsString": false + } + }, + "serverFarmId": { + "description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".", + "type": "string" + }, + "canonicalName": { + "description": "CNAME of the certificate to be issued via free certificate", + "type": "string" + }, + "domainValidationMethod": { + "description": "Method of domain validation for free cert", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "CertificateCollection": { + "description": "Collection of certificates.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Certificate" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "CertificatePatchResource": { + "description": "ARM resource for a certificate.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "CertificatePatchResource resource specific properties", + "type": "object", + "properties": { + "password": { + "description": "Certificate password.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "friendlyName": { + "description": "Friendly name of the certificate.", + "type": "string", + "readOnly": true + }, + "subjectName": { + "description": "Subject name of the certificate.", + "type": "string", + "readOnly": true + }, + "hostNames": { + "description": "Host names the certificate applies to.", + "type": "array", + "items": { + "type": "string" + } + }, + "pfxBlob": { + "format": "byte", + "description": "Pfx blob.", + "type": "string" + }, + "siteName": { + "description": "App name.", + "type": "string", + "readOnly": true + }, + "selfLink": { + "description": "Self link.", + "type": "string", + "readOnly": true + }, + "issuer": { + "description": "Certificate issuer.", + "type": "string", + "readOnly": true + }, + "issueDate": { + "format": "date-time", + "description": "Certificate issue Date.", + "type": "string", + "readOnly": true + }, + "expirationDate": { + "format": "date-time", + "description": "Certificate expiration date.", + "type": "string", + "readOnly": true + }, + "thumbprint": { + "description": "Certificate thumbprint.", + "type": "string", + "readOnly": true + }, + "valid": { + "description": "Is the certificate valid?.", + "type": "boolean", + "readOnly": true + }, + "cerBlob": { + "format": "byte", + "description": "Raw bytes of .cer file", + "type": "string", + "readOnly": true + }, + "publicKeyHash": { + "description": "Public key hash.", + "type": "string", + "readOnly": true + }, + "hostingEnvironmentProfile": { + "$ref": "./CommonDefinitions.json#/definitions/HostingEnvironmentProfile", + "description": "Specification for the App Service Environment to use for the certificate.", + "readOnly": true + }, + "keyVaultId": { + "description": "Key Vault Csm resource Id.", + "type": "string" + }, + "keyVaultSecretName": { + "description": "Key Vault secret name.", + "type": "string" + }, + "keyVaultSecretStatus": { + "description": "Status of the Key Vault secret.", + "enum": [ + "Initialized", + "WaitingOnCertificateOrder", + "Succeeded", + "CertificateOrderFailed", + "OperationNotPermittedOnKeyVault", + "AzureServiceUnauthorizedToAccessKeyVault", + "KeyVaultDoesNotExist", + "KeyVaultSecretDoesNotExist", + "UnknownError", + "ExternalPrivateKey", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "KeyVaultSecretStatus", + "modelAsString": false + } + }, + "serverFarmId": { + "description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".", + "type": "string" + }, + "canonicalName": { + "description": "CNAME of the certificate to be issued via free certificate", + "type": "string" + }, + "domainValidationMethod": { + "description": "Method of domain validation for free cert", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group to which the resource belongs.", + "required": true, + "type": "string", + "maxLength": 90, + "minLength": 1, + "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$", + "x-ms-parameter-location": "method" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API Version", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + } + }, + "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/web/resource-manager/Microsoft.Web/stable/2024-04-01/CommonDefinitions.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/CommonDefinitions.json new file mode 100644 index 000000000000..04963523245c --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/CommonDefinitions.json @@ -0,0 +1,4551 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "Common Definitions" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": {}, + "definitions": { + "ApiDefinitionInfo": { + "description": "Information about the formal API definition for the app.", + "type": "object", + "properties": { + "url": { + "description": "The URL of the API definition.", + "type": "string" + } + } + }, + "ApiManagementConfig": { + "description": "Azure API management (APIM) configuration linked to the app.", + "type": "object", + "properties": { + "id": { + "description": "APIM-Api Identifier.", + "type": "string" + } + } + }, + "AppServiceEnvironment": { + "description": "Description of an App Service Environment.", + "required": [ + "virtualNetwork" + ], + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the App Service Environment.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "InProgress", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "status": { + "description": "Current status of the App Service Environment.", + "enum": [ + "Preparing", + "Ready", + "Scaling", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "HostingEnvironmentStatus", + "modelAsString": false + } + }, + "virtualNetwork": { + "$ref": "#/definitions/VirtualNetworkProfile", + "description": "Description of the Virtual Network." + }, + "internalLoadBalancingMode": { + "description": "Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.", + "enum": [ + "None", + "Web", + "Publishing", + "Web, Publishing" + ], + "type": "string", + "x-ms-enum": { + "name": "LoadBalancingMode", + "modelAsString": true + } + }, + "multiSize": { + "description": "Front-end VM size, e.g. \"Medium\", \"Large\".", + "type": "string" + }, + "multiRoleCount": { + "format": "int32", + "description": "Number of front-end instances.", + "type": "integer", + "readOnly": true + }, + "ipsslAddressCount": { + "format": "int32", + "description": "Number of IP SSL addresses reserved for the App Service Environment.", + "type": "integer" + }, + "dnsSuffix": { + "description": "DNS suffix of the App Service Environment.", + "type": "string" + }, + "maximumNumberOfMachines": { + "format": "int32", + "description": "Maximum number of VMs in the App Service Environment.", + "type": "integer", + "readOnly": true + }, + "frontEndScaleFactor": { + "format": "int32", + "description": "Scale factor for front-ends.", + "type": "integer" + }, + "suspended": { + "description": "true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available\n (most likely because NSG blocked the incoming traffic).", + "type": "boolean", + "readOnly": true + }, + "clusterSettings": { + "description": "Custom settings for changing the behavior of the App Service Environment.", + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "userWhitelistedIpRanges": { + "description": "User added ip ranges to whitelist on ASE db", + "type": "array", + "items": { + "type": "string" + } + }, + "hasLinuxWorkers": { + "description": "Flag that displays whether an ASE has linux workers or not", + "type": "boolean", + "readOnly": true + }, + "upgradePreference": { + "description": "Upgrade Preference", + "default": "None", + "enum": [ + "None", + "Early", + "Late", + "Manual" + ], + "type": "string", + "x-ms-enum": { + "name": "UpgradePreference", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No preference on when this App Service Environment will be upgraded" + }, + { + "value": "Early", + "description": "This App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late'" + }, + { + "value": "Late", + "description": "This App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early'" + }, + { + "value": "Manual", + "description": "ASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically" + } + ] + } + }, + "dedicatedHostCount": { + "format": "int32", + "description": "Dedicated Host Count", + "type": "integer" + }, + "zoneRedundant": { + "description": "Whether or not this App Service Environment is zone-redundant.", + "type": "boolean" + }, + "customDnsSuffixConfiguration": { + "$ref": "#/definitions/CustomDnsSuffixConfiguration" + }, + "networkingConfiguration": { + "$ref": "#/definitions/AseV3NetworkingConfiguration" + }, + "upgradeAvailability": { + "description": "Whether an upgrade is available for this App Service Environment.", + "enum": [ + "None", + "Ready" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "UpgradeAvailability", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No upgrade is currently available for this App Service Environment" + }, + { + "value": "Ready", + "description": "An upgrade is ready to be manually initiated on this App Service Environment" + } + ] + } + } + } + }, + "AppServicePlan": { + "description": "App Service plan.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "AppServicePlan resource specific properties", + "type": "object", + "properties": { + "workerTierName": { + "description": "Target worker tier assigned to the App Service plan.", + "type": "string" + }, + "status": { + "description": "App Service plan status.", + "enum": [ + "Ready", + "Pending", + "Creating" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "StatusOptions", + "modelAsString": false + } + }, + "subscription": { + "description": "App Service plan subscription.", + "type": "string", + "readOnly": true + }, + "hostingEnvironmentProfile": { + "$ref": "#/definitions/HostingEnvironmentProfile", + "description": "Specification for the App Service Environment to use for the App Service plan.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "maximumNumberOfWorkers": { + "format": "int32", + "description": "Maximum number of instances that can be assigned to this App Service plan.", + "type": "integer", + "readOnly": true + }, + "numberOfWorkers": { + "format": "int32", + "description": "The number of instances that are assigned to this App Service plan.", + "type": "integer", + "readOnly": true + }, + "geoRegion": { + "description": "Geographical location for the App Service plan.", + "type": "string", + "readOnly": true + }, + "perSiteScaling": { + "description": "If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan.", + "default": false, + "type": "boolean" + }, + "elasticScaleEnabled": { + "description": "ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku", + "type": "boolean" + }, + "maximumElasticWorkerCount": { + "format": "int32", + "description": "Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan", + "type": "integer" + }, + "numberOfSites": { + "format": "int32", + "description": "Number of apps assigned to this App Service plan.", + "type": "integer", + "readOnly": true + }, + "isSpot": { + "description": "If true, this App Service Plan owns spot instances.", + "type": "boolean" + }, + "spotExpirationTime": { + "format": "date-time", + "description": "The time when the server farm expires. Valid only if it is a spot server farm.", + "type": "string" + }, + "freeOfferExpirationTime": { + "format": "date-time", + "description": "The time when the server farm free offer expires.", + "type": "string" + }, + "resourceGroup": { + "description": "Resource group of the App Service plan.", + "type": "string", + "readOnly": true + }, + "reserved": { + "description": "If Linux app service plan true, false otherwise.", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "isXenon": { + "description": "Obsolete: If Hyper-V container app service plan true, false otherwise.", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "hyperV": { + "description": "If Hyper-V container app service plan true, false otherwise.", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "targetWorkerCount": { + "format": "int32", + "description": "Scaling worker count.", + "type": "integer" + }, + "targetWorkerSizeId": { + "format": "int32", + "description": "Scaling worker size ID.", + "type": "integer" + }, + "provisioningState": { + "description": "Provisioning state of the App Service Plan.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "InProgress", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "kubeEnvironmentProfile": { + "$ref": "#/definitions/KubeEnvironmentProfile", + "description": "Specification for the Kubernetes Environment to use for the App Service plan." + }, + "zoneRedundant": { + "description": "If true, this App Service Plan will perform availability zone balancing.\nIf false, this App Service Plan will not perform availability zone balancing.", + "default": false, + "type": "boolean" + } + }, + "x-ms-client-flatten": true + }, + "sku": { + "$ref": "#/definitions/SkuDescription" + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation" + } + } + }, + "AppServicePlanCollection": { + "description": "Collection of App Service plans.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/AppServicePlan" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ArmIdWrapper": { + "description": "A wrapper for an ARM resource id", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true + } + } + }, + "AseV3NetworkingConfiguration": { + "description": "Full view of networking configuration for an ASE.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "AseV3NetworkingConfiguration resource specific properties", + "type": "object", + "properties": { + "windowsOutboundIpAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "linuxOutboundIpAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "externalInboundIpAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "internalInboundIpAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "allowNewPrivateEndpointConnections": { + "description": "Property to enable and disable new private endpoint connection creation on ASE", + "type": "boolean" + }, + "ftpEnabled": { + "description": "Property to enable and disable FTP on ASEV3", + "type": "boolean" + }, + "remoteDebugEnabled": { + "description": "Property to enable and disable Remote Debug on ASEV3", + "type": "boolean" + }, + "inboundIpAddressOverride": { + "description": "Customer provided Inbound IP Address. Only able to be set on Ase create.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "AutoHealActions": { + "description": "Actions which to take by the auto-heal module when a rule is triggered.", + "type": "object", + "properties": { + "actionType": { + "description": "Predefined action to be taken.", + "enum": [ + "Recycle", + "LogEvent", + "CustomAction" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoHealActionType", + "modelAsString": false + } + }, + "customAction": { + "$ref": "#/definitions/AutoHealCustomAction", + "description": "Custom action to be taken." + }, + "minProcessExecutionTime": { + "description": "Minimum time the process must execute\nbefore taking the action", + "type": "string" + } + } + }, + "AutoHealCustomAction": { + "description": "Custom action to be executed\nwhen an auto heal rule is triggered.", + "type": "object", + "properties": { + "exe": { + "description": "Executable to be run.", + "type": "string" + }, + "parameters": { + "description": "Parameters for the executable.", + "type": "string" + } + } + }, + "AutoHealRules": { + "description": "Rules that can be defined for auto-heal.", + "type": "object", + "properties": { + "triggers": { + "$ref": "#/definitions/AutoHealTriggers", + "description": "Conditions that describe when to execute the auto-heal actions." + }, + "actions": { + "$ref": "#/definitions/AutoHealActions", + "description": "Actions to be executed when a rule is triggered." + } + } + }, + "AutoHealTriggers": { + "description": "Triggers for auto-heal.", + "type": "object", + "properties": { + "requests": { + "$ref": "#/definitions/RequestsBasedTrigger", + "description": "A rule based on total requests." + }, + "privateBytesInKB": { + "format": "int32", + "description": "A rule based on private bytes.", + "type": "integer" + }, + "statusCodes": { + "description": "A rule based on status codes.", + "type": "array", + "items": { + "$ref": "#/definitions/StatusCodesBasedTrigger" + }, + "x-ms-identifiers": [ + "path" + ] + }, + "slowRequests": { + "$ref": "#/definitions/SlowRequestsBasedTrigger", + "description": "A rule based on request execution time." + }, + "slowRequestsWithPath": { + "description": "A rule based on multiple Slow Requests Rule with path", + "type": "array", + "items": { + "$ref": "#/definitions/SlowRequestsBasedTrigger" + }, + "x-ms-identifiers": [ + "path" + ] + }, + "statusCodesRange": { + "description": "A rule based on status codes ranges.", + "type": "array", + "items": { + "$ref": "#/definitions/StatusCodesRangeBasedTrigger" + }, + "x-ms-identifiers": [ + "path" + ] + } + } + }, + "AzureStorageInfoValue": { + "description": "Azure Files or Blob Storage access information value for dictionary storage.", + "type": "object", + "properties": { + "type": { + "description": "Type of storage.", + "enum": [ + "AzureFiles", + "AzureBlob" + ], + "type": "string", + "x-ms-enum": { + "name": "AzureStorageType", + "modelAsString": false + } + }, + "accountName": { + "description": "Name of the storage account.", + "type": "string" + }, + "shareName": { + "description": "Name of the file share (container name, for Blob storage).", + "type": "string" + }, + "accessKey": { + "description": "Access key for the storage account.", + "type": "string", + "x-ms-secret": true + }, + "mountPath": { + "description": "Path to mount the storage within the site's runtime environment.", + "type": "string" + }, + "state": { + "description": "State of the storage account.", + "enum": [ + "Ok", + "InvalidCredentials", + "InvalidShare", + "NotValidated" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AzureStorageState", + "modelAsString": false + } + }, + "protocol": { + "description": "Mounting protocol to use for the storage account.", + "enum": [ + "Smb", + "Http", + "Nfs" + ], + "type": "string", + "x-ms-enum": { + "name": "AzureStorageProtocol", + "modelAsString": true + } + } + } + }, + "Capability": { + "description": "Describes the capabilities/features allowed for a specific SKU.", + "type": "object", + "properties": { + "name": { + "description": "Name of the SKU capability.", + "type": "string" + }, + "value": { + "description": "Value of the SKU capability.", + "type": "string" + }, + "reason": { + "description": "Reason of the SKU capability.", + "type": "string" + } + } + }, + "CipherSuites": { + "description": "Describes valid TLS cipher suites.", + "type": "object", + "properties": { + "suites": { + "description": "List of TLS Cipher Suites that are supported by App Service.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "CloningInfo": { + "description": "Information needed for cloning operation.", + "required": [ + "sourceWebAppId" + ], + "type": "object", + "properties": { + "correlationId": { + "format": "uuid", + "description": "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot.", + "type": "string", + "example": "00000000-0000-0000-0000-000000000000" + }, + "overwrite": { + "description": "true to overwrite destination app; otherwise, false.", + "type": "boolean" + }, + "cloneCustomHostNames": { + "description": "true to clone custom hostnames from source app; otherwise, false.", + "type": "boolean" + }, + "cloneSourceControl": { + "description": "true to clone source control from source app; otherwise, false.", + "type": "boolean" + }, + "sourceWebAppId": { + "description": "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.", + "type": "string" + }, + "sourceWebAppLocation": { + "description": "Location of source app ex: West US or North Europe", + "type": "string" + }, + "hostingEnvironment": { + "description": "App Service Environment.", + "type": "string" + }, + "appSettingsOverrides": { + "description": "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "configureLoadBalancing": { + "description": "true to configure load balancing for source and destination app.", + "type": "boolean" + }, + "trafficManagerProfileId": { + "description": "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.", + "type": "string" + }, + "trafficManagerProfileName": { + "description": "Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.", + "type": "string" + } + } + }, + "ConnStringInfo": { + "description": "Database connection string information.", + "type": "object", + "properties": { + "name": { + "description": "Name of connection string.", + "type": "string" + }, + "connectionString": { + "description": "Connection string value.", + "type": "string" + }, + "type": { + "description": "Type of database.", + "enum": [ + "MySql", + "SQLServer", + "SQLAzure", + "Custom", + "NotificationHub", + "ServiceBus", + "EventHub", + "ApiHub", + "DocDb", + "RedisCache", + "PostgreSQL" + ], + "type": "string", + "x-ms-enum": { + "name": "ConnectionStringType", + "modelAsString": false + } + } + } + }, + "Container": { + "description": "Container App container definition.", + "type": "object", + "properties": { + "image": { + "description": "Container image tag.", + "type": "string" + }, + "name": { + "description": "Custom container name.", + "type": "string" + }, + "command": { + "description": "Container start command.", + "type": "array", + "items": { + "type": "string" + } + }, + "args": { + "description": "Container start command arguments.", + "type": "array", + "items": { + "type": "string" + } + }, + "env": { + "description": "Container environment variables.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVar" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "resources": { + "$ref": "#/definitions/ContainerResources", + "description": "Container resource requirements." + } + } + }, + "ContainerResources": { + "description": "Container App container resource requirements.", + "type": "object", + "properties": { + "cpu": { + "format": "double", + "description": "Required CPU in cores, e.g. 0.5", + "type": "number" + }, + "memory": { + "description": "Required memory, e.g. \"250Mb\"", + "type": "string" + } + } + }, + "CorsSettings": { + "description": "Cross-Origin Resource Sharing (CORS) settings for the app.", + "type": "object", + "properties": { + "allowedOrigins": { + "description": "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all.", + "type": "array", + "items": { + "type": "string" + } + }, + "supportCredentials": { + "description": "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details.", + "type": "boolean" + } + } + }, + "CsmOperationCollection": { + "description": "Collection of Azure resource manager operation metadata.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/CsmOperationDescription" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "CsmOperationDescription": { + "description": "Description of an operation available for Microsoft.Web resource provider.", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "isDataAction": { + "type": "boolean" + }, + "display": { + "$ref": "#/definitions/CsmOperationDisplay" + }, + "origin": { + "type": "string" + }, + "properties": { + "$ref": "#/definitions/CsmOperationDescriptionProperties" + } + } + }, + "CsmOperationDescriptionProperties": { + "description": "Properties available for a Microsoft.Web resource provider operation.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification" + } + } + }, + "CsmOperationDisplay": { + "description": "Meta data about operation used for display in portal.", + "type": "object", + "properties": { + "provider": { + "type": "string" + }, + "resource": { + "type": "string" + }, + "operation": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "CsmUsageQuota": { + "description": "Usage of the quota resource.", + "type": "object", + "properties": { + "unit": { + "description": "Units of measurement for the quota resource.", + "type": "string" + }, + "nextResetTime": { + "format": "date-time", + "description": "Next reset time for the resource counter.", + "type": "string" + }, + "currentValue": { + "format": "int64", + "description": "The current value of the resource counter.", + "type": "integer" + }, + "limit": { + "format": "int64", + "description": "The resource limit.", + "type": "integer" + }, + "name": { + "$ref": "#/definitions/LocalizableString", + "description": "Quota name." + } + } + }, + "CsmUsageQuotaCollection": { + "description": "Collection of CSM usage quotas.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/CsmUsageQuota" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "CustomDnsSuffixConfiguration": { + "description": "Full view of the custom domain suffix configuration for ASEv3.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "CustomDnsSuffixConfiguration resource specific properties", + "type": "object", + "properties": { + "provisioningState": { + "enum": [ + "Succeeded", + "Failed", + "Degraded", + "InProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "CustomDnsSuffixProvisioningState", + "modelAsString": false + } + }, + "provisioningDetails": { + "type": "string", + "readOnly": true + }, + "dnsSuffix": { + "description": "The default custom domain suffix to use for all sites deployed on the ASE.", + "type": "string" + }, + "certificateUrl": { + "description": "The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.", + "type": "string" + }, + "keyVaultReferenceIdentity": { + "description": "The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "CustomScaleRule": { + "description": "Container App container Custom scaling rule.", + "type": "object", + "properties": { + "type": { + "description": "Type of the custom scale rule\neg: azure-servicebus, redis etc.", + "type": "string" + }, + "metadata": { + "description": "Metadata properties to describe custom scale rule.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "auth": { + "description": "Authentication secrets for the custom scale rule.", + "type": "array", + "items": { + "$ref": "#/definitions/ScaleRuleAuth" + }, + "x-ms-identifiers": [ + "triggerParameter" + ] + } + } + }, + "Dapr": { + "description": "Container App Dapr configuration.", + "type": "object", + "properties": { + "enabled": { + "description": "Boolean indicating if the Dapr side car is enabled", + "type": "boolean" + }, + "appId": { + "description": "Dapr application identifier", + "type": "string" + }, + "appPort": { + "format": "int32", + "description": "Port on which the Dapr side car", + "type": "integer" + }, + "components": { + "description": "Collection of Dapr components", + "type": "array", + "items": { + "$ref": "#/definitions/DaprComponent" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "DaprComponent": { + "description": "Dapr component configuration", + "type": "object", + "properties": { + "name": { + "description": "Component name", + "type": "string" + }, + "type": { + "description": "Component type", + "type": "string" + }, + "version": { + "description": "Component version", + "type": "string" + }, + "metadata": { + "description": "Component metadata", + "type": "array", + "items": { + "$ref": "#/definitions/DaprMetadata" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "DaprMetadata": { + "description": "Container App Dapr component metadata.", + "type": "object", + "properties": { + "name": { + "description": "Metadata property name.", + "type": "string" + }, + "value": { + "description": "Metadata property value.", + "type": "string" + }, + "secretRef": { + "description": "Name of the Container App secret from which to pull the metadata property value.", + "type": "string" + } + } + }, + "DataProviderMetadata": { + "description": "Additional configuration for a data providers", + "type": "object", + "properties": { + "providerName": { + "type": "string" + }, + "propertyBag": { + "description": "Settings for the data provider", + "type": "array", + "items": { + "$ref": "#/definitions/KeyValuePair[String,Object]" + }, + "readOnly": true, + "x-ms-identifiers": [ + "key" + ] + } + } + }, + "DataTableResponseColumn": { + "description": "Column definition", + "type": "object", + "properties": { + "columnName": { + "description": "Name of the column", + "type": "string" + }, + "dataType": { + "description": "Data type which looks like 'String' or 'Int32'.", + "type": "string" + }, + "columnType": { + "description": "Column Type", + "type": "string" + } + } + }, + "DataTableResponseObject": { + "description": "Data Table which defines columns and raw row values", + "type": "object", + "properties": { + "tableName": { + "description": "Name of the table", + "type": "string" + }, + "columns": { + "description": "List of columns with data types", + "type": "array", + "items": { + "$ref": "#/definitions/DataTableResponseColumn" + }, + "x-ms-identifiers": [ + "columnName" + ] + }, + "rows": { + "description": "Raw row values", + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "DefaultErrorResponse": { + "description": "App Service error response.", + "type": "object", + "properties": { + "error": { + "description": "Error model.", + "type": "object", + "properties": { + "code": { + "description": "Standardized string to programmatically identify the error.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Detailed error description and debugging information.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "Detailed error description and debugging information.", + "type": "string", + "readOnly": true + }, + "details": { + "type": "array", + "items": { + "description": "Detailed errors.", + "type": "object", + "properties": { + "code": { + "description": "Standardized string to programmatically identify the error.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Detailed error description and debugging information.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "Detailed error description and debugging information.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "x-ms-identifiers": [] + }, + "innererror": { + "description": "More information to debug error.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + } + } + }, + "DeletedSite": { + "description": "A deleted app.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "DeletedSite resource specific properties", + "type": "object", + "properties": { + "deletedSiteId": { + "format": "int32", + "description": "Numeric id for the deleted site", + "type": "integer", + "readOnly": true + }, + "deletedTimestamp": { + "description": "Time in UTC when the app was deleted.", + "type": "string", + "readOnly": true + }, + "subscription": { + "description": "Subscription containing the deleted site", + "type": "string", + "readOnly": true + }, + "resourceGroup": { + "description": "ResourceGroup that contained the deleted site", + "type": "string", + "readOnly": true + }, + "deletedSiteName": { + "description": "Name of the deleted site", + "type": "string", + "readOnly": true + }, + "slot": { + "description": "Slot of the deleted site", + "type": "string", + "readOnly": true + }, + "kind": { + "description": "Kind of site that was deleted", + "type": "string", + "readOnly": true + }, + "geoRegionName": { + "description": "Geo Region of the deleted site", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "DetectorInfo": { + "description": "Definition of Detector", + "type": "object", + "properties": { + "id": { + "description": "Id of detector", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of detector", + "type": "string", + "readOnly": true + }, + "description": { + "description": "Short description of the detector and its purpose.", + "type": "string", + "readOnly": true + }, + "author": { + "description": "Author of the detector.", + "type": "string", + "readOnly": true + }, + "category": { + "description": "Problem category. This serves for organizing group for detectors.", + "type": "string", + "readOnly": true + }, + "supportTopicList": { + "description": "List of Support Topics for which this detector is enabled.", + "type": "array", + "items": { + "$ref": "#/definitions/SupportTopic" + }, + "readOnly": true + }, + "analysisType": { + "description": "Analysis Types for which this detector should apply to.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "type": { + "description": "Whether this detector is an Analysis Detector or not.", + "enum": [ + "Detector", + "Analysis", + "CategoryOverview" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DetectorType", + "modelAsString": false + } + }, + "score": { + "format": "float", + "description": "Defines score of a detector to power ML based matching.", + "type": "number", + "readOnly": true + } + } + }, + "DetectorResponse": { + "description": "Class representing Response from Detector", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "DetectorResponse resource specific properties", + "type": "object", + "properties": { + "metadata": { + "$ref": "#/definitions/DetectorInfo", + "description": "metadata for the detector" + }, + "dataset": { + "description": "Data Set", + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticData" + }, + "x-ms-identifiers": [] + }, + "status": { + "$ref": "#/definitions/Status", + "description": "Indicates status of the most severe insight." + }, + "dataProvidersMetadata": { + "description": "Additional configuration for different data providers to be used by the UI", + "type": "array", + "items": { + "$ref": "#/definitions/DataProviderMetadata" + }, + "x-ms-identifiers": [ + "providerName" + ] + }, + "suggestedUtterances": { + "$ref": "#/definitions/QueryUtterancesResults", + "description": "Suggested utterances where the detector can be applicable." + } + }, + "x-ms-client-flatten": true + } + } + }, + "DetectorResponseCollection": { + "description": "Collection of detector responses", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/DetectorResponse" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "DiagnosticData": { + "description": "Set of data with rendering instructions", + "type": "object", + "properties": { + "table": { + "$ref": "#/definitions/DataTableResponseObject", + "description": "Data in table form" + }, + "renderingProperties": { + "$ref": "#/definitions/Rendering", + "description": "Properties that describe how the table should be rendered" + } + } + }, + "Dimension": { + "description": "Dimension of a resource metric. For e.g. instance specific HTTP requests for a web app, \nwhere instance name is dimension of the metric HTTP request", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "internalName": { + "type": "string" + }, + "toBeExportedForShoebox": { + "type": "boolean" + } + } + }, + "EnvironmentVar": { + "description": "Container App container environment variable.", + "type": "object", + "properties": { + "name": { + "description": "Environment variable name.", + "type": "string" + }, + "value": { + "description": "Non-secret environment variable value.", + "type": "string" + }, + "secretRef": { + "description": "Name of the Container App secret from which to pull the environment variable value.", + "type": "string" + } + } + }, + "ErrorEntity": { + "description": "Body of the error response returned from the API.", + "type": "object", + "properties": { + "extendedCode": { + "description": "Type of error.", + "type": "string" + }, + "messageTemplate": { + "description": "Message template.", + "type": "string" + }, + "parameters": { + "description": "Parameters for the template.", + "type": "array", + "items": { + "type": "string" + } + }, + "innerErrors": { + "description": "Inner errors.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorEntity" + }, + "x-ms-identifiers": [] + }, + "details": { + "description": "Error Details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorEntity" + }, + "x-ms-identifiers": [] + }, + "target": { + "description": "The error target.", + "type": "string" + }, + "code": { + "description": "Basic error code.", + "type": "string" + }, + "message": { + "description": "Any details of the error.", + "type": "string" + } + } + }, + "Experiments": { + "description": "Routing rules in production experiments.", + "type": "object", + "properties": { + "rampUpRules": { + "description": "List of ramp-up rules.", + "type": "array", + "items": { + "$ref": "#/definitions/RampUpRule" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ExtendedLocation": { + "description": "Extended Location.", + "type": "object", + "properties": { + "name": { + "description": "Name of extended location.", + "type": "string" + }, + "type": { + "description": "Type of extended location.", + "type": "string", + "readOnly": true + } + } + }, + "HandlerMapping": { + "description": "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.", + "type": "object", + "properties": { + "extension": { + "description": "Requests with this extension will be handled using the specified FastCGI application.", + "type": "string" + }, + "scriptProcessor": { + "description": "The absolute path to the FastCGI application.", + "type": "string" + }, + "arguments": { + "description": "Command-line arguments to be passed to the script processor.", + "type": "string" + } + } + }, + "HostNameBinding": { + "description": "A hostname binding object.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "HostNameBinding resource specific properties", + "type": "object", + "properties": { + "siteName": { + "description": "App Service app name.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "domainId": { + "description": "Fully qualified ARM domain resource URI.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "azureResourceName": { + "description": "Azure resource name.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "azureResourceType": { + "description": "Azure resource type.", + "enum": [ + "Website", + "TrafficManager" + ], + "type": "string", + "x-ms-enum": { + "name": "AzureResourceType", + "modelAsString": false + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "customHostNameDnsRecordType": { + "description": "Custom DNS record type.", + "enum": [ + "CName", + "A" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomHostNameDnsRecordType", + "modelAsString": false + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "hostNameType": { + "description": "Hostname type.", + "enum": [ + "Verified", + "Managed" + ], + "type": "string", + "x-ms-enum": { + "name": "HostNameType", + "modelAsString": false + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "sslState": { + "description": "SSL type", + "enum": [ + "Disabled", + "SniEnabled", + "IpBasedEnabled" + ], + "type": "string", + "x-ms-enum": { + "name": "SslState", + "modelAsString": false + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "thumbprint": { + "description": "SSL certificate thumbprint", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "virtualIP": { + "description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "HostNameBindingCollection": { + "description": "Collection of hostname bindings.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/HostNameBinding" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "HostNameSslState": { + "description": "SSL-enabled hostname.", + "type": "object", + "properties": { + "name": { + "description": "Hostname.", + "type": "string" + }, + "sslState": { + "description": "SSL type.", + "enum": [ + "Disabled", + "SniEnabled", + "IpBasedEnabled" + ], + "type": "string", + "x-ms-enum": { + "name": "SslState", + "modelAsString": false + } + }, + "virtualIP": { + "description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.", + "type": "string" + }, + "thumbprint": { + "description": "SSL certificate thumbprint.", + "type": "string" + }, + "toUpdate": { + "description": "Set to true to update existing hostname.", + "type": "boolean" + }, + "hostType": { + "description": "Indicates whether the hostname is a standard or repository hostname.", + "enum": [ + "Standard", + "Repository" + ], + "type": "string", + "x-ms-enum": { + "name": "HostType", + "modelAsString": false + } + } + } + }, + "HostingEnvironmentProfile": { + "description": "Specification for an App Service Environment to use for this resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID of the App Service Environment.", + "type": "string" + }, + "name": { + "description": "Name of the App Service Environment.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type of the App Service Environment.", + "type": "string", + "readOnly": true + } + } + }, + "HttpScaleRule": { + "description": "Container App container Custom scaling rule.", + "type": "object", + "properties": { + "metadata": { + "description": "Metadata properties to describe http scale rule.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "auth": { + "description": "Authentication secrets for the custom scale rule.", + "type": "array", + "items": { + "$ref": "#/definitions/ScaleRuleAuth" + }, + "x-ms-identifiers": [ + "triggerParameter" + ] + } + } + }, + "HybridConnection": { + "description": "Hybrid Connection contract. This is used to configure a Hybrid Connection.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "HybridConnection resource specific properties", + "type": "object", + "properties": { + "serviceBusNamespace": { + "description": "The name of the Service Bus namespace.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "relayName": { + "description": "The name of the Service Bus relay.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "relayArmUri": { + "description": "The ARM URI to the Service Bus relay.", + "type": "string" + }, + "hostname": { + "description": "The hostname of the endpoint.", + "type": "string" + }, + "port": { + "format": "int32", + "description": "The port of the endpoint.", + "type": "integer" + }, + "sendKeyName": { + "description": "The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.", + "type": "string" + }, + "sendKeyValue": { + "description": "The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead.", + "type": "string" + }, + "serviceBusSuffix": { + "description": "The suffix for the service bus endpoint. By default this is .servicebus.windows.net", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "Identifier": { + "description": "A domain specific resource identifier.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "Identifier resource specific properties", + "type": "object", + "properties": { + "id": { + "description": "String representation of the identity.", + "type": "string", + "x-ms-client-name": "value" + } + }, + "x-ms-client-flatten": true + } + } + }, + "IdentifierCollection": { + "description": "Collection of identifiers.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Identifier" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "IpSecurityRestriction": { + "description": "IP security restriction on an app.", + "type": "object", + "properties": { + "ipAddress": { + "description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.", + "type": "string" + }, + "subnetMask": { + "description": "Subnet mask for the range of IP addresses the restriction is valid for.", + "type": "string" + }, + "vnetSubnetResourceId": { + "description": "Virtual network resource id", + "type": "string" + }, + "vnetTrafficTag": { + "format": "int32", + "description": "(internal) Vnet traffic tag", + "type": "integer" + }, + "subnetTrafficTag": { + "format": "int32", + "description": "(internal) Subnet traffic tag", + "type": "integer" + }, + "action": { + "description": "Allow or Deny access for this IP range.", + "type": "string" + }, + "tag": { + "description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.", + "enum": [ + "Default", + "XffProxy", + "ServiceTag" + ], + "type": "string", + "x-ms-enum": { + "name": "IpFilterTag", + "modelAsString": true + } + }, + "priority": { + "format": "int32", + "description": "Priority of IP restriction rule.", + "type": "integer" + }, + "name": { + "description": "IP restriction rule name.", + "type": "string" + }, + "description": { + "description": "IP restriction rule description.", + "type": "string" + }, + "headers": { + "description": "IP restriction rule headers.\nX-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). \nThe matching logic is ..\n- If the property is null or empty (default), all hosts(or lack of) are allowed.\n- A value is compared using ordinal-ignore-case (excluding port number).\n- Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com\n but not the root domain contoso.com or multi-level foo.bar.contoso.com\n- Unicode host names are allowed but are converted to Punycode for matching.\n\nX-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).\nThe matching logic is ..\n- If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.\n- If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.\n\nX-Azure-FDID and X-FD-HealthProbe.\nThe matching logic is exact match.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "KeyValuePair[String,Object]": { + "type": "object", + "properties": { + "key": { + "type": "string", + "readOnly": true + }, + "value": { + "type": "object", + "readOnly": true + } + } + }, + "KubeEnvironmentProfile": { + "description": "Specification for a Kubernetes Environment to use for this resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID of the Kubernetes Environment.", + "type": "string" + }, + "name": { + "description": "Name of the Kubernetes Environment.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type of the Kubernetes Environment.", + "type": "string", + "readOnly": true + } + } + }, + "LocalizableString": { + "description": "Localizable string object containing the name and a localized value.", + "type": "object", + "properties": { + "value": { + "description": "Non-localized name.", + "type": "string" + }, + "localizedValue": { + "description": "Localized name.", + "type": "string" + } + } + }, + "LogSpecification": { + "description": "Log Definition of a single resource metric.", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "blobDuration": { + "type": "string" + }, + "logFilterPattern": { + "type": "string" + } + } + }, + "ManagedServiceIdentity": { + "description": "Managed service identity.", + "type": "object", + "properties": { + "type": { + "description": "Type of managed service identity.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedServiceIdentityType", + "modelAsString": false + } + }, + "tenantId": { + "description": "Tenant of managed service identity.", + "type": "string", + "readOnly": true + }, + "principalId": { + "description": "Principal Id of managed service identity.", + "type": "string", + "readOnly": true + }, + "userAssignedIdentities": { + "description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/userAssignedIdentity" + } + } + } + }, + "MetricAvailability": { + "description": "Retention policy of a resource metric.", + "type": "object", + "properties": { + "timeGrain": { + "type": "string" + }, + "blobDuration": { + "type": "string" + } + } + }, + "MetricSpecification": { + "description": "Definition of a single resource metric.", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "displayDescription": { + "type": "string" + }, + "unit": { + "type": "string" + }, + "aggregationType": { + "type": "string" + }, + "supportsInstanceLevelAggregation": { + "type": "boolean" + }, + "enableRegionalMdmAccount": { + "type": "boolean" + }, + "sourceMdmAccount": { + "type": "string" + }, + "sourceMdmNamespace": { + "type": "string" + }, + "metricFilterPattern": { + "type": "string" + }, + "fillGapWithZero": { + "type": "boolean" + }, + "isInternal": { + "type": "boolean" + }, + "dimensions": { + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "category": { + "type": "string" + }, + "availabilities": { + "type": "array", + "items": { + "$ref": "#/definitions/MetricAvailability" + }, + "x-ms-identifiers": [] + }, + "supportedTimeGrainTypes": { + "type": "array", + "items": { + "type": "string" + } + }, + "supportedAggregationTypes": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "NameIdentifier": { + "description": "Identifies an object.", + "type": "object", + "properties": { + "name": { + "description": "Name of the object.", + "type": "string" + } + } + }, + "NameValuePair": { + "description": "Name value pair.", + "type": "object", + "properties": { + "name": { + "description": "Pair name.", + "type": "string" + }, + "value": { + "description": "Pair value.", + "type": "string" + } + } + }, + "Operation": { + "description": "An operation on a resource.", + "type": "object", + "properties": { + "id": { + "description": "Operation ID.", + "type": "string" + }, + "name": { + "description": "Operation name.", + "type": "string" + }, + "status": { + "description": "The current status of the operation.", + "enum": [ + "InProgress", + "Failed", + "Succeeded", + "TimedOut", + "Created" + ], + "type": "string", + "x-ms-enum": { + "name": "OperationStatus", + "modelAsString": false + } + }, + "errors": { + "description": "Any errors associate with the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorEntity" + }, + "x-ms-identifiers": [] + }, + "createdTime": { + "format": "date-time", + "description": "Time when operation has started.", + "type": "string" + }, + "modifiedTime": { + "format": "date-time", + "description": "Time when operation has been updated.", + "type": "string" + }, + "expirationTime": { + "format": "date-time", + "description": "Time when operation will expire.", + "type": "string" + }, + "geoMasterOperationId": { + "format": "uuid", + "description": "Applicable only for stamp operation ids.", + "type": "string", + "example": "00000000-0000-0000-0000-000000000000" + } + } + }, + "PrivateEndpointConnectionCollection": { + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/RemotePrivateEndpointConnectionARMResource" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateLinkConnectionApprovalRequest": { + "description": "A request to approve or reject a private endpoint connection", + "type": "object", + "properties": { + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkConnectionState" + } + } + }, + "PrivateLinkConnectionApprovalRequestResource": { + "description": "Private Endpoint Connection Approval ARM resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkConnectionApprovalRequest", + "description": "Core resource properties", + "type": "object", + "x-ms-client-flatten": true + } + } + }, + "PrivateLinkConnectionState": { + "description": "The state of a private link connection", + "type": "object", + "properties": { + "status": { + "description": "Status of a private link connection", + "type": "string" + }, + "description": { + "description": "Description of a private link connection", + "type": "string" + }, + "actionsRequired": { + "description": "ActionsRequired for a private link connection", + "type": "string" + } + } + }, + "PrivateLinkResource": { + "description": "A private link resource", + "required": [ + "id", + "name", + "type", + "properties" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "description": "Name of a private link resource", + "type": "string" + }, + "type": { + "type": "string" + }, + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Properties of a private link resource" + } + } + }, + "PrivateLinkResourceProperties": { + "description": "Properties of a private link resource", + "type": "object", + "properties": { + "groupId": { + "description": "GroupId of a private link resource", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "RequiredMembers of a private link resource", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "description": "RequiredZoneNames of a private link resource", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "PrivateLinkResourcesWrapper": { + "description": "Wrapper for a collection of private link resources", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + } + }, + "ProxyOnlyResource": { + "description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.", + "type": "object", + "properties": { + "id": { + "description": "Resource Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource Name.", + "type": "string", + "readOnly": true + }, + "kind": { + "description": "Kind of resource.", + "type": "string" + }, + "type": { + "description": "Resource type.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "PushSettings": { + "description": "Push settings for the App.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "PushSettings resource specific properties", + "required": [ + "isPushEnabled" + ], + "type": "object", + "properties": { + "isPushEnabled": { + "description": "Gets or sets a flag indicating whether the Push endpoint is enabled.", + "type": "boolean" + }, + "tagWhitelistJson": { + "description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.", + "type": "string" + }, + "tagsRequiringAuth": { + "description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.", + "type": "string" + }, + "dynamicTagsJson": { + "description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "QueryUtterancesResult": { + "description": "Result for utterances query.", + "type": "object", + "properties": { + "sampleUtterance": { + "$ref": "#/definitions/SampleUtterance", + "description": "A sample utterance." + }, + "score": { + "format": "float", + "description": "Score of a sample utterance.", + "type": "number" + } + } + }, + "QueryUtterancesResults": { + "description": "Suggested utterances where the detector can be applicable", + "type": "object", + "properties": { + "query": { + "description": "Search Query.", + "type": "string" + }, + "results": { + "description": "Array of utterance results for search query.", + "type": "array", + "items": { + "$ref": "#/definitions/QueryUtterancesResult" + }, + "x-ms-identifiers": [] + } + } + }, + "QueueScaleRule": { + "description": "Container App container Azure Queue based scaling rule.", + "type": "object", + "properties": { + "queueName": { + "description": "Queue name.", + "type": "string" + }, + "queueLength": { + "format": "int32", + "description": "Queue length.", + "type": "integer" + }, + "auth": { + "description": "Authentication secrets for the queue scale rule.", + "type": "array", + "items": { + "$ref": "#/definitions/ScaleRuleAuth" + }, + "x-ms-identifiers": [ + "triggerParameter" + ] + } + } + }, + "RampUpRule": { + "description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.", + "type": "object", + "properties": { + "actionHostName": { + "description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.", + "type": "string" + }, + "reroutePercentage": { + "format": "double", + "description": "Percentage of the traffic which will be redirected to ActionHostName.", + "type": "number" + }, + "changeStep": { + "format": "double", + "description": "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.", + "type": "number" + }, + "changeIntervalInMinutes": { + "format": "int32", + "description": "Specifies interval in minutes to reevaluate ReroutePercentage.", + "type": "integer" + }, + "minReroutePercentage": { + "format": "double", + "description": "Specifies lower boundary above which ReroutePercentage will stay.", + "type": "number" + }, + "maxReroutePercentage": { + "format": "double", + "description": "Specifies upper boundary below which ReroutePercentage will stay.", + "type": "number" + }, + "changeDecisionCallbackUrl": { + "description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/", + "type": "string" + }, + "name": { + "description": "Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.", + "type": "string" + } + } + }, + "RemotePrivateEndpointConnectionARMResource": { + "description": "Remote Private Endpoint Connection ARM resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "RemotePrivateEndpointConnectionARMResource resource specific properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true + }, + "privateEndpoint": { + "$ref": "#/definitions/ArmIdWrapper", + "description": "PrivateEndpoint of a remote private endpoint connection" + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkConnectionState" + }, + "ipAddresses": { + "description": "Private IPAddresses mapped to the remote private endpoint", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "Rendering": { + "description": "Instructions for rendering the data", + "type": "object", + "properties": { + "type": { + "description": "Rendering Type", + "enum": [ + "NoGraph", + "Table", + "TimeSeries", + "TimeSeriesPerInstance", + "PieChart", + "DataSummary", + "Email", + "Insights", + "DynamicInsight", + "Markdown", + "Detector", + "DropDown", + "Card", + "Solution", + "Guage", + "Form", + "ChangeSets", + "ChangeAnalysisOnboarding", + "ChangesView", + "AppInsight", + "DependencyGraph", + "DownTime", + "SummaryCard", + "SearchComponent", + "AppInsightEnablement" + ], + "type": "string", + "x-ms-enum": { + "name": "RenderingType", + "modelAsString": false + } + }, + "title": { + "description": "Title of data", + "type": "string" + }, + "description": { + "description": "Description of the data that will help it be interpreted", + "type": "string" + } + } + }, + "RequestsBasedTrigger": { + "description": "Trigger based on total requests.", + "type": "object", + "properties": { + "count": { + "format": "int32", + "description": "Request Count.", + "type": "integer" + }, + "timeInterval": { + "description": "Time interval.", + "type": "string" + } + } + }, + "Resource": { + "description": "Azure resource. This resource is tracked in Azure Resource Manager", + "required": [ + "location" + ], + "type": "object", + "properties": { + "id": { + "description": "Resource Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource Name.", + "type": "string", + "readOnly": true + }, + "kind": { + "description": "Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.", + "type": "string" + }, + "location": { + "description": "Resource Location.", + "type": "string" + }, + "type": { + "description": "Resource type.", + "type": "string", + "readOnly": true + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-azure-resource": true + }, + "SampleUtterance": { + "description": "Sample utterance.", + "type": "object", + "properties": { + "text": { + "description": "Text attribute of sample utterance.", + "type": "string" + }, + "links": { + "description": "Links attribute of sample utterance.", + "type": "array", + "items": { + "type": "string" + } + }, + "qid": { + "description": "Question id of sample utterance (for stackoverflow questions titles).", + "type": "string" + } + } + }, + "Scale": { + "description": "Container App scaling configurations.", + "type": "object", + "properties": { + "minReplicas": { + "format": "int32", + "description": "Optional. Minimum number of container replicas.", + "type": "integer" + }, + "maxReplicas": { + "format": "int32", + "description": "Optional. Maximum number of container replicas. Defaults to 10 if not set.", + "type": "integer" + }, + "rules": { + "description": "Scaling rules.", + "type": "array", + "items": { + "$ref": "#/definitions/ScaleRule" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ScaleRule": { + "description": "Container App container scaling rule.", + "type": "object", + "properties": { + "name": { + "description": "Scale Rule Name", + "type": "string" + }, + "azureQueue": { + "$ref": "#/definitions/QueueScaleRule", + "description": "Azure Queue based scaling." + }, + "custom": { + "$ref": "#/definitions/CustomScaleRule", + "description": "Custom scale rule." + }, + "http": { + "$ref": "#/definitions/HttpScaleRule", + "description": "HTTP requests based scaling." + } + } + }, + "ScaleRuleAuth": { + "description": "Auth Secrets for Container App Scale Rule", + "type": "object", + "properties": { + "secretRef": { + "description": "Name of the Container App secret from which to pull the auth params.", + "type": "string" + }, + "triggerParameter": { + "description": "Trigger Parameter that uses the secret", + "type": "string" + } + } + }, + "ServiceSpecification": { + "description": "Resource metrics service provided by Microsoft.Insights resource provider.", + "type": "object", + "properties": { + "metricSpecifications": { + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "logSpecifications": { + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "Site": { + "description": "A web app, a mobile app backend, or an API app.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Site resource specific properties", + "type": "object", + "properties": { + "state": { + "description": "Current state of the app.", + "type": "string", + "readOnly": true + }, + "hostNames": { + "description": "Hostnames associated with the app.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "repositorySiteName": { + "description": "Name of the repository site.", + "type": "string", + "readOnly": true + }, + "usageState": { + "description": "State indicating whether the app has exceeded its quota usage. Read-only.", + "enum": [ + "Normal", + "Exceeded" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "UsageState", + "modelAsString": false + } + }, + "enabled": { + "description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).", + "type": "boolean" + }, + "enabledHostNames": { + "description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "availabilityState": { + "description": "Management information availability state for the app.", + "enum": [ + "Normal", + "Limited", + "DisasterRecoveryMode" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SiteAvailabilityState", + "modelAsString": false + } + }, + "hostNameSslStates": { + "description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.", + "type": "array", + "items": { + "$ref": "#/definitions/HostNameSslState" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "serverFarmId": { + "description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".", + "type": "string" + }, + "reserved": { + "description": "true if reserved; otherwise, false.", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "isXenon": { + "description": "Obsolete: Hyper-V sandbox.", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "hyperV": { + "description": "Hyper-V sandbox.", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "lastModifiedTimeUtc": { + "format": "date-time", + "description": "Last time the app was modified, in UTC. Read-only.", + "type": "string", + "readOnly": true + }, + "dnsConfiguration": { + "$ref": "#/definitions/SiteDnsConfig", + "description": "Property to configure various DNS related settings for a site." + }, + "vnetRouteAllEnabled": { + "description": "Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.", + "type": "boolean" + }, + "vnetImagePullEnabled": { + "description": "To enable pulling image over Virtual Network", + "type": "boolean" + }, + "vnetContentShareEnabled": { + "description": "To enable accessing content over virtual network", + "type": "boolean" + }, + "vnetBackupRestoreEnabled": { + "description": "To enable Backup and Restore operations over virtual network", + "type": "boolean" + }, + "siteConfig": { + "$ref": "#/definitions/SiteConfig", + "description": "Configuration of the app." + }, + "functionAppConfig": { + "$ref": "#/definitions/FunctionAppConfig", + "description": "Configuration specific of the Azure Function app." + }, + "daprConfig": { + "$ref": "#/definitions/DaprConfig", + "description": "Dapr configuration of the app." + }, + "workloadProfileName": { + "description": "Workload profile name for function app to execute on.", + "type": "string" + }, + "resourceConfig": { + "$ref": "#/definitions/ResourceConfig", + "description": "Function app resource requirements." + }, + "trafficManagerHostNames": { + "description": "Azure Traffic Manager hostnames associated with the app. Read-only.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "scmSiteAlsoStopped": { + "description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.", + "default": false, + "type": "boolean" + }, + "targetSwapSlot": { + "description": "Specifies which deployment slot this app will swap into. Read-only.", + "type": "string", + "readOnly": true + }, + "hostingEnvironmentProfile": { + "$ref": "#/definitions/HostingEnvironmentProfile", + "description": "App Service Environment to use for the app.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "clientAffinityEnabled": { + "description": "true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.", + "type": "boolean" + }, + "clientCertEnabled": { + "description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.", + "type": "boolean" + }, + "clientCertMode": { + "description": "This composes with ClientCertEnabled setting.\n- ClientCertEnabled: false means ClientCert is ignored.\n- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.\n- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.", + "enum": [ + "Required", + "Optional", + "OptionalInteractiveUser" + ], + "type": "string", + "x-ms-enum": { + "name": "ClientCertMode", + "modelAsString": false + } + }, + "clientCertExclusionPaths": { + "description": "client certificate authentication comma-separated exclusion paths", + "type": "string" + }, + "ipMode": { + "description": "Specifies the IP mode of the app.", + "enum": [ + "IPv4", + "IPv6", + "IPv4AndIPv6" + ], + "type": "string", + "x-ms-enum": { + "name": "IPMode", + "modelAsString": false + } + }, + "endToEndEncryptionEnabled": { + "description": "Whether to use end to end encryption between the FrontEnd and the Worker", + "type": "boolean" + }, + "hostNamesDisabled": { + "description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.", + "type": "boolean" + }, + "customDomainVerificationId": { + "description": "Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.", + "type": "string" + }, + "outboundIpAddresses": { + "description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.", + "type": "string", + "readOnly": true + }, + "possibleOutboundIpAddresses": { + "description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.", + "type": "string", + "readOnly": true + }, + "containerSize": { + "format": "int32", + "description": "Size of the function container.", + "type": "integer" + }, + "dailyMemoryTimeQuota": { + "format": "int32", + "description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only).", + "type": "integer" + }, + "suspendedTill": { + "format": "date-time", + "description": "App suspended till in case memory-time quota is exceeded.", + "type": "string", + "readOnly": true + }, + "maxNumberOfWorkers": { + "format": "int32", + "description": "Maximum number of workers.\nThis only applies to Functions container.", + "type": "integer", + "readOnly": true + }, + "cloningInfo": { + "$ref": "#/definitions/CloningInfo", + "description": "If specified during app creation, the app is cloned from a source app.", + "x-ms-mutability": [ + "create" + ] + }, + "resourceGroup": { + "description": "Name of the resource group the app belongs to. Read-only.", + "type": "string", + "readOnly": true + }, + "isDefaultContainer": { + "description": "true if the app is a default container; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "defaultHostName": { + "description": "Default hostname of the app. Read-only.", + "type": "string", + "readOnly": true + }, + "slotSwapStatus": { + "$ref": "#/definitions/SlotSwapStatus", + "description": "Status of the last deployment slot swap operation.", + "readOnly": true + }, + "httpsOnly": { + "description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests", + "type": "boolean" + }, + "redundancyMode": { + "description": "Site redundancy mode", + "enum": [ + "None", + "Manual", + "Failover", + "ActiveActive", + "GeoRedundant" + ], + "type": "string", + "x-ms-enum": { + "name": "RedundancyMode", + "modelAsString": false + } + }, + "inProgressOperationId": { + "format": "uuid", + "description": "Specifies an operation id if this site has a pending operation.", + "type": "string", + "readOnly": true, + "example": "00000000-0000-0000-0000-000000000000" + }, + "publicNetworkAccess": { + "description": "Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string.", + "type": "string" + }, + "storageAccountRequired": { + "description": "Checks if Customer provided storage account is required", + "type": "boolean" + }, + "keyVaultReferenceIdentity": { + "description": "Identity to use for Key Vault Reference authentication.", + "type": "string" + }, + "autoGeneratedDomainNameLabelScope": { + "description": "Specifies the scope of uniqueness for the default hostname during resource creation", + "enum": [ + "TenantReuse", + "SubscriptionReuse", + "ResourceGroupReuse", + "NoReuse" + ], + "type": "string", + "x-ms-enum": { + "name": "autoGeneratedDomainNameLabelScope", + "modelAsString": false + } + }, + "virtualNetworkSubnetId": { + "description": "Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration.\nThis must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}", + "type": "string" + }, + "managedEnvironmentId": { + "description": "Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}", + "type": "string" + }, + "sku": { + "description": "Current SKU of application based on associated App Service Plan. Some valid SKU values are Free, Shared, Basic, Dynamic, FlexConsumption, Standard, Premium, PremiumV2, PremiumV3, Isolated, IsolatedV2", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "#/definitions/ManagedServiceIdentity" + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation" + } + } + }, + "SiteConfig": { + "description": "Configuration of an App Service app.", + "type": "object", + "properties": { + "numberOfWorkers": { + "format": "int32", + "description": "Number of workers.", + "type": "integer" + }, + "defaultDocuments": { + "description": "Default documents.", + "type": "array", + "items": { + "type": "string" + } + }, + "netFrameworkVersion": { + "description": ".NET Framework version.", + "default": "v4.6", + "type": "string" + }, + "phpVersion": { + "description": "Version of PHP.", + "type": "string" + }, + "pythonVersion": { + "description": "Version of Python.", + "type": "string" + }, + "nodeVersion": { + "description": "Version of Node.js.", + "type": "string" + }, + "powerShellVersion": { + "description": "Version of PowerShell.", + "type": "string" + }, + "linuxFxVersion": { + "description": "Linux App Framework and version", + "type": "string" + }, + "windowsFxVersion": { + "description": "Xenon App Framework and version", + "type": "string" + }, + "requestTracingEnabled": { + "description": "true if request tracing is enabled; otherwise, false.", + "type": "boolean" + }, + "requestTracingExpirationTime": { + "format": "date-time", + "description": "Request tracing expiration time.", + "type": "string" + }, + "remoteDebuggingEnabled": { + "description": "true if remote debugging is enabled; otherwise, false.", + "type": "boolean" + }, + "remoteDebuggingVersion": { + "description": "Remote debugging version.", + "type": "string" + }, + "httpLoggingEnabled": { + "description": "true if HTTP logging is enabled; otherwise, false.", + "type": "boolean" + }, + "acrUseManagedIdentityCreds": { + "description": "Flag to use Managed Identity Creds for ACR pull", + "type": "boolean" + }, + "acrUserManagedIdentityID": { + "description": "If using user managed identity, the user managed identity ClientId", + "type": "string" + }, + "logsDirectorySizeLimit": { + "format": "int32", + "description": "HTTP logs directory size limit.", + "type": "integer" + }, + "detailedErrorLoggingEnabled": { + "description": "true if detailed error logging is enabled; otherwise, false.", + "type": "boolean" + }, + "publishingUsername": { + "description": "Publishing user name.", + "type": "string" + }, + "appSettings": { + "description": "Application settings.", + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "metadata": { + "description": "Application metadata. This property cannot be retrieved, since it may contain secrets.", + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "x-ms-identifiers": [ + "name" + ], + "x-ms-mutability": [ + "create", + "update" + ] + }, + "connectionStrings": { + "description": "Connection strings.", + "type": "array", + "items": { + "$ref": "#/definitions/ConnStringInfo" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "machineKey": { + "$ref": "#/definitions/SiteMachineKey", + "description": "Site MachineKey.", + "readOnly": true + }, + "handlerMappings": { + "description": "Handler mappings.", + "type": "array", + "items": { + "$ref": "#/definitions/HandlerMapping" + }, + "x-ms-identifiers": [ + "extension" + ] + }, + "documentRoot": { + "description": "Document root.", + "type": "string" + }, + "scmType": { + "description": "SCM type.", + "enum": [ + "None", + "Dropbox", + "Tfs", + "LocalGit", + "GitHub", + "CodePlexGit", + "CodePlexHg", + "BitbucketGit", + "BitbucketHg", + "ExternalGit", + "ExternalHg", + "OneDrive", + "VSO", + "VSTSRM" + ], + "type": "string", + "x-ms-enum": { + "name": "ScmType", + "modelAsString": true + } + }, + "use32BitWorkerProcess": { + "description": "true to use 32-bit worker process; otherwise, false.", + "type": "boolean" + }, + "webSocketsEnabled": { + "description": "true if WebSocket is enabled; otherwise, false.", + "type": "boolean" + }, + "alwaysOn": { + "description": "true if Always On is enabled; otherwise, false.", + "type": "boolean" + }, + "javaVersion": { + "description": "Java version.", + "type": "string" + }, + "javaContainer": { + "description": "Java container.", + "type": "string" + }, + "javaContainerVersion": { + "description": "Java container version.", + "type": "string" + }, + "appCommandLine": { + "description": "App command line to launch.", + "type": "string" + }, + "managedPipelineMode": { + "description": "Managed pipeline mode.", + "enum": [ + "Integrated", + "Classic" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedPipelineMode", + "modelAsString": false + } + }, + "virtualApplications": { + "description": "Virtual applications.", + "type": "array", + "items": { + "$ref": "#/definitions/VirtualApplication" + }, + "x-ms-identifiers": [ + "virtualPath" + ] + }, + "loadBalancing": { + "description": "Site load balancing.", + "enum": [ + "WeightedRoundRobin", + "LeastRequests", + "LeastResponseTime", + "WeightedTotalTraffic", + "RequestHash", + "PerSiteRoundRobin", + "LeastRequestsWithTieBreaker" + ], + "type": "string", + "x-ms-enum": { + "name": "SiteLoadBalancing", + "modelAsString": false + } + }, + "experiments": { + "$ref": "#/definitions/Experiments", + "description": "This is work around for polymorphic types." + }, + "limits": { + "$ref": "#/definitions/SiteLimits", + "description": "Site limits." + }, + "autoHealEnabled": { + "description": "true if Auto Heal is enabled; otherwise, false.", + "type": "boolean" + }, + "autoHealRules": { + "$ref": "#/definitions/AutoHealRules", + "description": "Auto Heal rules." + }, + "tracingOptions": { + "description": "Tracing options.", + "type": "string" + }, + "vnetName": { + "description": "Virtual Network name.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "vnetRouteAllEnabled": { + "description": "Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.", + "type": "boolean" + }, + "vnetPrivatePortsCount": { + "format": "int32", + "description": "The number of private ports assigned to this app. These will be assigned dynamically on runtime.", + "type": "integer" + }, + "cors": { + "$ref": "#/definitions/CorsSettings", + "description": "Cross-Origin Resource Sharing (CORS) settings." + }, + "push": { + "$ref": "#/definitions/PushSettings", + "description": "Push endpoint settings." + }, + "apiDefinition": { + "$ref": "#/definitions/ApiDefinitionInfo", + "description": "Information about the formal API definition for the app." + }, + "apiManagementConfig": { + "$ref": "#/definitions/ApiManagementConfig", + "description": "Azure API management settings linked to the app." + }, + "autoSwapSlotName": { + "description": "Auto-swap slot name.", + "type": "string" + }, + "localMySqlEnabled": { + "description": "true to enable local MySQL; otherwise, false.", + "default": false, + "type": "boolean" + }, + "managedServiceIdentityId": { + "format": "int32", + "description": "Managed Service Identity Id", + "type": "integer" + }, + "xManagedServiceIdentityId": { + "format": "int32", + "description": "Explicit Managed Service Identity Id", + "type": "integer" + }, + "keyVaultReferenceIdentity": { + "description": "Identity to use for Key Vault Reference authentication.", + "type": "string" + }, + "ipSecurityRestrictions": { + "description": "IP security restrictions for main.", + "type": "array", + "items": { + "$ref": "#/definitions/IpSecurityRestriction" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "ipSecurityRestrictionsDefaultAction": { + "description": "Default action for main access restriction if no rules are matched.", + "enum": [ + "Allow", + "Deny" + ], + "type": "string", + "x-ms-enum": { + "name": "DefaultAction", + "modelAsString": true + } + }, + "scmIpSecurityRestrictions": { + "description": "IP security restrictions for scm.", + "type": "array", + "items": { + "$ref": "#/definitions/IpSecurityRestriction" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "scmIpSecurityRestrictionsDefaultAction": { + "description": "Default action for scm access restriction if no rules are matched.", + "enum": [ + "Allow", + "Deny" + ], + "type": "string", + "x-ms-enum": { + "name": "DefaultAction", + "modelAsString": true + } + }, + "scmIpSecurityRestrictionsUseMain": { + "description": "IP security restrictions for scm to use main.", + "type": "boolean" + }, + "http20Enabled": { + "description": "Http20Enabled: configures a web site to allow clients to connect over http2.0", + "default": true, + "type": "boolean" + }, + "minTlsVersion": { + "description": "MinTlsVersion: configures the minimum version of TLS required for SSL requests", + "enum": [ + "1.0", + "1.1", + "1.2", + "1.3" + ], + "type": "string", + "x-ms-enum": { + "name": "SupportedTlsVersions", + "modelAsString": true + } + }, + "minTlsCipherSuite": { + "description": "The minimum strength TLS cipher suite allowed for an application", + "enum": [ + "TLS_AES_256_GCM_SHA384", + "TLS_AES_128_GCM_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", + "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_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" + ], + "type": "string", + "x-ms-enum": { + "name": "TlsCipherSuites", + "modelAsString": true + } + }, + "scmMinTlsVersion": { + "description": "ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site", + "enum": [ + "1.0", + "1.1", + "1.2", + "1.3" + ], + "type": "string", + "x-ms-enum": { + "name": "SupportedTlsVersions", + "modelAsString": true + } + }, + "ftpsState": { + "description": "State of FTP / FTPS service", + "enum": [ + "AllAllowed", + "FtpsOnly", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "FtpsState", + "modelAsString": true + } + }, + "preWarmedInstanceCount": { + "format": "int32", + "description": "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans", + "maximum": 10, + "minimum": 0, + "type": "integer" + }, + "functionAppScaleLimit": { + "format": "int32", + "description": "Maximum number of workers that a site can scale out to.\nThis setting only applies to the Consumption and Elastic Premium Plans", + "minimum": 0, + "type": "integer" + }, + "elasticWebAppScaleLimit": { + "format": "int32", + "description": "Maximum number of workers that a site can scale out to.\nThis setting only applies to apps in plans where ElasticScaleEnabled is true", + "minimum": 0, + "type": "integer" + }, + "healthCheckPath": { + "description": "Health check path", + "type": "string" + }, + "functionsRuntimeScaleMonitoringEnabled": { + "description": "Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled,\nthe ScaleController will not monitor event sources directly, but will instead call to the\nruntime to get scale status.", + "type": "boolean" + }, + "websiteTimeZone": { + "description": "Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Time Zones", + "type": "string" + }, + "minimumElasticInstanceCount": { + "format": "int32", + "description": "Number of minimum instance count for a site\nThis setting only applies to the Elastic Plans", + "maximum": 20, + "minimum": 0, + "type": "integer" + }, + "azureStorageAccounts": { + "description": "List of Azure Storage Accounts.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AzureStorageInfoValue" + } + }, + "publicNetworkAccess": { + "description": "Property to allow or block all public traffic.", + "type": "string" + } + } + }, + "FunctionsDeployment": { + "description": "Configuration section for the function app deployment.", + "type": "object", + "properties": { + "storage": { + "description": "Storage for deployed package used by the function app.", + "type": "object", + "properties": { + "type": { + "description": "Property to select Azure Storage type. Available options: blobContainer.", + "type": "string", + "enum": [ + "blobContainer" + ], + "x-ms-enum": { + "name": "FunctionsDeploymentStorageType", + "modelAsString": true + } + }, + "value": { + "description": "Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://.blob.core.windows.net/.", + "type": "string", + "format": "uri" + }, + "authentication": { + "description": "Authentication method to access the storage account for deployment.", + "type": "object", + "properties": { + "type": { + "description": "Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString.", + "type": "string", + "enum": [ + "SystemAssignedIdentity", + "UserAssignedIdentity", + "StorageAccountConnectionString" + ], + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + }, + "userAssignedIdentityResourceId": { + "description": "Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type.", + "type": "string" + }, + "storageAccountConnectionStringName": { + "description": "Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type.", + "type": "string" + } + } + } + } + } + } + }, + "FunctionsAlwaysReadyConfig": { + "description": "Sets the number of 'Always Ready' instances for a function group or a specific function.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready." + }, + "instanceCount": { + "type": "integer", + "format": "int32", + "description": "Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready." + } + } + }, + "FunctionsScaleAndConcurrency": { + "description": "Scale and concurrency settings for the function app.", + "type": "object", + "properties": { + "alwaysReady": { + "description": "'Always Ready' configuration for the function app.", + "type": "array", + "items": { + "$ref": "#/definitions/FunctionsAlwaysReadyConfig" + } + }, + "maximumInstanceCount": { + "description": "The maximum number of instances for the function app.", + "type": "integer", + "format": "int32" + }, + "instanceMemoryMB": { + "description": "Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally.", + "type": "integer", + "format": "int32" + }, + "triggers": { + "type": "object", + "description": "Scale and concurrency settings for the function app triggers.", + "properties": { + "http": { + "type": "object", + "description": "Scale and concurrency settings for the HTTP trigger.", + "properties": { + "perInstanceConcurrency": { + "type": "integer", + "format": "int32", + "description": "The maximum number of concurrent HTTP trigger invocations per instance." + } + } + } + } + } + } + }, + "FunctionsRuntime": { + "description": "Function app runtime name and version.", + "type": "object", + "properties": { + "name": { + "description": "Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom", + "type": "string", + "enum": [ + "dotnet-isolated", + "node", + "java", + "powershell", + "python", + "custom" + ], + "x-ms-enum": { + "name": "RuntimeName", + "modelAsString": true + } + }, + "version": { + "description": "Function app runtime version. Example: 8 (for dotnet-isolated)", + "type": "string", + "x-nullable": true + } + } + }, + "FunctionAppConfig": { + "description": "Function app configuration.", + "type": "object", + "properties": { + "deployment": { + "$ref": "#/definitions/FunctionsDeployment", + "description": "Function app deployment configuration." + }, + "runtime": { + "$ref": "#/definitions/FunctionsRuntime", + "description": "Function app runtime settings." + }, + "scaleAndConcurrency": { + "$ref": "#/definitions/FunctionsScaleAndConcurrency", + "description": "Function app scale and concurrency settings." + } + } + }, + "DaprConfig": { + "description": "App Dapr configuration.", + "type": "object", + "properties": { + "enabled": { + "description": "Boolean indicating if the Dapr side car is enabled", + "type": "boolean", + "default": false + }, + "appId": { + "description": "Dapr application identifier", + "type": "string" + }, + "appPort": { + "format": "int32", + "description": "Tells Dapr which port your application is listening on", + "type": "integer" + }, + "httpReadBufferSize": { + "type": "integer", + "description": "Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB.", + "format": "int32" + }, + "httpMaxRequestSize": { + "type": "integer", + "description": "Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB.", + "format": "int32" + }, + "logLevel": { + "description": "Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info.", + "enum": [ + "info", + "debug", + "warn", + "error" + ], + "type": "string", + "x-ms-enum": { + "name": "daprLogLevel", + "modelAsString": true + } + }, + "enableApiLogging": { + "description": "Enables API logging for the Dapr sidecar", + "type": "boolean" + } + } + }, + "ResourceConfig": { + "description": "Function app resource requirements.", + "type": "object", + "properties": { + "cpu": { + "format": "double", + "description": "Required CPU in cores, e.g. 0.5", + "type": "number" + }, + "memory": { + "description": "Required memory, e.g. \"1Gi\"", + "type": "string" + } + } + }, + "SiteDnsConfig": { + "type": "object", + "properties": { + "dnsServers": { + "description": "List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set.", + "type": "array", + "items": { + "type": "string" + } + }, + "dnsAltServer": { + "description": "Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting.", + "type": "string" + }, + "dnsRetryAttemptTimeout": { + "format": "int32", + "description": "Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3.", + "type": "integer" + }, + "dnsRetryAttemptCount": { + "format": "int32", + "description": "Total number of retries for dns lookup. Allowed range: 1-5. Default is 3.", + "type": "integer" + }, + "dnsMaxCacheTimeout": { + "format": "int32", + "description": "Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled.", + "type": "integer" + }, + "dnsLegacySortOrder": { + "description": "Indicates that sites using Virtual network custom DNS servers are still sorting the list of DNS servers. Read-Only.", + "type": "boolean", + "readOnly": true + } + } + }, + "SiteLimits": { + "description": "Metric limits set on an app.", + "type": "object", + "properties": { + "maxPercentageCpu": { + "format": "double", + "description": "Maximum allowed CPU usage percentage.", + "type": "number" + }, + "maxMemoryInMb": { + "format": "int64", + "description": "Maximum allowed memory usage in MB.", + "type": "integer" + }, + "maxDiskSizeInMb": { + "format": "int64", + "description": "Maximum allowed disk size usage in MB.", + "type": "integer" + } + } + }, + "SiteMachineKey": { + "description": "MachineKey of an app.", + "type": "object", + "properties": { + "validation": { + "description": "MachineKey validation.", + "type": "string" + }, + "validationKey": { + "description": "Validation key.", + "type": "string" + }, + "decryption": { + "description": "Algorithm used for decryption.", + "type": "string" + }, + "decryptionKey": { + "description": "Decryption key.", + "type": "string" + } + } + }, + "SkuCapacity": { + "description": "Description of the App Service plan scale options.", + "type": "object", + "properties": { + "minimum": { + "format": "int32", + "description": "Minimum number of workers for this App Service plan SKU.", + "type": "integer" + }, + "maximum": { + "format": "int32", + "description": "Maximum number of workers for this App Service plan SKU.", + "type": "integer" + }, + "elasticMaximum": { + "format": "int32", + "description": "Maximum number of Elastic workers for this App Service plan SKU.", + "type": "integer" + }, + "default": { + "format": "int32", + "description": "Default number of workers for this App Service plan SKU.", + "type": "integer" + }, + "scaleType": { + "description": "Available scale configurations for an App Service plan.", + "type": "string" + } + } + }, + "SkuDescription": { + "description": "Description of a SKU for a scalable resource.", + "type": "object", + "properties": { + "name": { + "description": "Name of the resource SKU.", + "type": "string" + }, + "tier": { + "description": "Service tier of the resource SKU.", + "type": "string" + }, + "size": { + "description": "Size specifier of the resource SKU.", + "type": "string" + }, + "family": { + "description": "Family code of the resource SKU.", + "type": "string" + }, + "capacity": { + "format": "int32", + "description": "Current number of instances assigned to the resource.", + "type": "integer" + }, + "skuCapacity": { + "$ref": "#/definitions/SkuCapacity", + "description": "Min, max, and default scale values of the SKU." + }, + "locations": { + "description": "Locations of the SKU.", + "type": "array", + "items": { + "type": "string" + } + }, + "capabilities": { + "description": "Capabilities of the SKU, e.g., is traffic manager enabled?", + "type": "array", + "items": { + "$ref": "#/definitions/Capability" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "SlotSwapStatus": { + "description": "The status of the last successful slot swap operation.", + "type": "object", + "properties": { + "timestampUtc": { + "format": "date-time", + "description": "The time the last successful slot swap completed.", + "type": "string", + "readOnly": true + }, + "sourceSlotName": { + "description": "The source slot of the last swap operation.", + "type": "string", + "readOnly": true + }, + "destinationSlotName": { + "description": "The destination slot of the last swap operation.", + "type": "string", + "readOnly": true + } + } + }, + "SlowRequestsBasedTrigger": { + "description": "Trigger based on request execution time.", + "type": "object", + "properties": { + "timeTaken": { + "description": "Time taken.", + "type": "string" + }, + "path": { + "description": "Request Path.", + "type": "string" + }, + "count": { + "format": "int32", + "description": "Request Count.", + "type": "integer" + }, + "timeInterval": { + "description": "Time interval.", + "type": "string" + } + } + }, + "Snapshot": { + "description": "A snapshot of an app.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "Snapshot resource specific properties", + "type": "object", + "properties": { + "time": { + "description": "The time the snapshot was taken.", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "Status": { + "description": "Identify the status of the most severe insight generated by the detector.", + "type": "object", + "properties": { + "message": { + "description": "Descriptive message.", + "type": "string" + }, + "statusId": { + "description": "Level of the most severe insight generated by the detector.", + "enum": [ + "Critical", + "Warning", + "Info", + "Success", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "InsightStatus", + "modelAsString": false + } + } + } + }, + "StatusCodesBasedTrigger": { + "description": "Trigger based on status code.", + "type": "object", + "properties": { + "status": { + "format": "int32", + "description": "HTTP status code.", + "type": "integer" + }, + "subStatus": { + "format": "int32", + "description": "Request Sub Status.", + "type": "integer" + }, + "win32Status": { + "format": "int32", + "description": "Win32 error code.", + "type": "integer" + }, + "count": { + "format": "int32", + "description": "Request Count.", + "type": "integer" + }, + "timeInterval": { + "description": "Time interval.", + "type": "string" + }, + "path": { + "description": "Request Path", + "type": "string" + } + } + }, + "StatusCodesRangeBasedTrigger": { + "description": "Trigger based on range of status codes.", + "type": "object", + "properties": { + "statusCodes": { + "description": "HTTP status code.", + "type": "string" + }, + "path": { + "type": "string" + }, + "count": { + "format": "int32", + "description": "Request Count.", + "type": "integer" + }, + "timeInterval": { + "description": "Time interval.", + "type": "string" + } + } + }, + "StringDictionary": { + "description": "String dictionary resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "Settings.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-client-flatten": true + } + } + }, + "SupportTopic": { + "description": "Defines a unique Support Topic", + "type": "object", + "properties": { + "id": { + "description": "Support Topic Id", + "type": "string", + "readOnly": true + }, + "pesId": { + "description": "Unique resource Id", + "type": "string", + "readOnly": true + } + } + }, + "Template": { + "description": "Container App versioned application definition.\nDefines the desired state of an immutable revision.\nAny changes to this section Will result in a new revision being created", + "type": "object", + "properties": { + "revisionSuffix": { + "description": "User friendly suffix that is appended to the revision name", + "type": "string" + }, + "containers": { + "description": "List of container definitions for the Container App.", + "type": "array", + "items": { + "$ref": "#/definitions/Container" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "scale": { + "$ref": "#/definitions/Scale", + "description": "Scaling properties for the Container App." + }, + "dapr": { + "$ref": "#/definitions/Dapr", + "description": "Dapr configuration for the Container App." + } + } + }, + "User": { + "description": "User credentials used for publishing activity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "User resource specific properties", + "required": [ + "publishingUserName" + ], + "type": "object", + "properties": { + "publishingUserName": { + "description": "Username used for publishing.", + "type": "string" + }, + "publishingPassword": { + "format": "password", + "description": "Password used for publishing.", + "type": "string" + }, + "publishingPasswordHash": { + "format": "password", + "description": "Password hash used for publishing.", + "type": "string" + }, + "publishingPasswordHashSalt": { + "format": "password", + "description": "Password hash salt used for publishing.", + "type": "string" + }, + "scmUri": { + "description": "Url of SCM site.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "VirtualApplication": { + "description": "Virtual application in an app.", + "type": "object", + "properties": { + "virtualPath": { + "description": "Virtual path.", + "type": "string" + }, + "physicalPath": { + "description": "Physical path.", + "type": "string" + }, + "preloadEnabled": { + "description": "true if preloading is enabled; otherwise, false.", + "type": "boolean" + }, + "virtualDirectories": { + "description": "Virtual directories for virtual application.", + "type": "array", + "items": { + "$ref": "#/definitions/VirtualDirectory" + }, + "x-ms-identifiers": [ + "virtualPath" + ] + } + } + }, + "VirtualDirectory": { + "description": "Directory for virtual application.", + "type": "object", + "properties": { + "virtualPath": { + "description": "Path to virtual application.", + "type": "string" + }, + "physicalPath": { + "description": "Physical path.", + "type": "string" + } + } + }, + "VirtualNetworkProfile": { + "description": "Specification for using a Virtual Network.", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "Resource id of the Virtual Network.", + "type": "string" + }, + "name": { + "description": "Name of the Virtual Network (read-only).", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type of the Virtual Network (read-only).", + "type": "string", + "readOnly": true + }, + "subnet": { + "description": "Subnet within the Virtual Network.", + "type": "string" + } + } + }, + "VnetGateway": { + "description": "The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "VnetGateway resource specific properties", + "required": [ + "vpnPackageUri" + ], + "type": "object", + "properties": { + "vnetName": { + "description": "The Virtual Network name.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "vpnPackageUri": { + "description": "The URI where the VPN package can be downloaded.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + } + }, + "x-ms-client-flatten": true + } + } + }, + "VnetInfo": { + "description": "Virtual Network information contract.", + "type": "object", + "properties": { + "vnetResourceId": { + "description": "The Virtual Network's resource ID.", + "type": "string" + }, + "certThumbprint": { + "description": "The client certificate thumbprint.", + "type": "string", + "readOnly": true + }, + "certBlob": { + "description": "A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection.", + "type": "string" + }, + "routes": { + "description": "The routes that this Virtual Network connection uses.", + "type": "array", + "items": { + "$ref": "#/definitions/VnetRoute" + }, + "readOnly": true + }, + "resyncRequired": { + "description": "true if a resync is required; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "dnsServers": { + "description": "DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.", + "type": "string" + }, + "isSwift": { + "description": "Flag that is used to denote if this is VNET injection", + "type": "boolean" + } + } + }, + "VnetInfoResource": { + "description": "Virtual Network information ARM resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VnetInfo", + "description": "Core resource properties", + "type": "object", + "x-ms-client-flatten": true + } + } + }, + "VnetRoute": { + "description": "Virtual Network route contract used to pass routing information for a Virtual Network.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "VnetRoute resource specific properties", + "type": "object", + "properties": { + "startAddress": { + "description": "The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.", + "type": "string" + }, + "endAddress": { + "description": "The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.", + "type": "string" + }, + "routeType": { + "description": "The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network.", + "enum": [ + "DEFAULT", + "INHERITED", + "STATIC" + ], + "type": "string", + "x-ms-enum": { + "name": "RouteType", + "modelAsString": true + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "WebAppCollection": { + "description": "Collection of App Service apps.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Site" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "userAssignedIdentity": { + "description": "User Assigned identity.", + "type": "object", + "properties": { + "principalId": { + "description": "Principal Id of user assigned identity", + "type": "string", + "readOnly": true + }, + "clientId": { + "description": "Client Id of user assigned identity", + "type": "string", + "readOnly": true + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/ContainerApps.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/ContainerApps.json new file mode 100644 index 000000000000..5394d03db254 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/ContainerApps.json @@ -0,0 +1,612 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/containerApps": { + "get": { + "tags": [ + "ContainerApps" + ], + "summary": "Get the Container Apps in a given subscription.", + "operationId": "ContainerApps_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerAppCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container Apps by resource group": { + "$ref": "./examples/ListContainerAppsBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/containerApps": { + "get": { + "tags": [ + "ContainerApps" + ], + "summary": "Get the Container Apps in a given resource group.", + "operationId": "ContainerApps_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerAppCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container Apps by resource group": { + "$ref": "./examples/ListContainerAppsByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/containerApps/{name}": { + "get": { + "tags": [ + "ContainerApps" + ], + "summary": "Get the properties of a Container App.", + "operationId": "ContainerApps_Get", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/ContainerApp" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container App": { + "$ref": "./examples/GetContainerApp.json" + } + } + }, + "put": { + "tags": [ + "ContainerApps" + ], + "summary": "Create or update a Container App.", + "description": "Description for Create or update a Container App.", + "operationId": "ContainerApps_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "containerAppEnvelope", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerApp" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "No change performed on the Container App.", + "schema": { + "$ref": "#/definitions/ContainerApp" + } + }, + "201": { + "description": "Container App create or update has been started.", + "schema": { + "$ref": "#/definitions/ContainerApp" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update Container App": { + "$ref": "./examples/CreateOrUpdateContainerApp.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "ContainerApps" + ], + "summary": "Delete a Container App.", + "description": "Description for Delete a Container App.", + "operationId": "ContainerApps_Delete", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Container App deleted successfully." + }, + "202": { + "description": "Delete operation is in progress." + }, + "204": { + "description": "Container App does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Container App": { + "$ref": "./examples/DeleteContainerApp.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/containerApps/{name}/listSecrets": { + "post": { + "tags": [ + "ContainerApps" + ], + "summary": "List secrets for a container app", + "operationId": "ContainerApps_ListSecrets", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretsCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container Apps Secrets": { + "$ref": "./examples/ListContainerAppSecrets.json" + } + } + } + } + }, + "definitions": { + "Configuration": { + "description": "Non versioned Container App configuration properties that define the mutable settings of a Container app", + "type": "object", + "properties": { + "secrets": { + "description": "Collection of secrets used by a Container app", + "type": "array", + "items": { + "$ref": "#/definitions/Secret" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "activeRevisionsMode": { + "description": "ActiveRevisionsMode controls how active revisions are handled for the Container app:\nMultiple: multiple revisions can be active. If no value if provided, this is the defaultSingle: Only one revision can be active at a time. Revision weights can not be used in this mode", + "enum": [ + "multiple", + "single" + ], + "type": "string", + "x-ms-enum": { + "name": "ActiveRevisionsMode", + "modelAsString": true + } + }, + "ingress": { + "$ref": "#/definitions/Ingress", + "description": "Ingress configurations." + }, + "registries": { + "description": "Collection of private container registry credentials for containers used by the Container app", + "type": "array", + "items": { + "$ref": "#/definitions/RegistryCredentials" + }, + "x-ms-identifiers": [ + "server" + ] + } + } + }, + "ContainerApp": { + "description": "Container App.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "ContainerApp resource specific properties", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the Container App.", + "enum": [ + "InProgress", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ContainerAppProvisioningState", + "modelAsString": true + } + }, + "kubeEnvironmentId": { + "description": "Resource ID of the Container App's KubeEnvironment.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "latestRevisionName": { + "description": "Name of the latest revision of the Container App.", + "type": "string", + "readOnly": true + }, + "latestRevisionFqdn": { + "description": "Fully Qualified Domain Name of the latest revision of the Container App.", + "type": "string", + "readOnly": true + }, + "configuration": { + "$ref": "#/definitions/Configuration", + "description": "Non versioned Container App configuration properties." + }, + "template": { + "$ref": "./CommonDefinitions.json#/definitions/Template", + "description": "Container App versioned application definition." + } + }, + "x-ms-client-flatten": true + } + } + }, + "ContainerAppCollection": { + "description": "Container App collection ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerApp" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "SecretsCollection": { + "description": "Container App Secrets Collection ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerAppSecret" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "Ingress": { + "description": "Container App Ingress configuration.", + "type": "object", + "properties": { + "fqdn": { + "description": "Hostname.", + "type": "string", + "readOnly": true + }, + "external": { + "description": "Bool indicating if app exposes an external http endpoint", + "default": false, + "type": "boolean" + }, + "targetPort": { + "format": "int32", + "description": "Target Port in containers for traffic from ingress", + "type": "integer" + }, + "transport": { + "description": "Ingress transport protocol", + "enum": [ + "auto", + "http", + "http2" + ], + "type": "string", + "x-ms-enum": { + "name": "IngressTransportMethod", + "modelAsString": true + } + }, + "traffic": { + "type": "array", + "items": { + "$ref": "#/definitions/TrafficWeight" + }, + "x-ms-identifiers": [ + "revisionName" + ] + }, + "allowInsecure": { + "description": "Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections", + "type": "boolean" + } + } + }, + "RegistryCredentials": { + "description": "Container App Private Registry", + "type": "object", + "properties": { + "server": { + "description": "Container Registry Server", + "type": "string" + }, + "username": { + "description": "Container Registry Username", + "type": "string" + }, + "passwordSecretRef": { + "description": "The name of the Secret that contains the registry login password", + "type": "string" + } + } + }, + "Secret": { + "description": "Container App Secret.", + "type": "object", + "properties": { + "name": { + "description": "Secret Name.", + "type": "string" + }, + "value": { + "description": "Secret Value.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + }, + "ContainerAppSecret": { + "description": "Container App Secret.", + "type": "object", + "properties": { + "name": { + "description": "Secret Name.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Secret Value.", + "type": "string", + "readOnly": true + } + } + }, + "TrafficWeight": { + "description": "Traffic weight assigned to a revision", + "type": "object", + "properties": { + "revisionName": { + "description": "Name of a revision", + "type": "string" + }, + "weight": { + "format": "int32", + "description": "Traffic weight assigned to a revision", + "type": "integer" + }, + "latestRevision": { + "description": "Indicates that the traffic weight belongs to a latest stable revision", + "default": false, + "type": "boolean" + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group to which the resource belongs.", + "required": true, + "type": "string", + "maxLength": 90, + "minLength": 1, + "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$", + "x-ms-parameter-location": "method" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API Version", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + } + }, + "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/web/resource-manager/Microsoft.Web/stable/2024-04-01/ContainerAppsRevisions.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/ContainerAppsRevisions.json new file mode 100644 index 000000000000..b1865d81e01e --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/ContainerAppsRevisions.json @@ -0,0 +1,427 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "ContainerAppsRevisions API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/containerApps/{containerAppName}/revisions": { + "get": { + "tags": [ + "ContainerAppsRevisions" + ], + "summary": "Get the Revisions for a given Container App.", + "operationId": "ContainerAppsRevisions_ListRevisions", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App for which Revisions are needed.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RevisionCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container App's revisions": { + "$ref": "./examples/ListRevisions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/containerApps/{containerAppName}/revisions/{name}": { + "get": { + "tags": [ + "ContainerAppsRevisions" + ], + "summary": "Get a revision of a Container App.", + "operationId": "ContainerAppsRevisions_GetRevision", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Container App Revision.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Revision" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container App's revision": { + "$ref": "./examples/GetRevision.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/containerApps/{containerAppName}/revisions/{name}/activate": { + "post": { + "tags": [ + "ContainerAppsRevisions" + ], + "summary": "Activates a revision for a Container App", + "operationId": "ContainerAppsRevisions_ActivateRevision", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Container App Revision to activate", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Container App revision was activated" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Activate Container App's revision": { + "$ref": "./examples/ActivateRevision.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/containerApps/{containerAppName}/revisions/{name}/deactivate": { + "post": { + "tags": [ + "ContainerAppsRevisions" + ], + "summary": "Deactivates a revision for a Container App", + "operationId": "ContainerAppsRevisions_DeactivateRevision", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Container App Revision to deactivate", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Container App revision was deactivated" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Deactivate Container App's revision": { + "$ref": "./examples/DeactivateRevision.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/containerApps/{containerAppName}/revisions/{name}/restart": { + "post": { + "tags": [ + "ContainerAppsRevisions" + ], + "summary": "Restarts a revision for a Container App", + "operationId": "ContainerAppsRevisions_RestartRevision", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Container App Revision to restart", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Container App revision was restarted" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Restart Container App's revision": { + "$ref": "./examples/RestartRevision.json" + } + } + } + } + }, + "definitions": { + "Revision": { + "description": "Container App Revision.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Revision resource specific properties", + "type": "object", + "properties": { + "createdTime": { + "format": "date-time", + "description": "Timestamp describing when the revision was created\nby controller", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "Fully qualified domain name of the revision", + "type": "string", + "readOnly": true + }, + "template": { + "$ref": "./CommonDefinitions.json#/definitions/Template", + "description": "Container App Revision Template with all possible settings and the\ndefaults if user did not provide them. The defaults are populated\nas they were at the creation time", + "readOnly": true + }, + "active": { + "description": "Boolean describing if the Revision is Active", + "type": "boolean", + "readOnly": true + }, + "replicas": { + "format": "int32", + "description": "Number of pods currently running for this revision", + "type": "integer", + "readOnly": true + }, + "trafficWeight": { + "format": "int32", + "description": "Traffic weight assigned to this revision", + "type": "integer", + "readOnly": true + }, + "provisioningError": { + "description": "Optional Field - Platform Error Message", + "type": "string", + "readOnly": true + }, + "healthState": { + "description": "Current health State of the revision", + "enum": [ + "Healthy", + "Unhealthy", + "None" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RevisionHealthState", + "modelAsString": true + } + }, + "provisioningState": { + "description": "Current provisioning State of the revision", + "enum": [ + "Provisioning", + "Provisioned", + "Failed", + "Deprovisioning", + "Deprovisioned" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RevisionProvisioningState", + "modelAsString": true + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "RevisionCollection": { + "description": "Container App Revisions collection ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Revision" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group to which the resource belongs.", + "required": true, + "type": "string", + "maxLength": 90, + "minLength": 1, + "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$", + "x-ms-parameter-location": "method" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API Version", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + } + }, + "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/web/resource-manager/Microsoft.Web/stable/2024-04-01/DeletedWebApps.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/DeletedWebApps.json new file mode 100644 index 000000000000..91cab79f3da4 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/DeletedWebApps.json @@ -0,0 +1,209 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "DeletedWebApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/deletedSites": { + "get": { + "tags": [ + "DeletedWebApps" + ], + "summary": "Get all deleted apps for a subscription.", + "description": "Description for Get all deleted apps for a subscription.", + "operationId": "DeletedWebApps_List", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DeletedWebAppCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/deletedSites": { + "get": { + "tags": [ + "DeletedWebApps" + ], + "summary": "Get all deleted apps for a subscription at location", + "description": "Description for Get all deleted apps for a subscription at location", + "operationId": "DeletedWebApps_ListByLocation", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DeletedWebAppCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Deleted Web App by Location": { + "$ref": "./examples/ListDeletedWebAppsByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/deletedSites/{deletedSiteId}": { + "get": { + "tags": [ + "DeletedWebApps" + ], + "summary": "Get deleted app for a subscription at location.", + "description": "Description for Get deleted app for a subscription at location.", + "operationId": "DeletedWebApps_GetDeletedWebAppByLocation", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "deletedSiteId", + "in": "path", + "description": "The numeric ID of the deleted app, e.g. 12345", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DeletedSite" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Deleted Web App by Location": { + "$ref": "./examples/GetDeletedWebAppByLocation.json" + } + } + } + } + }, + "definitions": { + "DeletedWebAppCollection": { + "description": "Collection of deleted apps.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/DeletedSite" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API Version", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + } + }, + "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/web/resource-manager/Microsoft.Web/stable/2024-04-01/Diagnostics.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/Diagnostics.json new file mode 100644 index 000000000000..9597ec4cda8b --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/Diagnostics.json @@ -0,0 +1,2165 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "Diagnostics API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors": { + "get": { + "tags": [ + "Diagnostics" + ], + "summary": "List Hosting Environment Detector Responses", + "description": "Description for List Hosting Environment Detector Responses", + "operationId": "Diagnostics_ListHostingEnvironmentDetectorResponses", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DetectorResponseCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get App Service Environment Detector Responses": { + "$ref": "./examples/Diagnostics_ListHostingEnvironmentDetectorResponses.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors/{detectorName}": { + "get": { + "tags": [ + "Diagnostics" + ], + "summary": "Get Hosting Environment Detector Response", + "description": "Description for Get Hosting Environment Detector Response", + "operationId": "Diagnostics_GetHostingEnvironmentDetectorResponse", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "App Service Environment Name", + "required": true, + "type": "string" + }, + { + "name": "detectorName", + "in": "path", + "description": "Detector Resource Name", + "required": true, + "type": "string" + }, + { + "name": "startTime", + "in": "query", + "description": "Start Time", + "type": "string", + "format": "date-time" + }, + { + "name": "endTime", + "in": "query", + "description": "End Time", + "type": "string", + "format": "date-time" + }, + { + "name": "timeGrain", + "in": "query", + "description": "Time Grain", + "type": "string", + "pattern": "PT[1-9][0-9]+[SMH]" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DetectorResponse" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get App Service Environment Detector Responses": { + "$ref": "./examples/Diagnostics_GetHostingEnvironmentDetectorResponse.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors": { + "get": { + "tags": [ + "Diagnostics" + ], + "summary": "List Site Detector Responses", + "description": "Description for List Site Detector Responses", + "operationId": "Diagnostics_ListSiteDetectorResponses", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DetectorResponseCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get App Detector Responses": { + "$ref": "./examples/Diagnostics_ListSiteDetectorResponses.json" + }, + "Get App Slot Detector Responses": { + "$ref": "./examples/Diagnostics_ListSiteDetectorResponsesSlot.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors/{detectorName}": { + "get": { + "tags": [ + "Diagnostics" + ], + "summary": "Get site detector response", + "description": "Description for Get site detector response", + "operationId": "Diagnostics_GetSiteDetectorResponse", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "name": "detectorName", + "in": "path", + "description": "Detector Resource Name", + "required": true, + "type": "string" + }, + { + "name": "startTime", + "in": "query", + "description": "Start Time", + "type": "string", + "format": "date-time" + }, + { + "name": "endTime", + "in": "query", + "description": "End Time", + "type": "string", + "format": "date-time" + }, + { + "name": "timeGrain", + "in": "query", + "description": "Time Grain", + "type": "string", + "pattern": "PT[1-9][0-9]+[SMH]" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DetectorResponse" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get App Detector Response": { + "$ref": "./examples/Diagnostics_GetSiteDetectorResponse.json" + }, + "Get App Slot Detector Response": { + "$ref": "./examples/Diagnostics_GetSiteDetectorResponseSlot.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics": { + "get": { + "tags": [ + "Diagnostics" + ], + "summary": "Get Diagnostics Categories", + "description": "Description for Get Diagnostics Categories", + "operationId": "Diagnostics_ListSiteDiagnosticCategories", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiagnosticCategoryCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List App Diagnostic Categories": { + "$ref": "./examples/Diagnostics_ListSiteDiagnosticCategories.json" + }, + "List App Slot Diagnostic Categories": { + "$ref": "./examples/Diagnostics_ListSiteDiagnosticCategoriesSlot.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}": { + "get": { + "tags": [ + "Diagnostics" + ], + "summary": "Get Diagnostics Category", + "description": "Description for Get Diagnostics Category", + "operationId": "Diagnostics_GetSiteDiagnosticCategory", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "name": "diagnosticCategory", + "in": "path", + "description": "Diagnostic Category", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiagnosticCategory" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get App Diagnostic Category": { + "$ref": "./examples/Diagnostics_GetSiteDiagnosticCategory.json" + }, + "Get App Slot Diagnostic Category": { + "$ref": "./examples/Diagnostics_GetSiteDiagnosticCategorySlot.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses": { + "get": { + "tags": [ + "Diagnostics" + ], + "summary": "Get Site Analyses", + "description": "Description for Get Site Analyses", + "operationId": "Diagnostics_ListSiteAnalyses", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "name": "diagnosticCategory", + "in": "path", + "description": "Diagnostic Category", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiagnosticAnalysisCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List App Analyses": { + "$ref": "./examples/Diagnostics_ListSiteAnalyses.json" + }, + "List App Slot Analyses": { + "$ref": "./examples/Diagnostics_ListSiteAnalysesSlot.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses/{analysisName}": { + "get": { + "tags": [ + "Diagnostics" + ], + "summary": "Get Site Analysis", + "description": "Description for Get Site Analysis", + "operationId": "Diagnostics_GetSiteAnalysis", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "name": "diagnosticCategory", + "in": "path", + "description": "Diagnostic Category", + "required": true, + "type": "string" + }, + { + "name": "analysisName", + "in": "path", + "description": "Analysis Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AnalysisDefinition" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get App Analysis": { + "$ref": "./examples/Diagnostics_GetSiteAnalysis.json" + }, + "Get App Slot Analysis": { + "$ref": "./examples/Diagnostics_GetSiteAnalysisSlot.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses/{analysisName}/execute": { + "post": { + "tags": [ + "Diagnostics" + ], + "summary": "Execute Analysis", + "description": "Description for Execute Analysis", + "operationId": "Diagnostics_ExecuteSiteAnalysis", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "name": "diagnosticCategory", + "in": "path", + "description": "Category Name", + "required": true, + "type": "string" + }, + { + "name": "analysisName", + "in": "path", + "description": "Analysis Resource Name", + "required": true, + "type": "string" + }, + { + "name": "startTime", + "in": "query", + "description": "Start Time", + "type": "string", + "format": "date-time" + }, + { + "name": "endTime", + "in": "query", + "description": "End Time", + "type": "string", + "format": "date-time" + }, + { + "name": "timeGrain", + "in": "query", + "description": "Time Grain", + "type": "string", + "pattern": "PT[1-9][0-9]+[SMH]" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiagnosticAnalysis" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Execute site slot analysis": { + "$ref": "./examples/Diagnostics_ExecuteSiteAnalysisSlot.json" + }, + "Execute site analysis": { + "$ref": "./examples/Diagnostics_ExecuteSiteAnalysis.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors": { + "get": { + "tags": [ + "Diagnostics" + ], + "summary": "Get Detectors", + "description": "Description for Get Detectors", + "operationId": "Diagnostics_ListSiteDetectors", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "name": "diagnosticCategory", + "in": "path", + "description": "Diagnostic Category", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiagnosticDetectorCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List App Detectors": { + "$ref": "./examples/Diagnostics_ListSiteDetectors.json" + }, + "List App Slot Detectors": { + "$ref": "./examples/Diagnostics_ListSiteDetectorsSlot.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors/{detectorName}": { + "get": { + "tags": [ + "Diagnostics" + ], + "summary": "Get Detector", + "description": "Description for Get Detector", + "operationId": "Diagnostics_GetSiteDetector", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "name": "diagnosticCategory", + "in": "path", + "description": "Diagnostic Category", + "required": true, + "type": "string" + }, + { + "name": "detectorName", + "in": "path", + "description": "Detector Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DetectorDefinitionResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get App Detector": { + "$ref": "./examples/Diagnostics_GetSiteDetector.json" + }, + "Get App Slot Detector": { + "$ref": "./examples/Diagnostics_GetSiteDetectorSlot.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors/{detectorName}/execute": { + "post": { + "tags": [ + "Diagnostics" + ], + "summary": "Execute Detector", + "description": "Description for Execute Detector", + "operationId": "Diagnostics_ExecuteSiteDetector", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "name": "detectorName", + "in": "path", + "description": "Detector Resource Name", + "required": true, + "type": "string" + }, + { + "name": "diagnosticCategory", + "in": "path", + "description": "Category Name", + "required": true, + "type": "string" + }, + { + "name": "startTime", + "in": "query", + "description": "Start Time", + "type": "string", + "format": "date-time" + }, + { + "name": "endTime", + "in": "query", + "description": "End Time", + "type": "string", + "format": "date-time" + }, + { + "name": "timeGrain", + "in": "query", + "description": "Time Grain", + "type": "string", + "pattern": "PT[1-9][0-9]+[SMH]" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiagnosticDetectorResponse" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Execute site detector": { + "$ref": "./examples/Diagnostics_ExecuteSiteDetector.json" + }, + "Execute site slot detector": { + "$ref": "./examples/Diagnostics_ExecuteSiteDetectorSlot.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/detectors": { + "get": { + "tags": [ + "Diagnostics" + ], + "summary": "List Site Detector Responses", + "description": "Description for List Site Detector Responses", + "operationId": "Diagnostics_ListSiteDetectorResponsesSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Slot Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DetectorResponseCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get App Detector Responses": { + "$ref": "./examples/Diagnostics_ListSiteDetectorResponses.json" + }, + "Get App Slot Detector Responses": { + "$ref": "./examples/Diagnostics_ListSiteDetectorResponsesSlot.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/detectors/{detectorName}": { + "get": { + "tags": [ + "Diagnostics" + ], + "summary": "Get site detector response", + "description": "Description for Get site detector response", + "operationId": "Diagnostics_GetSiteDetectorResponseSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "name": "detectorName", + "in": "path", + "description": "Detector Resource Name", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Slot Name", + "required": true, + "type": "string" + }, + { + "name": "startTime", + "in": "query", + "description": "Start Time", + "type": "string", + "format": "date-time" + }, + { + "name": "endTime", + "in": "query", + "description": "End Time", + "type": "string", + "format": "date-time" + }, + { + "name": "timeGrain", + "in": "query", + "description": "Time Grain", + "type": "string", + "pattern": "PT[1-9][0-9]+[SMH]" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DetectorResponse" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get App Detector Response": { + "$ref": "./examples/Diagnostics_GetSiteDetectorResponse.json" + }, + "Get App Slot Detector Response": { + "$ref": "./examples/Diagnostics_GetSiteDetectorResponseSlot.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics": { + "get": { + "tags": [ + "Diagnostics" + ], + "summary": "Get Diagnostics Categories", + "description": "Description for Get Diagnostics Categories", + "operationId": "Diagnostics_ListSiteDiagnosticCategoriesSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Slot Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiagnosticCategoryCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List App Diagnostic Categories": { + "$ref": "./examples/Diagnostics_ListSiteDiagnosticCategories.json" + }, + "List App Slot Diagnostic Categories": { + "$ref": "./examples/Diagnostics_ListSiteDiagnosticCategoriesSlot.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}": { + "get": { + "tags": [ + "Diagnostics" + ], + "summary": "Get Diagnostics Category", + "description": "Description for Get Diagnostics Category", + "operationId": "Diagnostics_GetSiteDiagnosticCategorySlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "name": "diagnosticCategory", + "in": "path", + "description": "Diagnostic Category", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Slot Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiagnosticCategory" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get App Diagnostic Category": { + "$ref": "./examples/Diagnostics_GetSiteDiagnosticCategory.json" + }, + "Get App Slot Diagnostic Category": { + "$ref": "./examples/Diagnostics_GetSiteDiagnosticCategorySlot.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses": { + "get": { + "tags": [ + "Diagnostics" + ], + "summary": "Get Site Analyses", + "description": "Description for Get Site Analyses", + "operationId": "Diagnostics_ListSiteAnalysesSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "name": "diagnosticCategory", + "in": "path", + "description": "Diagnostic Category", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Slot Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiagnosticAnalysisCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List App Analyses": { + "$ref": "./examples/Diagnostics_ListSiteAnalyses.json" + }, + "List App Slot Analyses": { + "$ref": "./examples/Diagnostics_ListSiteAnalysesSlot.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses/{analysisName}": { + "get": { + "tags": [ + "Diagnostics" + ], + "summary": "Get Site Analysis", + "description": "Description for Get Site Analysis", + "operationId": "Diagnostics_GetSiteAnalysisSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "name": "diagnosticCategory", + "in": "path", + "description": "Diagnostic Category", + "required": true, + "type": "string" + }, + { + "name": "analysisName", + "in": "path", + "description": "Analysis Name", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Slot - optional", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AnalysisDefinition" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get App Analysis": { + "$ref": "./examples/Diagnostics_GetSiteAnalysis.json" + }, + "Get App Slot Analysis": { + "$ref": "./examples/Diagnostics_GetSiteAnalysisSlot.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses/{analysisName}/execute": { + "post": { + "tags": [ + "Diagnostics" + ], + "summary": "Execute Analysis", + "description": "Description for Execute Analysis", + "operationId": "Diagnostics_ExecuteSiteAnalysisSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "name": "diagnosticCategory", + "in": "path", + "description": "Category Name", + "required": true, + "type": "string" + }, + { + "name": "analysisName", + "in": "path", + "description": "Analysis Resource Name", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Slot Name", + "required": true, + "type": "string" + }, + { + "name": "startTime", + "in": "query", + "description": "Start Time", + "type": "string", + "format": "date-time" + }, + { + "name": "endTime", + "in": "query", + "description": "End Time", + "type": "string", + "format": "date-time" + }, + { + "name": "timeGrain", + "in": "query", + "description": "Time Grain", + "type": "string", + "pattern": "PT[1-9][0-9]+[SMH]" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiagnosticAnalysis" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Execute site slot analysis": { + "$ref": "./examples/Diagnostics_ExecuteSiteAnalysisSlot.json" + }, + "Execute site analysis": { + "$ref": "./examples/Diagnostics_ExecuteSiteAnalysis.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors": { + "get": { + "tags": [ + "Diagnostics" + ], + "summary": "Get Detectors", + "description": "Description for Get Detectors", + "operationId": "Diagnostics_ListSiteDetectorsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "name": "diagnosticCategory", + "in": "path", + "description": "Diagnostic Category", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Slot Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiagnosticDetectorCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List App Detectors": { + "$ref": "./examples/Diagnostics_ListSiteDetectors.json" + }, + "List App Slot Detectors": { + "$ref": "./examples/Diagnostics_ListSiteDetectorsSlot.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors/{detectorName}": { + "get": { + "tags": [ + "Diagnostics" + ], + "summary": "Get Detector", + "description": "Description for Get Detector", + "operationId": "Diagnostics_GetSiteDetectorSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "name": "diagnosticCategory", + "in": "path", + "description": "Diagnostic Category", + "required": true, + "type": "string" + }, + { + "name": "detectorName", + "in": "path", + "description": "Detector Name", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Slot Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DetectorDefinitionResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get App Detector": { + "$ref": "./examples/Diagnostics_GetSiteDetector.json" + }, + "Get App Slot Detector": { + "$ref": "./examples/Diagnostics_GetSiteDetectorSlot.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors/{detectorName}/execute": { + "post": { + "tags": [ + "Diagnostics" + ], + "summary": "Execute Detector", + "description": "Description for Execute Detector", + "operationId": "Diagnostics_ExecuteSiteDetectorSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "name": "detectorName", + "in": "path", + "description": "Detector Resource Name", + "required": true, + "type": "string" + }, + { + "name": "diagnosticCategory", + "in": "path", + "description": "Category Name", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Slot Name", + "required": true, + "type": "string" + }, + { + "name": "startTime", + "in": "query", + "description": "Start Time", + "type": "string", + "format": "date-time" + }, + { + "name": "endTime", + "in": "query", + "description": "End Time", + "type": "string", + "format": "date-time" + }, + { + "name": "timeGrain", + "in": "query", + "description": "Time Grain", + "type": "string", + "pattern": "PT[1-9][0-9]+[SMH]" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiagnosticDetectorResponse" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Execute site detector": { + "$ref": "./examples/Diagnostics_ExecuteSiteDetector.json" + }, + "Execute site slot detector": { + "$ref": "./examples/Diagnostics_ExecuteSiteDetectorSlot.json" + } + } + } + } + }, + "definitions": { + "AbnormalTimePeriod": { + "description": "Class representing Abnormal Time Period identified in diagnosis", + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "Start time of the downtime", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "End time of the downtime", + "type": "string" + }, + "events": { + "description": "List of Possible Cause of downtime", + "type": "array", + "items": { + "$ref": "#/definitions/DetectorAbnormalTimePeriod" + }, + "x-ms-identifiers": [] + }, + "solutions": { + "description": "List of proposed solutions", + "type": "array", + "items": { + "$ref": "#/definitions/Solution" + } + } + } + }, + "AnalysisData": { + "description": "Class Representing Detector Evidence used for analysis", + "type": "object", + "properties": { + "source": { + "description": "Name of the Detector", + "type": "string" + }, + "detectorDefinition": { + "$ref": "#/definitions/DetectorDefinition", + "description": "Detector Definition" + }, + "metrics": { + "description": "Source Metrics", + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticMetricSet" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "data": { + "description": "Additional Source Data", + "type": "array", + "items": { + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/NameValuePair" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "detectorMetaData": { + "$ref": "#/definitions/ResponseMetaData", + "description": "Detector Meta Data" + } + } + }, + "AnalysisDefinition": { + "description": "Definition of Analysis", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "AnalysisDefinition resource specific properties", + "type": "object", + "properties": { + "description": { + "description": "Description of the Analysis", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "DataSource": { + "description": "Class representing data source used by the detectors", + "type": "object", + "properties": { + "instructions": { + "description": "Instructions if any for the data source", + "type": "array", + "items": { + "type": "string" + } + }, + "dataSourceUri": { + "description": "Datasource Uri Links", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/NameValuePair" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "DetectorAbnormalTimePeriod": { + "description": "Class representing Abnormal Time Period detected.", + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "Start time of the correlated event", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "End time of the correlated event", + "type": "string" + }, + "message": { + "description": "Message describing the event", + "type": "string" + }, + "source": { + "description": "Represents the name of the Detector", + "type": "string" + }, + "priority": { + "format": "double", + "description": "Represents the rank of the Detector", + "type": "number" + }, + "metaData": { + "description": "Downtime metadata", + "type": "array", + "items": { + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/NameValuePair" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "type": { + "description": "Represents the type of the Detector", + "enum": [ + "ServiceIncident", + "AppDeployment", + "AppCrash", + "RuntimeIssueDetected", + "AseDeployment", + "UserIssue", + "PlatformIssue", + "Other" + ], + "type": "string", + "x-ms-enum": { + "name": "IssueType", + "modelAsString": false + } + }, + "solutions": { + "description": "List of proposed solutions", + "type": "array", + "items": { + "$ref": "#/definitions/Solution" + } + } + } + }, + "DetectorDefinition": { + "description": "Class representing detector definition", + "type": "object", + "properties": { + "displayName": { + "description": "Display name of the detector", + "type": "string", + "readOnly": true + }, + "description": { + "description": "Description of the detector", + "type": "string", + "readOnly": true + }, + "rank": { + "format": "double", + "description": "Detector Rank", + "type": "number", + "readOnly": true + }, + "isEnabled": { + "description": "Flag representing whether detector is enabled or not.", + "type": "boolean", + "readOnly": true + } + } + }, + "DetectorDefinitionResource": { + "description": "ARM resource for a detector definition", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DetectorDefinition", + "description": "Core resource properties", + "type": "object", + "x-ms-client-flatten": true + } + } + }, + "DiagnosticAnalysis": { + "description": "Class representing a diagnostic analysis done on an application", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "DiagnosticAnalysis resource specific properties", + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "Start time of the period", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "End time of the period", + "type": "string" + }, + "abnormalTimePeriods": { + "description": "List of time periods.", + "type": "array", + "items": { + "$ref": "#/definitions/AbnormalTimePeriod" + }, + "x-ms-identifiers": [] + }, + "payload": { + "description": "Data by each detector", + "type": "array", + "items": { + "$ref": "#/definitions/AnalysisData" + }, + "x-ms-identifiers": [ + "source" + ] + }, + "nonCorrelatedDetectors": { + "description": "Data by each detector for detectors that did not corelate", + "type": "array", + "items": { + "$ref": "#/definitions/DetectorDefinition" + }, + "x-ms-identifiers": [ + "displayName" + ] + } + }, + "x-ms-client-flatten": true + } + } + }, + "DiagnosticAnalysisCollection": { + "description": "Collection of Diagnostic Analyses", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/AnalysisDefinition" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "DiagnosticCategory": { + "description": "Class representing detector definition", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "DiagnosticCategory resource specific properties", + "type": "object", + "properties": { + "description": { + "description": "Description of the diagnostic category", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "DiagnosticCategoryCollection": { + "description": "Collection of Diagnostic Categories", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticCategory" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "DiagnosticDetectorCollection": { + "description": "Collection of Diagnostic Detectors", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/DetectorDefinitionResource" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "DiagnosticDetectorResponse": { + "description": "Class representing Response from Diagnostic Detectors", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "DiagnosticDetectorResponse resource specific properties", + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "Start time of the period", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "End time of the period", + "type": "string" + }, + "issueDetected": { + "description": "Flag representing Issue was detected.", + "type": "boolean" + }, + "detectorDefinition": { + "$ref": "#/definitions/DetectorDefinition", + "description": "Detector's definition" + }, + "metrics": { + "description": "Metrics provided by the detector", + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticMetricSet" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "abnormalTimePeriods": { + "description": "List of Correlated events found by the detector", + "type": "array", + "items": { + "$ref": "#/definitions/DetectorAbnormalTimePeriod" + }, + "x-ms-identifiers": [] + }, + "data": { + "description": "Additional Data that detector wants to send.", + "type": "array", + "items": { + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/NameValuePair" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "responseMetaData": { + "$ref": "#/definitions/ResponseMetaData", + "description": "Meta Data" + } + }, + "x-ms-client-flatten": true + } + } + }, + "DiagnosticMetricSample": { + "description": "Class representing Diagnostic Metric", + "type": "object", + "properties": { + "timestamp": { + "format": "date-time", + "description": "Time at which metric is measured", + "type": "string" + }, + "roleInstance": { + "description": "Role Instance. Null if this counter is not per instance \nThis is returned and should be whichever instance name we desire to be returned\ni.e. CPU and Memory return RDWORKERNAME (LargeDed..._IN_0) \nwhere RDWORKERNAME is Machine name below and RoleInstance name in parenthesis", + "type": "string" + }, + "total": { + "format": "double", + "description": "Total value of the metric. If multiple measurements are made this will have sum of all.", + "type": "number" + }, + "maximum": { + "format": "double", + "description": "Maximum of the metric sampled during the time period", + "type": "number" + }, + "minimum": { + "format": "double", + "description": "Minimum of the metric sampled during the time period", + "type": "number" + }, + "isAggregated": { + "description": "Whether the values are aggregates across all workers or not", + "type": "boolean" + } + } + }, + "DiagnosticMetricSet": { + "description": "Class representing Diagnostic Metric information", + "type": "object", + "properties": { + "name": { + "description": "Name of the metric", + "type": "string" + }, + "unit": { + "description": "Metric's unit", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "Start time of the period", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "End time of the period", + "type": "string" + }, + "timeGrain": { + "description": "Presented time grain. Supported grains at the moment are PT1M, PT1H, P1D", + "type": "string" + }, + "values": { + "description": "Collection of metric values for the selected period based on the {Microsoft.Web.Hosting.Administration.DiagnosticMetricSet.TimeGrain}", + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticMetricSample" + }, + "x-ms-identifiers": [] + } + } + }, + "ResponseMetaData": { + "type": "object", + "properties": { + "dataSource": { + "$ref": "#/definitions/DataSource", + "description": "Source of the Data" + } + } + }, + "Solution": { + "description": "Class Representing Solution for problems detected.", + "type": "object", + "properties": { + "id": { + "format": "double", + "description": "Solution Id.", + "type": "number" + }, + "displayName": { + "description": "Display Name of the solution", + "type": "string" + }, + "order": { + "format": "double", + "description": "Order of the solution.", + "type": "number" + }, + "description": { + "description": "Description of the solution", + "type": "string" + }, + "type": { + "description": "Type of Solution", + "enum": [ + "QuickSolution", + "DeepInvestigation", + "BestPractices" + ], + "type": "string", + "x-ms-enum": { + "name": "SolutionType", + "modelAsString": false + } + }, + "data": { + "description": "Solution Data.", + "type": "array", + "items": { + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/NameValuePair" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "metadata": { + "description": "Solution Metadata.", + "type": "array", + "items": { + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/NameValuePair" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group to which the resource belongs.", + "required": true, + "type": "string", + "maxLength": 90, + "minLength": 1, + "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$", + "x-ms-parameter-location": "method" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API Version", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + } + }, + "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/web/resource-manager/Microsoft.Web/stable/2024-04-01/Global.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/Global.json new file mode 100644 index 000000000000..e403f4fa924b --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/Global.json @@ -0,0 +1,195 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "Global API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}": { + "get": { + "tags": [ + "Global" + ], + "summary": "Get deleted app for a subscription.", + "description": "Description for Get deleted app for a subscription.", + "operationId": "Global_GetDeletedWebApp", + "parameters": [ + { + "name": "deletedSiteId", + "in": "path", + "description": "The numeric ID of the deleted app, e.g. 12345", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DeletedSite" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Deleted Web App": { + "$ref": "./examples/GetDeletedWebApp.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}/snapshots": { + "get": { + "tags": [ + "Global" + ], + "summary": "Get all deleted apps for a subscription.", + "description": "Description for Get all deleted apps for a subscription.", + "operationId": "Global_GetDeletedWebAppSnapshots", + "parameters": [ + { + "name": "deletedSiteId", + "in": "path", + "description": "The numeric ID of the deleted app, e.g. 12345", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/Snapshot" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Deleted Web App Snapshots": { + "$ref": "./examples/GetDeletedWebAppSnapshots.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/operations/{operationId}": { + "get": { + "tags": [ + "Global" + ], + "summary": "Gets an operation in a subscription and given region", + "description": "Description for Gets an operation in a subscription and given region", + "operationId": "Global_GetSubscriptionOperationWithAsyncResponse", + "parameters": [ + { + "name": "location", + "in": "path", + "description": "Location name", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation Id", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets an operation in a subscription and given region": { + "$ref": "./examples/GetSubscriptionOperationWithAsyncResponse.json" + } + } + } + } + }, + "definitions": {}, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API Version", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + } + }, + "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/web/resource-manager/Microsoft.Web/stable/2024-04-01/KubeEnvironments.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/KubeEnvironments.json new file mode 100644 index 000000000000..513629c88cee --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/KubeEnvironments.json @@ -0,0 +1,723 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "KubeEnvironments API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/kubeEnvironments": { + "get": { + "tags": [ + "KubeEnvironments" + ], + "summary": "Get all Kubernetes Environments for a subscription.", + "description": "Description for Get all Kubernetes Environments for a subscription.", + "operationId": "KubeEnvironments_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KubeEnvironmentCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List kube environments by subscription": { + "$ref": "./examples/KubeEnvironments_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments": { + "get": { + "tags": [ + "KubeEnvironments" + ], + "summary": "Get all the Kubernetes Environments in a resource group.", + "description": "Description for Get all the Kubernetes Environments in a resource group.", + "operationId": "KubeEnvironments_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KubeEnvironmentCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List kube environments by resource group": { + "$ref": "./examples/KubeEnvironments_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments/{name}": { + "get": { + "tags": [ + "KubeEnvironments" + ], + "summary": "Get the properties of a Kubernetes Environment.", + "description": "Description for Get the properties of a Kubernetes Environment.", + "operationId": "KubeEnvironments_Get", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Kubernetes Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KubeEnvironment" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get kube environments by name": { + "$ref": "./examples/KubeEnvironments_Get.json" + } + } + }, + "put": { + "tags": [ + "KubeEnvironments" + ], + "summary": "Creates or updates a Kubernetes Environment.", + "description": "Description for Creates or updates a Kubernetes Environment.", + "operationId": "KubeEnvironments_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Kubernetes Environment.", + "required": true, + "type": "string" + }, + { + "name": "kubeEnvironmentEnvelope", + "in": "body", + "description": "Configuration details of the Kubernetes Environment.", + "required": true, + "schema": { + "$ref": "#/definitions/KubeEnvironment" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KubeEnvironment" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/KubeEnvironment" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create kube environments": { + "$ref": "./examples/KubeEnvironments_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "KubeEnvironments" + ], + "summary": "Delete a Kubernetes Environment.", + "description": "Description for Delete a Kubernetes Environment.", + "operationId": "KubeEnvironments_Delete", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Kubernetes Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete operation completed" + }, + "202": { + "description": "Delete operation is in progress" + }, + "204": { + "description": "Kubernetes Environment does not exist" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete kube environment by name": { + "$ref": "./examples/KubeEnvironments_Delete.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "KubeEnvironments" + ], + "summary": "Creates or updates a Kubernetes Environment.", + "description": "Description for Creates or updates a Kubernetes Environment.", + "operationId": "KubeEnvironments_Update", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Kubernetes Environment.", + "required": true, + "type": "string" + }, + { + "name": "kubeEnvironmentEnvelope", + "in": "body", + "description": "Configuration details of the Kubernetes Environment.", + "required": true, + "schema": { + "$ref": "#/definitions/KubeEnvironmentPatchResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KubeEnvironment" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/KubeEnvironment" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Update kube environments": { + "$ref": "./examples/KubeEnvironments_Update.json" + } + } + } + } + }, + "definitions": { + "AppLogsConfiguration": { + "type": "object", + "properties": { + "destination": { + "type": "string" + }, + "logAnalyticsConfiguration": { + "$ref": "#/definitions/LogAnalyticsConfiguration" + } + } + }, + "ContainerAppsConfiguration": { + "type": "object", + "properties": { + "daprAIInstrumentationKey": { + "type": "string", + "description": "Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "platformReservedCidr": { + "type": "string", + "description": "IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "platformReservedDnsIP": { + "type": "string", + "description": "An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "controlPlaneSubnetResourceId": { + "type": "string", + "description": "Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "appSubnetResourceId": { + "type": "string", + "description": "Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "dockerBridgeCidr": { + "type": "string", + "description": "CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined.", + "x-ms-mutability": [ + "create", + "read" + ] + } + } + }, + "ArcConfiguration": { + "type": "object", + "properties": { + "artifactsStorageType": { + "enum": [ + "LocalNode", + "NetworkFileSystem" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageType", + "modelAsString": false + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "artifactStorageClassName": { + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "artifactStorageMountPath": { + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "artifactStorageNodeName": { + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "artifactStorageAccessMode": { + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "frontEndServiceConfiguration": { + "$ref": "#/definitions/FrontEndConfiguration" + }, + "kubeConfig": { + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + }, + "FrontEndConfiguration": { + "type": "object", + "properties": { + "kind": { + "enum": [ + "NodePort", + "LoadBalancer" + ], + "type": "string", + "x-ms-enum": { + "name": "FrontEndServiceType", + "modelAsString": false + } + } + } + }, + "KubeEnvironment": { + "description": "A Kubernetes cluster specialized for web workloads by Azure App Service", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "KubeEnvironment resource specific properties", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the Kubernetes Environment.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Waiting", + "InitializationInProgress", + "InfrastructureSetupInProgress", + "InfrastructureSetupComplete", + "ScheduledForDelete", + "UpgradeRequested", + "UpgradeFailed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "KubeEnvironmentProvisioningState", + "modelAsString": false + } + }, + "deploymentErrors": { + "description": "Any errors that occurred during deployment or deployment validation", + "type": "string", + "readOnly": true + }, + "internalLoadBalancerEnabled": { + "description": "Only visible within Vnet/Subnet", + "type": "boolean", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "defaultDomain": { + "description": "Default Domain Name for the cluster", + "type": "string", + "readOnly": true + }, + "staticIp": { + "description": "Static IP of the KubeEnvironment", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "environmentType": { + "description": "Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "arcConfiguration": { + "$ref": "#/definitions/ArcConfiguration", + "description": "Cluster configuration which determines the ARC cluster\ncomponents types. Eg: Choosing between BuildService kind,\nFrontEnd Service ArtifactsStorageType etc." + }, + "appLogsConfiguration": { + "$ref": "#/definitions/AppLogsConfiguration", + "description": "Cluster configuration which enables the log daemon to export\napp logs to a destination. Currently only \"log-analytics\" is\nsupported" + }, + "containerAppsConfiguration": { + "$ref": "#/definitions/ContainerAppsConfiguration", + "description": "Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration" + }, + "aksResourceID": { + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "./CommonDefinitions.json#/definitions/ExtendedLocation" + } + } + }, + "KubeEnvironmentCollection": { + "description": "Collection of Kubernetes Environments", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/KubeEnvironment" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "KubeEnvironmentPatchResource": { + "description": "ARM resource for a KubeEnvironment when patching", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "KubeEnvironmentPatchResource resource specific properties", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the Kubernetes Environment.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Waiting", + "InitializationInProgress", + "InfrastructureSetupInProgress", + "InfrastructureSetupComplete", + "ScheduledForDelete", + "UpgradeRequested", + "UpgradeFailed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "KubeEnvironmentProvisioningState", + "modelAsString": false + } + }, + "deploymentErrors": { + "description": "Any errors that occurred during deployment or deployment validation", + "type": "string", + "readOnly": true + }, + "internalLoadBalancerEnabled": { + "description": "Only visible within Vnet/Subnet", + "type": "boolean", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "defaultDomain": { + "description": "Default Domain Name for the cluster", + "type": "string", + "readOnly": true + }, + "staticIp": { + "description": "Static IP of the KubeEnvironment", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "arcConfiguration": { + "$ref": "#/definitions/ArcConfiguration", + "description": "Cluster configuration which determines the ARC cluster\ncomponents types. Eg: Choosing between BuildService kind,\nFrontEnd Service ArtifactsStorageType etc." + }, + "appLogsConfiguration": { + "$ref": "#/definitions/AppLogsConfiguration", + "description": "Cluster configuration which enables the log daemon to export\napp logs to a destination. Currently only \"log-analytics\" is\nsupported" + }, + "containerAppsConfiguration": { + "$ref": "#/definitions/ContainerAppsConfiguration", + "description": "Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration" + }, + "aksResourceID": { + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-client-flatten": true + } + } + }, + "LogAnalyticsConfiguration": { + "type": "object", + "properties": { + "customerId": { + "type": "string" + }, + "sharedKey": { + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group to which the resource belongs.", + "required": true, + "type": "string", + "maxLength": 90, + "minLength": 1, + "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$", + "x-ms-parameter-location": "method" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API Version", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + } + }, + "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/web/resource-manager/Microsoft.Web/stable/2024-04-01/Provider.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/Provider.json new file mode 100644 index 000000000000..00af2ca98086 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/Provider.json @@ -0,0 +1,1126 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "Provider API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.Web/availableStacks": { + "get": { + "tags": [ + "Provider" + ], + "summary": "Get available application frameworks and their versions", + "description": "Description for Get available application frameworks and their versions", + "operationId": "Provider_GetAvailableStacks", + "parameters": [ + { + "$ref": "#/parameters/osTypeSelectedParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplicationStackCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Web/functionAppStacks": { + "get": { + "tags": [ + "Provider" + ], + "summary": "Get available Function app frameworks and their versions", + "description": "Description for Get available Function app frameworks and their versions", + "operationId": "Provider_GetFunctionAppStacks", + "parameters": [ + { + "$ref": "#/parameters/stackOsTypeParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FunctionAppStackCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Function App Stacks": { + "$ref": "./examples/GetFunctionAppStacks.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Web/locations/{location}/functionAppStacks": { + "get": { + "tags": [ + "Provider" + ], + "summary": "Get available Function app frameworks and their versions for location", + "description": "Description for Get available Function app frameworks and their versions for location", + "operationId": "Provider_GetFunctionAppStacksForLocation", + "parameters": [ + { + "name": "location", + "in": "path", + "description": "Function App stack location.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/stackOsTypeParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FunctionAppStackCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Locations Function App Stacks": { + "$ref": "./examples/GetFunctionAppStacksForLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Web/locations/{location}/webAppStacks": { + "get": { + "tags": [ + "Provider" + ], + "summary": "Get available Web app frameworks and their versions for location", + "description": "Description for Get available Web app frameworks and their versions for location", + "operationId": "Provider_GetWebAppStacksForLocation", + "parameters": [ + { + "name": "location", + "in": "path", + "description": "Web App stack location.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/stackOsTypeParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebAppStackCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Locations Web App Stacks": { + "$ref": "./examples/GetWebAppStacksForLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Web/operations": { + "get": { + "tags": [ + "Provider" + ], + "summary": "Gets all available operations for the Microsoft.Web resource provider. Also exposes resource metric definitions", + "description": "Description for Gets all available operations for the Microsoft.Web resource provider. Also exposes resource metric definitions", + "operationId": "Provider_ListOperations", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/CsmOperationCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List operations": { + "$ref": "./examples/ListOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Web/webAppStacks": { + "get": { + "tags": [ + "Provider" + ], + "summary": "Get available Web app frameworks and their versions", + "description": "Description for Get available Web app frameworks and their versions", + "operationId": "Provider_GetWebAppStacks", + "parameters": [ + { + "$ref": "#/parameters/stackOsTypeParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebAppStackCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Web App Stacks": { + "$ref": "./examples/GetWebAppStacks.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/availableStacks": { + "get": { + "tags": [ + "Provider" + ], + "summary": "Get available application frameworks and their versions", + "description": "Description for Get available application frameworks and their versions", + "operationId": "Provider_GetAvailableStacksOnPrem", + "parameters": [ + { + "$ref": "#/parameters/osTypeSelectedParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplicationStackCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AppInsightsWebAppStackSettings": { + "description": "App Insights Web App stack settings.", + "type": "object", + "properties": { + "isSupported": { + "description": "true if remote Application Insights is supported for the stack; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "isDefaultOff": { + "description": "true if Application Insights is disabled by default for the stack; otherwise, false.", + "type": "boolean", + "readOnly": true + } + } + }, + "ApplicationStack": { + "description": "Application stack.", + "type": "object", + "properties": { + "name": { + "description": "Application stack name.", + "type": "string" + }, + "display": { + "description": "Application stack display name.", + "type": "string" + }, + "dependency": { + "description": "Application stack dependency.", + "type": "string" + }, + "majorVersions": { + "description": "List of major versions available.", + "type": "array", + "items": { + "$ref": "#/definitions/StackMajorVersion" + }, + "x-ms-identifiers": [ + "runtimeVersion" + ] + }, + "frameworks": { + "description": "List of frameworks associated with application stack.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationStack" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "isDeprecated": { + "description": "true if this is the stack is deprecated; otherwise, false.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationStack" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ApplicationStackCollection": { + "description": "Collection of Application Stacks", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationStackResource" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ApplicationStackResource": { + "description": "ARM resource for a ApplicationStack.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ApplicationStack", + "description": "Core resource properties", + "type": "object", + "x-ms-client-flatten": true + } + } + }, + "FunctionAppMajorVersion": { + "description": "Function App stack major version.", + "type": "object", + "properties": { + "displayText": { + "description": "Function App stack major version (display only).", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Function App stack major version name.", + "type": "string", + "readOnly": true + }, + "minorVersions": { + "description": "Minor versions associated with the major version.", + "type": "array", + "items": { + "$ref": "#/definitions/FunctionAppMinorVersion" + }, + "readOnly": true, + "x-ms-identifiers": [ + "value" + ] + } + } + }, + "FunctionAppMinorVersion": { + "description": "Function App stack minor version.", + "type": "object", + "properties": { + "displayText": { + "description": "Function App stack (display only).", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Function App stack name.", + "type": "string", + "readOnly": true + }, + "stackSettings": { + "$ref": "#/definitions/FunctionAppRuntimes", + "description": "Settings associated with the minor version.", + "readOnly": true + } + } + }, + "FunctionAppRuntimeSettings": { + "description": "Function App runtime settings.", + "type": "object", + "properties": { + "runtimeVersion": { + "description": "Function App stack minor version (runtime only).", + "type": "string", + "readOnly": true + }, + "remoteDebuggingSupported": { + "description": "true if remote debugging is supported for the stack; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "appInsightsSettings": { + "$ref": "#/definitions/AppInsightsWebAppStackSettings", + "description": "Application Insights settings associated with the minor version.", + "readOnly": true + }, + "gitHubActionSettings": { + "$ref": "#/definitions/GitHubActionWebAppStackSettings", + "description": "GitHub Actions settings associated with the minor version.", + "readOnly": true + }, + "appSettingsDictionary": { + "description": "Application settings associated with the minor version.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "siteConfigPropertiesDictionary": { + "$ref": "#/definitions/SiteConfigPropertiesDictionary", + "description": "Configuration settings associated with the minor version.", + "readOnly": true + }, + "supportedFunctionsExtensionVersions": { + "description": "List of supported Functions extension versions.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "isPreview": { + "description": "true if the stack is in preview; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "isDeprecated": { + "description": "true if the stack is deprecated; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "isHidden": { + "description": "true if the stack should be hidden; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "endOfLifeDate": { + "format": "date-time", + "description": "End-of-life date for the minor version.", + "type": "string", + "readOnly": true + }, + "isAutoUpdate": { + "description": "true if the stack version is auto-updated; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "isEarlyAccess": { + "description": "true if the minor version is early-access; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "isDefault": { + "description": "true if the minor version the default; otherwise, false.", + "type": "boolean", + "readOnly": true + } + } + }, + "FunctionAppRuntimes": { + "description": "Function App stack runtimes.", + "type": "object", + "properties": { + "linuxRuntimeSettings": { + "$ref": "#/definitions/FunctionAppRuntimeSettings", + "description": "Linux-specific settings associated with the minor version.", + "readOnly": true + }, + "windowsRuntimeSettings": { + "$ref": "#/definitions/FunctionAppRuntimeSettings", + "description": "Windows-specific settings associated with the minor version.", + "readOnly": true + } + } + }, + "FunctionAppStack": { + "description": "Function App Stack.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "location": { + "description": "Function App stack location.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "FunctionAppStack resource specific properties", + "type": "object", + "properties": { + "displayText": { + "description": "Function App stack (display only).", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Function App stack name.", + "type": "string", + "readOnly": true + }, + "majorVersions": { + "description": "List of major versions available.", + "type": "array", + "items": { + "$ref": "#/definitions/FunctionAppMajorVersion" + }, + "readOnly": true, + "x-ms-identifiers": [ + "value" + ] + }, + "preferredOs": { + "description": "Function App stack preferred OS.", + "enum": [ + "Windows", + "Linux" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "StackPreferredOs", + "modelAsString": false + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "FunctionAppStackCollection": { + "description": "Collection of Function app Stacks", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/FunctionAppStack" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "GitHubActionWebAppStackSettings": { + "description": "GitHub Actions Web App stack settings.", + "type": "object", + "properties": { + "isSupported": { + "description": "true if GitHub Actions is supported for the stack; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "supportedVersion": { + "description": "The minor version that is supported for GitHub Actions.", + "type": "string", + "readOnly": true + } + } + }, + "LinuxJavaContainerSettings": { + "description": "Linux Java Container settings.", + "type": "object", + "properties": { + "java11Runtime": { + "description": "Java 11 version (runtime only).", + "type": "string", + "readOnly": true + }, + "java8Runtime": { + "description": "Java 8 version (runtime only).", + "type": "string", + "readOnly": true + }, + "isPreview": { + "description": "true if the stack is in preview; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "isDeprecated": { + "description": "true if the stack is deprecated; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "isHidden": { + "description": "true if the stack should be hidden; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "endOfLifeDate": { + "format": "date-time", + "description": "End-of-life date for the minor version.", + "type": "string", + "readOnly": true + }, + "isAutoUpdate": { + "description": "true if the stack version is auto-updated; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "isEarlyAccess": { + "description": "true if the minor version is early-access; otherwise, false.", + "type": "boolean", + "readOnly": true + } + } + }, + "SiteConfigPropertiesDictionary": { + "description": "Site config properties dictionary.", + "type": "object", + "properties": { + "use32BitWorkerProcess": { + "description": "true if use32BitWorkerProcess should be set to true for the stack; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "linuxFxVersion": { + "description": "LinuxFxVersion configuration setting.", + "type": "string", + "readOnly": true + }, + "javaVersion": { + "description": "JavaVersion configuration setting.", + "type": "string", + "readOnly": true + }, + "powerShellVersion": { + "description": "PowerShellVersion configuration setting.", + "type": "string", + "readOnly": true + } + } + }, + "StackMajorVersion": { + "description": "Application stack major version.", + "type": "object", + "properties": { + "displayVersion": { + "description": "Application stack major version (display only).", + "type": "string" + }, + "runtimeVersion": { + "description": "Application stack major version (runtime only).", + "type": "string" + }, + "isDefault": { + "description": "true if this is the default major version; otherwise, false.", + "type": "boolean" + }, + "minorVersions": { + "description": "Minor versions associated with the major version.", + "type": "array", + "items": { + "$ref": "#/definitions/StackMinorVersion" + }, + "x-ms-identifiers": [ + "runtimeVersion" + ] + }, + "applicationInsights": { + "description": "true if this supports Application Insights; otherwise, false.", + "type": "boolean" + }, + "isPreview": { + "description": "true if this stack is in Preview, otherwise false.", + "type": "boolean" + }, + "isDeprecated": { + "description": "true if this stack has been deprecated, otherwise false.", + "type": "boolean" + }, + "isHidden": { + "description": "true if this stack should be hidden for new customers on portal, otherwise false.", + "type": "boolean" + }, + "appSettingsDictionary": { + "description": "\n \n\n Example: All the function apps need AppSetting: \"FUNCTIONS_WORKER_RUNTIME\" to be set stack name", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "siteConfigPropertiesDictionary": { + "description": "\n \n\n Example: All Linux Function Apps, need Use32BitWorkerProcess to be set to 0", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "StackMinorVersion": { + "description": "Application stack minor version.", + "type": "object", + "properties": { + "displayVersion": { + "description": "Application stack minor version (display only).", + "type": "string" + }, + "runtimeVersion": { + "description": "Application stack minor version (runtime only).", + "type": "string" + }, + "isDefault": { + "description": "true if this is the default minor version; otherwise, false.", + "type": "boolean" + }, + "isRemoteDebuggingEnabled": { + "description": "true if this supports Remote Debugging, otherwise false.", + "type": "boolean" + } + } + }, + "WebAppMajorVersion": { + "description": "Web App stack major version.", + "type": "object", + "properties": { + "displayText": { + "description": "Web App stack major version (display only).", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Web App stack major version name.", + "type": "string", + "readOnly": true + }, + "minorVersions": { + "description": "Minor versions associated with the major version.", + "type": "array", + "items": { + "$ref": "#/definitions/WebAppMinorVersion" + }, + "readOnly": true, + "x-ms-identifiers": [ + "value" + ] + } + } + }, + "WebAppMinorVersion": { + "description": "Web App stack minor version.", + "type": "object", + "properties": { + "displayText": { + "description": "Web App stack minor version (display only).", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Web App stack major version name.", + "type": "string", + "readOnly": true + }, + "stackSettings": { + "$ref": "#/definitions/WebAppRuntimes", + "description": "Settings associated with the minor version.", + "readOnly": true + } + } + }, + "WebAppRuntimeSettings": { + "description": "Web App runtime settings.", + "type": "object", + "properties": { + "runtimeVersion": { + "description": "Web App stack minor version (runtime only).", + "type": "string", + "readOnly": true + }, + "remoteDebuggingSupported": { + "description": "true if remote debugging is supported for the stack; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "appInsightsSettings": { + "$ref": "#/definitions/AppInsightsWebAppStackSettings", + "description": "Application Insights settings associated with the minor version.", + "readOnly": true + }, + "gitHubActionSettings": { + "$ref": "#/definitions/GitHubActionWebAppStackSettings", + "description": "GitHub Actions settings associated with the minor version.", + "readOnly": true + }, + "isPreview": { + "description": "true if the stack is in preview; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "isDeprecated": { + "description": "true if the stack is deprecated; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "isHidden": { + "description": "true if the stack should be hidden; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "endOfLifeDate": { + "format": "date-time", + "description": "End-of-life date for the minor version.", + "type": "string", + "readOnly": true + }, + "isAutoUpdate": { + "description": "true if the stack version is auto-updated; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "isEarlyAccess": { + "description": "true if the minor version is early-access; otherwise, false.", + "type": "boolean", + "readOnly": true + } + } + }, + "WebAppRuntimes": { + "description": "Web App stack runtimes.", + "type": "object", + "properties": { + "linuxRuntimeSettings": { + "$ref": "#/definitions/WebAppRuntimeSettings", + "description": "Linux-specific settings associated with the minor version.", + "readOnly": true + }, + "windowsRuntimeSettings": { + "$ref": "#/definitions/WebAppRuntimeSettings", + "description": "Windows-specific settings associated with the minor version.", + "readOnly": true + }, + "linuxContainerSettings": { + "$ref": "#/definitions/LinuxJavaContainerSettings", + "description": "Linux-specific settings associated with the Java container minor version.", + "readOnly": true + }, + "windowsContainerSettings": { + "$ref": "#/definitions/WindowsJavaContainerSettings", + "description": "Windows-specific settings associated with the Java container minor version.", + "readOnly": true + } + } + }, + "WebAppStack": { + "description": "Web App stack.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "location": { + "description": "Web App stack location.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "WebAppStack resource specific properties", + "type": "object", + "properties": { + "displayText": { + "description": "Web App stack (display only).", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Web App stack name.", + "type": "string", + "readOnly": true + }, + "majorVersions": { + "description": "List of major versions available.", + "type": "array", + "items": { + "$ref": "#/definitions/WebAppMajorVersion" + }, + "readOnly": true, + "x-ms-identifiers": [ + "value" + ] + }, + "preferredOs": { + "description": "Web App stack preferred OS.", + "enum": [ + "Windows", + "Linux" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "StackPreferredOs", + "modelAsString": false + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "WebAppStackCollection": { + "description": "Collection of Web app Stacks", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/WebAppStack" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "WindowsJavaContainerSettings": { + "description": "Windows Java Container settings.", + "type": "object", + "properties": { + "javaContainer": { + "description": "Java container (runtime only).", + "type": "string", + "readOnly": true + }, + "javaContainerVersion": { + "description": "Java container version (runtime only).", + "type": "string", + "readOnly": true + }, + "isPreview": { + "description": "true if the stack is in preview; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "isDeprecated": { + "description": "true if the stack is deprecated; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "isHidden": { + "description": "true if the stack should be hidden; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "endOfLifeDate": { + "format": "date-time", + "description": "End-of-life date for the minor version.", + "type": "string", + "readOnly": true + }, + "isAutoUpdate": { + "description": "true if the stack version is auto-updated; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "isEarlyAccess": { + "description": "true if the minor version is early-access; otherwise, false.", + "type": "boolean", + "readOnly": true + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API Version", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "osTypeSelectedParameter": { + "name": "osTypeSelected", + "in": "query", + "type": "string", + "enum": [ + "Windows", + "Linux", + "WindowsFunctions", + "LinuxFunctions", + "All" + ], + "x-ms-enum": { + "name": "ProviderOsTypeSelected", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + }, + "stackOsTypeParameter": { + "name": "stackOsType", + "in": "query", + "description": "Stack OS Type", + "type": "string", + "enum": [ + "Windows", + "Linux", + "All" + ], + "x-ms-enum": { + "name": "ProviderStackOsType", + "modelAsString": true + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/Recommendations.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/Recommendations.json new file mode 100644 index 000000000000..0b601aa6625e --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/Recommendations.json @@ -0,0 +1,1076 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "Recommendations API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations": { + "get": { + "tags": [ + "Recommendations" + ], + "summary": "List all recommendations for a subscription.", + "description": "Description for List all recommendations for a subscription.", + "operationId": "Recommendations_List", + "parameters": [ + { + "name": "featured", + "in": "query", + "description": "Specify true to return only the most critical recommendations. The default is false, which returns all recommendations.", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification' and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[PT1H|PT1M|P1D]", + "type": "string", + "x-ms-skip-url-encoding": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecommendationCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations/reset": { + "post": { + "tags": [ + "Recommendations" + ], + "summary": "Reset all recommendation opt-out settings for a subscription.", + "description": "Description for Reset all recommendation opt-out settings for a subscription.", + "operationId": "Recommendations_ResetAllFilters", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations/{name}/disable": { + "post": { + "tags": [ + "Recommendations" + ], + "summary": "Disables the specified rule so it will not apply to a subscription in the future.", + "description": "Description for Disables the specified rule so it will not apply to a subscription in the future.", + "operationId": "Recommendations_DisableRecommendationForSubscription", + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Rule name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully disabled recommendations." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendationHistory": { + "get": { + "tags": [ + "Recommendations" + ], + "summary": "Get past recommendations for an app, optionally specified by the time range.", + "description": "Description for Get past recommendations for an app, optionally specified by the time range.", + "operationId": "Recommendations_ListHistoryForHostingEnvironment", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "hostingEnvironmentName", + "in": "path", + "description": "Name of the hosting environment.", + "required": true, + "type": "string" + }, + { + "name": "expiredOnly", + "in": "query", + "description": "Specify false to return all recommendations. The default is true, which returns only expired recommendations.", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification' and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[PT1H|PT1M|P1D]", + "type": "string", + "x-ms-skip-url-encoding": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecommendationCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations": { + "get": { + "tags": [ + "Recommendations" + ], + "summary": "Get all recommendations for a hosting environment.", + "description": "Description for Get all recommendations for a hosting environment.", + "operationId": "Recommendations_ListRecommendedRulesForHostingEnvironment", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "hostingEnvironmentName", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "featured", + "in": "query", + "description": "Specify true to return only the most critical recommendations. The default is false, which returns all recommendations.", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only channels specified in the filter. Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification'", + "type": "string", + "x-ms-skip-url-encoding": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecommendationCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations/disable": { + "post": { + "tags": [ + "Recommendations" + ], + "summary": "Disable all recommendations for an app.", + "description": "Description for Disable all recommendations for an app.", + "operationId": "Recommendations_DisableAllForHostingEnvironment", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "query", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "hostingEnvironmentName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations/reset": { + "post": { + "tags": [ + "Recommendations" + ], + "summary": "Reset all recommendation opt-out settings for an app.", + "description": "Description for Reset all recommendation opt-out settings for an app.", + "operationId": "Recommendations_ResetAllFiltersForHostingEnvironment", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "query", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "hostingEnvironmentName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations/{name}": { + "get": { + "tags": [ + "Recommendations" + ], + "summary": "Get a recommendation rule for an app.", + "description": "Description for Get a recommendation rule for an app.", + "operationId": "Recommendations_GetRuleDetailsByHostingEnvironment", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "hostingEnvironmentName", + "in": "path", + "description": "Name of the hosting environment.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the recommendation.", + "required": true, + "type": "string" + }, + { + "name": "updateSeen", + "in": "query", + "description": "Specify true to update the last-seen timestamp of the recommendation object.", + "type": "boolean" + }, + { + "name": "recommendationId", + "in": "query", + "description": "The GUID of the recommendation object if you query an expired one. You don't need to specify it to query an active entry.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecommendationRule" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations/{name}/disable": { + "post": { + "tags": [ + "Recommendations" + ], + "summary": "Disables the specific rule for a web site permanently.", + "description": "Description for Disables the specific rule for a web site permanently.", + "operationId": "Recommendations_DisableRecommendationForHostingEnvironment", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "query", + "description": "Site name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Rule name", + "required": true, + "type": "string" + }, + { + "name": "hostingEnvironmentName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully disabled recommendations." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendationHistory": { + "get": { + "tags": [ + "Recommendations" + ], + "summary": "Get past recommendations for an app, optionally specified by the time range.", + "description": "Description for Get past recommendations for an app, optionally specified by the time range.", + "operationId": "Recommendations_ListHistoryForWebApp", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "expiredOnly", + "in": "query", + "description": "Specify false to return all recommendations. The default is true, which returns only expired recommendations.", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification' and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[PT1H|PT1M|P1D]", + "type": "string", + "x-ms-skip-url-encoding": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecommendationCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations": { + "get": { + "tags": [ + "Recommendations" + ], + "summary": "Get all recommendations for an app.", + "description": "Description for Get all recommendations for an app.", + "operationId": "Recommendations_ListRecommendedRulesForWebApp", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "featured", + "in": "query", + "description": "Specify true to return only the most critical recommendations. The default is false, which returns all recommendations.", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only channels specified in the filter. Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification'", + "type": "string", + "x-ms-skip-url-encoding": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecommendationCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations/disable": { + "post": { + "tags": [ + "Recommendations" + ], + "summary": "Disable all recommendations for an app.", + "description": "Description for Disable all recommendations for an app.", + "operationId": "Recommendations_DisableAllForWebApp", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations/reset": { + "post": { + "tags": [ + "Recommendations" + ], + "summary": "Reset all recommendation opt-out settings for an app.", + "description": "Description for Reset all recommendation opt-out settings for an app.", + "operationId": "Recommendations_ResetAllFiltersForWebApp", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations/{name}": { + "get": { + "tags": [ + "Recommendations" + ], + "summary": "Get a recommendation rule for an app.", + "description": "Description for Get a recommendation rule for an app.", + "operationId": "Recommendations_GetRuleDetailsByWebApp", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the recommendation.", + "required": true, + "type": "string" + }, + { + "name": "updateSeen", + "in": "query", + "description": "Specify true to update the last-seen timestamp of the recommendation object.", + "type": "boolean" + }, + { + "name": "recommendationId", + "in": "query", + "description": "The GUID of the recommendation object if you query an expired one. You don't need to specify it to query an active entry.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecommendationRule" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations/{name}/disable": { + "post": { + "tags": [ + "Recommendations" + ], + "summary": "Disables the specific rule for a web site permanently.", + "description": "Description for Disables the specific rule for a web site permanently.", + "operationId": "Recommendations_DisableRecommendationForSite", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Rule name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully disabled recommendations." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Recommendation": { + "description": "Represents a recommendation result generated by the recommendation engine.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "Recommendation resource specific properties", + "type": "object", + "properties": { + "creationTime": { + "format": "date-time", + "description": "Timestamp when this instance was created.", + "type": "string" + }, + "recommendationId": { + "format": "uuid", + "description": "A GUID value that each recommendation object is associated with.", + "type": "string", + "example": "00000000-0000-0000-0000-000000000000" + }, + "resourceId": { + "description": "Full ARM resource ID string that this recommendation object is associated with.", + "type": "string" + }, + "resourceScope": { + "description": "Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site.", + "enum": [ + "ServerFarm", + "Subscription", + "WebSite" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceScopeType", + "modelAsString": true + } + }, + "ruleName": { + "description": "Unique name of the rule.", + "type": "string" + }, + "displayName": { + "description": "UI friendly name of the rule (may not be unique).", + "type": "string" + }, + "message": { + "description": "Recommendation text.", + "type": "string" + }, + "level": { + "description": "Level indicating how critical this recommendation can impact.", + "enum": [ + "Critical", + "Warning", + "Information", + "NonUrgentSuggestion" + ], + "type": "string", + "x-ms-enum": { + "name": "NotificationLevel", + "modelAsString": false + } + }, + "channels": { + "description": "List of channels that this recommendation can apply.", + "enum": [ + "Notification", + "Api", + "Email", + "Webhook", + "All" + ], + "type": "string", + "x-ms-enum": { + "name": "Channels", + "modelAsString": false + } + }, + "categoryTags": { + "description": "The list of category tags that this recommendation belongs to.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "actionName": { + "description": "Name of action recommended by this object.", + "type": "string" + }, + "enabled": { + "format": "int32", + "description": "True if this recommendation is still valid (i.e. \"actionable\"). False if it is invalid.", + "type": "integer" + }, + "states": { + "description": "The list of states of this recommendation. If it's null then it should be considered \"Active\".", + "type": "array", + "items": { + "type": "string" + } + }, + "startTime": { + "format": "date-time", + "description": "The beginning time in UTC of a range that the recommendation refers to.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "The end time in UTC of a range that the recommendation refers to.", + "type": "string" + }, + "nextNotificationTime": { + "format": "date-time", + "description": "When to notify this recommendation next in UTC. Null means that this will never be notified anymore.", + "type": "string" + }, + "notificationExpirationTime": { + "format": "date-time", + "description": "Date and time in UTC when this notification expires.", + "type": "string" + }, + "notifiedTime": { + "format": "date-time", + "description": "Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet.", + "type": "string" + }, + "score": { + "format": "double", + "description": "A metric value measured by the rule.", + "type": "number" + }, + "isDynamic": { + "description": "True if this is associated with a dynamically added rule", + "type": "boolean" + }, + "extensionName": { + "description": "Extension name of the portal if exists.", + "type": "string" + }, + "bladeName": { + "description": "Deep link to a blade on the portal.", + "type": "string" + }, + "forwardLink": { + "description": "Forward link to an external document associated with the rule.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "RecommendationCollection": { + "description": "Collection of recommendations.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Recommendation" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "RecommendationRule": { + "description": "Represents a recommendation rule that the recommendation engine can perform.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "RecommendationRule resource specific properties", + "type": "object", + "properties": { + "recommendationName": { + "description": "Unique name of the rule.", + "type": "string" + }, + "displayName": { + "description": "UI friendly name of the rule.", + "type": "string" + }, + "message": { + "description": "Localized name of the rule (Good for UI).", + "type": "string" + }, + "recommendationId": { + "format": "uuid", + "description": "Recommendation ID of an associated recommendation object tied to the rule, if exists.\nIf such an object doesn't exist, it is set to null.", + "type": "string", + "example": "00000000-0000-0000-0000-000000000000" + }, + "description": { + "description": "Localized detailed description of the rule.", + "type": "string" + }, + "actionName": { + "description": "Name of action that is recommended by this rule in string.", + "type": "string" + }, + "level": { + "description": "Level of impact indicating how critical this rule is.", + "enum": [ + "Critical", + "Warning", + "Information", + "NonUrgentSuggestion" + ], + "type": "string", + "x-ms-enum": { + "name": "NotificationLevel", + "modelAsString": false + } + }, + "channels": { + "description": "List of available channels that this rule applies.", + "enum": [ + "Notification", + "Api", + "Email", + "Webhook", + "All" + ], + "type": "string", + "x-ms-enum": { + "name": "Channels", + "modelAsString": false + } + }, + "categoryTags": { + "description": "The list of category tags that this recommendation rule belongs to.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "isDynamic": { + "description": "True if this is associated with a dynamically added rule", + "type": "boolean" + }, + "extensionName": { + "description": "Extension name of the portal if exists. Applicable to dynamic rule only.", + "type": "string" + }, + "bladeName": { + "description": "Deep link to a blade on the portal. Applicable to dynamic rule only.", + "type": "string" + }, + "forwardLink": { + "description": "Forward link to an external document associated with the rule. Applicable to dynamic rule only.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group to which the resource belongs.", + "required": true, + "type": "string", + "maxLength": 90, + "minLength": 1, + "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$", + "x-ms-parameter-location": "method" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API Version", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + } + }, + "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/web/resource-manager/Microsoft.Web/stable/2024-04-01/ResourceHealthMetadata.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/ResourceHealthMetadata.json new file mode 100644 index 000000000000..f85f081b552e --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/ResourceHealthMetadata.json @@ -0,0 +1,406 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "ResourceHealthMetadata API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/resourceHealthMetadata": { + "get": { + "tags": [ + "ResourceHealthMetadata" + ], + "summary": "List all ResourceHealthMetadata for all sites in the subscription.", + "description": "Description for List all ResourceHealthMetadata for all sites in the subscription.", + "operationId": "ResourceHealthMetadata_List", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceHealthMetadataCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List ResourceHealthMetadata for a subscription": { + "$ref": "./examples/ListResourceHealthMetadataBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/resourceHealthMetadata": { + "get": { + "tags": [ + "ResourceHealthMetadata" + ], + "summary": "List all ResourceHealthMetadata for all sites in the resource group in the subscription.", + "description": "Description for List all ResourceHealthMetadata for all sites in the resource group in the subscription.", + "operationId": "ResourceHealthMetadata_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceHealthMetadataCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List ResourceHealthMetadata for a resource group": { + "$ref": "./examples/ListResourceHealthMetadataByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resourceHealthMetadata": { + "get": { + "tags": [ + "ResourceHealthMetadata" + ], + "summary": "Gets the category of ResourceHealthMetadata to use for the given site as a collection", + "description": "Description for Gets the category of ResourceHealthMetadata to use for the given site as a collection", + "operationId": "ResourceHealthMetadata_ListBySite", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceHealthMetadataCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List ResourceHealthMetadata for a site": { + "$ref": "./examples/ListResourceHealthMetadataBySite.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resourceHealthMetadata/default": { + "get": { + "tags": [ + "ResourceHealthMetadata" + ], + "summary": "Gets the category of ResourceHealthMetadata to use for the given site", + "description": "Description for Gets the category of ResourceHealthMetadata to use for the given site", + "operationId": "ResourceHealthMetadata_GetBySite", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceHealthMetadata" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get ResourceHealthMetadata": { + "$ref": "./examples/GetResourceHealthMetadataBySite.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resourceHealthMetadata": { + "get": { + "tags": [ + "ResourceHealthMetadata" + ], + "summary": "Gets the category of ResourceHealthMetadata to use for the given site as a collection", + "description": "Description for Gets the category of ResourceHealthMetadata to use for the given site as a collection", + "operationId": "ResourceHealthMetadata_ListBySiteSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceHealthMetadataCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List ResourceHealthMetadata for a site": { + "$ref": "./examples/ListResourceHealthMetadataBySite.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resourceHealthMetadata/default": { + "get": { + "tags": [ + "ResourceHealthMetadata" + ], + "summary": "Gets the category of ResourceHealthMetadata to use for the given site", + "description": "Description for Gets the category of ResourceHealthMetadata to use for the given site", + "operationId": "ResourceHealthMetadata_GetBySiteSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceHealthMetadata" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get ResourceHealthMetadata": { + "$ref": "./examples/GetResourceHealthMetadataBySite.json" + } + } + } + } + }, + "definitions": { + "ResourceHealthMetadata": { + "description": "Used for getting ResourceHealthCheck settings.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "ResourceHealthMetadata resource specific properties", + "type": "object", + "properties": { + "category": { + "description": "The category that the resource matches in the RHC Policy File", + "type": "string" + }, + "signalAvailability": { + "description": "Is there a health signal for the resource", + "type": "boolean" + } + }, + "x-ms-client-flatten": true + } + } + }, + "ResourceHealthMetadataCollection": { + "description": "Collection of resource health metadata.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceHealthMetadata" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group to which the resource belongs.", + "required": true, + "type": "string", + "maxLength": 90, + "minLength": 1, + "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$", + "x-ms-parameter-location": "method" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API Version", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + } + }, + "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/web/resource-manager/Microsoft.Web/stable/2024-04-01/ResourceProvider.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/ResourceProvider.json new file mode 100644 index 000000000000..682922b482b0 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/ResourceProvider.json @@ -0,0 +1,1675 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": " API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.Web/publishingUsers/web": { + "get": { + "summary": "Gets publishing user", + "description": "Description for Gets publishing user", + "operationId": "GetPublishingUser", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/User" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "summary": "Updates publishing user", + "description": "Description for Updates publishing user", + "operationId": "UpdatePublishingUser", + "parameters": [ + { + "name": "userDetails", + "in": "body", + "description": "Details of publishing user", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/User" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/User" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Web/sourcecontrols": { + "get": { + "summary": "Gets the source controls available for Azure websites.", + "description": "Description for Gets the source controls available for Azure websites.", + "operationId": "ListSourceControls", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SourceControlCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Web/sourcecontrols/{sourceControlType}": { + "get": { + "summary": "Gets source control token", + "description": "Description for Gets source control token", + "operationId": "GetSourceControl", + "parameters": [ + { + "name": "sourceControlType", + "in": "path", + "description": "Type of source control", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SourceControl" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "summary": "Updates source control token", + "description": "Description for Updates source control token", + "operationId": "UpdateSourceControl", + "parameters": [ + { + "name": "sourceControlType", + "in": "path", + "description": "Type of source control", + "required": true, + "type": "string" + }, + { + "name": "requestMessage", + "in": "body", + "description": "Source control token information", + "required": true, + "schema": { + "$ref": "#/definitions/SourceControl" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SourceControl" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/billingMeters": { + "get": { + "summary": "Gets a list of meters for a given location.", + "description": "Description for Gets a list of meters for a given location.", + "operationId": "ListBillingMeters", + "parameters": [ + { + "name": "billingLocation", + "in": "query", + "description": "Azure Location of billable resource", + "type": "string" + }, + { + "name": "osType", + "in": "query", + "description": "App Service OS type meters used for", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BillingMeterCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/checknameavailability": { + "post": { + "summary": "Check if a resource name is available.", + "description": "Description for Check if a resource name is available.", + "operationId": "CheckNameAvailability", + "parameters": [ + { + "name": "request", + "in": "body", + "description": "Name availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceNameAvailabilityRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceNameAvailability" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/customhostnameSites": { + "get": { + "summary": "Get custom hostnames under this subscription", + "operationId": "ListCustomHostNameSites", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/hostnameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CustomHostnameSitesCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get custom hostnames under subscription": { + "$ref": "./examples/ListCustomHostNameSites.json" + }, + "Get specific custom hostname under subscription": { + "$ref": "./examples/ListCustomSpecificHostNameSites.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/deploymentLocations": { + "get": { + "summary": "Gets list of available geo regions plus ministamps", + "description": "Description for Gets list of available geo regions plus ministamps", + "operationId": "GetSubscriptionDeploymentLocations", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DeploymentLocations" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/aseRegions": { + "get": { + "summary": "Get a list of available ASE regions and its supported Skus.", + "description": "Description for get a list of available ASE regions and its supported Skus.", + "operationId": "ListAseRegions", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AseRegionCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List aseregions": { + "$ref": "./examples/ListAseRegions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/geoRegions": { + "get": { + "summary": "Get a list of available geographical regions.", + "description": "Description for Get a list of available geographical regions.", + "operationId": "ListGeoRegions", + "parameters": [ + { + "name": "sku", + "in": "query", + "description": "Name of SKU used to filter the regions.", + "type": "string", + "enum": [ + "Free", + "Shared", + "Basic", + "Standard", + "Premium", + "Dynamic", + "Isolated", + "IsolatedV2", + "PremiumV2", + "PremiumV3", + "PremiumContainer", + "ElasticPremium", + "ElasticIsolated", + "FlexConsumption" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + { + "name": "linuxWorkersEnabled", + "in": "query", + "description": "Specify true if you want to filter to only regions that support Linux workers.", + "type": "boolean" + }, + { + "name": "xenonWorkersEnabled", + "in": "query", + "description": "Specify true if you want to filter to only regions that support Xenon workers.", + "type": "boolean" + }, + { + "name": "linuxDynamicWorkersEnabled", + "in": "query", + "description": "Specify true if you want to filter to only regions that support Linux Consumption Workers.", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GeoRegionCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/listSitesAssignedToHostName": { + "post": { + "summary": "List all apps that are assigned to a hostname.", + "description": "Description for List all apps that are assigned to a hostname.", + "operationId": "ListSiteIdentifiersAssignedToHostName", + "parameters": [ + { + "name": "nameIdentifier", + "in": "body", + "description": "Hostname information.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/NameIdentifier" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/IdentifierCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/premieraddonoffers": { + "get": { + "summary": "List all premier add-on offers.", + "description": "Description for List all premier add-on offers.", + "operationId": "ListPremierAddOnOffers", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PremierAddOnOfferCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/skus": { + "get": { + "summary": "List all SKUs.", + "description": "Description for List all SKUs.", + "operationId": "ListSkus", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SkuInfos" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/usages": { + "get": { + "summary": "Lists subscription core usages for all skus used in a location, for a given type of quota.", + "description": "List usages in cores for all skus used by a subscription in a given location, for a specific quota type.", + "operationId": "GetUsagesInLocation_list", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/CsmUsageQuotaCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get usages in location for subscription": { + "$ref": "./examples/GetUsagesInLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/verifyHostingEnvironmentVnet": { + "post": { + "summary": "Verifies if this VNET is compatible with an App Service Environment by analyzing the Network Security Group rules.", + "description": "Description for Verifies if this VNET is compatible with an App Service Environment by analyzing the Network Security Group rules.", + "operationId": "VerifyHostingEnvironmentVnet", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "VNET information", + "required": true, + "schema": { + "$ref": "#/definitions/VnetParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetValidationFailureDetails" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "VerifyHostingEnvironmentVnet": { + "$ref": "./examples/VerifyHostingEnvironmentVnet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources": { + "post": { + "summary": "Move resources between resource groups.", + "description": "Description for Move resources between resource groups.", + "operationId": "Move", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "moveResourceEnvelope", + "in": "body", + "description": "Object that represents the resource to move.", + "required": true, + "schema": { + "$ref": "#/definitions/CsmMoveResourceEnvelope" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/validate": { + "post": { + "summary": "Validate if a resource can be created.", + "description": "Description for Validate if a resource can be created.", + "operationId": "Validate", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "validateRequest", + "in": "body", + "description": "Request with the resources to validate.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ValidateResponse" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/validateMoveResources": { + "post": { + "summary": "Validate whether a resource can be moved.", + "description": "Description for Validate whether a resource can be moved.", + "operationId": "ValidateMove", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "moveResourceEnvelope", + "in": "body", + "description": "Object that represents the resource to move.", + "required": true, + "schema": { + "$ref": "#/definitions/CsmMoveResourceEnvelope" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + } + }, + "definitions": { + "AppserviceGithubToken": { + "description": "Github access token for Appservice CLI github integration.", + "type": "object", + "properties": { + "accessToken": { + "description": "Github access token for Appservice CLI github integration", + "type": "string" + }, + "scope": { + "description": "Scope of the github access token", + "type": "string" + }, + "tokenType": { + "description": "token type", + "type": "string" + }, + "gotToken": { + "description": "True if valid github token received, False otherwise", + "type": "boolean" + }, + "errorMessage": { + "description": "Error message if unable to get token", + "type": "string" + } + } + }, + "AppserviceGithubTokenRequest": { + "description": "Appservice Github token request content.", + "required": [ + "code", + "state" + ], + "type": "object", + "properties": { + "code": { + "description": "Code string to exchange for Github Access token", + "type": "string" + }, + "state": { + "description": "State string used for verification.", + "type": "string" + } + } + }, + "BillingMeter": { + "description": "App Service billing entity that contains information about meter which the Azure billing system utilizes to charge users for services.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "BillingMeter resource specific properties", + "type": "object", + "properties": { + "meterId": { + "description": "Meter GUID onboarded in Commerce", + "type": "string" + }, + "billingLocation": { + "description": "Azure Location of billable resource", + "type": "string" + }, + "shortName": { + "description": "Short Name from App Service Azure pricing Page", + "type": "string" + }, + "friendlyName": { + "description": "Friendly name of the meter", + "type": "string" + }, + "resourceType": { + "description": "App Service ResourceType meter used for", + "type": "string" + }, + "osType": { + "description": "App Service OS type meter used for", + "type": "string" + }, + "multiplier": { + "format": "double", + "description": "Meter Multiplier", + "type": "number" + } + }, + "x-ms-client-flatten": true + } + } + }, + "BillingMeterCollection": { + "description": "Collection of Billing Meters", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/BillingMeter" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "CsmMoveResourceEnvelope": { + "description": "Object with a list of the resources that need to be moved and the resource group they should be moved to.", + "type": "object", + "properties": { + "targetResourceGroup": { + "maxLength": 90, + "minLength": 1, + "pattern": " ^[-\\w\\._\\(\\)]+[^\\.]$", + "type": "string" + }, + "resources": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "CustomHostnameSites": { + "description": "A hostname and its assigned sites", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "CustomHostnameSites resource specific properties", + "type": "object", + "properties": { + "customHostname": { + "type": "string" + }, + "region": { + "type": "string" + }, + "siteResourceIds": { + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/Identifier" + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "CustomHostnameSitesCollection": { + "description": "Collection of custom hostname sites", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomHostnameSites" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "DeploymentLocations": { + "description": "List of available locations (regions or App Service Environments) for\ndeployment of App Service resources.", + "type": "object", + "properties": { + "locations": { + "description": "Available regions.", + "type": "array", + "items": { + "$ref": "#/definitions/GeoRegion" + } + }, + "hostingEnvironments": { + "description": "Available App Service Environments with full descriptions of the environments.", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/AppServiceEnvironment" + }, + "x-ms-identifiers": [] + }, + "hostingEnvironmentDeploymentInfos": { + "description": "Available App Service Environments with basic information.", + "type": "array", + "items": { + "$ref": "#/definitions/HostingEnvironmentDeploymentInfo" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "AseRegion": { + "description": "ASE region.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "ASE region resource specific properties", + "type": "object", + "properties": { + "displayName": { + "description": "Display name for region.", + "type": "string", + "readOnly": true + }, + "standard": { + "description": "Is region standard.", + "type": "boolean", + "readOnly": true + }, + "dedicatedHost": { + "description": "Dedicated host enabled.", + "type": "boolean", + "readOnly": true + }, + "zoneRedundant": { + "description": "Zone redundant deployment enabled.", + "type": "boolean", + "readOnly": true + }, + "availableSku": { + "description": "Available Skus in region.", + "type": "array", + "items": { + "type": "string" + } + }, + "availableOS": { + "description": "Available OSs in region.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "GeoRegion": { + "description": "Geographical region.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "GeoRegion resource specific properties", + "type": "object", + "properties": { + "description": { + "description": "Region description.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "Display name for region.", + "type": "string", + "readOnly": true + }, + "orgDomain": { + "description": "Display name for region.", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "AseRegionCollection": { + "description": "Collection of ASE regions.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/AseRegion" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "GeoRegionCollection": { + "description": "Collection of geographical regions.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/GeoRegion" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "GlobalCsmSkuDescription": { + "description": "A Global SKU Description.", + "type": "object", + "properties": { + "name": { + "description": "Name of the resource SKU.", + "type": "string" + }, + "tier": { + "description": "Service Tier of the resource SKU.", + "type": "string" + }, + "size": { + "description": "Size specifier of the resource SKU.", + "type": "string" + }, + "family": { + "description": "Family code of the resource SKU.", + "type": "string" + }, + "capacity": { + "$ref": "./CommonDefinitions.json#/definitions/SkuCapacity", + "description": "Min, max, and default scale values of the SKU." + }, + "locations": { + "description": "Locations of the SKU.", + "type": "array", + "items": { + "type": "string" + } + }, + "capabilities": { + "description": "Capabilities of the SKU, e.g., is traffic manager enabled?", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/Capability" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "HostingEnvironmentDeploymentInfo": { + "description": "Information needed to create resources on an App Service Environment.", + "type": "object", + "properties": { + "name": { + "description": "Name of the App Service Environment.", + "type": "string" + }, + "location": { + "description": "Location of the App Service Environment.", + "type": "string" + } + } + }, + "PremierAddOnOffer": { + "description": "Premier add-on offer.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "PremierAddOnOffer resource specific properties", + "type": "object", + "properties": { + "sku": { + "description": "Premier add on SKU.", + "type": "string" + }, + "product": { + "description": "Premier add on offer Product.", + "type": "string" + }, + "vendor": { + "description": "Premier add on offer Vendor.", + "type": "string" + }, + "promoCodeRequired": { + "description": "true if promotion code is required; otherwise, false.", + "type": "boolean" + }, + "quota": { + "format": "int32", + "description": "Premier add on offer Quota.", + "type": "integer" + }, + "webHostingPlanRestrictions": { + "description": "App Service plans this offer is restricted to.", + "enum": [ + "None", + "Free", + "Shared", + "Basic", + "Standard", + "Premium" + ], + "type": "string", + "x-ms-enum": { + "name": "AppServicePlanRestrictions", + "modelAsString": false + } + }, + "privacyPolicyUrl": { + "description": "Privacy policy URL.", + "type": "string" + }, + "legalTermsUrl": { + "description": "Legal terms URL.", + "type": "string" + }, + "marketplacePublisher": { + "description": "Marketplace publisher.", + "type": "string" + }, + "marketplaceOffer": { + "description": "Marketplace offer.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "PremierAddOnOfferCollection": { + "description": "Collection of premier add-on offers.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/PremierAddOnOffer" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ResourceNameAvailability": { + "description": "Information regarding availability of a resource name.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "true indicates name is valid and available. false indicates the name is invalid, unavailable, or both.", + "type": "boolean" + }, + "reason": { + "description": "Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "x-ms-enum": { + "name": "InAvailabilityReasonType", + "modelAsString": true + } + }, + "message": { + "description": "If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name.", + "type": "string" + } + } + }, + "ResourceNameAvailabilityRequest": { + "description": "Resource name availability request content.", + "required": [ + "name", + "type" + ], + "type": "object", + "properties": { + "name": { + "description": "Resource name to verify.", + "type": "string" + }, + "type": { + "description": "Resource type used for verification.", + "enum": [ + "Site", + "Slot", + "HostingEnvironment", + "PublishingUser", + "Microsoft.Web/sites", + "Microsoft.Web/sites/slots", + "Microsoft.Web/hostingEnvironments", + "Microsoft.Web/publishingUsers" + ], + "type": "string", + "x-ms-enum": { + "name": "CheckNameResourceTypes", + "modelAsString": true + } + }, + "isFqdn": { + "description": "Is fully qualified domain name.", + "type": "boolean" + }, + "environmentId": { + "description": "Azure Resource Manager ID of the customer's selected Container Apps Environment on which to host the Function app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}", + "type": "string" + } + } + }, + "SkuInfos": { + "description": "Collection of SKU information.", + "type": "object", + "properties": { + "resourceType": { + "description": "Resource type that this SKU applies to.", + "type": "string" + }, + "skus": { + "description": "List of SKUs the subscription is able to use.", + "type": "array", + "items": { + "$ref": "#/definitions/GlobalCsmSkuDescription" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "SourceControl": { + "description": "The source control OAuth token.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "SourceControl resource specific properties", + "type": "object", + "properties": { + "token": { + "description": "OAuth access token.", + "type": "string" + }, + "tokenSecret": { + "description": "OAuth access token secret.", + "type": "string" + }, + "refreshToken": { + "description": "OAuth refresh token.", + "type": "string" + }, + "expirationTime": { + "format": "date-time", + "description": "OAuth token expiration.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "SourceControlCollection": { + "description": "Collection of source controls.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SourceControl" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ValidateProperties": { + "description": "App properties used for validation.", + "type": "object", + "properties": { + "serverFarmId": { + "description": "ARM resource ID of an App Service plan that would host the app.", + "type": "string" + }, + "skuName": { + "description": "Name of the target SKU for the App Service plan.", + "type": "string" + }, + "needLinuxWorkers": { + "description": "true if App Service plan is for Linux workers; otherwise, false.", + "type": "boolean" + }, + "isSpot": { + "description": "true if App Service plan is for Spot instances; otherwise, false.", + "type": "boolean" + }, + "capacity": { + "format": "int32", + "description": "Target capacity of the App Service plan (number of VMs).", + "minimum": 1, + "type": "integer" + }, + "hostingEnvironment": { + "description": "Name of App Service Environment where app or App Service plan should be created.", + "type": "string" + }, + "isXenon": { + "description": "true if App Service plan is running as a windows container", + "type": "boolean" + }, + "containerRegistryBaseUrl": { + "description": "Base URL of the container registry", + "type": "string" + }, + "containerRegistryUsername": { + "description": "Username for to access the container registry", + "type": "string" + }, + "containerRegistryPassword": { + "description": "Password for to access the container registry", + "type": "string" + }, + "containerImageRepository": { + "description": "Repository name (image name)", + "type": "string" + }, + "containerImageTag": { + "description": "Image tag", + "type": "string" + }, + "containerImagePlatform": { + "description": "Platform (windows or linux)", + "type": "string" + }, + "appServiceEnvironment": { + "$ref": "./CommonDefinitions.json#/definitions/AppServiceEnvironment", + "description": "App Service Environment Properties" + } + } + }, + "ValidateRequest": { + "description": "Resource validation request content.", + "required": [ + "name", + "type", + "location", + "properties" + ], + "type": "object", + "properties": { + "name": { + "description": "Resource name to verify.", + "type": "string" + }, + "type": { + "description": "Resource type used for verification.", + "enum": [ + "ServerFarm", + "Site", + "Microsoft.Web/hostingEnvironments" + ], + "type": "string", + "x-ms-enum": { + "name": "ValidateResourceTypes", + "modelAsString": true + } + }, + "location": { + "description": "Expected location of the resource.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ValidateProperties", + "description": "Properties of the resource to validate.", + "x-ms-client-flatten": true + } + } + }, + "ValidateResponse": { + "description": "Describes the result of resource validation.", + "type": "object", + "properties": { + "status": { + "description": "Result of validation.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/ValidateResponseError", + "description": "Error details for the case when validation fails." + } + } + }, + "ValidateResponseError": { + "description": "Error details for when validation fails.", + "type": "object", + "properties": { + "code": { + "description": "Validation error code.", + "type": "string" + }, + "message": { + "description": "Validation error message.", + "type": "string" + } + } + }, + "VnetParameters": { + "description": "The required set of inputs to validate a VNET", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "VnetParameters resource specific properties", + "type": "object", + "properties": { + "vnetResourceGroup": { + "description": "The Resource Group of the VNET to be validated", + "type": "string" + }, + "vnetName": { + "description": "The name of the VNET to be validated", + "type": "string" + }, + "vnetSubnetName": { + "description": "The subnet name to be validated", + "type": "string" + }, + "subnetResourceId": { + "description": "The ARM Resource ID of the subnet to validate", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "VnetValidationFailureDetails": { + "description": "A class that describes the reason for a validation failure.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "VnetValidationFailureDetails resource specific properties", + "type": "object", + "properties": { + "message": { + "description": "Text describing the validation outcome.", + "type": "string" + }, + "failed": { + "description": "A flag describing whether or not validation failed.", + "type": "boolean" + }, + "failedTests": { + "description": "A list of tests that failed in the validation.", + "type": "array", + "items": { + "$ref": "#/definitions/VnetValidationTestFailure" + } + }, + "warnings": { + "description": "A list of warnings generated during validation.", + "type": "array", + "items": { + "$ref": "#/definitions/VnetValidationTestFailure" + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "VnetValidationTestFailure": { + "description": "A class that describes a test that failed during NSG and UDR validation.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "VnetValidationTestFailure resource specific properties", + "type": "object", + "properties": { + "testName": { + "description": "The name of the test that failed.", + "type": "string" + }, + "details": { + "description": "The details of what caused the failure, e.g. the blocking rule name, etc.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group to which the resource belongs.", + "required": true, + "type": "string", + "maxLength": 90, + "minLength": 1, + "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$", + "x-ms-parameter-location": "method" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API Version", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "hostnameParameter": { + "name": "hostname", + "in": "query", + "description": "Specific hostname", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure region.", + "minLength": 1, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/StaticSites.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/StaticSites.json new file mode 100644 index 000000000000..6b0788ce4704 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/StaticSites.json @@ -0,0 +1,5585 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "StaticSites API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/previewStaticSiteWorkflowFile": { + "post": { + "tags": [ + "StaticSites" + ], + "summary": "Generates a preview workflow file for the static site", + "description": "Description for Generates a preview workflow file for the static site", + "operationId": "StaticSites_PreviewWorkflow", + "parameters": [ + { + "name": "location", + "in": "path", + "description": "Location where you plan to create the static site.", + "required": true, + "type": "string" + }, + { + "name": "staticSitesWorkflowPreviewRequest", + "in": "body", + "description": "A JSON representation of the StaticSitesWorkflowPreviewRequest properties. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/StaticSitesWorkflowPreviewRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StaticSitesWorkflowPreview" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Generates a preview workflow file for the static site": { + "$ref": "./examples/GenerateStaticSiteWorkflowPreview.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/staticSites": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Get all Static Sites for a subscription.", + "description": "Description for Get all Static Sites for a subscription.", + "operationId": "StaticSites_List", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StaticSiteCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get all static sites in a subscription": { + "$ref": "./examples/GetAllStaticSites.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Gets all static sites in the specified resource group.", + "description": "Description for Gets all static sites in the specified resource group.", + "operationId": "StaticSites_GetStaticSitesByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/StaticSiteCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get static sites for a resource group": { + "$ref": "./examples/GetStaticSites.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Gets the details of a static site.", + "description": "Description for Gets the details of a static site.", + "operationId": "StaticSites_GetStaticSite", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/StaticSiteARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get details for a static site": { + "$ref": "./examples/GetStaticSite.json" + } + } + }, + "put": { + "tags": [ + "StaticSites" + ], + "summary": "Creates a new static site in an existing resource group, or updates an existing static site.", + "description": "Description for Creates a new static site in an existing resource group, or updates an existing static site.", + "operationId": "StaticSites_CreateOrUpdateStaticSite", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site to create or update.", + "required": true, + "type": "string" + }, + { + "name": "staticSiteEnvelope", + "in": "body", + "description": "A JSON representation of the staticsite properties. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/StaticSiteARMResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/StaticSiteARMResource" + } + }, + "202": { + "description": "Asynchronous operation in progress.", + "schema": { + "$ref": "#/definitions/StaticSiteARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a static site": { + "$ref": "./examples/CreateOrUpdateStaticSite.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "StaticSites" + ], + "summary": "Deletes a static site.", + "description": "Description for Deletes a static site.", + "operationId": "StaticSites_DeleteStaticSite", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site to delete.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Asynchronous operation in progress." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a static site": { + "$ref": "./examples/DeleteStaticSite.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "StaticSites" + ], + "summary": "Creates a new static site in an existing resource group, or updates an existing static site.", + "description": "Description for Creates a new static site in an existing resource group, or updates an existing static site.", + "operationId": "StaticSites_UpdateStaticSite", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site to create or update.", + "required": true, + "type": "string" + }, + { + "name": "staticSiteEnvelope", + "in": "body", + "description": "A JSON representation of the staticsite properties. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/StaticSitePatchResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/StaticSiteARMResource" + } + }, + "202": { + "description": "Asynchronous operation in progress.", + "schema": { + "$ref": "#/definitions/StaticSiteARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch a static site": { + "$ref": "./examples/PatchStaticSite.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/authproviders/{authprovider}/listUsers": { + "post": { + "tags": [ + "StaticSites" + ], + "summary": "Gets the list of users of a static site.", + "description": "Description for Gets the list of users of a static site.", + "operationId": "StaticSites_ListStaticSiteUsers", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "authprovider", + "in": "path", + "description": "The auth provider for the users.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/StaticSiteUserCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List users for a static site": { + "$ref": "./examples/ListStaticSiteUsers.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/authproviders/{authprovider}/users/{userid}": { + "delete": { + "tags": [ + "StaticSites" + ], + "summary": "Deletes the user entry from the static site.", + "description": "Description for Deletes the user entry from the static site.", + "operationId": "StaticSites_DeleteStaticSiteUser", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the staticsite.", + "required": true, + "type": "string" + }, + { + "name": "authprovider", + "in": "path", + "description": "The auth provider for this user.", + "required": true, + "type": "string" + }, + { + "name": "userid", + "in": "path", + "description": "The user id of the user.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a user for a static site": { + "$ref": "./examples/DeleteStaticSiteUser.json" + } + } + }, + "patch": { + "tags": [ + "StaticSites" + ], + "summary": "Updates a user entry with the listed roles", + "description": "Description for Updates a user entry with the listed roles", + "operationId": "StaticSites_UpdateStaticSiteUser", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "authprovider", + "in": "path", + "description": "The auth provider for this user.", + "required": true, + "type": "string" + }, + { + "name": "userid", + "in": "path", + "description": "The user id of the user.", + "required": true, + "type": "string" + }, + { + "name": "staticSiteUserEnvelope", + "in": "body", + "description": "A JSON representation of the StaticSiteUser properties. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/StaticSiteUserARMResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/StaticSiteUserARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a user for a static site": { + "$ref": "./examples/UpdateStaticSiteUser.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Gets all static site builds for a particular static site.", + "description": "Description for Gets all static site builds for a particular static site.", + "operationId": "StaticSites_GetStaticSiteBuilds", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/StaticSiteBuildCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get all builds for a static site": { + "$ref": "./examples/GetStaticSiteBuilds.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Gets the details of a static site build.", + "description": "Description for Gets the details of a static site build.", + "operationId": "StaticSites_GetStaticSiteBuild", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "The stage site identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/StaticSiteBuildARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a static site build": { + "$ref": "./examples/GetStaticSiteBuild.json" + } + } + }, + "delete": { + "tags": [ + "StaticSites" + ], + "summary": "Deletes a static site build.", + "description": "Description for Deletes a static site build.", + "operationId": "StaticSites_DeleteStaticSiteBuild", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "The stage site identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "OK." + }, + "202": { + "description": "Asynchronous operation in progress." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a static site build": { + "$ref": "./examples/DeleteStaticSiteBuild.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/config/appsettings": { + "put": { + "tags": [ + "StaticSites" + ], + "summary": "Creates or updates the app settings of a static site build.", + "description": "Description for Creates or updates the app settings of a static site build.", + "operationId": "StaticSites_CreateOrUpdateStaticSiteBuildAppSettings", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "The stage site identifier.", + "required": true, + "type": "string" + }, + { + "name": "appSettings", + "in": "body", + "description": "The dictionary containing the static site app settings to update.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Creates or updates the function app settings of a static site build.": { + "$ref": "./examples/CreateOrUpdateStaticSiteBuildAppSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/config/functionappsettings": { + "put": { + "tags": [ + "StaticSites" + ], + "summary": "Creates or updates the function app settings of a static site build.", + "description": "Description for Creates or updates the function app settings of a static site build.", + "operationId": "StaticSites_CreateOrUpdateStaticSiteBuildFunctionAppSettings", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "The stage site identifier.", + "required": true, + "type": "string" + }, + { + "name": "appSettings", + "in": "body", + "description": "The dictionary containing the static site function app settings to update.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Creates or updates the function app settings of a static site build.": { + "$ref": "./examples/CreateOrUpdateStaticSiteBuildFunctionAppSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Returns overviews of database connections for a static site build", + "operationId": "StaticSites_GetBuildDatabaseConnections", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/environmentNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DatabaseConnectionCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List overviews of database connections for the static site build.": { + "$ref": "./examples/GetStaticSiteBuildDatabaseConnections.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Returns overview of a database connection for a static site build by name", + "operationId": "StaticSites_GetBuildDatabaseConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/environmentNameParameter" + }, + { + "$ref": "#/parameters/databaseConnectionNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DatabaseConnection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get overview of database connections for the static site build.": { + "$ref": "./examples/GetStaticSiteBuildDatabaseConnection.json" + } + } + }, + "put": { + "tags": [ + "StaticSites" + ], + "summary": "Create or update a database connection for a static site build", + "description": "Description for Create or update a database connection for a static site build", + "operationId": "StaticSites_CreateOrUpdateBuildDatabaseConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/environmentNameParameter" + }, + { + "$ref": "#/parameters/databaseConnectionNameParameter" + }, + { + "name": "databaseConnectionRequestEnvelope", + "in": "body", + "description": "A JSON representation of the database connection request properties", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseConnection" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DatabaseConnection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a database connection for a static site build": { + "$ref": "./examples/CreateOrUpdateStaticSiteBuildDatabaseConnection.json" + } + } + }, + "delete": { + "tags": [ + "StaticSites" + ], + "summary": "Delete a database connection for a static site build", + "operationId": "StaticSites_DeleteBuildDatabaseConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/environmentNameParameter" + }, + { + "$ref": "#/parameters/databaseConnectionNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a database connection from a static site build.": { + "$ref": "./examples/DeleteStaticSiteBuildDatabaseConnection.json" + } + } + }, + "patch": { + "tags": [ + "StaticSites" + ], + "summary": "Create or update a database connection for a static site build", + "description": "Description for Create or update a database connection for a static site build", + "operationId": "StaticSites_UpdateBuildDatabaseConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/environmentNameParameter" + }, + { + "$ref": "#/parameters/databaseConnectionNameParameter" + }, + { + "name": "databaseConnectionRequestEnvelope", + "in": "body", + "description": "A JSON representation of the database connection request properties", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseConnectionPatchRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DatabaseConnection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch a database connection for a static site build": { + "$ref": "./examples/PatchStaticSiteBuildDatabaseConnection.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}/show": { + "post": { + "tags": [ + "StaticSites" + ], + "summary": "Returns details of a database connection for a static site build by name", + "operationId": "StaticSites_GetBuildDatabaseConnectionWithDetails", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/environmentNameParameter" + }, + { + "$ref": "#/parameters/databaseConnectionNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DatabaseConnection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get details of database connections for the static site build.": { + "$ref": "./examples/GetStaticSiteBuildDatabaseConnectionWithDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/functions": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Gets the functions of a particular static site build.", + "description": "Description for Gets the functions of a particular static site build.", + "operationId": "StaticSites_ListStaticSiteBuildFunctions", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "The stage site identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/StaticSiteFunctionOverviewCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets the functions of a particular static site build": { + "$ref": "./examples/ListStaticSiteBuildFunctions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/listAppSettings": { + "post": { + "tags": [ + "StaticSites" + ], + "summary": "Gets the application settings of a static site build.", + "description": "Description for Gets the application settings of a static site build.", + "operationId": "StaticSites_ListStaticSiteBuildAppSettings", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "The stage site identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get app settings of a static site build": { + "$ref": "./examples/ListStaticSiteBuildAppSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/listFunctionAppSettings": { + "post": { + "tags": [ + "StaticSites" + ], + "summary": "Gets the application settings of a static site build.", + "description": "Description for Gets the application settings of a static site build.", + "operationId": "StaticSites_ListStaticSiteBuildFunctionAppSettings", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "The stage site identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get function app settings of a static site build": { + "$ref": "./examples/ListStaticSiteBuildFunctionAppSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/showDatabaseConnections": { + "post": { + "tags": [ + "StaticSites" + ], + "summary": "Returns details of database connections for a static site build", + "operationId": "StaticSites_GetBuildDatabaseConnectionsWithDetails", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/environmentNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DatabaseConnectionCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List full details of database connections for the static site build.": { + "$ref": "./examples/GetStaticSiteBuildDatabaseConnectionsWithDetails.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Gets the details of the user provided function apps registered with a static site build", + "description": "Description for Gets the details of the user provided function apps registered with a static site build", + "operationId": "StaticSites_GetUserProvidedFunctionAppsForStaticSiteBuild", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "The stage site identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/StaticSiteUserProvidedFunctionAppsCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get details of the user provided function apps registered with a static site build.": { + "$ref": "./examples/GetUserProvidedFunctionAppsForStaticSiteBuild.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps/{functionAppName}": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Gets the details of the user provided function app registered with a static site build", + "description": "Description for Gets the details of the user provided function app registered with a static site build", + "operationId": "StaticSites_GetUserProvidedFunctionAppForStaticSiteBuild", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "The stage site identifier.", + "required": true, + "type": "string" + }, + { + "name": "functionAppName", + "in": "path", + "description": "Name of the function app registered with the static site build.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/StaticSiteUserProvidedFunctionAppARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get details of the user provided function app registered with a static site build.": { + "$ref": "./examples/GetUserProvidedFunctionAppForStaticSiteBuild.json" + } + } + }, + "put": { + "tags": [ + "StaticSites" + ], + "summary": "Register a user provided function app with a static site build", + "description": "Description for Register a user provided function app with a static site build", + "operationId": "StaticSites_RegisterUserProvidedFunctionAppWithStaticSiteBuild", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "The stage site identifier.", + "required": true, + "type": "string" + }, + { + "name": "functionAppName", + "in": "path", + "description": "Name of the function app to register with the static site build.", + "required": true, + "type": "string" + }, + { + "name": "staticSiteUserProvidedFunctionEnvelope", + "in": "body", + "description": "A JSON representation of the user provided function app properties. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/StaticSiteUserProvidedFunctionAppARMResource" + } + }, + { + "name": "isForced", + "in": "query", + "description": "Specify true to force the update of the auth configuration on the function app even if an AzureStaticWebApps provider is already configured on the function app. The default is false.", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/StaticSiteUserProvidedFunctionAppARMResource" + } + }, + "202": { + "description": "Asynchronous operation in progress.", + "schema": { + "$ref": "#/definitions/StaticSiteUserProvidedFunctionAppARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Register a user provided function app with a static site build": { + "$ref": "./examples/RegisterUserProvidedFunctionAppWithStaticSiteBuild.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "StaticSites" + ], + "summary": "Detach the user provided function app from the static site build", + "description": "Description for Detach the user provided function app from the static site build", + "operationId": "StaticSites_DetachUserProvidedFunctionAppFromStaticSiteBuild", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "The stage site identifier.", + "required": true, + "type": "string" + }, + { + "name": "functionAppName", + "in": "path", + "description": "Name of the function app registered with the static site build.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Detach the user provided function app from the static site build.": { + "$ref": "./examples/DetachUserProvidedFunctionAppFromStaticSiteBuild.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/zipdeploy": { + "post": { + "tags": [ + "StaticSites" + ], + "summary": "Deploys zipped content to a specific environment of a static site.", + "description": "Description for Deploys zipped content to a specific environment of a static site.", + "operationId": "StaticSites_CreateZipDeploymentForStaticSiteBuild", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the environment.", + "required": true, + "type": "string" + }, + { + "name": "staticSiteZipDeploymentEnvelope", + "in": "body", + "description": "A JSON representation of the StaticSiteZipDeployment properties. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/StaticSiteZipDeploymentARMResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Asynchronous operation in progress." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Deploy a site from a zipped package to a particular static site build": { + "$ref": "./examples/StaticSiteBuildZipDeploy.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/config/appsettings": { + "put": { + "tags": [ + "StaticSites" + ], + "summary": "Creates or updates the app settings of a static site.", + "description": "Description for Creates or updates the app settings of a static site.", + "operationId": "StaticSites_CreateOrUpdateStaticSiteAppSettings", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "appSettings", + "in": "body", + "description": "The dictionary containing the static site app settings to update.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Creates or updates the app settings of a static site.": { + "$ref": "./examples/CreateOrUpdateStaticSiteAppSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/basicAuth": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Gets the basic auth properties for a static site as a collection.", + "description": "Description for Gets the basic auth properties for a static site as a collection.", + "operationId": "StaticSites_ListBasicAuth", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/StaticSiteBasicAuthPropertiesCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Lists the basic auth properties for a static site.": { + "$ref": "./examples/ListStaticSiteBasicAuth.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/basicAuth/{basicAuthName}": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Gets the basic auth properties for a static site.", + "description": "Description for Gets the basic auth properties for a static site.", + "operationId": "StaticSites_GetBasicAuth", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "basicAuthName", + "in": "path", + "description": "name of the basic auth entry.", + "required": true, + "type": "string", + "pattern": "default", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "BasicAuthName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/StaticSiteBasicAuthPropertiesARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets the basic auth properties for a static site.": { + "$ref": "./examples/GetStaticSiteBasicAuth.json" + } + } + }, + "put": { + "tags": [ + "StaticSites" + ], + "summary": "Adds or updates basic auth for a static site.", + "description": "Description for Adds or updates basic auth for a static site.", + "operationId": "StaticSites_CreateOrUpdateBasicAuth", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "basicAuthName", + "in": "path", + "description": "name of the basic auth entry.", + "required": true, + "type": "string", + "pattern": "default", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "BasicAuthName", + "modelAsString": true + } + }, + { + "name": "basicAuthEnvelope", + "in": "body", + "description": "A JSON representation of the basic auth properties.", + "required": true, + "schema": { + "$ref": "#/definitions/StaticSiteBasicAuthPropertiesARMResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/StaticSiteBasicAuthPropertiesARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Creates or updates basic auth properties for a static site.": { + "$ref": "./examples/CreateOrUpdateStaticSiteBasicAuth.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/config/functionappsettings": { + "put": { + "tags": [ + "StaticSites" + ], + "summary": "Creates or updates the function app settings of a static site.", + "description": "Description for Creates or updates the function app settings of a static site.", + "operationId": "StaticSites_CreateOrUpdateStaticSiteFunctionAppSettings", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "appSettings", + "in": "body", + "description": "The dictionary containing the static site function app settings to update.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Creates or updates the function app settings of a static site.": { + "$ref": "./examples/CreateOrUpdateStaticSiteFunctionAppSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/createUserInvitation": { + "post": { + "tags": [ + "StaticSites" + ], + "summary": "Creates an invitation link for a user with the role", + "description": "Description for Creates an invitation link for a user with the role", + "operationId": "StaticSites_CreateUserRolesInvitationLink", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "staticSiteUserRolesInvitationEnvelope", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StaticSiteUserInvitationRequestResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/StaticSiteUserInvitationResponseResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create an invitation link for a user for a static site": { + "$ref": "./examples/CreateUserRolesInvitationLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Gets all static site custom domains for a particular static site.", + "description": "Description for Gets all static site custom domains for a particular static site.", + "operationId": "StaticSites_ListStaticSiteCustomDomains", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site resource to search in.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StaticSiteCustomDomainOverviewCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List custom domains for a static site": { + "$ref": "./examples/GetStaticSiteCustomDomains.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Gets an existing custom domain for a particular static site.", + "description": "Description for Gets an existing custom domain for a particular static site.", + "operationId": "StaticSites_GetStaticSiteCustomDomain", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site resource to search in.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "The custom domain name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StaticSiteCustomDomainOverviewARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get custom domain for a static site": { + "$ref": "./examples/GetStaticSiteCustomDomain.json" + } + } + }, + "put": { + "tags": [ + "StaticSites" + ], + "summary": "Creates a new static site custom domain in an existing resource group and static site.", + "description": "Description for Creates a new static site custom domain in an existing resource group and static site.", + "operationId": "StaticSites_CreateOrUpdateStaticSiteCustomDomain", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "The custom domain to create.", + "required": true, + "type": "string" + }, + { + "name": "staticSiteCustomDomainRequestPropertiesEnvelope", + "in": "body", + "description": "A JSON representation of the static site custom domain request properties. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/StaticSiteCustomDomainRequestPropertiesARMResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/StaticSiteCustomDomainOverviewARMResource" + } + }, + "202": { + "description": "Asynchronous operation in progress.", + "schema": { + "$ref": "#/definitions/StaticSiteCustomDomainOverviewARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a custom domain for a static site": { + "$ref": "./examples/CreateOrUpdateStaticSiteCustomDomain.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "StaticSites" + ], + "summary": "Deletes a custom domain.", + "description": "Description for Deletes a custom domain.", + "operationId": "StaticSites_DeleteStaticSiteCustomDomain", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "The custom domain to delete.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Asynchronous operation in progress." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a custom domain for a static site": { + "$ref": "./examples/DeleteStaticSiteCustomDomain.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}/validate": { + "post": { + "tags": [ + "StaticSites" + ], + "summary": "Validates a particular custom domain can be added to a static site.", + "description": "Description for Validates a particular custom domain can be added to a static site.", + "operationId": "StaticSites_ValidateCustomDomainCanBeAddedToStaticSite", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "The custom domain to validate.", + "required": true, + "type": "string" + }, + { + "name": "staticSiteCustomDomainRequestPropertiesEnvelope", + "in": "body", + "description": "A JSON representation of the static site custom domain request properties. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/StaticSiteCustomDomainRequestPropertiesARMResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Asynchronous operation in progress." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Validate a custom domain for a static site": { + "$ref": "./examples/ValidateStaticSiteCustomDomain.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Returns overviews of database connections for a static site", + "operationId": "StaticSites_GetDatabaseConnections", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DatabaseConnectionCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List overviews of database connections for the static site.": { + "$ref": "./examples/GetStaticSiteDatabaseConnections.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Returns overview of a database connection for a static site by name", + "operationId": "StaticSites_GetDatabaseConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/databaseConnectionNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DatabaseConnection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get overview of database connections for the static site.": { + "$ref": "./examples/GetStaticSiteDatabaseConnection.json" + } + } + }, + "put": { + "tags": [ + "StaticSites" + ], + "summary": "Create or update a database connection for a static site", + "description": "Description for Create or update a database connection for a static site", + "operationId": "StaticSites_CreateOrUpdateDatabaseConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/databaseConnectionNameParameter" + }, + { + "name": "databaseConnectionRequestEnvelope", + "in": "body", + "description": "A JSON representation of the database connection request properties", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseConnection" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DatabaseConnection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a database connection for a static site": { + "$ref": "./examples/CreateOrUpdateStaticSiteDatabaseConnection.json" + } + } + }, + "delete": { + "tags": [ + "StaticSites" + ], + "summary": "Delete a database connection for a static site", + "operationId": "StaticSites_DeleteDatabaseConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/databaseConnectionNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a database connection from a static site.": { + "$ref": "./examples/DeleteStaticSiteDatabaseConnection.json" + } + } + }, + "patch": { + "tags": [ + "StaticSites" + ], + "summary": "Create or update a database connection for a static site", + "description": "Description for Create or update a database connection for a static site", + "operationId": "StaticSites_UpdateDatabaseConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/databaseConnectionNameParameter" + }, + { + "name": "databaseConnectionRequestEnvelope", + "in": "body", + "description": "A JSON representation of the database connection request properties", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseConnectionPatchRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DatabaseConnection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch a database connection for a static site": { + "$ref": "./examples/PatchStaticSiteDatabaseConnection.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}/show": { + "post": { + "tags": [ + "StaticSites" + ], + "summary": "Returns details of a database connection for a static site by name", + "operationId": "StaticSites_GetDatabaseConnectionWithDetails", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/databaseConnectionNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DatabaseConnection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get details of database connections for the static site.": { + "$ref": "./examples/GetStaticSiteDatabaseConnectionWithDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/detach": { + "post": { + "tags": [ + "StaticSites" + ], + "summary": "Detaches a static site.", + "description": "Description for Detaches a static site.", + "operationId": "StaticSites_DetachStaticSite", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site to detach.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Asynchronous operation in progress." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Detach a static site": { + "$ref": "./examples/DetachStaticSite.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/functions": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Gets the functions of a static site.", + "description": "Description for Gets the functions of a static site.", + "operationId": "StaticSites_ListStaticSiteFunctions", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/StaticSiteFunctionOverviewCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets the functions of a static site": { + "$ref": "./examples/ListStaticSiteFunctions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listAppSettings": { + "post": { + "tags": [ + "StaticSites" + ], + "summary": "Gets the application settings of a static site.", + "description": "Description for Gets the application settings of a static site.", + "operationId": "StaticSites_ListStaticSiteAppSettings", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get app settings of a static site": { + "$ref": "./examples/ListStaticSiteAppSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listConfiguredRoles": { + "post": { + "tags": [ + "StaticSites" + ], + "summary": "Lists the roles configured for the static site.", + "description": "Description for Lists the roles configured for the static site.", + "operationId": "StaticSites_ListStaticSiteConfiguredRoles", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/StringList" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Lists the configured roles for a static site": { + "$ref": "./examples/ListStaticSiteConfiguredRoles.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listFunctionAppSettings": { + "post": { + "tags": [ + "StaticSites" + ], + "summary": "Gets the application settings of a static site.", + "description": "Description for Gets the application settings of a static site.", + "operationId": "StaticSites_ListStaticSiteFunctionAppSettings", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get function app settings of a static site": { + "$ref": "./examples/ListStaticSiteFunctionAppSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listSecrets": { + "post": { + "tags": [ + "StaticSites" + ], + "summary": "Lists the secrets for an existing static site.", + "description": "Description for Lists the secrets for an existing static site.", + "operationId": "StaticSites_ListStaticSiteSecrets", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List secrets for a static site": { + "$ref": "./examples/ListStaticSiteSecrets.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/privateEndpointConnections": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Gets the list of private endpoint connections associated with a static site", + "description": "Description for Gets the list of private endpoint connections associated with a static site", + "operationId": "StaticSites_GetPrivateEndpointConnectionList", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PrivateEndpointConnectionCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a list of private endpoint connections associated with a site.": { + "$ref": "./examples/GetSitePrivateEndpointConnectionList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Gets a private endpoint connection", + "description": "Description for Gets a private endpoint connection", + "operationId": "StaticSites_GetPrivateEndpointConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a private endpoint connection for a site.": { + "$ref": "./examples/GetSitePrivateEndpointConnection.json" + } + } + }, + "put": { + "tags": [ + "StaticSites" + ], + "summary": "Approves or rejects a private endpoint connection", + "description": "Description for Approves or rejects a private endpoint connection", + "operationId": "StaticSites_ApproveOrRejectPrivateEndpointConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointWrapper", + "in": "body", + "description": "Request body.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource" + } + }, + "202": { + "description": "Asynchronous operation in progress.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Approves or rejects a private endpoint connection for a site.": { + "$ref": "./examples/ApproveRejectSitePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "StaticSites" + ], + "summary": "Deletes a private endpoint connection", + "description": "Description for Deletes a private endpoint connection", + "operationId": "StaticSites_DeletePrivateEndpointConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Asynchronous operation in progress.", + "schema": { + "type": "object" + } + }, + "204": { + "description": "No content.", + "schema": { + "type": "object" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a private endpoint connection for a site.": { + "$ref": "./examples/DeleteSitePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/privateLinkResources": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Gets the private link resources", + "description": "Description for Gets the private link resources", + "operationId": "StaticSites_GetPrivateLinkResources", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the site.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PrivateLinkResourcesWrapper" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get private link resources of a site": { + "$ref": "./examples/GetSitePrivateLinkResources.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/resetapikey": { + "post": { + "tags": [ + "StaticSites" + ], + "summary": "Resets the api key for an existing static site.", + "description": "Description for Resets the api key for an existing static site.", + "operationId": "StaticSites_ResetStaticSiteApiKey", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "resetPropertiesEnvelope", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StaticSiteResetPropertiesARMResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Reset the api key for a static site": { + "$ref": "./examples/ResetStaticSiteApiKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/showDatabaseConnections": { + "post": { + "tags": [ + "StaticSites" + ], + "summary": "Returns details of database connections for a static site", + "operationId": "StaticSites_GetDatabaseConnectionsWithDetails", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DatabaseConnectionCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List full details of database connections for the static site.": { + "$ref": "./examples/GetStaticSiteDatabaseConnectionsWithDetails.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/userProvidedFunctionApps": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Gets the details of the user provided function apps registered with a static site", + "description": "Description for Gets the details of the user provided function apps registered with a static site", + "operationId": "StaticSites_GetUserProvidedFunctionAppsForStaticSite", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/StaticSiteUserProvidedFunctionAppsCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get details of the user provided function apps registered with a static site.": { + "$ref": "./examples/GetUserProvidedFunctionAppsForStaticSite.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/userProvidedFunctionApps/{functionAppName}": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Gets the details of the user provided function app registered with a static site", + "description": "Description for Gets the details of the user provided function app registered with a static site", + "operationId": "StaticSites_GetUserProvidedFunctionAppForStaticSite", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "functionAppName", + "in": "path", + "description": "Name of the function app registered with the static site.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/StaticSiteUserProvidedFunctionAppARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get details of the user provided function app registered with a static site.": { + "$ref": "./examples/GetUserProvidedFunctionAppForStaticSite.json" + } + } + }, + "put": { + "tags": [ + "StaticSites" + ], + "summary": "Register a user provided function app with a static site", + "description": "Description for Register a user provided function app with a static site", + "operationId": "StaticSites_RegisterUserProvidedFunctionAppWithStaticSite", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "functionAppName", + "in": "path", + "description": "Name of the function app to register with the static site.", + "required": true, + "type": "string" + }, + { + "name": "staticSiteUserProvidedFunctionEnvelope", + "in": "body", + "description": "A JSON representation of the user provided function app properties. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/StaticSiteUserProvidedFunctionAppARMResource" + } + }, + { + "name": "isForced", + "in": "query", + "description": "Specify true to force the update of the auth configuration on the function app even if an AzureStaticWebApps provider is already configured on the function app. The default is false.", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/StaticSiteUserProvidedFunctionAppARMResource" + } + }, + "202": { + "description": "Asynchronous operation in progress.", + "schema": { + "$ref": "#/definitions/StaticSiteUserProvidedFunctionAppARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Register a user provided function app with a static site": { + "$ref": "./examples/RegisterUserProvidedFunctionAppWithStaticSite.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "StaticSites" + ], + "summary": "Detach the user provided function app from the static site", + "description": "Description for Detach the user provided function app from the static site", + "operationId": "StaticSites_DetachUserProvidedFunctionAppFromStaticSite", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "functionAppName", + "in": "path", + "description": "Name of the function app registered with the static site.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Detach the user provided function app from the static site.": { + "$ref": "./examples/DetachUserProvidedFunctionAppFromStaticSite.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/zipdeploy": { + "post": { + "tags": [ + "StaticSites" + ], + "summary": "Deploys zipped content to a static site.", + "description": "Description for Deploys zipped content to a static site.", + "operationId": "StaticSites_CreateZipDeploymentForStaticSite", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site.", + "required": true, + "type": "string" + }, + { + "name": "staticSiteZipDeploymentEnvelope", + "in": "body", + "description": "A JSON representation of the StaticSiteZipDeployment properties. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/StaticSiteZipDeploymentARMResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Asynchronous operation in progress." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Deploy a site from a zipped package": { + "$ref": "./examples/StaticSiteZipDeploy.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends/{linkedBackendName}/validate": { + "post": { + "tags": [ + "StaticSites" + ], + "summary": "Validates that a backend can be linked to a static site", + "operationId": "StaticSites_ValidateBackend", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site", + "required": true, + "type": "string" + }, + { + "name": "linkedBackendName", + "in": "path", + "description": "Name of the linked backend that should be retrieved", + "required": true, + "type": "string" + }, + { + "name": "staticSiteLinkedBackendEnvelope", + "in": "body", + "description": "A JSON representation of the linked backend request properties", + "required": true, + "schema": { + "$ref": "#/definitions/StaticSiteLinkedBackendARMResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No content" + }, + "202": { + "description": "Asynchronous operation in progress." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Validate if backend can be linked to static site.": { + "$ref": "./examples/ValidateLinkedBackendForStaticSite.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends/{linkedBackendName}/validate": { + "post": { + "tags": [ + "StaticSites" + ], + "summary": "Validates that a backend can be linked to a static site build", + "operationId": "StaticSites_ValidateBackendForBuild", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "The stage site identifier", + "required": true, + "type": "string" + }, + { + "name": "linkedBackendName", + "in": "path", + "description": "Name of the linked backend that should be retrieved", + "required": true, + "type": "string" + }, + { + "name": "staticSiteLinkedBackendEnvelope", + "in": "body", + "description": "A JSON representation of the linked backend request properties", + "required": true, + "schema": { + "$ref": "#/definitions/StaticSiteLinkedBackendARMResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No content" + }, + "202": { + "description": "Asynchronous operation in progress." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Validate if backend can be linked to static site build.": { + "$ref": "./examples/ValidateLinkedBackendForStaticSiteBuild.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Returns details of all backends linked to a static site", + "operationId": "StaticSites_GetLinkedBackends", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StaticSiteLinkedBackendsCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get details of the linked backends registered with a static site.": { + "$ref": "./examples/GetLinkedBackendsForStaticSite.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Returns details of all backends linked to a static site build", + "operationId": "StaticSites_GetLinkedBackendsForBuild", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "The stage site identifier", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StaticSiteLinkedBackendsCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get details of the linked backends registered with a static site build.": { + "$ref": "./examples/GetLinkedBackendsForStaticSiteBuild.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends/{linkedBackendName}": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Returns the details of a linked backend linked to a static site by name", + "operationId": "StaticSites_GetLinkedBackend", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site", + "required": true, + "type": "string" + }, + { + "name": "linkedBackendName", + "in": "path", + "description": "Name of the linked backend that should be retrieved", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StaticSiteLinkedBackendARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get details of the linked backend registered with a static site by name.": { + "$ref": "./examples/GetLinkedBackendForStaticSite.json" + } + } + }, + "put": { + "tags": [ + "StaticSites" + ], + "summary": "Link backend to a static site", + "operationId": "StaticSites_LinkBackend", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site", + "required": true, + "type": "string" + }, + { + "name": "linkedBackendName", + "in": "path", + "description": "Name of the backend to link to the static site", + "required": true, + "type": "string" + }, + { + "name": "staticSiteLinkedBackendEnvelope", + "in": "body", + "description": "A JSON representation of the linked backend request properties", + "required": true, + "schema": { + "$ref": "#/definitions/StaticSiteLinkedBackendARMResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StaticSiteLinkedBackendARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Link a backend to a static site": { + "$ref": "./examples/LinkBackendToStaticSite.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "StaticSites" + ], + "summary": "Unlink a backend from a static site", + "operationId": "StaticSites_UnlinkBackend", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site", + "required": true, + "type": "string" + }, + { + "name": "linkedBackendName", + "in": "path", + "description": "Name of the backend linked to the static site", + "required": true, + "type": "string" + }, + { + "name": "isCleaningAuthConfig", + "in": "query", + "description": "Decides if Easy Auth configuration will be removed from backend configuration", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No content" + }, + "200": { + "description": "OK." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Unlink a backend from a static site.": { + "$ref": "./examples/UnlinkBackendFromStaticSite.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends/{linkedBackendName}": { + "get": { + "tags": [ + "StaticSites" + ], + "summary": "Returns the details of a linked backend linked to a static site build by name", + "operationId": "StaticSites_GetLinkedBackendForBuild", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "The stage site identifier", + "required": true, + "type": "string" + }, + { + "name": "linkedBackendName", + "in": "path", + "description": "Name of the linked backend that should be retrieved", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StaticSiteLinkedBackendARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get details of the linked backend registered with a static site build by name.": { + "$ref": "./examples/GetLinkedBackendForStaticSiteBuild.json" + } + } + }, + "put": { + "tags": [ + "StaticSites" + ], + "summary": "Link backend to a static site build", + "operationId": "StaticSites_LinkBackendToBuild", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "The stage site identifier", + "required": true, + "type": "string" + }, + { + "name": "linkedBackendName", + "in": "path", + "description": "Name of the backend to link to the static site", + "required": true, + "type": "string" + }, + { + "name": "staticSiteLinkedBackendEnvelope", + "in": "body", + "description": "A JSON representation of the linked backend request properties", + "required": true, + "schema": { + "$ref": "#/definitions/StaticSiteLinkedBackendARMResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StaticSiteLinkedBackendARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Link a backend to a static site build": { + "$ref": "./examples/LinkBackendToStaticSiteBuild.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "StaticSites" + ], + "summary": "Unlink a backend from a static site build", + "operationId": "StaticSites_UnlinkBackendFromBuild", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the static site", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "The stage site identifier", + "required": true, + "type": "string" + }, + { + "name": "linkedBackendName", + "in": "path", + "description": "Name of the backend linked to the static site", + "required": true, + "type": "string" + }, + { + "name": "isCleaningAuthConfig", + "in": "query", + "description": "Decides if auth will be removed from backend configuration", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No content" + }, + "200": { + "description": "OK." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Unlink a backend from a static site build.": { + "$ref": "./examples/UnlinkBackendFromStaticSiteBuild.json" + } + } + } + } + }, + "definitions": { + "ArmPlan": { + "description": "The plan object in Azure Resource Manager, represents a marketplace plan.", + "type": "object", + "properties": { + "name": { + "description": "The name.", + "type": "string" + }, + "publisher": { + "description": "The publisher.", + "type": "string" + }, + "product": { + "description": "The product.", + "type": "string" + }, + "promotionCode": { + "description": "The promotion code.", + "type": "string" + }, + "version": { + "description": "Version of product.", + "type": "string" + } + } + }, + "RemotePrivateEndpointConnection": { + "description": "A remote private endpoint connection", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "RemotePrivateEndpointConnection resource specific properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true + }, + "privateEndpoint": { + "$ref": "./CommonDefinitions.json#/definitions/ArmIdWrapper", + "description": "PrivateEndpoint of a remote private endpoint connection" + }, + "privateLinkServiceConnectionState": { + "$ref": "./CommonDefinitions.json#/definitions/PrivateLinkConnectionState" + }, + "ipAddresses": { + "description": "Private IPAddresses mapped to the remote private endpoint", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "ResponseMessageEnvelope[RemotePrivateEndpointConnection]": { + "description": "Message envelope that contains the common Azure resource manager properties and the resource provider specific content.", + "type": "object", + "properties": { + "id": { + "description": "Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this\nvalue for GET requests only.\nFor example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}", + "type": "string" + }, + "name": { + "description": "Name of resource.", + "type": "string" + }, + "type": { + "description": "Type of resource e.g \"Microsoft.Web/sites\".", + "type": "string" + }, + "location": { + "description": "Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia.", + "type": "string" + }, + "tags": { + "description": "Tags associated with resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "plan": { + "$ref": "#/definitions/ArmPlan", + "description": "Azure resource manager plan." + }, + "properties": { + "$ref": "#/definitions/RemotePrivateEndpointConnection", + "description": "Resource specific properties." + }, + "sku": { + "$ref": "./CommonDefinitions.json#/definitions/SkuDescription", + "description": "SKU description of the resource." + }, + "status": { + "description": "Azure-AsyncOperation Status info.", + "type": "string" + }, + "error": { + "$ref": "./CommonDefinitions.json#/definitions/ErrorEntity", + "description": "Azure-AsyncOperation Error info." + }, + "identity": { + "$ref": "./CommonDefinitions.json#/definitions/ManagedServiceIdentity", + "description": "MSI resource" + }, + "zones": { + "description": "Logical Availability Zones the service is hosted in", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "StaticSite": { + "description": "A static site.", + "type": "object", + "properties": { + "defaultHostname": { + "description": "The default autogenerated hostname for the static site.", + "type": "string", + "readOnly": true + }, + "repositoryUrl": { + "description": "URL for the repository of the static site.", + "type": "string" + }, + "branch": { + "description": "The target branch in the repository.", + "type": "string" + }, + "customDomains": { + "description": "The custom domains associated with this static site.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "repositoryToken": { + "description": "A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.", + "type": "string" + }, + "buildProperties": { + "$ref": "#/definitions/StaticSiteBuildProperties", + "description": "Build properties to configure on the repository." + }, + "privateEndpointConnections": { + "description": "Private endpoint connections", + "type": "array", + "items": { + "$ref": "#/definitions/ResponseMessageEnvelope[RemotePrivateEndpointConnection]" + }, + "readOnly": true + }, + "stagingEnvironmentPolicy": { + "description": "State indicating whether staging environments are allowed or not allowed for a static web app.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "StagingEnvironmentPolicy", + "modelAsString": false + } + }, + "allowConfigFileUpdates": { + "description": "false if config file is locked for this static web app; otherwise, true.", + "type": "boolean" + }, + "templateProperties": { + "$ref": "#/definitions/StaticSiteTemplateOptions", + "description": "Template options for generating a new repository." + }, + "contentDistributionEndpoint": { + "description": "The content distribution endpoint for the static site.", + "type": "string", + "readOnly": true + }, + "keyVaultReferenceIdentity": { + "description": "Identity to use for Key Vault Reference authentication.", + "type": "string", + "readOnly": true + }, + "userProvidedFunctionApps": { + "description": "User provided function apps registered with the static site", + "type": "array", + "items": { + "$ref": "#/definitions/StaticSiteUserProvidedFunctionApp" + }, + "readOnly": true + }, + "linkedBackends": { + "description": "Backends linked to the static side", + "type": "array", + "items": { + "$ref": "#/definitions/StaticSiteLinkedBackend" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "provider": { + "description": "The provider that submitted the last deployment to the primary environment of the static site.", + "type": "string" + }, + "enterpriseGradeCdnStatus": { + "description": "State indicating the status of the enterprise grade CDN serving traffic to the static web app.", + "enum": [ + "Enabled", + "Enabling", + "Disabled", + "Disabling" + ], + "type": "string", + "x-ms-enum": { + "name": "EnterpriseGradeCdnStatus", + "modelAsString": true + } + }, + "publicNetworkAccess": { + "description": "State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string.", + "type": "string" + }, + "databaseConnections": { + "description": "Database connections for the static site", + "type": "array", + "items": { + "$ref": "#/definitions/DatabaseConnectionOverview" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + } + } + }, + "StaticSiteARMResource": { + "description": "Static Site ARM resource.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StaticSite", + "description": "Core resource properties", + "type": "object", + "x-ms-client-flatten": true + }, + "sku": { + "$ref": "./CommonDefinitions.json#/definitions/SkuDescription" + }, + "identity": { + "$ref": "./CommonDefinitions.json#/definitions/ManagedServiceIdentity" + } + } + }, + "StaticSiteBasicAuthPropertiesARMResource": { + "description": "Static site basic auth properties ARM resource.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "StaticSiteBasicAuthPropertiesARMResource resource specific properties", + "required": [ + "applicableEnvironmentsMode" + ], + "type": "object", + "properties": { + "password": { + "description": "The password for basic auth.", + "type": "string", + "x-ms-secret": true + }, + "secretUrl": { + "description": "Url to the secret in Key Vault.", + "type": "string" + }, + "applicableEnvironmentsMode": { + "description": "State indicating if basic auth is enabled and for what environments it is active.", + "type": "string" + }, + "environments": { + "description": "The list of enabled environments for Basic Auth if ApplicableEnvironmentsMode is set to SpecifiedEnvironments.", + "type": "array", + "items": { + "type": "string" + } + }, + "secretState": { + "description": "State indicating if basic auth has a secret and what type it is.", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "StaticSiteBasicAuthPropertiesCollection": { + "description": "Collection of static site basic auth.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/StaticSiteBasicAuthPropertiesARMResource" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "StaticSiteBuildARMResource": { + "description": "Static Site Build ARM resource.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "StaticSiteBuildARMResource resource specific properties", + "type": "object", + "properties": { + "buildId": { + "description": "An identifier for the static site build.", + "type": "string", + "readOnly": true + }, + "sourceBranch": { + "description": "The source branch.", + "type": "string", + "readOnly": true + }, + "pullRequestTitle": { + "description": "The title of a pull request that a static site build is related to.", + "type": "string", + "readOnly": true + }, + "hostname": { + "description": "The hostname for a static site build.", + "type": "string", + "readOnly": true + }, + "createdTimeUtc": { + "format": "date-time", + "description": "When this build was created.", + "type": "string", + "readOnly": true + }, + "lastUpdatedOn": { + "format": "date-time", + "description": "When this build was updated.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the static site build.", + "enum": [ + "WaitingForDeployment", + "Uploading", + "Deploying", + "Ready", + "Failed", + "Deleting", + "Detached" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BuildStatus", + "modelAsString": true + } + }, + "userProvidedFunctionApps": { + "description": "User provided function apps registered with the static site build", + "type": "array", + "items": { + "$ref": "#/definitions/StaticSiteUserProvidedFunctionApp" + }, + "readOnly": true + }, + "linkedBackends": { + "description": "Backends linked to the static side build", + "type": "array", + "items": { + "$ref": "#/definitions/StaticSiteLinkedBackend" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "databaseConnections": { + "description": "Database connections for the static site build", + "type": "array", + "items": { + "$ref": "#/definitions/DatabaseConnectionOverview" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "StaticSiteBuildCollection": { + "description": "Collection of static site builds.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/StaticSiteBuildARMResource" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "StaticSiteBuildProperties": { + "description": "Build properties for the static site.", + "type": "object", + "properties": { + "appLocation": { + "description": "The path to the app code within the repository.", + "type": "string" + }, + "apiLocation": { + "description": "The path to the api code within the repository.", + "type": "string" + }, + "appArtifactLocation": { + "description": "Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation)", + "type": "string" + }, + "outputLocation": { + "description": "The output path of the app after building.", + "type": "string" + }, + "appBuildCommand": { + "description": "A custom command to run during deployment of the static content application.", + "type": "string" + }, + "apiBuildCommand": { + "description": "A custom command to run during deployment of the Azure Functions API application.", + "type": "string" + }, + "skipGithubActionWorkflowGeneration": { + "description": "Skip Github Action workflow generation.", + "type": "boolean" + }, + "githubActionSecretNameOverride": { + "description": "Github Action secret name override.", + "type": "string" + } + } + }, + "StaticSiteCollection": { + "description": "Collection of static sites.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/StaticSiteARMResource" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "StaticSiteCustomDomainOverviewARMResource": { + "description": "Static Site Custom Domain Overview ARM resource.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "StaticSiteCustomDomainOverviewARMResource resource specific properties", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name for the static site custom domain.", + "type": "string", + "readOnly": true + }, + "createdOn": { + "format": "date-time", + "description": "The date and time on which the custom domain was created for the static site.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the custom domain", + "enum": [ + "RetrievingValidationToken", + "Validating", + "Adding", + "Ready", + "Failed", + "Deleting", + "Unhealthy" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "CustomDomainStatus", + "modelAsString": true + } + }, + "validationToken": { + "description": "The TXT record validation token", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "StaticSiteCustomDomainOverviewCollection": { + "description": "Collection of static site custom domains.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/StaticSiteCustomDomainOverviewARMResource" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "StaticSiteCustomDomainRequestPropertiesARMResource": { + "description": "Static Site Custom Domain Request Properties ARM resource.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "StaticSiteCustomDomainRequestPropertiesARMResource resource specific properties", + "type": "object", + "properties": { + "validationMethod": { + "description": "Validation method for adding a custom domain", + "default": "cname-delegation", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "StaticSiteDatabaseConnectionConfigurationFileOverview": { + "description": "A database connection configuration file", + "type": "object", + "properties": { + "fileName": { + "description": "The name of the configuration file.", + "type": "string", + "readOnly": true + }, + "contents": { + "description": "The Base64 encoding of the file contents.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of configuration file.", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + }, + "DatabaseConnection": { + "description": "Static Site Database Connection resource.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "DatabaseConnection resource specific properties", + "type": "object", + "required": [ + "resourceId", + "region" + ], + "properties": { + "resourceId": { + "description": "The resource id of the database.", + "type": "string" + }, + "connectionIdentity": { + "description": "If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource.", + "type": "string" + }, + "connectionString": { + "description": "The connection string to use to connect to the database.", + "type": "string", + "x-ms-secret": true + }, + "region": { + "description": "The region of the database resource.", + "type": "string" + }, + "configurationFiles": { + "description": "A list of configuration files associated with this database connection.", + "type": "array", + "items": { + "$ref": "#/definitions/StaticSiteDatabaseConnectionConfigurationFileOverview" + }, + "x-ms-identifiers": [ + "fileName" + ], + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "DatabaseConnectionOverview": { + "description": "Static Site Database Connection overview.", + "type": "object", + "properties": { + "resourceId": { + "description": "The resource id of the database.", + "type": "string", + "readOnly": true + }, + "connectionIdentity": { + "description": "If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource.", + "type": "string", + "readOnly": true + }, + "region": { + "description": "The region of the database resource.", + "type": "string", + "readOnly": true + }, + "configurationFiles": { + "description": "A list of configuration files associated with this database connection.", + "type": "array", + "items": { + "$ref": "#/definitions/StaticSiteDatabaseConnectionConfigurationFileOverview" + }, + "x-ms-identifiers": [ + "fileName" + ], + "readOnly": true + }, + "name": { + "description": "If present, the name of this database connection resource.", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + }, + "DatabaseConnectionCollection": { + "description": "Collection of static site database connections.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/DatabaseConnection" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "DatabaseConnectionPatchRequest": { + "description": "Static Site Database Connection Request Properties resource when patching", + "type": "object", + "properties": { + "properties": { + "description": "DatabaseConnectionPatchRequest resource specific properties", + "type": "object", + "properties": { + "resourceId": { + "description": "The resource id of the database.", + "type": "string" + }, + "connectionIdentity": { + "description": "If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource.", + "type": "string" + }, + "connectionString": { + "description": "The connection string to use to connect to the database.", + "type": "string", + "x-ms-secret": true + }, + "region": { + "description": "The region of the database resource.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "StaticSiteFunctionOverviewARMResource": { + "description": "Static Site Function Overview ARM resource.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "StaticSiteFunctionOverviewARMResource resource specific properties", + "type": "object", + "properties": { + "functionName": { + "description": "The name for the function", + "type": "string", + "readOnly": true + }, + "triggerType": { + "description": "The trigger type of the function", + "enum": [ + "HttpTrigger", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TriggerTypes", + "modelAsString": true + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "StaticSiteFunctionOverviewCollection": { + "description": "Collection of static site functions.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/StaticSiteFunctionOverviewARMResource" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "StaticSitePatchResource": { + "description": "ARM resource for a static site when patching", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StaticSite", + "description": "Core resource properties", + "type": "object", + "x-ms-client-flatten": true + } + } + }, + "StaticSiteResetPropertiesARMResource": { + "description": "Static Site Reset Properties ARM resource.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "StaticSiteResetPropertiesARMResource resource specific properties", + "type": "object", + "properties": { + "repositoryToken": { + "description": "The token which proves admin privileges to the repository.", + "type": "string" + }, + "shouldUpdateRepository": { + "description": "Determines whether the repository should be updated with the new properties.", + "type": "boolean" + } + }, + "x-ms-client-flatten": true + } + } + }, + "StaticSiteTemplateOptions": { + "description": "Template Options for the static site.", + "type": "object", + "properties": { + "templateRepositoryUrl": { + "description": "URL of the template repository. The newly generated repository will be based on this one.", + "type": "string" + }, + "owner": { + "description": "Owner of the newly generated repository.", + "type": "string" + }, + "repositoryName": { + "description": "Name of the newly generated repository.", + "type": "string" + }, + "description": { + "description": "Description of the newly generated repository.", + "type": "string" + }, + "isPrivate": { + "description": "Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public).", + "type": "boolean" + } + } + }, + "StaticSiteUserARMResource": { + "description": "Static Site User ARM resource.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "StaticSiteUserARMResource resource specific properties", + "type": "object", + "properties": { + "provider": { + "description": "The identity provider for the static site user.", + "type": "string", + "readOnly": true + }, + "userId": { + "description": "The user id for the static site user.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name for the static site user.", + "type": "string", + "readOnly": true + }, + "roles": { + "description": "The roles for the static site user, in free-form string format", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "StaticSiteUserCollection": { + "description": "Collection of static site custom users.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/StaticSiteUserARMResource" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "StaticSiteUserInvitationRequestResource": { + "description": "Static sites user roles invitation resource.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "StaticSiteUserInvitationRequestResource resource specific properties", + "type": "object", + "properties": { + "domain": { + "description": "The domain name for the static site custom domain.", + "type": "string" + }, + "provider": { + "description": "The identity provider for the static site user.", + "type": "string" + }, + "userDetails": { + "description": "The user id for the static site user.", + "type": "string" + }, + "roles": { + "description": "The roles for the static site user, in free-form string format", + "type": "string" + }, + "numHoursToExpiration": { + "format": "int32", + "description": "The number of hours the sas token stays valid", + "type": "integer" + } + }, + "x-ms-client-flatten": true + } + } + }, + "StaticSiteUserInvitationResponseResource": { + "description": "Static sites user roles invitation link resource.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "StaticSiteUserInvitationResponseResource resource specific properties", + "type": "object", + "properties": { + "expiresOn": { + "format": "date-time", + "description": "The expiration time of the invitation", + "type": "string", + "readOnly": true + }, + "invitationUrl": { + "description": "The url for the invitation link", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "StaticSiteUserProvidedFunctionApp": { + "description": "A static site user provided function.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "StaticSiteUserProvidedFunctionApp resource specific properties", + "type": "object", + "properties": { + "functionAppResourceId": { + "description": "The resource id of the function app registered with the static site", + "type": "string" + }, + "functionAppRegion": { + "description": "The region of the function app registered with the static site", + "type": "string" + }, + "createdOn": { + "format": "date-time", + "description": "The date and time on which the function app was registered with the static site.", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "StaticSiteUserProvidedFunctionAppARMResource": { + "description": "Static Site User Provided Function App ARM resource.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "StaticSiteUserProvidedFunctionAppARMResource resource specific properties", + "type": "object", + "properties": { + "functionAppResourceId": { + "description": "The resource id of the function app registered with the static site", + "type": "string" + }, + "functionAppRegion": { + "description": "The region of the function app registered with the static site", + "type": "string" + }, + "createdOn": { + "format": "date-time", + "description": "The date and time on which the function app was registered with the static site.", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "StaticSiteUserProvidedFunctionAppsCollection": { + "description": "Collection of static site user provided function apps.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/StaticSiteUserProvidedFunctionAppARMResource" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "StaticSiteZipDeployment": { + "description": "A static site zip deployment.", + "type": "object", + "properties": { + "appZipUrl": { + "description": "URL for the zipped app content", + "type": "string" + }, + "apiZipUrl": { + "description": "URL for the zipped api content", + "type": "string" + }, + "deploymentTitle": { + "description": "A title to label the deployment", + "type": "string" + }, + "provider": { + "description": "The provider submitting this deployment", + "type": "string" + }, + "functionLanguage": { + "description": "The language of the api content, if it exists", + "type": "string" + } + } + }, + "StaticSiteZipDeploymentARMResource": { + "description": "Static site zip deployment ARM resource.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StaticSiteZipDeployment", + "description": "Core resource properties", + "type": "object", + "x-ms-client-flatten": true + } + } + }, + "StaticSitesWorkflowPreview": { + "description": "Preview for the Static Site Workflow to be generated", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "StaticSitesWorkflowPreview resource specific properties", + "type": "object", + "properties": { + "path": { + "description": "The path for the workflow file to be generated", + "type": "string", + "readOnly": true + }, + "contents": { + "description": "The contents for the workflow file to be generated", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "StaticSitesWorkflowPreviewRequest": { + "description": "Request entity for previewing the Static Site workflow", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "StaticSitesWorkflowPreviewRequest resource specific properties", + "type": "object", + "properties": { + "repositoryUrl": { + "description": "URL for the repository of the static site.", + "type": "string" + }, + "branch": { + "description": "The target branch in the repository.", + "type": "string" + }, + "buildProperties": { + "$ref": "#/definitions/StaticSiteBuildProperties", + "description": "Build properties to configure on the repository." + } + }, + "x-ms-client-flatten": true + } + } + }, + "StringList": { + "description": "String list resource.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "List of string resources.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "StaticSiteLinkedBackendARMResource": { + "description": "Static Site Linked Backend ARM resource.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "StaticSiteLinkedBackendARMResource resource specific properties", + "type": "object", + "properties": { + "backendResourceId": { + "description": "The resource id of the backend linked to the static site", + "type": "string" + }, + "region": { + "description": "The region of the backend linked to the static site", + "type": "string" + }, + "createdOn": { + "format": "date-time", + "description": "The date and time on which the backend was linked to the static site.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the linking process.", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "StaticSiteLinkedBackend": { + "description": "Static Site Linked Backend ARM resource.", + "type": "object", + "properties": { + "backendResourceId": { + "description": "The resource id of the backend linked to the static site", + "type": "string" + }, + "region": { + "description": "The region of the backend linked to the static site", + "type": "string" + }, + "createdOn": { + "format": "date-time", + "description": "The date and time on which the backend was linked to the static site.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the linking process.", + "type": "string", + "readOnly": true + } + } + }, + "StaticSiteLinkedBackendsCollection": { + "description": "Collection of static site linked backends.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/StaticSiteLinkedBackendARMResource" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group to which the resource belongs.", + "required": true, + "type": "string", + "maxLength": 90, + "minLength": 1, + "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$", + "x-ms-parameter-location": "method" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API Version", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "environmentNameParameter": { + "name": "environmentName", + "in": "path", + "description": "The stage site identifier.", + "required": true, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string", + "x-ms-parameter-location": "method" + }, + "databaseConnectionNameParameter": { + "name": "databaseConnectionName", + "in": "path", + "description": "Name of the database connection.", + "required": true, + "pattern": "^[a-zA-Z0-9]+$", + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/WebApps.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/WebApps.json new file mode 100644 index 000000000000..1d7342d3af36 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/WebApps.json @@ -0,0 +1,31534 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "WebApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/sites": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get all apps for a subscription.", + "description": "Description for Get all apps for a subscription.", + "operationId": "WebApps_List", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Web apps for subscription": { + "$ref": "./examples/ListWebApps.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets all web, mobile, and API apps in the specified resource group.", + "description": "Description for Gets all web, mobile, and API apps in the specified resource group.", + "operationId": "WebApps_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "includeSlots", + "in": "query", + "description": "Specify true to include deployment slots in results. The default is false, which only gives you the production slot of all apps.", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Web Apps by Resource group": { + "$ref": "./examples/ListWebAppsByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the details of a web, mobile, or API app.", + "description": "Description for Gets the details of a web, mobile, or API app.", + "operationId": "WebApps_Get", + "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": "./CommonDefinitions.json#/definitions/Site" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Web App": { + "$ref": "./examples/GetWebApp.json" + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", + "description": "Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", + "operationId": "WebApps_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.", + "required": true, + "type": "string" + }, + { + "name": "siteEnvelope", + "in": "body", + "description": "A JSON representation of the app properties. See example.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Site" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Site" + } + }, + "202": { + "description": "Asynchronous operation in progress.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Site" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update web app": { + "$ref": "./examples/CreateOrUpdateWebApp.json" + }, + "Create or Update Flex Consumption function app": { + "$ref": "./examples/CreateOrUpdateFunctionAppFlexConsumption.json" + }, + "Create or Update Flex Consumption function app with details": { + "$ref": "./examples/CreateOrUpdateFunctionAppFlexConsumptionWithDetails.json" + }, + "Clone web app": { + "$ref": "./examples/CloneWebApp.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a web, mobile, or API app, or one of the deployment slots.", + "description": "Description for Deletes a web, mobile, or API app, or one of the deployment slots.", + "operationId": "WebApps_Delete", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app to delete.", + "required": true, + "type": "string" + }, + { + "name": "deleteMetrics", + "in": "query", + "description": "If true, web app metrics are also deleted.", + "type": "boolean" + }, + { + "name": "deleteEmptyServerFarm", + "in": "query", + "description": "Specify false if you want to keep empty App Service plan. By default, empty App Service plan is deleted.", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted web app." + }, + "204": { + "description": "Successfully deleted web app." + }, + "404": { + "description": "Web app not found.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Web app": { + "$ref": "./examples/DeleteWebApp.json" + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", + "description": "Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", + "operationId": "WebApps_Update", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.", + "required": true, + "type": "string" + }, + { + "name": "siteEnvelope", + "in": "body", + "description": "A JSON representation of the app properties. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SitePatchResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Site" + } + }, + "202": { + "description": "Asynchronous operation in progress.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Site" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Update web app": { + "$ref": "./examples/UpdateWebApp.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/analyzeCustomHostname": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Analyze a custom hostname.", + "description": "Description for Analyze a custom hostname.", + "operationId": "WebApps_AnalyzeCustomHostname", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "hostName", + "in": "query", + "description": "Custom hostname.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CustomHostnameAnalysisResult" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Analyze custom hostname for webapp.": { + "$ref": "./examples/AnalyzeCustomHostName.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/applySlotConfig": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Applies the configuration settings from the target slot onto the current slot.", + "description": "Description for Applies the configuration settings from the target slot onto the current slot.", + "operationId": "WebApps_ApplySlotConfigToProduction", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slotSwapEntity", + "in": "body", + "description": "JSON object that contains the target slot name. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/CsmSlotEntity" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Apply web app slot config": { + "$ref": "./examples/ApplySlotConfig.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backup": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Creates a backup of an app.", + "description": "Description for Creates a backup of an app.", + "operationId": "WebApps_Backup", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Backup configuration. You can use the JSON response from the POST action as input here.", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupItem" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Backup web app": { + "$ref": "./examples/BackupWebApp.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets existing backups of an app.", + "description": "Description for Gets existing backups of an app.", + "operationId": "WebApps_ListBackups", + "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/BackupItemCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List web app backups": { + "$ref": "./examples/ListWebAppBackups.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a backup of an app by its ID.", + "description": "Description for Gets a backup of an app by its ID.", + "operationId": "WebApps_GetBackupStatus", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "backupId", + "in": "path", + "description": "ID of the backup.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupItem" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get web app backup": { + "$ref": "./examples/GetWebAppBackup.json" + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a backup of an app by its ID.", + "description": "Description for Deletes a backup of an app by its ID.", + "operationId": "WebApps_DeleteBackup", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "backupId", + "in": "path", + "description": "ID of the backup.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted web app backup item." + }, + "404": { + "description": "Web app backup item does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete web app backup": { + "$ref": "./examples/DeleteWebAppBackup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/list": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.", + "description": "Description for Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.", + "operationId": "WebApps_ListBackupStatusSecrets", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "backupId", + "in": "path", + "description": "ID of backup.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Information on backup request.", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupItem" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get web app backup with secrets": { + "$ref": "./examples/GetWebAppBackupWithSecrets.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/restore": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Restores a specific backup to another app (or deployment slot, if specified).", + "description": "Description for Restores a specific backup to another app (or deployment slot, if specified).", + "operationId": "WebApps_Restore", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "backupId", + "in": "path", + "description": "ID of the backup.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Information on restore request .", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Restore operation started." + }, + "200": { + "description": "Restore operation started." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Restore web app from backup": { + "$ref": "./examples/RestoreWebAppBackup.json" + } + }, + "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_ListBasicPublishingCredentialsPolicies", + "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/PublishingCredentialsPoliciesCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Publishing Credentials Policies": { + "$ref": "./examples/ListPublishingCredentialsPolicies.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/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": [ + "WebApps" + ], + "summary": "List the configurations of an app", + "description": "Description for List the configurations of an app", + "operationId": "WebApps_ListConfigurations", + "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/SiteConfigResourceCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List web app configurations": { + "$ref": "./examples/ListWebAppConfigurations.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings": { + "put": { + "tags": [ + "WebApps" + ], + "summary": "Replaces the application settings of an app.", + "description": "Description for Replaces the application settings of an app.", + "operationId": "WebApps_UpdateApplicationSettings", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "appSettings", + "in": "body", + "description": "Application settings of the app.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Update App Settings": { + "$ref": "./examples/UpdateAppSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings/list": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets the application settings of an app.", + "description": "Description for Gets the application settings of an app.", + "operationId": "WebApps_ListApplicationSettings", + "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": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List App Settings": { + "$ref": "./examples/ListAppSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings": { + "put": { + "tags": [ + "WebApps" + ], + "summary": "Updates the Authentication / Authorization settings associated with web app.", + "description": "Description for Updates the Authentication / Authorization settings associated with web app.", + "operationId": "WebApps_UpdateAuthSettings", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "siteAuthSettings", + "in": "body", + "description": "Auth settings associated with web app.", + "required": true, + "schema": { + "$ref": "#/definitions/SiteAuthSettings" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteAuthSettings" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Auth Settings": { + "$ref": "./examples/UpdateAuthSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets the Authentication/Authorization settings of an app.", + "description": "Description for Gets the Authentication/Authorization settings of an app.", + "operationId": "WebApps_GetAuthSettings", + "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/SiteAuthSettings" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Auth Settings": { + "$ref": "./examples/ListAuthSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets site's Authentication / Authorization settings for apps via the V2 format", + "description": "Description for Gets site's Authentication / Authorization settings for apps via the V2 format", + "operationId": "WebApps_GetAuthSettingsV2WithoutSecrets", + "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/SiteAuthSettingsV2" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Auth Settings without Secrets": { + "$ref": "./examples/GetAuthSettingsV2WithoutSecrets.json" + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Updates site's Authentication / Authorization settings for apps via the V2 format", + "description": "Description for Updates site's Authentication / Authorization settings for apps via the V2 format", + "operationId": "WebApps_UpdateAuthSettingsV2", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "siteAuthSettingsV2", + "in": "body", + "description": "Auth settings associated with web app.", + "required": true, + "schema": { + "$ref": "#/definitions/SiteAuthSettingsV2" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteAuthSettingsV2" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Auth Settings V2": { + "$ref": "./examples/UpdateAuthSettingsV2.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2/list": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets site's Authentication / Authorization settings for apps via the V2 format", + "description": "Description for Gets site's Authentication / Authorization settings for apps via the V2 format", + "operationId": "WebApps_GetAuthSettingsV2", + "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/SiteAuthSettingsV2" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Auth Settings V2": { + "$ref": "./examples/ListAuthSettingsV2.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/azurestorageaccounts": { + "put": { + "tags": [ + "WebApps" + ], + "summary": "Updates the Azure storage account configurations of an app.", + "description": "Description for Updates the Azure storage account configurations of an app.", + "operationId": "WebApps_UpdateAzureStorageAccounts", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "azureStorageAccounts", + "in": "body", + "description": "Azure storage accounts of the app.", + "required": true, + "schema": { + "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Azure Storage Accounts": { + "$ref": "./examples/UpdateAzureStorageAccounts.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/azurestorageaccounts/list": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets the Azure storage account configurations of an app.", + "description": "Description for Gets the Azure storage account configurations of an app.", + "operationId": "WebApps_ListAzureStorageAccounts", + "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/AzureStoragePropertyDictionaryResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup": { + "put": { + "tags": [ + "WebApps" + ], + "summary": "Updates the backup configuration of an app.", + "description": "Description for Updates the backup configuration of an app.", + "operationId": "WebApps_UpdateBackupConfiguration", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Edited backup configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupRequest" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes the backup configuration of an app.", + "description": "Description for Deletes the backup configuration of an app.", + "operationId": "WebApps_DeleteBackupConfiguration", + "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": "Successfully deleted backup configuration." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup/list": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets the backup configuration of an app.", + "description": "Description for Gets the backup configuration of an app.", + "operationId": "WebApps_GetBackupConfiguration", + "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/BackupRequest" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/appsettings": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the config reference app settings and status of an app", + "description": "Description for Gets the config reference app settings and status of an app", + "operationId": "WebApps_GetAppSettingsKeyVaultReferences", + "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/ApiKVReferenceCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Azure Key Vault references for app settings": { + "$ref": "./examples/GetKeyVaultReferencesForAppSettings.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/appsettings/{appSettingKey}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the config reference and status of an app", + "description": "Description for Gets the config reference and status of an app", + "operationId": "WebApps_GetAppSettingKeyVaultReference", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "appSettingKey", + "in": "path", + "description": "App Setting key name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApiKVReference" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Azure Key Vault app setting reference": { + "$ref": "./examples/GetKeyVaultReferencesForAppSetting.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/connectionstrings": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the config reference app settings and status of an app", + "description": "Description for Gets the config reference app settings and status of an app", + "operationId": "WebApps_GetSiteConnectionStringKeyVaultReferences", + "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/ApiKVReferenceCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/connectionstrings/{connectionStringKey}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the config reference and status of an app", + "description": "Description for Gets the config reference and status of an app", + "operationId": "WebApps_GetSiteConnectionStringKeyVaultReference", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "connectionStringKey", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApiKVReference" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings": { + "put": { + "tags": [ + "WebApps" + ], + "summary": "Replaces the connection strings of an app.", + "description": "Description for Replaces the connection strings of an app.", + "operationId": "WebApps_UpdateConnectionStrings", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "connectionStrings", + "in": "body", + "description": "Connection strings of the app or deployment slot. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionStringDictionary" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectionStringDictionary" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings/list": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets the connection strings of an app.", + "description": "Description for Gets the connection strings of an app.", + "operationId": "WebApps_ListConnectionStrings", + "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/ConnectionStringDictionary" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the logging configuration of an app.", + "description": "Description for Gets the logging configuration of an app.", + "operationId": "WebApps_GetDiagnosticLogsConfiguration", + "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/SiteLogsConfig" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Updates the logging configuration of an app.", + "description": "Description for Updates the logging configuration of an app.", + "operationId": "WebApps_UpdateDiagnosticLogsConfig", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "siteLogsConfig", + "in": "body", + "description": "A SiteLogsConfig JSON object that contains the logging configuration to change in the \"properties\" property.", + "required": true, + "schema": { + "$ref": "#/definitions/SiteLogsConfig" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteLogsConfig" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata": { + "put": { + "tags": [ + "WebApps" + ], + "summary": "Replaces the metadata of an app.", + "description": "Description for Replaces the metadata of an app.", + "operationId": "WebApps_UpdateMetadata", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "metadata", + "in": "body", + "description": "Edited metadata of the app or deployment slot. See example.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata/list": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets the metadata of an app.", + "description": "Description for Gets the metadata of an app.", + "operationId": "WebApps_ListMetadata", + "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": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/publishingcredentials/list": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets the Git/FTP publishing credentials of an app.", + "description": "Description for Gets the Git/FTP publishing credentials of an app.", + "operationId": "WebApps_ListPublishingCredentials", + "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": "./CommonDefinitions.json#/definitions/User" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings": { + "put": { + "tags": [ + "WebApps" + ], + "summary": "Updates the Push settings associated with web app.", + "description": "Description for Updates the Push settings associated with web app.", + "operationId": "WebApps_UpdateSitePushSettings", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "pushSettings", + "in": "body", + "description": "Push settings associated with web app.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PushSettings" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PushSettings" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings/list": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets the Push settings associated with web app.", + "description": "Description for Gets the Push settings associated with web app.", + "operationId": "WebApps_ListSitePushSettings", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PushSettings" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the names of app settings and connection strings that stick to the slot (not swapped).", + "description": "Description for Gets the names of app settings and connection strings that stick to the slot (not swapped).", + "operationId": "WebApps_ListSlotConfigurationNames", + "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/SlotConfigNamesResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Updates the names of application settings and connection string that remain with the slot during swap operation.", + "description": "Description for Updates the names of application settings and connection string that remain with the slot during swap operation.", + "operationId": "WebApps_UpdateSlotConfigurationNames", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slotConfigNames", + "in": "body", + "description": "Names of application settings and connection strings. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SlotConfigNamesResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SlotConfigNamesResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.", + "description": "Description for Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.", + "operationId": "WebApps_GetConfiguration", + "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/SiteConfigResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Site Config": { + "$ref": "./examples/GetSiteConfig.json" + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Updates the configuration of an app.", + "description": "Description for Updates the configuration of an app.", + "operationId": "WebApps_CreateOrUpdateConfiguration", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "siteConfig", + "in": "body", + "description": "JSON representation of a SiteConfig object. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SiteConfigResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteConfigResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Site Config": { + "$ref": "./examples/UpdateSiteConfig.json" + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Updates the configuration of an app.", + "description": "Description for Updates the configuration of an app.", + "operationId": "WebApps_UpdateConfiguration", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "siteConfig", + "in": "body", + "description": "JSON representation of a SiteConfig object. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SiteConfigResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteConfigResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.", + "description": "Description for Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.", + "operationId": "WebApps_ListConfigurationSnapshotInfo", + "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/SiteConfigurationSnapshotInfoCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a snapshot of the configuration of an app at a previous point in time.", + "description": "Description for Gets a snapshot of the configuration of an app at a previous point in time.", + "operationId": "WebApps_GetConfigurationSnapshot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "snapshotId", + "in": "path", + "description": "The ID of the snapshot to read.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteConfigResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId}/recover": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Reverts the configuration of an app to a previous snapshot.", + "description": "Description for Reverts the configuration of an app to a previous snapshot.", + "operationId": "WebApps_RecoverSiteConfigurationSnapshot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "snapshotId", + "in": "path", + "description": "The ID of the snapshot to read.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/containerlogs": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets the last lines of docker logs for the given site", + "description": "Description for Gets the last lines of docker logs for the given site", + "operationId": "WebApps_GetWebSiteContainerLogs", + "produces": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "200": { + "description": "OK", + "schema": { + "type": "file" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/containerlogs/zip/download": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets the ZIP archived docker log files for the given site", + "description": "Description for Gets the ZIP archived docker log files for the given site", + "operationId": "WebApps_GetContainerLogsZip", + "produces": [ + "application/zip" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "200": { + "description": "OK", + "schema": { + "type": "file" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List continuous web jobs for an app, or a deployment slot.", + "description": "Description for List continuous web jobs for an app, or a deployment slot.", + "operationId": "WebApps_ListContinuousWebJobs", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContinuousWebJobCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a continuous web job by its ID for an app, or a deployment slot.", + "description": "Description for Gets a continuous web job by its ID for an app, or a deployment slot.", + "operationId": "WebApps_GetContinuousWebJob", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Found continuous web job.", + "schema": { + "$ref": "#/definitions/ContinuousWebJob" + } + }, + "404": { + "description": "Continuous web job does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Delete a continuous web job by its ID for an app, or a deployment slot.", + "description": "Description for Delete a continuous web job by its ID for an app, or a deployment slot.", + "operationId": "WebApps_DeleteContinuousWebJob", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted continuous web job." + }, + "204": { + "description": "Continuous web job does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}/start": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Start a continuous web job for an app, or a deployment slot.", + "description": "Description for Start a continuous web job for an app, or a deployment slot.", + "operationId": "WebApps_StartContinuousWebJob", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Found continuous web job." + }, + "404": { + "description": "Continuous web job does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}/stop": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Stop a continuous web job for an app, or a deployment slot.", + "description": "Description for Stop a continuous web job for an app, or a deployment slot.", + "operationId": "WebApps_StopContinuousWebJob", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Found continuous web job." + }, + "404": { + "description": "Continuous web job does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deploymentStatus": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List deployment statuses for an app (or deployment slot, if specified).", + "operationId": "WebApps_ListProductionSiteDeploymentStatuses", + "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/CsmDeploymentStatusCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Deployment Status": { + "$ref": "./examples/ListSiteDeploymentStatus.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deploymentStatus/{deploymentStatusId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the deployment status for an app (or deployment slot, if specified).", + "operationId": "WebApps_GetProductionSiteDeploymentStatus", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "deploymentStatusId", + "in": "path", + "description": "GUID of the deployment operation.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CsmDeploymentStatus" + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "$ref": "#/definitions/CsmDeploymentStatus" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Deployment Status": { + "$ref": "./examples/GetSiteDeploymentStatus.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List deployments for an app, or a deployment slot.", + "description": "Description for List deployments for an app, or a deployment slot.", + "operationId": "WebApps_ListDeployments", + "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/DeploymentCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get a deployment by its ID for an app, or a deployment slot.", + "description": "Description for Get a deployment by its ID for an app, or a deployment slot.", + "operationId": "WebApps_GetDeployment", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "Deployment ID.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Create a deployment for an app, or a deployment slot.", + "description": "Description for Create a deployment for an app, or a deployment slot.", + "operationId": "WebApps_CreateDeployment", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "ID of an existing deployment.", + "required": true, + "type": "string" + }, + { + "name": "deployment", + "in": "body", + "description": "Deployment details.", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Delete a deployment by its ID for an app, or a deployment slot.", + "description": "Description for Delete a deployment by its ID for an app, or a deployment slot.", + "operationId": "WebApps_DeleteDeployment", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "Deployment ID.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted deployment." + }, + "204": { + "description": "Deployment does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}/log": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List deployment log for specific deployment for an app, or a deployment slot.", + "description": "Description for List deployment log for specific deployment for an app, or a deployment slot.", + "operationId": "WebApps_ListDeploymentLog", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "The ID of a specific deployment. This is the value of the name property in the JSON response from \"GET /api/sites/{siteName}/deployments\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/discoverbackup": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.", + "description": "Description for Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.", + "operationId": "WebApps_DiscoverBackup", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestoreRequest" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Lists ownership identifiers for domain associated with web app.", + "description": "Description for Lists ownership identifiers for domain associated with web app.", + "operationId": "WebApps_ListDomainOwnershipIdentifiers", + "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": "./CommonDefinitions.json#/definitions/IdentifierCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get domain ownership identifier for web app.", + "description": "Description for Get domain ownership identifier for web app.", + "operationId": "WebApps_GetDomainOwnershipIdentifier", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "domainOwnershipIdentifierName", + "in": "path", + "description": "Name of domain ownership identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Identifier" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.", + "description": "Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.", + "operationId": "WebApps_CreateOrUpdateDomainOwnershipIdentifier", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "domainOwnershipIdentifierName", + "in": "path", + "description": "Name of domain ownership identifier.", + "required": true, + "type": "string" + }, + { + "name": "domainOwnershipIdentifier", + "in": "body", + "description": "A JSON representation of the domain ownership properties.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Identifier" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Identifier" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a domain ownership identifier for a web app.", + "description": "Description for Deletes a domain ownership identifier for a web app.", + "operationId": "WebApps_DeleteDomainOwnershipIdentifier", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "domainOwnershipIdentifierName", + "in": "path", + "description": "Name of domain ownership identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted domain ownership identifier." + }, + "204": { + "description": "Domain ownership identifier does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.", + "description": "Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.", + "operationId": "WebApps_UpdateDomainOwnershipIdentifier", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "domainOwnershipIdentifierName", + "in": "path", + "description": "Name of domain ownership identifier.", + "required": true, + "type": "string" + }, + { + "name": "domainOwnershipIdentifier", + "in": "body", + "description": "A JSON representation of the domain ownership properties.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Identifier" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Identifier" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get the status of the last MSDeploy operation.", + "description": "Description for Get the status of the last MSDeploy operation.", + "operationId": "WebApps_GetMSDeployStatus", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MSDeployStatus" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Invoke the MSDeploy web app extension.", + "description": "Description for Invoke the MSDeploy web app extension.", + "operationId": "WebApps_CreateMSDeployOperation", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "MSDeploy", + "in": "body", + "description": "Details of MSDeploy operation", + "required": true, + "schema": { + "$ref": "#/definitions/MSDeploy" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Deployment is scheduled.", + "schema": { + "$ref": "#/definitions/MSDeployStatus" + } + }, + "409": { + "description": "Another deployment is in progress.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy/log": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get the MSDeploy Log for the last MSDeploy operation.", + "description": "Description for Get the MSDeploy Log for the last MSDeploy operation.", + "operationId": "WebApps_GetMSDeployLog", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "MSDeploy log returned.", + "schema": { + "$ref": "#/definitions/MSDeployLog" + } + }, + "404": { + "description": "MSDeploy log not found.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/onedeploy": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Invoke onedeploy status API /api/deployments and gets the deployment status for the site", + "description": "Description for Invoke onedeploy status API /api/deployments and gets the deployment status for the site", + "operationId": "WebApps_GetOneDeployStatus", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Invoke the OneDeploy publish web app extension.", + "description": "Description for Invoke the OneDeploy publish web app extension.", + "operationId": "WebApps_CreateOneDeployOperation", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List the functions for a web site, or a deployment slot.", + "description": "Description for List the functions for a web site, or a deployment slot.", + "operationId": "WebApps_ListFunctions", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Function information returned.", + "schema": { + "$ref": "#/definitions/FunctionEnvelopeCollection" + } + }, + "404": { + "description": "Function with an ID of {functionName} is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/admin/token": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Fetch a short lived token that can be exchanged for a master key.", + "description": "Description for Fetch a short lived token that can be exchanged for a master key.", + "operationId": "WebApps_GetFunctionsAdminToken", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get function information by its ID for web site, or a deployment slot.", + "description": "Description for Get function information by its ID for web site, or a deployment slot.", + "operationId": "WebApps_GetFunction", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "functionName", + "in": "path", + "description": "Function name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Function information returned.", + "schema": { + "$ref": "#/definitions/FunctionEnvelope" + } + }, + "404": { + "description": "Function with a name of {functionName} does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Create function for web site, or a deployment slot.", + "description": "Description for Create function for web site, or a deployment slot.", + "operationId": "WebApps_CreateFunction", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "functionName", + "in": "path", + "description": "Function name.", + "required": true, + "type": "string" + }, + { + "name": "function_envelope", + "in": "body", + "description": "Function details.", + "required": true, + "schema": { + "$ref": "#/definitions/FunctionEnvelope" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Function created.", + "schema": { + "$ref": "#/definitions/FunctionEnvelope" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Delete a function for web site, or a deployment slot.", + "description": "Description for Delete a function for web site, or a deployment slot.", + "operationId": "WebApps_DeleteFunction", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "functionName", + "in": "path", + "description": "Function name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Function deleted." + }, + "404": { + "description": "Function does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/keys/{keyName}": { + "put": { + "tags": [ + "WebApps" + ], + "summary": "Add or update a function secret.", + "description": "Description for Add or update a function secret.", + "operationId": "WebApps_CreateOrUpdateFunctionSecret", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "functionName", + "in": "path", + "description": "The name of the function.", + "required": true, + "type": "string" + }, + { + "name": "keyName", + "in": "path", + "description": "The name of the key.", + "required": true, + "type": "string" + }, + { + "name": "key", + "in": "body", + "description": "The key to create or update", + "required": true, + "schema": { + "$ref": "#/definitions/KeyInfo" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Key was created.", + "schema": { + "$ref": "#/definitions/KeyInfo" + } + }, + "200": { + "description": "Key was updated.", + "schema": { + "$ref": "#/definitions/KeyInfo" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Delete a function secret.", + "description": "Description for Delete a function secret.", + "operationId": "WebApps_DeleteFunctionSecret", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "functionName", + "in": "path", + "description": "The name of the function.", + "required": true, + "type": "string" + }, + { + "name": "keyName", + "in": "path", + "description": "The name of the key.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "404": { + "description": "Key was not found.", + "x-ms-error-response": true + }, + "204": { + "description": "Key was deleted." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/listkeys": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Get function keys for a function in a web site, or a deployment slot.", + "description": "Description for Get function keys for a function in a web site, or a deployment slot.", + "operationId": "WebApps_ListFunctionKeys", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "functionName", + "in": "path", + "description": "Function name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Function keys returned.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/listsecrets": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Get function secrets for a function in a web site, or a deployment slot.", + "description": "Description for Get function secrets for a function in a web site, or a deployment slot.", + "operationId": "WebApps_ListFunctionSecrets", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "functionName", + "in": "path", + "description": "Function name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Function secrets returned.", + "schema": { + "$ref": "#/definitions/FunctionSecrets" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/listkeys": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Get host secrets for a function app.", + "description": "Description for Get host secrets for a function app.", + "operationId": "WebApps_ListHostKeys", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Host secrets returned.", + "schema": { + "$ref": "#/definitions/HostKeys" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/listsyncstatus": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "This is to allow calling via powershell and ARM template.", + "description": "Description for This is to allow calling via powershell and ARM template.", + "operationId": "WebApps_ListSyncStatus", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/sync": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Syncs function trigger metadata to the management database", + "description": "Description for Syncs function trigger metadata to the management database", + "operationId": "WebApps_SyncFunctions", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/{keyType}/{keyName}": { + "put": { + "tags": [ + "WebApps" + ], + "summary": "Add or update a host level secret.", + "description": "Description for Add or update a host level secret.", + "operationId": "WebApps_CreateOrUpdateHostSecret", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "keyType", + "in": "path", + "description": "The type of host key.", + "required": true, + "type": "string" + }, + { + "name": "keyName", + "in": "path", + "description": "The name of the key.", + "required": true, + "type": "string" + }, + { + "name": "key", + "in": "body", + "description": "The key to create or update", + "required": true, + "schema": { + "$ref": "#/definitions/KeyInfo" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Key was created.", + "schema": { + "$ref": "#/definitions/KeyInfo" + } + }, + "200": { + "description": "Key was updated.", + "schema": { + "$ref": "#/definitions/KeyInfo" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Delete a host level secret.", + "description": "Description for Delete a host level secret.", + "operationId": "WebApps_DeleteHostSecret", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "keyType", + "in": "path", + "description": "The type of host key.", + "required": true, + "type": "string" + }, + { + "name": "keyName", + "in": "path", + "description": "The name of the key.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "404": { + "description": "Key was not found.", + "x-ms-error-response": true + }, + "204": { + "description": "Key was deleted." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get hostname bindings for an app or a deployment slot.", + "description": "Description for Get hostname bindings for an app or a deployment slot.", + "operationId": "WebApps_ListHostNameBindings", + "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/HostNameBindingCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get the named hostname binding for an app (or deployment slot, if specified).", + "description": "Description for Get the named hostname binding for an app (or deployment slot, if specified).", + "operationId": "WebApps_GetHostNameBinding", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "hostName", + "in": "path", + "description": "Hostname in the hostname binding.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HostNameBinding" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Creates a hostname binding for an app.", + "description": "Description for Creates a hostname binding for an app.", + "operationId": "WebApps_CreateOrUpdateHostNameBinding", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "hostName", + "in": "path", + "description": "Hostname in the hostname binding.", + "required": true, + "type": "string" + }, + { + "name": "hostNameBinding", + "in": "body", + "description": "Binding details. This is the JSON representation of a HostNameBinding object.", + "required": true, + "schema": { + "$ref": "#/definitions/HostNameBinding" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HostNameBinding" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a hostname binding for an app.", + "description": "Description for Deletes a hostname binding for an app.", + "operationId": "WebApps_DeleteHostNameBinding", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "hostName", + "in": "path", + "description": "Hostname in the hostname binding.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted hostname binding." + }, + "204": { + "description": "Hostname binding does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Retrieves a specific Service Bus Hybrid Connection used by this Web App.", + "description": "Description for Retrieves a specific Service Bus Hybrid Connection used by this Web App.", + "operationId": "WebApps_GetHybridConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "namespaceName", + "in": "path", + "description": "The namespace for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "relayName", + "in": "path", + "description": "The relay name for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Creates a new Hybrid Connection using a Service Bus relay.", + "description": "Description for Creates a new Hybrid Connection using a Service Bus relay.", + "operationId": "WebApps_CreateOrUpdateHybridConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "namespaceName", + "in": "path", + "description": "The namespace for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "relayName", + "in": "path", + "description": "The relay name for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The details of the hybrid connection.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Removes a Hybrid Connection from this site.", + "description": "Description for Removes a Hybrid Connection from this site.", + "operationId": "WebApps_DeleteHybridConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "namespaceName", + "in": "path", + "description": "The namespace for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "relayName", + "in": "path", + "description": "The relay name for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted hybrid connection." + }, + "404": { + "description": "Hybrid connection does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Creates a new Hybrid Connection using a Service Bus relay.", + "description": "Description for Creates a new Hybrid Connection using a Service Bus relay.", + "operationId": "WebApps_UpdateHybridConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "namespaceName", + "in": "path", + "description": "The namespace for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "relayName", + "in": "path", + "description": "The relay name for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The details of the hybrid connection.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionRelays": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Retrieves all Service Bus Hybrid Connections used by this Web App.", + "description": "Description for Retrieves all Service Bus Hybrid Connections used by this Web App.", + "operationId": "WebApps_ListHybridConnections", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets hybrid connections configured for an app (or deployment slot, if specified).", + "description": "Description for Gets hybrid connections configured for an app (or deployment slot, if specified).", + "operationId": "WebApps_ListRelayServiceConnections", + "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/RelayServiceConnectionEntity" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a hybrid connection configuration by its name.", + "description": "Description for Gets a hybrid connection configuration by its name.", + "operationId": "WebApps_GetRelayServiceConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "entityName", + "in": "path", + "description": "Name of the hybrid connection.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).", + "description": "Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).", + "operationId": "WebApps_CreateOrUpdateRelayServiceConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "entityName", + "in": "path", + "description": "Name of the hybrid connection configuration.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "Details of the hybrid connection configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a relay service connection by its name.", + "description": "Description for Deletes a relay service connection by its name.", + "operationId": "WebApps_DeleteRelayServiceConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "entityName", + "in": "path", + "description": "Name of the hybrid connection configuration.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted relay service connection." + }, + "404": { + "description": "Relay service connection does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).", + "description": "Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).", + "operationId": "WebApps_UpdateRelayServiceConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "entityName", + "in": "path", + "description": "Name of the hybrid connection configuration.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "Details of the hybrid connection configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets all scale-out instances of an app.", + "description": "Description for Gets all scale-out instances of an app.", + "operationId": "WebApps_ListInstanceIdentifiers", + "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/WebAppInstanceStatusCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets all scale-out instances of an app.", + "description": "Description for Gets all scale-out instances of an app.", + "operationId": "WebApps_GetInstanceInfo", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebSiteInstanceStatus" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get site instance info": { + "$ref": "./examples/GetSiteInstanceInfo.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get the status of the last MSDeploy operation.", + "description": "Description for Get the status of the last MSDeploy operation.", + "operationId": "WebApps_GetInstanceMsDeployStatus", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of web app instance.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MSDeployStatus" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Invoke the MSDeploy web app extension.", + "description": "Description for Invoke the MSDeploy web app extension.", + "operationId": "WebApps_CreateInstanceMSDeployOperation", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of web app instance.", + "required": true, + "type": "string" + }, + { + "name": "MSDeploy", + "in": "body", + "description": "Details of MSDeploy operation", + "required": true, + "schema": { + "$ref": "#/definitions/MSDeploy" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Deployment is scheduled.", + "schema": { + "$ref": "#/definitions/MSDeployStatus" + } + }, + "409": { + "description": "Another deployment is in progress.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy/log": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get the MSDeploy Log for the last MSDeploy operation.", + "description": "Description for Get the MSDeploy Log for the last MSDeploy operation.", + "operationId": "WebApps_GetInstanceMSDeployLog", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of web app instance.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "MSDeploy log returned.", + "schema": { + "$ref": "#/definitions/MSDeployLog" + } + }, + "404": { + "description": "MSDeploy log not found.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.", + "description": "Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.", + "operationId": "WebApps_ListInstanceProcesses", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Process terminated.", + "schema": { + "$ref": "#/definitions/ProcessInfoCollection" + } + }, + "404": { + "description": "Process with the specified ID is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get process information by its ID for a specific scaled-out instance in a web site.", + "description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_GetInstanceProcess", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Process information returned.", + "schema": { + "$ref": "#/definitions/ProcessInfo" + } + }, + "404": { + "description": "Process with the specified ID is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", + "description": "Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", + "operationId": "WebApps_DeleteInstanceProcess", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Process terminated." + }, + "404": { + "description": "Process with the specified ID is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/dump": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", + "description": "Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_GetInstanceProcessDump", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "file" + } + }, + "404": { + "description": "Process with the specified ID is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.", + "description": "Description for List module information for a process by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_ListInstanceProcessModules", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Module information returned.", + "schema": { + "$ref": "#/definitions/ProcessModuleInfoCollection" + } + }, + "404": { + "description": "Process with the specified ID is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get process information by its ID for a specific scaled-out instance in a web site.", + "description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_GetInstanceProcessModule", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "baseAddress", + "in": "path", + "description": "Module base address.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Module information returned.", + "schema": { + "$ref": "#/definitions/ProcessModuleInfo" + } + }, + "404": { + "description": "Process with the specified ID is not running, or a module with the specified baseAddress was not found.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.", + "description": "Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_ListInstanceProcessThreads", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Thread information returned.", + "schema": { + "$ref": "#/definitions/ProcessThreadInfoCollection" + } + }, + "404": { + "description": "Process with the specified ID is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/iscloneable": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Shows whether an app can be cloned to another resource group or subscription.", + "description": "Description for Shows whether an app can be cloned to another resource group or subscription.", + "operationId": "WebApps_IsCloneable", + "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/SiteCloneability" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listbackups": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets existing backups of an app.", + "description": "Description for Gets existing backups of an app.", + "operationId": "WebApps_ListSiteBackups", + "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/BackupItemCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List backups": { + "$ref": "./examples/ListSlotBackups.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listsyncfunctiontriggerstatus": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "This is to allow calling via powershell and ARM template.", + "description": "Description for This is to allow calling via powershell and ARM template.", + "operationId": "WebApps_ListSyncFunctionTriggers", + "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/FunctionSecrets" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/updatemachinekey": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Updates the machine key of an app.", + "operationId": "WebApps_UpdateMachineKey", + "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": { + "type": "object" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates the machine key for a site": { + "$ref": "./examples/UpdateMachineKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate": { + "put": { + "tags": [ + "WebApps" + ], + "summary": "Restores a web app.", + "description": "Description for Restores a web app.", + "operationId": "WebApps_MigrateStorage", + "parameters": [ + { + "name": "subscriptionName", + "in": "query", + "description": "Azure subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "migrationOptions", + "in": "body", + "description": "Migration migrationOptions.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageMigrationOptions" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageMigrationResponse" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Migrates a local (in-app) MySql database to a remote MySql database.", + "description": "Description for Migrates a local (in-app) MySql database to a remote MySql database.", + "operationId": "WebApps_MigrateMySql", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "migrationRequestEnvelope", + "in": "body", + "description": "MySql migration options.", + "required": true, + "schema": { + "$ref": "#/definitions/MigrateMySqlRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Operation" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql/status": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled", + "description": "Description for Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled", + "operationId": "WebApps_GetMigrateMySqlStatus", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrateMySqlStatus" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a Swift Virtual Network connection.", + "description": "Description for Gets a Swift Virtual Network connection.", + "operationId": "WebApps_GetSwiftVirtualNetworkConnection", + "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/SwiftVirtualNetwork" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.", + "description": "Description for Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.", + "operationId": "WebApps_CreateOrUpdateSwiftVirtualNetworkConnectionWithCheck", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "Properties of the Virtual Network connection. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a Swift Virtual Network connection from an app (or deployment slot).", + "description": "Description for Deletes a Swift Virtual Network connection from an app (or deployment slot).", + "operationId": "WebApps_DeleteSwiftVirtualNetwork", + "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": "Successfully deleted virtual network." + }, + "404": { + "description": "Virtual network does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.", + "description": "Description for Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.", + "operationId": "WebApps_UpdateSwiftVirtualNetworkConnectionWithCheck", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "Properties of the Virtual Network connection. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets all network features used by the app (or deployment slot, if specified).", + "description": "Description for Gets all network features used by the app (or deployment slot, if specified).", + "operationId": "WebApps_ListNetworkFeatures", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "view", + "in": "path", + "description": "The type of view. Only \"summary\" is supported at this time.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/NetworkFeatures" + } + }, + "404": { + "description": "The requested view does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/operationresults/{operationId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "operationId": "WebApps_GetNetworkTraceOperation", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "GUID of the operation.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get the current status of a network trace operation for a site": { + "$ref": "./examples/GetWebSiteNetworkTraceOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/start": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Start capturing network packets for the site (To be deprecated).", + "description": "Description for Start capturing network packets for the site (To be deprecated).", + "operationId": "WebApps_StartWebSiteNetworkTrace", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "durationInSeconds", + "in": "query", + "description": "The duration to keep capturing in seconds.", + "type": "integer", + "format": "int32" + }, + { + "name": "maxFrameLength", + "in": "query", + "description": "The maximum frame length in bytes (Optional).", + "type": "integer", + "format": "int32" + }, + { + "name": "sasUrl", + "in": "query", + "description": "The Blob URL to store capture file.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/startOperation": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Start capturing network packets for the site.", + "description": "Description for Start capturing network packets for the site.", + "operationId": "WebApps_StartWebSiteNetworkTraceOperation", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "durationInSeconds", + "in": "query", + "description": "The duration to keep capturing in seconds.", + "type": "integer", + "format": "int32" + }, + { + "name": "maxFrameLength", + "in": "query", + "description": "The maximum frame length in bytes (Optional).", + "type": "integer", + "format": "int32" + }, + { + "name": "sasUrl", + "in": "query", + "description": "The Blob URL to store capture file.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Start a new network trace operation for a site": { + "$ref": "./examples/StartWebSiteNetworkTraceOperation.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/stop": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Stop ongoing capturing network packets for the site.", + "description": "Description for Stop ongoing capturing network packets for the site.", + "operationId": "WebApps_StopWebSiteNetworkTrace", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Stopped." + }, + "204": { + "description": "Stopped." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Stop a currently running network trace operation for a site": { + "$ref": "./examples/StopWebSiteNetworkTrace.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/{operationId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "operationId": "WebApps_GetNetworkTraces", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "GUID of the operation.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get NetworkTraces for a site": { + "$ref": "./examples/GetWebSiteNetworkTraces.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/current/operationresults/{operationId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "operationId": "WebApps_GetNetworkTraceOperationV2", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "GUID of the operation.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get the current status of a network trace operation for a site": { + "$ref": "./examples/GetWebSiteNetworkTraceOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/{operationId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "operationId": "WebApps_GetNetworkTracesV2", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "GUID of the operation.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get NetworkTraces for a site": { + "$ref": "./examples/GetWebSiteNetworkTraces.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/newpassword": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Generates a new publishing password for an app (or deployment slot, if specified).", + "description": "Description for Generates a new publishing password for an app (or deployment slot, if specified).", + "operationId": "WebApps_GenerateNewSitePublishingPassword", + "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": "Successfully generate new password." + }, + "204": { + "description": "Successfully generate new password." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/perfcounters": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets perfmon counters for web app.", + "description": "Description for Gets perfmon counters for web app.", + "operationId": "WebApps_ListPerfMonCounters", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.", + "type": "string", + "x-ms-skip-url-encoding": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PerfMonCounterCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/phplogging": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets web app's event logs.", + "description": "Description for Gets web app's event logs.", + "operationId": "WebApps_GetSitePhpErrorLogFlag", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SitePhpErrorLogFlag" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the premier add-ons of an app.", + "description": "Description for Gets the premier add-ons of an app.", + "operationId": "WebApps_ListPremierAddOns", + "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/PremierAddOn" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a named add-on of an app.", + "description": "Description for Gets a named add-on of an app.", + "operationId": "WebApps_GetPremierAddOn", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "premierAddOnName", + "in": "path", + "description": "Add-on name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PremierAddOn" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Updates a named add-on of an app.", + "description": "Description for Updates a named add-on of an app.", + "operationId": "WebApps_AddPremierAddOn", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "premierAddOnName", + "in": "path", + "description": "Add-on name.", + "required": true, + "type": "string" + }, + { + "name": "premierAddOn", + "in": "body", + "description": "A JSON representation of the edited premier add-on.", + "required": true, + "schema": { + "$ref": "#/definitions/PremierAddOn" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PremierAddOn" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Delete a premier add-on from an app.", + "description": "Description for Delete a premier add-on from an app.", + "operationId": "WebApps_DeletePremierAddOn", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "premierAddOnName", + "in": "path", + "description": "Add-on name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted premier add-on." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Updates a named add-on of an app.", + "description": "Description for Updates a named add-on of an app.", + "operationId": "WebApps_UpdatePremierAddOn", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "premierAddOnName", + "in": "path", + "description": "Add-on name.", + "required": true, + "type": "string" + }, + { + "name": "premierAddOn", + "in": "body", + "description": "A JSON representation of the edited premier add-on.", + "required": true, + "schema": { + "$ref": "#/definitions/PremierAddOnPatchResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PremierAddOn" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateAccess/virtualNetworks": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets data around private site access enablement and authorized Virtual Networks that can access the site.", + "description": "Description for Gets data around private site access enablement and authorized Virtual Networks that can access the site.", + "operationId": "WebApps_GetPrivateAccess", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateAccess" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Sets data around private site access enablement and authorized Virtual Networks that can access the site.", + "description": "Description for Sets data around private site access enablement and authorized Virtual Networks that can access the site.", + "operationId": "WebApps_PutPrivateAccessVnet", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "access", + "in": "body", + "description": "The information for the private access", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateAccess" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateAccess" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the list of private endpoint connections associated with a site", + "description": "Description for Gets the list of private endpoint connections associated with a site", + "operationId": "WebApps_GetPrivateEndpointConnectionList", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the site.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PrivateEndpointConnectionCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a private endpoint connection", + "description": "Description for Gets a private endpoint connection", + "operationId": "WebApps_GetPrivateEndpointConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the site.", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a private endpoint connection for a site.": { + "$ref": "./examples/GetSitePrivateEndpointConnection.json" + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Approves or rejects a private endpoint connection", + "description": "Description for Approves or rejects a private endpoint connection", + "operationId": "WebApps_ApproveOrRejectPrivateEndpointConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the site.", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointWrapper", + "in": "body", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource" + } + }, + "202": { + "description": "Asynchronous operation in progress.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Approves or rejects a private endpoint connection for a site.": { + "$ref": "./examples/ApproveRejectSitePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a private endpoint connection", + "description": "Description for Deletes a private endpoint connection", + "operationId": "WebApps_DeletePrivateEndpointConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the site.", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Asynchronous operation in progress.", + "schema": { + "type": "object" + } + }, + "204": { + "description": "No content.", + "schema": { + "type": "object" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a private endpoint connection for a site.": { + "$ref": "./examples/DeleteSitePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateLinkResources": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the private link resources", + "description": "Description for Gets the private link resources", + "operationId": "WebApps_GetPrivateLinkResources", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the site.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PrivateLinkResourcesWrapper" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get private link resources of a site": { + "$ref": "./examples/GetSitePrivateLinkResources.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.", + "description": "Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.", + "operationId": "WebApps_ListProcesses", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Process terminated.", + "schema": { + "$ref": "#/definitions/ProcessInfoCollection" + } + }, + "404": { + "description": "Process with the specified ID is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get process information by its ID for a specific scaled-out instance in a web site.", + "description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_GetProcess", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Process information returned.", + "schema": { + "$ref": "#/definitions/ProcessInfo" + } + }, + "404": { + "description": "Process with the specified ID is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", + "description": "Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", + "operationId": "WebApps_DeleteProcess", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Process terminated." + }, + "404": { + "description": "Process with the specified ID is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/dump": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", + "description": "Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_GetProcessDump", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "file" + } + }, + "404": { + "description": "Process with the specified ID is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.", + "description": "Description for List module information for a process by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_ListProcessModules", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Module information returned.", + "schema": { + "$ref": "#/definitions/ProcessModuleInfoCollection" + } + }, + "404": { + "description": "Process with the specified ID is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules/{baseAddress}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get process information by its ID for a specific scaled-out instance in a web site.", + "description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_GetProcessModule", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "baseAddress", + "in": "path", + "description": "Module base address.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Module information returned.", + "schema": { + "$ref": "#/definitions/ProcessModuleInfo" + } + }, + "404": { + "description": "Process with the specified ID is not running, or a module with the specified baseAddress was not found.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.", + "description": "Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_ListProcessThreads", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Thread information returned.", + "schema": { + "$ref": "#/definitions/ProcessThreadInfoCollection" + } + }, + "404": { + "description": "Process with the specified ID is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get public certificates for an app or a deployment slot.", + "description": "Description for Get public certificates for an app or a deployment slot.", + "operationId": "WebApps_ListPublicCertificates", + "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/PublicCertificateCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get the named public certificate for an app (or deployment slot, if specified).", + "description": "Description for Get the named public certificate for an app (or deployment slot, if specified).", + "operationId": "WebApps_GetPublicCertificate", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "publicCertificateName", + "in": "path", + "description": "Public certificate name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PublicCertificate" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Creates a hostname binding for an app.", + "description": "Description for Creates a hostname binding for an app.", + "operationId": "WebApps_CreateOrUpdatePublicCertificate", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "publicCertificateName", + "in": "path", + "description": "Public certificate name.", + "required": true, + "type": "string" + }, + { + "name": "publicCertificate", + "in": "body", + "description": "Public certificate details. This is the JSON representation of a PublicCertificate object.", + "required": true, + "schema": { + "$ref": "#/definitions/PublicCertificate" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PublicCertificate" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a hostname binding for an app.", + "description": "Description for Deletes a hostname binding for an app.", + "operationId": "WebApps_DeletePublicCertificate", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "publicCertificateName", + "in": "path", + "description": "Public certificate name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted hostname binding." + }, + "204": { + "description": "Hostname binding does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets the publishing profile for an app (or deployment slot, if specified).", + "description": "Description for Gets the publishing profile for an app (or deployment slot, if specified).", + "operationId": "WebApps_ListPublishingProfileXmlWithSecrets", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "publishingProfileOptions", + "in": "body", + "description": "Specifies publishingProfileOptions for publishing profile. For example, use {\"format\": \"FileZilla3\"} to get a FileZilla publishing profile.", + "required": true, + "schema": { + "$ref": "#/definitions/CsmPublishingProfileOptions" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "file" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.", + "description": "Description for Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.", + "operationId": "WebApps_ResetProductionSlotConfig", + "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." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Restarts an app (or deployment slot, if specified).", + "description": "Description for Restarts an app (or deployment slot, if specified).", + "operationId": "WebApps_Restart", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "softRestart", + "in": "query", + "description": "Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.", + "type": "boolean" + }, + { + "name": "synchronous", + "in": "query", + "description": "Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully restarted app." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromBackupBlob": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Restores an app from a backup blob in Azure Storage.", + "description": "Description for Restores an app from a backup blob in Azure Storage.", + "operationId": "WebApps_RestoreFromBackupBlob", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Information on restore request .", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Restore operation started." + }, + "200": { + "description": "Restore operation started." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromDeletedApp": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Restores a deleted web app to this web app.", + "description": "Description for Restores a deleted web app to this web app.", + "operationId": "WebApps_RestoreFromDeletedApp", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "restoreRequest", + "in": "body", + "description": "Deleted web app restore information.", + "required": true, + "schema": { + "$ref": "#/definitions/DeletedAppRestoreRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Restore operation started." + }, + "200": { + "description": "Restore operation started." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreSnapshot": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Restores a web app from a snapshot.", + "description": "Description for Restores a web app from a snapshot.", + "operationId": "WebApps_RestoreSnapshot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "restoreRequest", + "in": "body", + "description": "Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.", + "required": true, + "schema": { + "$ref": "#/definitions/SnapshotRestoreRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Restore operation started." + }, + "200": { + "description": "Restore operation started." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sitecontainers": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Lists all the site containers of a site, or a deployment slot.", + "operationId": "WebApps_ListSiteContainers", + "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/SiteContainerCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sitecontainers/{containerName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a site container of a site, or a deployment slot.", + "operationId": "WebApps_GetSiteContainer", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Site Container Name", + "required": true, + "type": "string", + "pattern": "(^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$)" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteContainer" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Creates or Updates a site container for a site, or a deployment slot.", + "operationId": "WebApps_CreateOrUpdateSiteContainer", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Site Container Name", + "required": true, + "type": "string", + "pattern": "(^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$)" + }, + { + "name": "request", + "in": "body", + "description": "Container Entity", + "required": true, + "schema": { + "$ref": "#/definitions/SiteContainer" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Site container was created.", + "schema": { + "$ref": "#/definitions/SiteContainer" + } + }, + "200": { + "description": "Site container was updated.", + "schema": { + "$ref": "#/definitions/SiteContainer" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a site container for a site, or a deployment slot.", + "operationId": "WebApps_DeleteSiteContainer", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Site Container Name", + "required": true, + "type": "string", + "pattern": "(^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$)" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted site container." + }, + "204": { + "description": "Site container does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get list of siteextensions for a web site, or a deployment slot.", + "description": "Description for Get list of siteextensions for a web site, or a deployment slot.", + "operationId": "WebApps_ListSiteExtensions", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "SiteExtension information returned.", + "schema": { + "$ref": "#/definitions/SiteExtensionInfoCollection" + } + }, + "404": { + "description": "SiteExtension not found.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get site extension information by its ID for a web site, or a deployment slot.", + "description": "Description for Get site extension information by its ID for a web site, or a deployment slot.", + "operationId": "WebApps_GetSiteExtension", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "siteExtensionId", + "in": "path", + "description": "Site extension name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "SiteExtension information returned.", + "schema": { + "$ref": "#/definitions/SiteExtensionInfo" + } + }, + "404": { + "description": "SiteExtension with an ID of {siteExtensionId} is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Install site extension on a web site, or a deployment slot.", + "description": "Description for Install site extension on a web site, or a deployment slot.", + "operationId": "WebApps_InstallSiteExtension", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "siteExtensionId", + "in": "path", + "description": "Site extension name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Site Extension created.", + "schema": { + "$ref": "#/definitions/SiteExtensionInfo" + } + }, + "200": { + "description": "Site Extension created.", + "schema": { + "$ref": "#/definitions/SiteExtensionInfo" + } + }, + "429": { + "description": "Site Extension is being installed on another request: Rejecting current request.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Remove a site extension from a web site, or a deployment slot.", + "description": "Description for Remove a site extension from a web site, or a deployment slot.", + "operationId": "WebApps_DeleteSiteExtension", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "siteExtensionId", + "in": "path", + "description": "Site extension name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "SiteExtension terminated." + }, + "404": { + "description": "SiteExtension with an ID of {siteExtensionId} is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets an app's deployment slots.", + "description": "Description for Gets an app's deployment slots.", + "operationId": "WebApps_ListSlots", + "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": "./CommonDefinitions.json#/definitions/WebAppCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Web App Slots": { + "$ref": "./examples/ListWebAppSlots.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the details of a web, mobile, or API app.", + "description": "Description for Gets the details of a web, mobile, or API app.", + "operationId": "WebApps_GetSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. By default, this API returns the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Site" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Web App Slot": { + "$ref": "./examples/GetWebAppSlot.json" + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", + "description": "Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", + "operationId": "WebApps_CreateOrUpdateSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.", + "required": true, + "type": "string" + }, + { + "name": "siteEnvelope", + "in": "body", + "description": "A JSON representation of the app properties. See example.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Site" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Site" + } + }, + "202": { + "description": "Asynchronous operation in progress.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Site" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update Web App Slot": { + "$ref": "./examples/CreateOrUpdateWebAppSlot.json" + }, + "Clone web app slot": { + "$ref": "./examples/CloneWebAppSlot.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a web, mobile, or API app, or one of the deployment slots.", + "description": "Description for Deletes a web, mobile, or API app, or one of the deployment slots.", + "operationId": "WebApps_DeleteSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app to delete.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot to delete. By default, the API deletes the production slot.", + "required": true, + "type": "string" + }, + { + "name": "deleteMetrics", + "in": "query", + "description": "If true, web app metrics are also deleted.", + "type": "boolean" + }, + { + "name": "deleteEmptyServerFarm", + "in": "query", + "description": "Specify false if you want to keep empty App Service plan. By default, empty App Service plan is deleted.", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted web app." + }, + "204": { + "description": "Successfully deleted web app." + }, + "404": { + "description": "Web app not found.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Web App Slot": { + "$ref": "./examples/DeleteWebAppSlot.json" + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", + "description": "Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", + "operationId": "WebApps_UpdateSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.", + "required": true, + "type": "string" + }, + { + "name": "siteEnvelope", + "in": "body", + "description": "A JSON representation of the app properties. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SitePatchResource" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Site" + } + }, + "202": { + "description": "Asynchronous operation in progress.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Site" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Web App Slot": { + "$ref": "./examples/UpdateWebAppSlot.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/analyzeCustomHostname": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Analyze a custom hostname.", + "description": "Description for Analyze a custom hostname.", + "operationId": "WebApps_AnalyzeCustomHostnameSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "name": "hostName", + "in": "query", + "description": "Custom hostname.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CustomHostnameAnalysisResult" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Analyze custom hostname for slot": { + "$ref": "./examples/AnalyzeCustomHostNameSlot.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/applySlotConfig": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Applies the configuration settings from the target slot onto the current slot.", + "description": "Description for Applies the configuration settings from the target slot onto the current slot.", + "operationId": "WebApps_ApplySlotConfigurationSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slotSwapEntity", + "in": "body", + "description": "JSON object that contains the target slot name. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/CsmSlotEntity" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the source slot. If a slot is not specified, the production slot is used as the source slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Creates a backup of an app.", + "description": "Description for Creates a backup of an app.", + "operationId": "WebApps_BackupSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Backup configuration. You can use the JSON response from the POST action as input here.", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequest" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will create a backup for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupItem" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets existing backups of an app.", + "description": "Description for Gets existing backups of an app.", + "operationId": "WebApps_ListBackupsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get backups of the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupItemCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a backup of an app by its ID.", + "description": "Description for Gets a backup of an app by its ID.", + "operationId": "WebApps_GetBackupStatusSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "backupId", + "in": "path", + "description": "ID of the backup.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get a backup of the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupItem" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a backup of an app by its ID.", + "description": "Description for Deletes a backup of an app by its ID.", + "operationId": "WebApps_DeleteBackupSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "backupId", + "in": "path", + "description": "ID of the backup.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete a backup of the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted web app backup item." + }, + "404": { + "description": "Web app backup item does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/list": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.", + "description": "Description for Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.", + "operationId": "WebApps_ListBackupStatusSecretsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "backupId", + "in": "path", + "description": "ID of backup.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Information on backup request.", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequest" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupItem" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Restores a specific backup to another app (or deployment slot, if specified).", + "description": "Description for Restores a specific backup to another app (or deployment slot, if specified).", + "operationId": "WebApps_RestoreSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "backupId", + "in": "path", + "description": "ID of the backup.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Information on restore request .", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreRequest" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Restore operation started." + }, + "200": { + "description": "Restore operation started." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/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_ListBasicPublishingCredentialsPoliciesSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PublishingCredentialsPoliciesCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Publishing Credentials Policies": { + "$ref": "./examples/ListPublishingCredentialsPoliciesSlot.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/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_GetFtpAllowedSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "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/GetPublishingCredentialsPolicySlot.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_UpdateFtpAllowedSlot", + "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" + } + }, + { + "name": "slot", + "in": "path", + "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": { + "Update FTP Allowed": { + "$ref": "./examples/UpdatePublishingCredentialsPolicySlot.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/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_GetScmAllowedSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "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/GetPublishingCredentialsPolicySlot.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_UpdateScmAllowedSlot", + "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" + } + }, + { + "name": "slot", + "in": "path", + "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": { + "Update SCM Allowed": { + "$ref": "./examples/UpdatePublishingCredentialsPolicySlot.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List the configurations of an app", + "description": "Description for List the configurations of an app", + "operationId": "WebApps_ListConfigurationsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteConfigResourceCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings": { + "put": { + "tags": [ + "WebApps" + ], + "summary": "Replaces the application settings of an app.", + "description": "Description for Replaces the application settings of an app.", + "operationId": "WebApps_UpdateApplicationSettingsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "appSettings", + "in": "body", + "description": "Application settings of the app.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the application settings for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets the application settings of an app.", + "description": "Description for Gets the application settings of an app.", + "operationId": "WebApps_ListApplicationSettingsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the application settings for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings": { + "put": { + "tags": [ + "WebApps" + ], + "summary": "Updates the Authentication / Authorization settings associated with web app.", + "description": "Description for Updates the Authentication / Authorization settings associated with web app.", + "operationId": "WebApps_UpdateAuthSettingsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "siteAuthSettings", + "in": "body", + "description": "Auth settings associated with web app.", + "required": true, + "schema": { + "$ref": "#/definitions/SiteAuthSettings" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteAuthSettings" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets the Authentication/Authorization settings of an app.", + "description": "Description for Gets the Authentication/Authorization settings of an app.", + "operationId": "WebApps_GetAuthSettingsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteAuthSettings" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettingsV2": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets site's Authentication / Authorization settings for apps via the V2 format", + "operationId": "WebApps_GetAuthSettingsV2WithoutSecretsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteAuthSettingsV2" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Updates site's Authentication / Authorization settings for apps via the V2 format", + "description": "Description for Updates site's Authentication / Authorization settings for apps via the V2 format", + "operationId": "WebApps_UpdateAuthSettingsV2Slot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "siteAuthSettingsV2", + "in": "body", + "description": "Auth settings associated with web app.", + "required": true, + "schema": { + "$ref": "#/definitions/SiteAuthSettingsV2" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteAuthSettingsV2" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettingsV2/list": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets site's Authentication / Authorization settings for apps via the V2 format", + "description": "Description for Gets site's Authentication / Authorization settings for apps via the V2 format", + "operationId": "WebApps_GetAuthSettingsV2Slot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteAuthSettingsV2" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts": { + "put": { + "tags": [ + "WebApps" + ], + "summary": "Updates the Azure storage account configurations of an app.", + "description": "Description for Updates the Azure storage account configurations of an app.", + "operationId": "WebApps_UpdateAzureStorageAccountsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "azureStorageAccounts", + "in": "body", + "description": "Azure storage accounts of the app.", + "required": true, + "schema": { + "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the Azure storage account configurations for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts/list": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets the Azure storage account configurations of an app.", + "description": "Description for Gets the Azure storage account configurations of an app.", + "operationId": "WebApps_ListAzureStorageAccountsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the Azure storage account configurations for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup": { + "put": { + "tags": [ + "WebApps" + ], + "summary": "Updates the backup configuration of an app.", + "description": "Description for Updates the backup configuration of an app.", + "operationId": "WebApps_UpdateBackupConfigurationSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Edited backup configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequest" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the backup configuration for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupRequest" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes the backup configuration of an app.", + "description": "Description for Deletes the backup configuration of an app.", + "operationId": "WebApps_DeleteBackupConfigurationSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the backup configuration for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted backup configuration." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets the backup configuration of an app.", + "description": "Description for Gets the backup configuration of an app.", + "operationId": "WebApps_GetBackupConfigurationSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the backup configuration for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupRequest" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/appsettings": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the config reference app settings and status of an app", + "description": "Description for Gets the config reference app settings and status of an app", + "operationId": "WebApps_GetAppSettingsKeyVaultReferencesSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApiKVReferenceCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Azure Key Vault references for app settings for slot": { + "$ref": "./examples/GetKeyVaultReferencesForAppSettingsSlot.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/appsettings/{appSettingKey}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the config reference and status of an app", + "description": "Description for Gets the config reference and status of an app", + "operationId": "WebApps_GetAppSettingKeyVaultReferenceSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "appSettingKey", + "in": "path", + "description": "App Setting key name.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApiKVReference" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Azure Key Vault slot app setting reference": { + "$ref": "./examples/GetKeyVaultReferencesForAppSettingSlot.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/connectionstrings": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the config reference app settings and status of an app", + "description": "Description for Gets the config reference app settings and status of an app", + "operationId": "WebApps_GetSiteConnectionStringKeyVaultReferencesSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApiKVReferenceCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/connectionstrings/{connectionStringKey}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the config reference and status of an app", + "description": "Description for Gets the config reference and status of an app", + "operationId": "WebApps_GetSiteConnectionStringKeyVaultReferenceSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "connectionStringKey", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApiKVReference" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings": { + "put": { + "tags": [ + "WebApps" + ], + "summary": "Replaces the connection strings of an app.", + "description": "Description for Replaces the connection strings of an app.", + "operationId": "WebApps_UpdateConnectionStringsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "connectionStrings", + "in": "body", + "description": "Connection strings of the app or deployment slot. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionStringDictionary" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the connection settings for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectionStringDictionary" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets the connection strings of an app.", + "description": "Description for Gets the connection strings of an app.", + "operationId": "WebApps_ListConnectionStringsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the connection settings for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectionStringDictionary" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the logging configuration of an app.", + "description": "Description for Gets the logging configuration of an app.", + "operationId": "WebApps_GetDiagnosticLogsConfigurationSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the logging configuration for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteLogsConfig" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Updates the logging configuration of an app.", + "description": "Description for Updates the logging configuration of an app.", + "operationId": "WebApps_UpdateDiagnosticLogsConfigSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "siteLogsConfig", + "in": "body", + "description": "A SiteLogsConfig JSON object that contains the logging configuration to change in the \"properties\" property.", + "required": true, + "schema": { + "$ref": "#/definitions/SiteLogsConfig" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the logging configuration for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteLogsConfig" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata": { + "put": { + "tags": [ + "WebApps" + ], + "summary": "Replaces the metadata of an app.", + "description": "Description for Replaces the metadata of an app.", + "operationId": "WebApps_UpdateMetadataSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "metadata", + "in": "body", + "description": "Edited metadata of the app or deployment slot. See example.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the metadata for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets the metadata of an app.", + "description": "Description for Gets the metadata of an app.", + "operationId": "WebApps_ListMetadataSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the metadata for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/publishingcredentials/list": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets the Git/FTP publishing credentials of an app.", + "description": "Description for Gets the Git/FTP publishing credentials of an app.", + "operationId": "WebApps_ListPublishingCredentialsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the publishing credentials for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/User" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings": { + "put": { + "tags": [ + "WebApps" + ], + "summary": "Updates the Push settings associated with web app.", + "description": "Description for Updates the Push settings associated with web app.", + "operationId": "WebApps_UpdateSitePushSettingsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "pushSettings", + "in": "body", + "description": "Push settings associated with web app.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PushSettings" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PushSettings" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings/list": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets the Push settings associated with web app.", + "description": "Description for Gets the Push settings associated with web app.", + "operationId": "WebApps_ListSitePushSettingsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PushSettings" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.", + "description": "Description for Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.", + "operationId": "WebApps_GetConfigurationSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteConfigResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Updates the configuration of an app.", + "description": "Description for Updates the configuration of an app.", + "operationId": "WebApps_CreateOrUpdateConfigurationSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "siteConfig", + "in": "body", + "description": "JSON representation of a SiteConfig object. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SiteConfigResource" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteConfigResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Updates the configuration of an app.", + "description": "Description for Updates the configuration of an app.", + "operationId": "WebApps_UpdateConfigurationSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "siteConfig", + "in": "body", + "description": "JSON representation of a SiteConfig object. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SiteConfigResource" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteConfigResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.", + "description": "Description for Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.", + "operationId": "WebApps_ListConfigurationSnapshotInfoSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteConfigurationSnapshotInfoCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a snapshot of the configuration of an app at a previous point in time.", + "description": "Description for Gets a snapshot of the configuration of an app at a previous point in time.", + "operationId": "WebApps_GetConfigurationSnapshotSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "snapshotId", + "in": "path", + "description": "The ID of the snapshot to read.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteConfigResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}/recover": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Reverts the configuration of an app to a previous snapshot.", + "description": "Description for Reverts the configuration of an app to a previous snapshot.", + "operationId": "WebApps_RecoverSiteConfigurationSnapshotSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "snapshotId", + "in": "path", + "description": "The ID of the snapshot to read.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets the last lines of docker logs for the given site", + "description": "Description for Gets the last lines of docker logs for the given site", + "operationId": "WebApps_GetWebSiteContainerLogsSlot", + "produces": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "200": { + "description": "OK", + "schema": { + "type": "file" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs/zip/download": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets the ZIP archived docker log files for the given site", + "description": "Description for Gets the ZIP archived docker log files for the given site", + "operationId": "WebApps_GetContainerLogsZipSlot", + "produces": [ + "application/zip" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "200": { + "description": "OK", + "schema": { + "type": "file" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List continuous web jobs for an app, or a deployment slot.", + "description": "Description for List continuous web jobs for an app, or a deployment slot.", + "operationId": "WebApps_ListContinuousWebJobsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContinuousWebJobCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a continuous web job by its ID for an app, or a deployment slot.", + "description": "Description for Gets a continuous web job by its ID for an app, or a deployment slot.", + "operationId": "WebApps_GetContinuousWebJobSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Found continuous web job.", + "schema": { + "$ref": "#/definitions/ContinuousWebJob" + } + }, + "404": { + "description": "Continuous web job does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Delete a continuous web job by its ID for an app, or a deployment slot.", + "description": "Description for Delete a continuous web job by its ID for an app, or a deployment slot.", + "operationId": "WebApps_DeleteContinuousWebJobSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted continuous web job." + }, + "204": { + "description": "Continuous web job does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/start": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Start a continuous web job for an app, or a deployment slot.", + "description": "Description for Start a continuous web job for an app, or a deployment slot.", + "operationId": "WebApps_StartContinuousWebJobSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Found continuous web job." + }, + "404": { + "description": "Continuous web job does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/stop": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Stop a continuous web job for an app, or a deployment slot.", + "description": "Description for Stop a continuous web job for an app, or a deployment slot.", + "operationId": "WebApps_StopContinuousWebJobSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Found continuous web job." + }, + "404": { + "description": "Continuous web job does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deploymentStatus": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List deployment statuses for an app (or deployment slot, if specified).", + "operationId": "WebApps_ListSlotSiteDeploymentStatusesSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the deployment status for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CsmDeploymentStatusCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Deployment Status Slot": { + "$ref": "./examples/ListSiteDeploymentStatusSlot.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deploymentStatus/{deploymentStatusId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the deployment status for an app (or deployment slot, if specified).", + "operationId": "WebApps_GetSlotSiteDeploymentStatusSlot", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the deployment status for the production slot.", + "required": true, + "type": "string" + }, + { + "name": "deploymentStatusId", + "in": "path", + "description": "GUID of the deployment operation.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CsmDeploymentStatus" + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "$ref": "#/definitions/CsmDeploymentStatus" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Deployment Status Slot": { + "$ref": "./examples/GetSiteDeploymentStatusSlot.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List deployments for an app, or a deployment slot.", + "description": "Description for List deployments for an app, or a deployment slot.", + "operationId": "WebApps_ListDeploymentsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DeploymentCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get a deployment by its ID for an app, or a deployment slot.", + "description": "Description for Get a deployment by its ID for an app, or a deployment slot.", + "operationId": "WebApps_GetDeploymentSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "Deployment ID.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API gets a deployment for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Create a deployment for an app, or a deployment slot.", + "description": "Description for Create a deployment for an app, or a deployment slot.", + "operationId": "WebApps_CreateDeploymentSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "ID of an existing deployment.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API creates a deployment for the production slot.", + "required": true, + "type": "string" + }, + { + "name": "deployment", + "in": "body", + "description": "Deployment details.", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Delete a deployment by its ID for an app, or a deployment slot.", + "description": "Description for Delete a deployment by its ID for an app, or a deployment slot.", + "operationId": "WebApps_DeleteDeploymentSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "Deployment ID.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted deployment." + }, + "204": { + "description": "Deployment does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}/log": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List deployment log for specific deployment for an app, or a deployment slot.", + "description": "Description for List deployment log for specific deployment for an app, or a deployment slot.", + "operationId": "WebApps_ListDeploymentLogSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "The ID of a specific deployment. This is the value of the name property in the JSON response from \"GET /api/sites/{siteName}/deployments\".", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/discoverbackup": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.", + "description": "Description for Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.", + "operationId": "WebApps_DiscoverBackupSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreRequest" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will perform discovery for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestoreRequest" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Lists ownership identifiers for domain associated with web app.", + "description": "Description for Lists ownership identifiers for domain associated with web app.", + "operationId": "WebApps_ListDomainOwnershipIdentifiersSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/IdentifierCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get domain ownership identifier for web app.", + "description": "Description for Get domain ownership identifier for web app.", + "operationId": "WebApps_GetDomainOwnershipIdentifierSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "domainOwnershipIdentifierName", + "in": "path", + "description": "Name of domain ownership identifier.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Identifier" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.", + "description": "Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.", + "operationId": "WebApps_CreateOrUpdateDomainOwnershipIdentifierSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "domainOwnershipIdentifierName", + "in": "path", + "description": "Name of domain ownership identifier.", + "required": true, + "type": "string" + }, + { + "name": "domainOwnershipIdentifier", + "in": "body", + "description": "A JSON representation of the domain ownership properties.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Identifier" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Identifier" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a domain ownership identifier for a web app.", + "description": "Description for Deletes a domain ownership identifier for a web app.", + "operationId": "WebApps_DeleteDomainOwnershipIdentifierSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "domainOwnershipIdentifierName", + "in": "path", + "description": "Name of domain ownership identifier.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted domain ownership identifier." + }, + "204": { + "description": "Domain ownership identifier does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.", + "description": "Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.", + "operationId": "WebApps_UpdateDomainOwnershipIdentifierSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "domainOwnershipIdentifierName", + "in": "path", + "description": "Name of domain ownership identifier.", + "required": true, + "type": "string" + }, + { + "name": "domainOwnershipIdentifier", + "in": "body", + "description": "A JSON representation of the domain ownership properties.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Identifier" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Identifier" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get the status of the last MSDeploy operation.", + "description": "Description for Get the status of the last MSDeploy operation.", + "operationId": "WebApps_GetMSDeployStatusSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MSDeployStatus" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Invoke the MSDeploy web app extension.", + "description": "Description for Invoke the MSDeploy web app extension.", + "operationId": "WebApps_CreateMSDeployOperationSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "name": "MSDeploy", + "in": "body", + "description": "Details of MSDeploy operation", + "required": true, + "schema": { + "$ref": "#/definitions/MSDeploy" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Deployment is scheduled.", + "schema": { + "$ref": "#/definitions/MSDeployStatus" + } + }, + "409": { + "description": "Another deployment is in progress.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy/log": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get the MSDeploy Log for the last MSDeploy operation.", + "description": "Description for Get the MSDeploy Log for the last MSDeploy operation.", + "operationId": "WebApps_GetMSDeployLogSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "MSDeploy log returned.", + "schema": { + "$ref": "#/definitions/MSDeployLog" + } + }, + "404": { + "description": "MSDeploy log not found.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List the functions for a web site, or a deployment slot.", + "description": "Description for List the functions for a web site, or a deployment slot.", + "operationId": "WebApps_ListInstanceFunctionsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/slotNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Function information returned.", + "schema": { + "$ref": "#/definitions/FunctionEnvelopeCollection" + } + }, + "404": { + "description": "Function with an ID of {functionName} is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/admin/token": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Fetch a short lived token that can be exchanged for a master key.", + "description": "Description for Fetch a short lived token that can be exchanged for a master key.", + "operationId": "WebApps_GetFunctionsAdminTokenSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get function information by its ID for web site, or a deployment slot.", + "description": "Description for Get function information by its ID for web site, or a deployment slot.", + "operationId": "WebApps_GetInstanceFunctionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "functionName", + "in": "path", + "description": "Function name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/slotNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Function information returned.", + "schema": { + "$ref": "#/definitions/FunctionEnvelope" + } + }, + "404": { + "description": "Function with a name of {functionName} does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Create function for web site, or a deployment slot.", + "description": "Description for Create function for web site, or a deployment slot.", + "operationId": "WebApps_CreateInstanceFunctionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "functionName", + "in": "path", + "description": "Function name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/slotNameParameter" + }, + { + "name": "function_envelope", + "in": "body", + "description": "Function details.", + "required": true, + "schema": { + "$ref": "#/definitions/FunctionEnvelope" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Function created.", + "schema": { + "$ref": "#/definitions/FunctionEnvelope" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Delete a function for web site, or a deployment slot.", + "description": "Description for Delete a function for web site, or a deployment slot.", + "operationId": "WebApps_DeleteInstanceFunctionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "functionName", + "in": "path", + "description": "Function name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/slotNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Function deleted." + }, + "404": { + "description": "Function does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/keys/{keyName}": { + "put": { + "tags": [ + "WebApps" + ], + "summary": "Add or update a function secret.", + "description": "Description for Add or update a function secret.", + "operationId": "WebApps_CreateOrUpdateFunctionSecretSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "functionName", + "in": "path", + "description": "The name of the function.", + "required": true, + "type": "string" + }, + { + "name": "keyName", + "in": "path", + "description": "The name of the key.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/slotNameParameter" + }, + { + "name": "key", + "in": "body", + "description": "The key to create or update", + "required": true, + "schema": { + "$ref": "#/definitions/KeyInfo" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Key was created.", + "schema": { + "$ref": "#/definitions/KeyInfo" + } + }, + "200": { + "description": "Key was updated.", + "schema": { + "$ref": "#/definitions/KeyInfo" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Delete a function secret.", + "description": "Description for Delete a function secret.", + "operationId": "WebApps_DeleteFunctionSecretSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "functionName", + "in": "path", + "description": "The name of the function.", + "required": true, + "type": "string" + }, + { + "name": "keyName", + "in": "path", + "description": "The name of the key.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/slotNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "404": { + "description": "Key was not found.", + "x-ms-error-response": true + }, + "204": { + "description": "Key was deleted." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listkeys": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Get function keys for a function in a web site, or a deployment slot.", + "description": "Description for Get function keys for a function in a web site, or a deployment slot.", + "operationId": "WebApps_ListFunctionKeysSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "functionName", + "in": "path", + "description": "Function name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/slotNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Function keys returned.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listsecrets": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Get function secrets for a function in a web site, or a deployment slot.", + "description": "Description for Get function secrets for a function in a web site, or a deployment slot.", + "operationId": "WebApps_ListFunctionSecretsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "functionName", + "in": "path", + "description": "Function name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/slotNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Function secrets returned.", + "schema": { + "$ref": "#/definitions/FunctionSecrets" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/listkeys": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Get host secrets for a function app.", + "description": "Description for Get host secrets for a function app.", + "operationId": "WebApps_ListHostKeysSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/slotNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Host secrets returned.", + "schema": { + "$ref": "#/definitions/HostKeys" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/listsyncstatus": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "This is to allow calling via powershell and ARM template.", + "description": "Description for This is to allow calling via powershell and ARM template.", + "operationId": "WebApps_ListSyncStatusSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/slotNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/sync": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Syncs function trigger metadata to the management database", + "description": "Description for Syncs function trigger metadata to the management database", + "operationId": "WebApps_SyncFunctionsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/slotNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/{keyType}/{keyName}": { + "put": { + "tags": [ + "WebApps" + ], + "summary": "Add or update a host level secret.", + "description": "Description for Add or update a host level secret.", + "operationId": "WebApps_CreateOrUpdateHostSecretSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "keyType", + "in": "path", + "description": "The type of host key.", + "required": true, + "type": "string" + }, + { + "name": "keyName", + "in": "path", + "description": "The name of the key.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/slotNameParameter" + }, + { + "name": "key", + "in": "body", + "description": "The key to create or update", + "required": true, + "schema": { + "$ref": "#/definitions/KeyInfo" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Key was created.", + "schema": { + "$ref": "#/definitions/KeyInfo" + } + }, + "200": { + "description": "Key was updated.", + "schema": { + "$ref": "#/definitions/KeyInfo" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Delete a host level secret.", + "description": "Description for Delete a host level secret.", + "operationId": "WebApps_DeleteHostSecretSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "keyType", + "in": "path", + "description": "The type of host key.", + "required": true, + "type": "string" + }, + { + "name": "keyName", + "in": "path", + "description": "The name of the key.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/slotNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "404": { + "description": "Key was not found.", + "x-ms-error-response": true + }, + "204": { + "description": "Key was deleted." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get hostname bindings for an app or a deployment slot.", + "description": "Description for Get hostname bindings for an app or a deployment slot.", + "operationId": "WebApps_ListHostNameBindingsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API gets hostname bindings for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HostNameBindingCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get the named hostname binding for an app (or deployment slot, if specified).", + "description": "Description for Get the named hostname binding for an app (or deployment slot, if specified).", + "operationId": "WebApps_GetHostNameBindingSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.", + "required": true, + "type": "string" + }, + { + "name": "hostName", + "in": "path", + "description": "Hostname in the hostname binding.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HostNameBinding" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Creates a hostname binding for an app.", + "description": "Description for Creates a hostname binding for an app.", + "operationId": "WebApps_CreateOrUpdateHostNameBindingSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "hostName", + "in": "path", + "description": "Hostname in the hostname binding.", + "required": true, + "type": "string" + }, + { + "name": "hostNameBinding", + "in": "body", + "description": "Binding details. This is the JSON representation of a HostNameBinding object.", + "required": true, + "schema": { + "$ref": "#/definitions/HostNameBinding" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HostNameBinding" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a hostname binding for an app.", + "description": "Description for Deletes a hostname binding for an app.", + "operationId": "WebApps_DeleteHostNameBindingSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", + "required": true, + "type": "string" + }, + { + "name": "hostName", + "in": "path", + "description": "Hostname in the hostname binding.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted hostname binding." + }, + "204": { + "description": "Hostname binding does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Retrieves a specific Service Bus Hybrid Connection used by this Web App.", + "description": "Description for Retrieves a specific Service Bus Hybrid Connection used by this Web App.", + "operationId": "WebApps_GetHybridConnectionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "namespaceName", + "in": "path", + "description": "The namespace for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "relayName", + "in": "path", + "description": "The relay name for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for the web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Creates a new Hybrid Connection using a Service Bus relay.", + "description": "Description for Creates a new Hybrid Connection using a Service Bus relay.", + "operationId": "WebApps_CreateOrUpdateHybridConnectionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "namespaceName", + "in": "path", + "description": "The namespace for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "relayName", + "in": "path", + "description": "The relay name for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The details of the hybrid connection.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + } + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for the web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Removes a Hybrid Connection from this site.", + "description": "Description for Removes a Hybrid Connection from this site.", + "operationId": "WebApps_DeleteHybridConnectionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "namespaceName", + "in": "path", + "description": "The namespace for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "relayName", + "in": "path", + "description": "The relay name for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for the web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted hybrid connection." + }, + "404": { + "description": "Hybrid connection does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Creates a new Hybrid Connection using a Service Bus relay.", + "description": "Description for Creates a new Hybrid Connection using a Service Bus relay.", + "operationId": "WebApps_UpdateHybridConnectionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "namespaceName", + "in": "path", + "description": "The namespace for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "relayName", + "in": "path", + "description": "The relay name for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The details of the hybrid connection.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + } + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for the web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionRelays": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Retrieves all Service Bus Hybrid Connections used by this Web App.", + "description": "Description for Retrieves all Service Bus Hybrid Connections used by this Web App.", + "operationId": "WebApps_ListHybridConnectionsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for the web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets hybrid connections configured for an app (or deployment slot, if specified).", + "description": "Description for Gets hybrid connections configured for an app (or deployment slot, if specified).", + "operationId": "WebApps_ListRelayServiceConnectionsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get hybrid connections for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a hybrid connection configuration by its name.", + "description": "Description for Gets a hybrid connection configuration by its name.", + "operationId": "WebApps_GetRelayServiceConnectionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "entityName", + "in": "path", + "description": "Name of the hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get a hybrid connection for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).", + "description": "Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).", + "operationId": "WebApps_CreateOrUpdateRelayServiceConnectionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "entityName", + "in": "path", + "description": "Name of the hybrid connection configuration.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "Details of the hybrid connection configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will create or update a hybrid connection for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a relay service connection by its name.", + "description": "Description for Deletes a relay service connection by its name.", + "operationId": "WebApps_DeleteRelayServiceConnectionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "entityName", + "in": "path", + "description": "Name of the hybrid connection configuration.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete a hybrid connection for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted relay service connection." + }, + "404": { + "description": "Relay service connection does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).", + "description": "Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).", + "operationId": "WebApps_UpdateRelayServiceConnectionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "entityName", + "in": "path", + "description": "Name of the hybrid connection configuration.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "Details of the hybrid connection configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will create or update a hybrid connection for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets all scale-out instances of an app.", + "description": "Description for Gets all scale-out instances of an app.", + "operationId": "WebApps_ListInstanceIdentifiersSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API gets the production slot instances.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebAppInstanceStatusCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets all scale-out instances of an app.", + "description": "Description for Gets all scale-out instances of an app.", + "operationId": "WebApps_GetInstanceInfoSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API gets the production slot instances.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebSiteInstanceStatus" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get site instance info": { + "$ref": "./examples/GetSiteInstanceInfo.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get the status of the last MSDeploy operation.", + "description": "Description for Get the status of the last MSDeploy operation.", + "operationId": "WebApps_GetInstanceMsDeployStatusSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of web app instance.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MSDeployStatus" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Invoke the MSDeploy web app extension.", + "description": "Description for Invoke the MSDeploy web app extension.", + "operationId": "WebApps_CreateInstanceMSDeployOperationSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of web app instance.", + "required": true, + "type": "string" + }, + { + "name": "MSDeploy", + "in": "body", + "description": "Details of MSDeploy operation", + "required": true, + "schema": { + "$ref": "#/definitions/MSDeploy" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Deployment is scheduled.", + "schema": { + "$ref": "#/definitions/MSDeployStatus" + } + }, + "409": { + "description": "Another deployment is in progress.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy/log": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get the MSDeploy Log for the last MSDeploy operation.", + "description": "Description for Get the MSDeploy Log for the last MSDeploy operation.", + "operationId": "WebApps_GetInstanceMSDeployLogSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of web app instance.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "MSDeploy log returned.", + "schema": { + "$ref": "#/definitions/MSDeployLog" + } + }, + "404": { + "description": "MSDeploy log not found.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.", + "description": "Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.", + "operationId": "WebApps_ListInstanceProcessesSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Process terminated.", + "schema": { + "$ref": "#/definitions/ProcessInfoCollection" + } + }, + "404": { + "description": "Process with the specified ID is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get process information by its ID for a specific scaled-out instance in a web site.", + "description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_GetInstanceProcessSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Process information returned.", + "schema": { + "$ref": "#/definitions/ProcessInfo" + } + }, + "404": { + "description": "Process with the specified ID is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", + "description": "Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", + "operationId": "WebApps_DeleteInstanceProcessSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Process terminated." + }, + "404": { + "description": "Process with the specified ID is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/dump": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", + "description": "Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_GetInstanceProcessDumpSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "file" + } + }, + "404": { + "description": "Process with the specified ID is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.", + "description": "Description for List module information for a process by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_ListInstanceProcessModulesSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Module information returned.", + "schema": { + "$ref": "#/definitions/ProcessModuleInfoCollection" + } + }, + "404": { + "description": "Process with the specified ID is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get process information by its ID for a specific scaled-out instance in a web site.", + "description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_GetInstanceProcessModuleSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "baseAddress", + "in": "path", + "description": "Module base address.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Module information returned.", + "schema": { + "$ref": "#/definitions/ProcessModuleInfo" + } + }, + "404": { + "description": "Process with the specified ID is not running, or a module with the specified baseAddress was not found.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/threads": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.", + "description": "Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_ListInstanceProcessThreadsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Thread information returned.", + "schema": { + "$ref": "#/definitions/ProcessThreadInfoCollection" + } + }, + "404": { + "description": "Process with the specified ID is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/iscloneable": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Shows whether an app can be cloned to another resource group or subscription.", + "description": "Description for Shows whether an app can be cloned to another resource group or subscription.", + "operationId": "WebApps_IsCloneableSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. By default, this API returns information on the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SiteCloneability" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listbackups": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets existing backups of an app.", + "description": "Description for Gets existing backups of an app.", + "operationId": "WebApps_ListSiteBackupsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get backups of the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupItemCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List backups": { + "$ref": "./examples/ListSlotBackups.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listsyncfunctiontriggerstatus": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "This is to allow calling via powershell and ARM template.", + "description": "Description for This is to allow calling via powershell and ARM template.", + "operationId": "WebApps_ListSyncFunctionTriggersSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/slotNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FunctionSecrets" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/migratemysql/status": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled", + "description": "Description for Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled", + "operationId": "WebApps_GetMigrateMySqlStatusSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/slotNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrateMySqlStatus" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkConfig/virtualNetwork": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a Swift Virtual Network connection.", + "description": "Description for Gets a Swift Virtual Network connection.", + "operationId": "WebApps_GetSwiftVirtualNetworkConnectionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.", + "description": "Description for Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.", + "operationId": "WebApps_CreateOrUpdateSwiftVirtualNetworkConnectionWithCheckSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "Properties of the Virtual Network connection. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a Swift Virtual Network connection from an app (or deployment slot).", + "description": "Description for Deletes a Swift Virtual Network connection from an app (or deployment slot).", + "operationId": "WebApps_DeleteSwiftVirtualNetworkSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the connection for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted virtual network." + }, + "404": { + "description": "Virtual network does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.", + "description": "Description for Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.", + "operationId": "WebApps_UpdateSwiftVirtualNetworkConnectionWithCheckSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "Properties of the Virtual Network connection. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkFeatures/{view}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets all network features used by the app (or deployment slot, if specified).", + "description": "Description for Gets all network features used by the app (or deployment slot, if specified).", + "operationId": "WebApps_ListNetworkFeaturesSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "view", + "in": "path", + "description": "The type of view. Only \"summary\" is supported at this time.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get network features for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/NetworkFeatures" + } + }, + "404": { + "description": "The requested view does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/operationresults/{operationId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "operationId": "WebApps_GetNetworkTraceOperationSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "GUID of the operation.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get the current status of a network trace operation for a site": { + "$ref": "./examples/GetWebSiteNetworkTraceOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/start": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Start capturing network packets for the site (To be deprecated).", + "description": "Description for Start capturing network packets for the site (To be deprecated).", + "operationId": "WebApps_StartWebSiteNetworkTraceSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "durationInSeconds", + "in": "query", + "description": "The duration to keep capturing in seconds.", + "type": "integer", + "format": "int32" + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for this web app.", + "required": true, + "type": "string" + }, + { + "name": "maxFrameLength", + "in": "query", + "description": "The maximum frame length in bytes (Optional).", + "type": "integer", + "format": "int32" + }, + { + "name": "sasUrl", + "in": "query", + "description": "The Blob URL to store capture file.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/startOperation": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Start capturing network packets for the site.", + "description": "Description for Start capturing network packets for the site.", + "operationId": "WebApps_StartWebSiteNetworkTraceOperationSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "durationInSeconds", + "in": "query", + "description": "The duration to keep capturing in seconds.", + "type": "integer", + "format": "int32" + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for this web app.", + "required": true, + "type": "string" + }, + { + "name": "maxFrameLength", + "in": "query", + "description": "The maximum frame length in bytes (Optional).", + "type": "integer", + "format": "int32" + }, + { + "name": "sasUrl", + "in": "query", + "description": "The Blob URL to store capture file.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Start a new network trace operation for a site": { + "$ref": "./examples/StartWebSiteNetworkTraceOperation.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/stop": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Stop ongoing capturing network packets for the site.", + "description": "Description for Stop ongoing capturing network packets for the site.", + "operationId": "WebApps_StopWebSiteNetworkTraceSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for this web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Stopped." + }, + "204": { + "description": "Stopped." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Stop a currently running network trace operation for a site": { + "$ref": "./examples/StopWebSiteNetworkTrace.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/{operationId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "operationId": "WebApps_GetNetworkTracesSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "GUID of the operation.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get NetworkTraces for a site": { + "$ref": "./examples/GetWebSiteNetworkTraces.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTraces/current/operationresults/{operationId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "operationId": "WebApps_GetNetworkTraceOperationSlotV2", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "GUID of the operation.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get the current status of a network trace operation for a site": { + "$ref": "./examples/GetWebSiteNetworkTraceOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTraces/{operationId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "operationId": "WebApps_GetNetworkTracesSlotV2", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "GUID of the operation.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get NetworkTraces for a site": { + "$ref": "./examples/GetWebSiteNetworkTraces.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/newpassword": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Generates a new publishing password for an app (or deployment slot, if specified).", + "description": "Description for Generates a new publishing password for an app (or deployment slot, if specified).", + "operationId": "WebApps_GenerateNewSitePublishingPasswordSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API generate a new publishing password for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully generate new password." + }, + "204": { + "description": "Successfully generate new password." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/perfcounters": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets perfmon counters for web app.", + "description": "Description for Gets perfmon counters for web app.", + "operationId": "WebApps_ListPerfMonCountersSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.", + "type": "string", + "x-ms-skip-url-encoding": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PerfMonCounterCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/phplogging": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets web app's event logs.", + "description": "Description for Gets web app's event logs.", + "operationId": "WebApps_GetSitePhpErrorLogFlagSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SitePhpErrorLogFlag" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the premier add-ons of an app.", + "description": "Description for Gets the premier add-ons of an app.", + "operationId": "WebApps_ListPremierAddOnsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the premier add-ons for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PremierAddOn" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a named add-on of an app.", + "description": "Description for Gets a named add-on of an app.", + "operationId": "WebApps_GetPremierAddOnSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "premierAddOnName", + "in": "path", + "description": "Add-on name.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the named add-on for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PremierAddOn" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Updates a named add-on of an app.", + "description": "Description for Updates a named add-on of an app.", + "operationId": "WebApps_AddPremierAddOnSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "premierAddOnName", + "in": "path", + "description": "Add-on name.", + "required": true, + "type": "string" + }, + { + "name": "premierAddOn", + "in": "body", + "description": "A JSON representation of the edited premier add-on.", + "required": true, + "schema": { + "$ref": "#/definitions/PremierAddOn" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the named add-on for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PremierAddOn" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Delete a premier add-on from an app.", + "description": "Description for Delete a premier add-on from an app.", + "operationId": "WebApps_DeletePremierAddOnSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "premierAddOnName", + "in": "path", + "description": "Add-on name.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the named add-on for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted premier add-on." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Updates a named add-on of an app.", + "description": "Description for Updates a named add-on of an app.", + "operationId": "WebApps_UpdatePremierAddOnSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "premierAddOnName", + "in": "path", + "description": "Add-on name.", + "required": true, + "type": "string" + }, + { + "name": "premierAddOn", + "in": "body", + "description": "A JSON representation of the edited premier add-on.", + "required": true, + "schema": { + "$ref": "#/definitions/PremierAddOnPatchResource" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the named add-on for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PremierAddOn" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateAccess/virtualNetworks": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets data around private site access enablement and authorized Virtual Networks that can access the site.", + "description": "Description for Gets data around private site access enablement and authorized Virtual Networks that can access the site.", + "operationId": "WebApps_GetPrivateAccessSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for the web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateAccess" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Sets data around private site access enablement and authorized Virtual Networks that can access the site.", + "description": "Description for Sets data around private site access enablement and authorized Virtual Networks that can access the site.", + "operationId": "WebApps_PutPrivateAccessVnetSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "access", + "in": "body", + "description": "The information for the private access", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateAccess" + } + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for the web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateAccess" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateEndpointConnections": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the list of private endpoint connections associated with a site", + "description": "Description for Gets the list of private endpoint connections associated with a site", + "operationId": "WebApps_GetPrivateEndpointConnectionListSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the site.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the site deployment slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PrivateEndpointConnectionCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a private endpoint connection", + "description": "Description for Gets a private endpoint connection", + "operationId": "WebApps_GetPrivateEndpointConnectionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the site.", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the site deployment slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a private endpoint connection for a site.": { + "$ref": "./examples/GetSitePrivateEndpointConnectionSlot.json" + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Approves or rejects a private endpoint connection", + "description": "Description for Approves or rejects a private endpoint connection", + "operationId": "WebApps_ApproveOrRejectPrivateEndpointConnectionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the site.", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointWrapper", + "in": "body", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource" + } + }, + { + "name": "slot", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource" + } + }, + "202": { + "description": "Asynchronous operation in progress.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Approves or rejects a private endpoint connection for a site.": { + "$ref": "./examples/ApproveRejectSitePrivateEndpointConnectionSlot.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a private endpoint connection", + "description": "Description for Deletes a private endpoint connection", + "operationId": "WebApps_DeletePrivateEndpointConnectionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the site.", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Asynchronous operation in progress.", + "schema": { + "type": "object" + } + }, + "204": { + "description": "No content.", + "schema": { + "type": "object" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a private endpoint connection for a site.": { + "$ref": "./examples/DeleteSitePrivateEndpointConnectionSlot.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateLinkResources": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the private link resources", + "description": "Description for Gets the private link resources", + "operationId": "WebApps_GetPrivateLinkResourcesSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the site.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PrivateLinkResourcesWrapper" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get private link resources of a site": { + "$ref": "./examples/GetSitePrivateLinkResourcesSlot.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.", + "description": "Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.", + "operationId": "WebApps_ListProcessesSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Process terminated.", + "schema": { + "$ref": "#/definitions/ProcessInfoCollection" + } + }, + "404": { + "description": "Process with the specified ID is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get process information by its ID for a specific scaled-out instance in a web site.", + "description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_GetProcessSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Process information returned.", + "schema": { + "$ref": "#/definitions/ProcessInfo" + } + }, + "404": { + "description": "Process with the specified ID is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", + "description": "Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", + "operationId": "WebApps_DeleteProcessSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Process terminated." + }, + "404": { + "description": "Process with the specified ID is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/dump": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", + "description": "Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_GetProcessDumpSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "file" + } + }, + "404": { + "description": "Process with the specified ID is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.", + "description": "Description for List module information for a process by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_ListProcessModulesSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Module information returned.", + "schema": { + "$ref": "#/definitions/ProcessModuleInfoCollection" + } + }, + "404": { + "description": "Process with the specified ID is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules/{baseAddress}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get process information by its ID for a specific scaled-out instance in a web site.", + "description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_GetProcessModuleSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "baseAddress", + "in": "path", + "description": "Module base address.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Module information returned.", + "schema": { + "$ref": "#/definitions/ProcessModuleInfo" + } + }, + "404": { + "description": "Process with the specified ID is not running, or a module with the specified baseAddress was not found.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/threads": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.", + "description": "Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_ListProcessThreadsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Thread information returned.", + "schema": { + "$ref": "#/definitions/ProcessThreadInfoCollection" + } + }, + "404": { + "description": "Process with the specified ID is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get public certificates for an app or a deployment slot.", + "description": "Description for Get public certificates for an app or a deployment slot.", + "operationId": "WebApps_ListPublicCertificatesSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API gets hostname bindings for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PublicCertificateCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get the named public certificate for an app (or deployment slot, if specified).", + "description": "Description for Get the named public certificate for an app (or deployment slot, if specified).", + "operationId": "WebApps_GetPublicCertificateSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.", + "required": true, + "type": "string" + }, + { + "name": "publicCertificateName", + "in": "path", + "description": "Public certificate name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PublicCertificate" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Creates a hostname binding for an app.", + "description": "Description for Creates a hostname binding for an app.", + "operationId": "WebApps_CreateOrUpdatePublicCertificateSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "publicCertificateName", + "in": "path", + "description": "Public certificate name.", + "required": true, + "type": "string" + }, + { + "name": "publicCertificate", + "in": "body", + "description": "Public certificate details. This is the JSON representation of a PublicCertificate object.", + "required": true, + "schema": { + "$ref": "#/definitions/PublicCertificate" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PublicCertificate" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a hostname binding for an app.", + "description": "Description for Deletes a hostname binding for an app.", + "operationId": "WebApps_DeletePublicCertificateSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", + "required": true, + "type": "string" + }, + { + "name": "publicCertificateName", + "in": "path", + "description": "Public certificate name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted hostname binding." + }, + "204": { + "description": "Hostname binding does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publishxml": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets the publishing profile for an app (or deployment slot, if specified).", + "description": "Description for Gets the publishing profile for an app (or deployment slot, if specified).", + "operationId": "WebApps_ListPublishingProfileXmlWithSecretsSlot", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "publishingProfileOptions", + "in": "body", + "description": "Specifies publishingProfileOptions for publishing profile. For example, use {\"format\": \"FileZilla3\"} to get a FileZilla publishing profile.", + "required": true, + "schema": { + "$ref": "#/definitions/CsmPublishingProfileOptions" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the publishing profile for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "file" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resetSlotConfig": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.", + "description": "Description for Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.", + "operationId": "WebApps_ResetSlotConfigurationSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API resets configuration settings for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restart": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Restarts an app (or deployment slot, if specified).", + "description": "Description for Restarts an app (or deployment slot, if specified).", + "operationId": "WebApps_RestartSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will restart the production slot.", + "required": true, + "type": "string" + }, + { + "name": "softRestart", + "in": "query", + "description": "Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.", + "type": "boolean" + }, + { + "name": "synchronous", + "in": "query", + "description": "Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully restarted app." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreFromBackupBlob": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Restores an app from a backup blob in Azure Storage.", + "description": "Description for Restores an app from a backup blob in Azure Storage.", + "operationId": "WebApps_RestoreFromBackupBlobSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Information on restore request .", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreRequest" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Restore operation started." + }, + "200": { + "description": "Restore operation started." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreFromDeletedApp": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Restores a deleted web app to this web app.", + "description": "Description for Restores a deleted web app to this web app.", + "operationId": "WebApps_RestoreFromDeletedAppSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "restoreRequest", + "in": "body", + "description": "Deleted web app restore information.", + "required": true, + "schema": { + "$ref": "#/definitions/DeletedAppRestoreRequest" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Restore operation started." + }, + "200": { + "description": "Restore operation started." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreSnapshot": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Restores a web app from a snapshot.", + "description": "Description for Restores a web app from a snapshot.", + "operationId": "WebApps_RestoreSnapshotSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "restoreRequest", + "in": "body", + "description": "Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.", + "required": true, + "schema": { + "$ref": "#/definitions/SnapshotRestoreRequest" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Restore operation started." + }, + "200": { + "description": "Restore operation started." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sitecontainers": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Lists all the site containers of a site, or a deployment slot.", + "operationId": "WebApps_ListSiteContainersSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get a list of site containers for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteContainerCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sitecontainers/{containerName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a site container of a site, or a deployment slot.", + "operationId": "WebApps_GetSiteContainerSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the Site Container for the production slot.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Site Container Name", + "required": true, + "type": "string", + "pattern": "(^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$)" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteContainer" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Creates or Updates a site container for a site, or a deployment slot.", + "operationId": "WebApps_CreateOrUpdateSiteContainerSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will create the container for the production slot.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Site Container Name", + "required": true, + "type": "string", + "pattern": "(^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$)" + }, + { + "name": "request", + "in": "body", + "description": "Container Entity", + "required": true, + "schema": { + "$ref": "#/definitions/SiteContainer" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Site container was created.", + "schema": { + "$ref": "#/definitions/SiteContainer" + } + }, + "200": { + "description": "Site container was updated.", + "schema": { + "$ref": "#/definitions/SiteContainer" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a site container for a site, or a deployment slot.", + "operationId": "WebApps_DeleteSiteContainerSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the container for the production slot.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Site Container Name", + "required": true, + "type": "string", + "pattern": "(^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$)" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted site container." + }, + "204": { + "description": "Site container does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get list of siteextensions for a web site, or a deployment slot.", + "description": "Description for Get list of siteextensions for a web site, or a deployment slot.", + "operationId": "WebApps_ListSiteExtensionsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "SiteExtension information returned.", + "schema": { + "$ref": "#/definitions/SiteExtensionInfoCollection" + } + }, + "404": { + "description": "SiteExtension not found.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get site extension information by its ID for a web site, or a deployment slot.", + "description": "Description for Get site extension information by its ID for a web site, or a deployment slot.", + "operationId": "WebApps_GetSiteExtensionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "siteExtensionId", + "in": "path", + "description": "Site extension name.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "SiteExtension information returned.", + "schema": { + "$ref": "#/definitions/SiteExtensionInfo" + } + }, + "404": { + "description": "SiteExtension with an ID of {siteExtensionId} is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Install site extension on a web site, or a deployment slot.", + "description": "Description for Install site extension on a web site, or a deployment slot.", + "operationId": "WebApps_InstallSiteExtensionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "siteExtensionId", + "in": "path", + "description": "Site extension name.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Site Extension created.", + "schema": { + "$ref": "#/definitions/SiteExtensionInfo" + } + }, + "200": { + "description": "Site Extension created.", + "schema": { + "$ref": "#/definitions/SiteExtensionInfo" + } + }, + "429": { + "description": "Site Extension is being installed on another request: Rejecting current request.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Remove a site extension from a web site, or a deployment slot.", + "description": "Description for Remove a site extension from a web site, or a deployment slot.", + "operationId": "WebApps_DeleteSiteExtensionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "siteExtensionId", + "in": "path", + "description": "Site extension name.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "SiteExtension terminated." + }, + "404": { + "description": "SiteExtension with an ID of {siteExtensionId} is not running.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsdiffs": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Get the difference in configuration settings between two web app slots.", + "description": "Description for Get the difference in configuration settings between two web app slots.", + "operationId": "WebApps_ListSlotDifferencesSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slotSwapEntity", + "in": "body", + "description": "JSON object that contains the target slot name. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/CsmSlotEntity" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the source slot. If a slot is not specified, the production slot is used as the source slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SlotDifferenceCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsswap": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Swaps two deployment slots of an app.", + "description": "Description for Swaps two deployment slots of an app.", + "operationId": "WebApps_SwapSlotSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slotSwapEntity", + "in": "body", + "description": "JSON object that contains the target slot name. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/CsmSlotEntity" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the source slot. If a slot is not specified, the production slot is used as the source slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Operation is in progress." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshots": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Returns all Snapshots to the user.", + "description": "Description for Returns all Snapshots to the user.", + "operationId": "WebApps_ListSnapshotsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Website Name.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Website Slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshotsdr": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Returns all Snapshots to the user from DRSecondary endpoint.", + "description": "Description for Returns all Snapshots to the user from DRSecondary endpoint.", + "operationId": "WebApps_ListSnapshotsFromDRSecondarySlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Website Name.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Website Slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the source control configuration of an app.", + "description": "Description for Gets the source control configuration of an app.", + "operationId": "WebApps_GetSourceControlSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the source control configuration for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved source control for web app.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "201": { + "description": "Create or update source control for web app still in progress.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "202": { + "description": "Create or update source control for web app still in progress.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Updates the source control configuration of an app.", + "description": "Description for Updates the source control configuration of an app.", + "operationId": "WebApps_CreateOrUpdateSourceControlSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "siteSourceControl", + "in": "body", + "description": "JSON representation of a SiteSourceControl object. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the source control configuration for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated source control for web app.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "201": { + "description": "Create or update source control for web app in progress.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "202": { + "description": "Create or update source control for web app in progress.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes the source control configuration of an app.", + "description": "Description for Deletes the source control configuration of an app.", + "operationId": "WebApps_DeleteSourceControlSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the source control configuration for the production slot.", + "required": true, + "type": "string" + }, + { + "name": "additionalFlags", + "in": "query", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted source control for web app." + }, + "202": { + "description": "Source control delete operation in progress." + }, + "404": { + "description": "Source control does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Updates the source control configuration of an app.", + "description": "Description for Updates the source control configuration of an app.", + "operationId": "WebApps_UpdateSourceControlSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "siteSourceControl", + "in": "body", + "description": "JSON representation of a SiteSourceControl object. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the source control configuration for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated source control for web app.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "201": { + "description": "Create or update source control for web app in progress.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "202": { + "description": "Create or update source control for web app in progress.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/start": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Starts an app (or deployment slot, if specified).", + "description": "Description for Starts an app (or deployment slot, if specified).", + "operationId": "WebApps_StartSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will start the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully started app." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/startNetworkTrace": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Start capturing network packets for the site.", + "description": "Description for Start capturing network packets for the site.", + "operationId": "WebApps_StartNetworkTraceSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "durationInSeconds", + "in": "query", + "description": "The duration to keep capturing in seconds.", + "type": "integer", + "format": "int32" + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for this web app.", + "required": true, + "type": "string" + }, + { + "name": "maxFrameLength", + "in": "query", + "description": "The maximum frame length in bytes (Optional).", + "type": "integer", + "format": "int32" + }, + { + "name": "sasUrl", + "in": "query", + "description": "The Blob URL to store capture file.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Start a new network trace operation for a site": { + "$ref": "./examples/StartWebSiteNetworkTraceOperation.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stop": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Stops an app (or deployment slot, if specified).", + "description": "Description for Stops an app (or deployment slot, if specified).", + "operationId": "WebApps_StopSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will stop the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully stopped app." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stopNetworkTrace": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Stop ongoing capturing network packets for the site.", + "description": "Description for Stop ongoing capturing network packets for the site.", + "operationId": "WebApps_StopNetworkTraceSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for this web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Stopped." + }, + "204": { + "description": "Stopped." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Stop a currently running network trace operation for a site": { + "$ref": "./examples/StopWebSiteNetworkTrace.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sync": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Sync web app repository.", + "description": "Description for Sync web app repository.", + "operationId": "WebApps_SyncRepositorySlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully sync source control." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/syncfunctiontriggers": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Syncs function trigger metadata to the management database", + "description": "Description for Syncs function trigger metadata to the management database", + "operationId": "WebApps_SyncFunctionTriggersSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/slotNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List triggered web jobs for an app, or a deployment slot.", + "description": "Description for List triggered web jobs for an app, or a deployment slot.", + "operationId": "WebApps_ListTriggeredWebJobsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TriggeredWebJobCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a triggered web job by its ID for an app, or a deployment slot.", + "description": "Description for Gets a triggered web job by its ID for an app, or a deployment slot.", + "operationId": "WebApps_GetTriggeredWebJobSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Found continuous web job.", + "schema": { + "$ref": "#/definitions/TriggeredWebJob" + } + }, + "404": { + "description": "Triggered web job does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Delete a triggered web job by its ID for an app, or a deployment slot.", + "description": "Description for Delete a triggered web job by its ID for an app, or a deployment slot.", + "operationId": "WebApps_DeleteTriggeredWebJobSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes web job for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted continuous web job." + }, + "204": { + "description": "Triggered web job does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List a triggered web job's history for an app, or a deployment slot.", + "description": "Description for List a triggered web job's history for an app, or a deployment slot.", + "operationId": "WebApps_ListTriggeredWebJobHistorySlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Found continuous web job.", + "schema": { + "$ref": "#/definitions/TriggeredJobHistoryCollection" + } + }, + "404": { + "description": "Triggered web job does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history/{id}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a triggered web job's history by its ID for an app, , or a deployment slot.", + "description": "Description for Gets a triggered web job's history by its ID for an app, , or a deployment slot.", + "operationId": "WebApps_GetTriggeredWebJobHistorySlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "History ID.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Found continuous web job.", + "schema": { + "$ref": "#/definitions/TriggeredJobHistory" + } + }, + "404": { + "description": "Triggered web job does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/run": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Run a triggered web job for an app, or a deployment slot.", + "description": "Description for Run a triggered web job for an app, or a deployment slot.", + "operationId": "WebApps_RunTriggeredWebJobSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Run a triggered web job." + }, + "404": { + "description": "Triggered web job does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/usages": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the quota usage information of an app (or deployment slot, if specified).", + "description": "Description for Gets the quota usage information of an app (or deployment slot, if specified).", + "operationId": "WebApps_ListUsagesSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get quota information of the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only information specified in the filter (using OData syntax). For example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.", + "type": "string", + "x-ms-skip-url-encoding": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/CsmUsageQuotaCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the virtual networks the app (or deployment slot) is connected to.", + "description": "Description for Gets the virtual networks the app (or deployment slot) is connected to.", + "operationId": "WebApps_ListVnetConnectionsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get virtual network connections for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/VnetInfoResource" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a virtual network the app (or deployment slot) is connected to by name.", + "description": "Description for Gets a virtual network the app (or deployment slot) is connected to by name.", + "operationId": "WebApps_GetVnetConnectionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the virtual network.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the named virtual network for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetInfoResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).", + "description": "Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).", + "operationId": "WebApps_CreateOrUpdateVnetConnectionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of an existing Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "Properties of the Virtual Network connection. See example.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetInfoResource" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetInfoResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a connection from an app (or deployment slot to a named virtual network.", + "description": "Description for Deletes a connection from an app (or deployment slot to a named virtual network.", + "operationId": "WebApps_DeleteVnetConnectionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the virtual network.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the connection for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted virtual network." + }, + "404": { + "description": "Virtual network does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).", + "description": "Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).", + "operationId": "WebApps_UpdateVnetConnectionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of an existing Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "Properties of the Virtual Network connection. See example.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetInfoResource" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetInfoResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets an app's Virtual Network gateway.", + "description": "Description for Gets an app's Virtual Network gateway.", + "operationId": "WebApps_GetVnetConnectionGatewaySlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "gatewayName", + "in": "path", + "description": "Name of the gateway. Currently, the only supported string is \"primary\".", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetGateway" + } + }, + "404": { + "description": "Named gateway does not exist. Only the \"primary\" gateway is supported currently.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).", + "description": "Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).", + "operationId": "WebApps_CreateOrUpdateVnetConnectionGatewaySlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "gatewayName", + "in": "path", + "description": "Name of the gateway. Currently, the only supported string is \"primary\".", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The properties to update this gateway with.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetGateway" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will add or update a gateway for the production slot's Virtual Network.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetGateway" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).", + "description": "Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).", + "operationId": "WebApps_UpdateVnetConnectionGatewaySlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "gatewayName", + "in": "path", + "description": "Name of the gateway. Currently, the only supported string is \"primary\".", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The properties to update this gateway with.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetGateway" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will add or update a gateway for the production slot's Virtual Network.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetGateway" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List webjobs for an app, or a deployment slot.", + "description": "Description for List webjobs for an app, or a deployment slot.", + "operationId": "WebApps_ListWebJobsSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebJobCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs/{webJobName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get webjob information for an app, or a deployment slot.", + "description": "Description for Get webjob information for an app, or a deployment slot.", + "operationId": "WebApps_GetWebJobSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of the web job.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebJob" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsdiffs": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Get the difference in configuration settings between two web app slots.", + "description": "Description for Get the difference in configuration settings between two web app slots.", + "operationId": "WebApps_ListSlotDifferencesFromProduction", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slotSwapEntity", + "in": "body", + "description": "JSON object that contains the target slot name. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/CsmSlotEntity" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SlotDifferenceCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsswap": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Swaps two deployment slots of an app.", + "description": "Description for Swaps two deployment slots of an app.", + "operationId": "WebApps_SwapSlotWithProduction", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slotSwapEntity", + "in": "body", + "description": "JSON object that contains the target slot name. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/CsmSlotEntity" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Operation is in progress." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshots": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Returns all Snapshots to the user.", + "description": "Description for Returns all Snapshots to the user.", + "operationId": "WebApps_ListSnapshots", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Website Name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshotsdr": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Returns all Snapshots to the user from DRSecondary endpoint.", + "description": "Description for Returns all Snapshots to the user from DRSecondary endpoint.", + "operationId": "WebApps_ListSnapshotsFromDRSecondary", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Website Name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the source control configuration of an app.", + "description": "Description for Gets the source control configuration of an app.", + "operationId": "WebApps_GetSourceControl", + "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": "Successfully retrieved source control for web app.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "201": { + "description": "Create or update source control for web app still in progress.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "202": { + "description": "Create or update source control for web app still in progress.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Updates the source control configuration of an app.", + "description": "Description for Updates the source control configuration of an app.", + "operationId": "WebApps_CreateOrUpdateSourceControl", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "siteSourceControl", + "in": "body", + "description": "JSON representation of a SiteSourceControl object. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated source control for web app.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "201": { + "description": "Create or update source control for web app in progress.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "202": { + "description": "Create or update source control for web app in progress.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes the source control configuration of an app.", + "description": "Description for Deletes the source control configuration of an app.", + "operationId": "WebApps_DeleteSourceControl", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "additionalFlags", + "in": "query", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted source control for web app." + }, + "202": { + "description": "Source control delete operation in progress." + }, + "404": { + "description": "Source control does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Updates the source control configuration of an app.", + "description": "Description for Updates the source control configuration of an app.", + "operationId": "WebApps_UpdateSourceControl", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "siteSourceControl", + "in": "body", + "description": "JSON representation of a SiteSourceControl object. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated source control for web app.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "201": { + "description": "Create or update source control for web app in progress.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "202": { + "description": "Create or update source control for web app in progress.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/start": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Starts an app (or deployment slot, if specified).", + "description": "Description for Starts an app (or deployment slot, if specified).", + "operationId": "WebApps_Start", + "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": "Successfully started app." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/startNetworkTrace": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Start capturing network packets for the site.", + "description": "Description for Start capturing network packets for the site.", + "operationId": "WebApps_StartNetworkTrace", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "durationInSeconds", + "in": "query", + "description": "The duration to keep capturing in seconds.", + "type": "integer", + "format": "int32" + }, + { + "name": "maxFrameLength", + "in": "query", + "description": "The maximum frame length in bytes (Optional).", + "type": "integer", + "format": "int32" + }, + { + "name": "sasUrl", + "in": "query", + "description": "The Blob URL to store capture file.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Start a new network trace operation for a site": { + "$ref": "./examples/StartWebSiteNetworkTraceOperation.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stop": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Stops an app (or deployment slot, if specified).", + "description": "Description for Stops an app (or deployment slot, if specified).", + "operationId": "WebApps_Stop", + "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": "Successfully stopped app." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stopNetworkTrace": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Stop ongoing capturing network packets for the site.", + "description": "Description for Stop ongoing capturing network packets for the site.", + "operationId": "WebApps_StopNetworkTrace", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Stopped." + }, + "204": { + "description": "Stopped." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Stop a currently running network trace operation for a site": { + "$ref": "./examples/StopWebSiteNetworkTrace.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sync": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Sync web app repository.", + "description": "Description for Sync web app repository.", + "operationId": "WebApps_SyncRepository", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully sync source control." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/syncfunctiontriggers": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Syncs function trigger metadata to the management database", + "description": "Description for Syncs function trigger metadata to the management database", + "operationId": "WebApps_SyncFunctionTriggers", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List triggered web jobs for an app, or a deployment slot.", + "description": "Description for List triggered web jobs for an app, or a deployment slot.", + "operationId": "WebApps_ListTriggeredWebJobs", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TriggeredWebJobCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a triggered web job by its ID for an app, or a deployment slot.", + "description": "Description for Gets a triggered web job by its ID for an app, or a deployment slot.", + "operationId": "WebApps_GetTriggeredWebJob", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Found continuous web job.", + "schema": { + "$ref": "#/definitions/TriggeredWebJob" + } + }, + "404": { + "description": "Triggered web job does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Delete a triggered web job by its ID for an app, or a deployment slot.", + "description": "Description for Delete a triggered web job by its ID for an app, or a deployment slot.", + "operationId": "WebApps_DeleteTriggeredWebJob", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted continuous web job." + }, + "204": { + "description": "Triggered web job does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List a triggered web job's history for an app, or a deployment slot.", + "description": "Description for List a triggered web job's history for an app, or a deployment slot.", + "operationId": "WebApps_ListTriggeredWebJobHistory", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Found continuous web job.", + "schema": { + "$ref": "#/definitions/TriggeredJobHistoryCollection" + } + }, + "404": { + "description": "Triggered web job does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history/{id}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a triggered web job's history by its ID for an app, , or a deployment slot.", + "description": "Description for Gets a triggered web job's history by its ID for an app, , or a deployment slot.", + "operationId": "WebApps_GetTriggeredWebJobHistory", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "History ID.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Found continuous web job.", + "schema": { + "$ref": "#/definitions/TriggeredJobHistory" + } + }, + "404": { + "description": "Triggered web job does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/run": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Run a triggered web job for an app, or a deployment slot.", + "description": "Description for Run a triggered web job for an app, or a deployment slot.", + "operationId": "WebApps_RunTriggeredWebJob", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Run a triggered web job." + }, + "404": { + "description": "Triggered web job does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/usages": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the quota usage information of an app (or deployment slot, if specified).", + "description": "Description for Gets the quota usage information of an app (or deployment slot, if specified).", + "operationId": "WebApps_ListUsages", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only information specified in the filter (using OData syntax). For example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.", + "type": "string", + "x-ms-skip-url-encoding": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/CsmUsageQuotaCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the virtual networks the app (or deployment slot) is connected to.", + "description": "Description for Gets the virtual networks the app (or deployment slot) is connected to.", + "operationId": "WebApps_ListVnetConnections", + "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": { + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/VnetInfoResource" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a virtual network the app (or deployment slot) is connected to by name.", + "description": "Description for Gets a virtual network the app (or deployment slot) is connected to by name.", + "operationId": "WebApps_GetVnetConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the virtual network.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetInfoResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).", + "description": "Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).", + "operationId": "WebApps_CreateOrUpdateVnetConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of an existing Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "Properties of the Virtual Network connection. See example.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetInfoResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetInfoResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a connection from an app (or deployment slot to a named virtual network.", + "description": "Description for Deletes a connection from an app (or deployment slot to a named virtual network.", + "operationId": "WebApps_DeleteVnetConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the virtual network.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted virtual network." + }, + "404": { + "description": "Virtual network does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).", + "description": "Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).", + "operationId": "WebApps_UpdateVnetConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of an existing Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "Properties of the Virtual Network connection. See example.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetInfoResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetInfoResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets an app's Virtual Network gateway.", + "description": "Description for Gets an app's Virtual Network gateway.", + "operationId": "WebApps_GetVnetConnectionGateway", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "gatewayName", + "in": "path", + "description": "Name of the gateway. Currently, the only supported string is \"primary\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetGateway" + } + }, + "404": { + "description": "Named gateway does not exist. Only the \"primary\" gateway is supported currently.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).", + "description": "Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).", + "operationId": "WebApps_CreateOrUpdateVnetConnectionGateway", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "gatewayName", + "in": "path", + "description": "Name of the gateway. Currently, the only supported string is \"primary\".", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The properties to update this gateway with.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetGateway" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetGateway" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).", + "description": "Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).", + "operationId": "WebApps_UpdateVnetConnectionGateway", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "gatewayName", + "in": "path", + "description": "Name of the gateway. Currently, the only supported string is \"primary\".", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The properties to update this gateway with.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetGateway" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/VnetGateway" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List webjobs for an app, or a deployment slot.", + "description": "Description for List webjobs for an app, or a deployment slot.", + "operationId": "WebApps_ListWebJobs", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebJobCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs/{webJobName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get webjob information for an app, or a deployment slot.", + "description": "Description for Get webjob information for an app, or a deployment slot.", + "operationId": "WebApps_GetWebJob", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of the web job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebJob" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployWorkflowArtifacts": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Creates the artifacts for web site, or a deployment slot.", + "description": "Description for Creates the artifacts for web site, or a deployment slot.", + "operationId": "WebApps_DeployWorkflowArtifacts", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "workflowArtifacts", + "in": "body", + "description": "Application settings and files of the workflow.", + "required": false, + "x-ms-secret": true, + "schema": { + "$ref": "#/definitions/WorkflowArtifacts" + } + } + ], + "responses": { + "200": { + "description": "Artifacts deployed." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Deploys workflow artifacts": { + "$ref": "./examples/PostDeployWorkflowArtifacts.json" + }, + "Delete workflow artifacts": { + "$ref": "./examples/DeleteDeployWorkflowArtifacts.json" + } + }, + "x-ms-long-running-operation": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployWorkflowArtifacts": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Creates the artifacts for web site, or a deployment slot.", + "description": "Description for Creates the artifacts for web site, or a deployment slot.", + "operationId": "WebApps_DeployWorkflowArtifactsSlot", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "$ref": "#/parameters/slotNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "workflowArtifacts", + "in": "body", + "description": "Application settings and files of the workflow.", + "required": false, + "x-ms-secret": true, + "schema": { + "$ref": "#/definitions/WorkflowArtifacts" + } + } + ], + "responses": { + "200": { + "description": "Artifacts deployed." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Deploys workflow artifacts slot": { + "$ref": "./examples/PostDeployWorkflowArtifactsSlot.json" + } + }, + "x-ms-long-running-operation": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/workflows": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List the workflows for a web site, or a deployment slot.", + "operationId": "WebApps_ListInstanceWorkflowsSlot", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "$ref": "#/parameters/slotNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Workflow information returned.", + "schema": { + "$ref": "#/definitions/WorkflowEnvelopeCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List the workflows Slot": { + "$ref": "./examples/ListWorkflows.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/workflows/{workflowName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get workflow information by its ID for web site, or a deployment slot.", + "operationId": "WebApps_GetInstanceWorkflowSlot", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "$ref": "#/parameters/slotNameParameter" + }, + { + "name": "workflowName", + "in": "path", + "description": "Workflow name.", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$", + "minLength": 3, + "maxLength": 63 + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Workflow information returned.", + "schema": { + "$ref": "#/definitions/WorkflowEnvelope" + } + }, + "404": { + "description": "Workflow with a name of {workflowName} does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "GET a workflow Slot": { + "$ref": "./examples/GetWorkflow.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listWorkflowsConnections": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Lists logic app's connections for web site, or a deployment slot.", + "operationId": "WebApps_ListWorkflowsConnectionsSlot", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "$ref": "#/parameters/slotNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Connections information returned.", + "schema": { + "$ref": "#/definitions/WorkflowEnvelope" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List the Instance Workflows Configuration Connections Slot": { + "$ref": "./examples/ListWorkflowsConfigurationConnections.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/workflows": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List the workflows for a web site, or a deployment slot.", + "operationId": "WebApps_ListWorkflows", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Workflow information returned.", + "schema": { + "$ref": "#/definitions/WorkflowEnvelopeCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List the workflows": { + "$ref": "./examples/ListWorkflows.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/workflows/{workflowName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get workflow information by its ID for web site, or a deployment slot.", + "operationId": "WebApps_GetWorkflow", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "in": "path", + "description": "Workflow name.", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$", + "minLength": 3, + "maxLength": 63 + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Workflow information returned.", + "schema": { + "$ref": "#/definitions/WorkflowEnvelope" + } + }, + "404": { + "description": "Workflow with a name of {workflowName} does not exist.", + "x-ms-error-response": true + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "GET a workflow": { + "$ref": "./examples/GetWorkflow.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listWorkflowsConnections": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Lists logic app's connections for web site, or a deployment slot.", + "operationId": "WebApps_ListWorkflowsConnections", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Connections information returned.", + "schema": { + "$ref": "#/definitions/WorkflowEnvelope" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List the Instance Workflows Configuration Connections": { + "$ref": "./examples/ListWorkflowsConfigurationConnections.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/regenerateAccessKey": { + "post": { + "tags": [ + "Workflows" + ], + "operationId": "Workflows_RegenerateAccessKey", + "description": "Regenerates the callback URL access key for request triggers.", + "x-ms-examples": { + "Regenerate the callback URL access key for request triggers": { + "$ref": "./examples/Workflows_RegenerateAccessKey.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "keyType", + "description": "The access key type.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateActionParameter" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs": { + "get": { + "tags": [ + "WorkflowRuns" + ], + "operationId": "WorkflowRuns_List", + "description": "Gets a list of workflow runs.", + "x-ms-examples": { + "List workflow runs": { + "$ref": "./examples/WorkflowRuns_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$top", + "description": "The number of items to be included in the result.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$filter", + "description": "The filter to apply on the operation. Options for filters include: Status, StartTime, and ClientTrackingId.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkflowRunListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/WorkflowRunFilter" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}": { + "get": { + "tags": [ + "WorkflowRuns" + ], + "operationId": "WorkflowRuns_Get", + "description": "Gets a workflow run.", + "x-ms-examples": { + "Get a run for a workflow": { + "$ref": "./examples/WorkflowRuns_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkflowRun" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions": { + "get": { + "tags": [ + "WorkflowRunActions" + ], + "operationId": "WorkflowRunActions_List", + "description": "Gets a list of workflow run actions.", + "x-ms-examples": { + "List a workflow run actions": { + "$ref": "./examples/WorkflowRunActions_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$top", + "description": "The number of items to be included in the result.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$filter", + "description": "The filter to apply on the operation. Options for filters include: Status.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkflowRunActionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/WorkflowRunActionFilter" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}": { + "get": { + "tags": [ + "WorkflowRunActions" + ], + "operationId": "WorkflowRunActions_Get", + "description": "Gets a workflow run action.", + "x-ms-examples": { + "Get a workflow run action": { + "$ref": "./examples/WorkflowRunActions_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "actionName", + "description": "The workflow action name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkflowRunAction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/listExpressionTraces": { + "post": { + "tags": [ + "WorkflowRunActions" + ], + "operationId": "WorkflowRunActions_ListExpressionTraces", + "description": "Lists a workflow run expression trace.", + "x-ms-examples": { + "List expression traces": { + "$ref": "./examples/WorkflowRunActions_ListExpressionTraces.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "actionName", + "description": "The workflow action name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExpressionTraces" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "inputs" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions": { + "get": { + "tags": [ + "WorkflowRunActions" + ], + "operationId": "WorkflowRunActionRepetitions_List", + "description": "Get all of a workflow run action repetitions.", + "x-ms-examples": { + "List repetitions": { + "$ref": "./examples/WorkflowRunActionRepetitions_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "actionName", + "description": "The workflow action name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkflowRunActionRepetitionDefinitionCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}": { + "get": { + "tags": [ + "WorkflowRunActions" + ], + "operationId": "WorkflowRunActionRepetitions_Get", + "description": "Get a workflow run action repetition.", + "x-ms-examples": { + "Get a repetition": { + "$ref": "./examples/WorkflowRunActionRepetitions_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "actionName", + "description": "The workflow action name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "repetitionName", + "description": "The workflow repetition.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkflowRunActionRepetitionDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/listExpressionTraces": { + "post": { + "tags": [ + "WorkflowRunActions" + ], + "operationId": "WorkflowRunActionRepetitions_ListExpressionTraces", + "description": "Lists a workflow run expression trace.", + "x-ms-examples": { + "List expression traces for a repetition": { + "$ref": "./examples/WorkflowRunActionRepetitions_ListExpressionTraces.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "actionName", + "description": "The workflow action name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "repetitionName", + "description": "The workflow repetition.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExpressionTraces" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "inputs" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories": { + "get": { + "tags": [ + "WorkflowRunActions" + ], + "operationId": "WorkflowRunActionRepetitionsRequestHistories_List", + "description": "List a workflow run repetition request history.", + "x-ms-examples": { + "List repetition request history": { + "$ref": "./examples/WorkflowRunActionRepetitionsRequestHistories_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "actionName", + "description": "The workflow action name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "repetitionName", + "description": "The workflow repetition.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RequestHistoryListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories/{requestHistoryName}": { + "get": { + "tags": [ + "WorkflowRunActions" + ], + "operationId": "WorkflowRunActionRepetitionsRequestHistories_Get", + "description": "Gets a workflow run repetition request history.", + "x-ms-examples": { + "Get a repetition request history": { + "$ref": "./examples/WorkflowRunActionRepetitionsRequestHistories_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "actionName", + "description": "The workflow action name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "repetitionName", + "description": "The workflow repetition.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "requestHistoryName", + "description": "The request history name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RequestHistory" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/scopeRepetitions": { + "get": { + "tags": [ + "WorkflowRunActions" + ], + "operationId": "WorkflowRunActionScopeRepetitions_List", + "description": "List the workflow run action scoped repetitions.", + "x-ms-examples": { + "List the scoped repetitions": { + "$ref": "./examples/WorkflowRunActionScopeRepetitions_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "actionName", + "description": "The workflow action name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkflowRunActionRepetitionDefinitionCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/scopeRepetitions/{repetitionName}": { + "get": { + "tags": [ + "WorkflowRunActions" + ], + "operationId": "WorkflowRunActionScopeRepetitions_Get", + "description": "Get a workflow run action scoped repetition.", + "x-ms-examples": { + "Get a scoped repetition": { + "$ref": "./examples/WorkflowRunActionScopeRepetitions_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "actionName", + "description": "The workflow action name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "repetitionName", + "description": "The workflow repetition.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkflowRunActionRepetitionDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/cancel": { + "post": { + "tags": [ + "WorkflowRuns" + ], + "operationId": "WorkflowRuns_Cancel", + "description": "Cancels a workflow run.", + "x-ms-examples": { + "Cancel a workflow run": { + "$ref": "./examples/WorkflowRuns_Cancel.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers": { + "get": { + "tags": [ + "WorkflowTriggers" + ], + "operationId": "WorkflowTriggers_List", + "description": "Gets a list of workflow triggers.", + "x-ms-examples": { + "List workflow triggers": { + "$ref": "./examples/WorkflowTriggers_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$top", + "description": "The number of items to be included in the result.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$filter", + "description": "The filter to apply on the operation.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkflowTriggerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/WorkflowTriggerFilter" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}": { + "get": { + "tags": [ + "WorkflowTriggers" + ], + "operationId": "WorkflowTriggers_Get", + "description": "Gets a workflow trigger.", + "x-ms-examples": { + "Get a workflow trigger": { + "$ref": "./examples/WorkflowTriggers_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "triggerName", + "description": "The workflow trigger name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkflowTrigger" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/histories": { + "get": { + "tags": [ + "WorkflowTriggerHistories" + ], + "operationId": "WorkflowTriggerHistories_List", + "description": "Gets a list of workflow trigger histories.", + "x-ms-examples": { + "List a workflow trigger history": { + "$ref": "./examples/WorkflowTriggerHistories_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "triggerName", + "description": "The workflow trigger name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$top", + "description": "The number of items to be included in the result.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$filter", + "description": "The filter to apply on the operation. Options for filters include: Status, StartTime, and ClientTrackingId.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkflowTriggerHistoryListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/WorkflowTriggerHistoryFilter" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/histories/{historyName}": { + "get": { + "tags": [ + "WorkflowTriggerHistories" + ], + "operationId": "WorkflowTriggerHistories_Get", + "description": "Gets a workflow trigger history.", + "x-ms-examples": { + "Get a workflow trigger history": { + "$ref": "./examples/WorkflowTriggerHistories_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "triggerName", + "description": "The workflow trigger name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "historyName", + "description": "The workflow trigger history name. Corresponds to the run name for triggers that resulted in a run.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkflowTriggerHistory" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/histories/{historyName}/resubmit": { + "post": { + "tags": [ + "WorkflowTriggerHistories" + ], + "operationId": "WorkflowTriggerHistories_Resubmit", + "description": "Resubmits a workflow run based on the trigger history.", + "x-ms-examples": { + "Resubmit a workflow run based on the trigger history": { + "$ref": "./examples/WorkflowTriggerHistories_Resubmit.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "triggerName", + "description": "The workflow trigger name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "historyName", + "description": "The workflow trigger history name. Corresponds to the run name for triggers that resulted in a run.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/listCallbackUrl": { + "post": { + "tags": [ + "WorkflowTriggers" + ], + "operationId": "WorkflowTriggers_ListCallbackUrl", + "description": "Get the callback URL for a workflow trigger.", + "x-ms-examples": { + "Get the callback URL for a trigger": { + "$ref": "./examples/WorkflowTriggers_ListCallbackUrl.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "triggerName", + "description": "The workflow trigger name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkflowTriggerCallbackUrl" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/run": { + "post": { + "tags": [ + "WorkflowTriggers" + ], + "operationId": "WorkflowTriggers_Run", + "description": "Runs a workflow trigger.", + "x-ms-examples": { + "Run a workflow trigger": { + "$ref": "./examples/WorkflowTriggers_Run.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "triggerName", + "description": "The workflow trigger name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the trigger run failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/schemas/json": { + "get": { + "tags": [ + "WorkflowTriggers" + ], + "operationId": "WorkflowTriggers_GetSchemaJson", + "description": "Get the trigger schema as JSON.", + "x-ms-examples": { + "Get trigger schema": { + "$ref": "./examples/WorkflowTriggers_GetSchemaJson.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "triggerName", + "description": "The workflow trigger name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JsonSchema" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/validate": { + "post": { + "tags": [ + "Workflows" + ], + "operationId": "Workflows_Validate", + "description": "Validates the workflow definition.", + "x-ms-examples": { + "Validate a workflow": { + "$ref": "./examples/Workflows_Validate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "validate", + "description": "The workflow.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Workflow" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/versions": { + "get": { + "tags": [ + "WorkflowVersions" + ], + "operationId": "WorkflowVersions_List", + "description": "Gets a list of workflow versions.", + "x-ms-examples": { + "List a workflows versions": { + "$ref": "./examples/WorkflowVersions_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$top", + "description": "The number of items to be included in the result.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkflowVersionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/versions/{versionId}": { + "get": { + "tags": [ + "WorkflowVersions" + ], + "operationId": "WorkflowVersions_Get", + "description": "Gets a workflow version.", + "x-ms-examples": { + "Get a workflow version": { + "$ref": "./examples/WorkflowVersions_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/siteNameParameter" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "versionId", + "description": "The workflow versionId.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkflowVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "AllowedAudiencesValidation": { + "description": "The configuration settings of the Allowed Audiences validation flow.", + "type": "object", + "properties": { + "allowedAudiences": { + "description": "The configuration settings of the allowed list of audiences from which to validate the JWT token.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AllowedPrincipals": { + "description": "The configuration settings of the Azure Active Directory allowed principals.", + "type": "object", + "properties": { + "groups": { + "description": "The list of the allowed groups.", + "type": "array", + "items": { + "type": "string" + } + }, + "identities": { + "description": "The list of the allowed identities.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ApiKVReference": { + "description": "Description of site key vault references.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "ApiKVReference resource specific properties", + "type": "object", + "properties": { + "reference": { + "type": "string" + }, + "status": { + "enum": [ + "Initialized", + "Resolved", + "InvalidSyntax", + "MSINotEnabled", + "VaultNotFound", + "SecretNotFound", + "SecretVersionNotFound", + "AccessToKeyVaultDenied", + "OtherReasons", + "FetchTimedOut", + "UnauthorizedClient" + ], + "type": "string", + "x-ms-enum": { + "name": "ResolveStatus", + "modelAsString": false + } + }, + "vaultName": { + "type": "string" + }, + "secretName": { + "type": "string" + }, + "secretVersion": { + "type": "string" + }, + "identityType": { + "$ref": "./CommonDefinitions.json#/definitions/ManagedServiceIdentity" + }, + "details": { + "type": "string" + }, + "source": { + "enum": [ + "KeyVault" + ], + "type": "string", + "x-ms-enum": { + "name": "ConfigReferenceSource", + "modelAsString": false + } + }, + "activeVersion": { + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "ApiKVReferenceCollection": { + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ApiKVReference" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "AppRegistration": { + "description": "The configuration settings of the app registration for providers that have app ids and app secrets", + "type": "object", + "properties": { + "appId": { + "description": "The App ID of the app used for login.", + "type": "string" + }, + "appSecretSettingName": { + "description": "The app setting name that contains the app secret.", + "type": "string" + } + } + }, + "Apple": { + "description": "The configuration settings of the Apple provider.", + "type": "object", + "properties": { + "enabled": { + "description": "false if the Apple provider should not be enabled despite the set registration; otherwise, true.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/AppleRegistration", + "description": "The configuration settings of the Apple registration." + }, + "login": { + "$ref": "#/definitions/LoginScopes", + "description": "The configuration settings of the login flow." + } + } + }, + "AppleRegistration": { + "description": "The configuration settings of the registration for the Apple provider", + "type": "object", + "properties": { + "clientId": { + "description": "The Client ID of the app used for login.", + "type": "string" + }, + "clientSecretSettingName": { + "description": "The app setting name that contains the client secret.", + "type": "string" + } + } + }, + "ApplicationLogsConfig": { + "description": "Application logs configuration.", + "type": "object", + "properties": { + "fileSystem": { + "$ref": "#/definitions/FileSystemApplicationLogsConfig", + "description": "Application logs to file system configuration." + }, + "azureTableStorage": { + "$ref": "#/definitions/AzureTableStorageApplicationLogsConfig", + "description": "Application logs to azure table storage configuration." + }, + "azureBlobStorage": { + "$ref": "#/definitions/AzureBlobStorageApplicationLogsConfig", + "description": "Application logs to blob storage configuration." + } + } + }, + "AuthPlatform": { + "description": "The configuration settings of the platform of App Service Authentication/Authorization.", + "type": "object", + "properties": { + "enabled": { + "description": "true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.", + "type": "boolean" + }, + "runtimeVersion": { + "description": "The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module.", + "type": "string" + }, + "configFilePath": { + "description": "The path of the config file containing auth settings if they come from a file.\nIf the path is relative, base will the site's root directory.", + "type": "string" + } + } + }, + "AzureActiveDirectory": { + "description": "The configuration settings of the Azure Active directory provider.", + "type": "object", + "properties": { + "enabled": { + "description": "false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/AzureActiveDirectoryRegistration", + "description": "The configuration settings of the Azure Active Directory app registration." + }, + "login": { + "$ref": "#/definitions/AzureActiveDirectoryLogin", + "description": "The configuration settings of the Azure Active Directory login flow." + }, + "validation": { + "$ref": "#/definitions/AzureActiveDirectoryValidation", + "description": "The configuration settings of the Azure Active Directory token validation flow." + }, + "isAutoProvisioned": { + "description": "Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling.\nThis is an internal flag primarily intended to support the Azure Management Portal. Users should not\nread or write to this property.", + "type": "boolean" + } + } + }, + "AzureActiveDirectoryLogin": { + "description": "The configuration settings of the Azure Active Directory login flow.", + "type": "object", + "properties": { + "loginParameters": { + "description": "Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\".", + "type": "array", + "items": { + "type": "string" + } + }, + "disableWWWAuthenticate": { + "description": "true if the www-authenticate provider should be omitted from the request; otherwise, false.", + "type": "boolean" + } + } + }, + "AzureActiveDirectoryRegistration": { + "description": "The configuration settings of the Azure Active Directory app registration.", + "type": "object", + "properties": { + "openIdIssuer": { + "description": "The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html", + "type": "string" + }, + "clientId": { + "description": "The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html", + "type": "string" + }, + "clientSecretSettingName": { + "description": "The app setting name that contains the client secret of the relying party application.", + "type": "string" + }, + "clientSecretCertificateThumbprint": { + "description": "An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional.", + "type": "string" + }, + "clientSecretCertificateSubjectAlternativeName": { + "description": "An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional.", + "type": "string" + }, + "clientSecretCertificateIssuer": { + "description": "An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional.", + "type": "string" + } + } + }, + "AzureActiveDirectoryValidation": { + "description": "The configuration settings of the Azure Active Directory token validation flow.", + "type": "object", + "properties": { + "jwtClaimChecks": { + "$ref": "#/definitions/JwtClaimChecks", + "description": "The configuration settings of the checks that should be made while validating the JWT Claims." + }, + "allowedAudiences": { + "description": "The list of audiences that can make successful authentication/authorization requests.", + "type": "array", + "items": { + "type": "string" + } + }, + "defaultAuthorizationPolicy": { + "$ref": "#/definitions/DefaultAuthorizationPolicy", + "description": "The configuration settings of the default authorization policy." + } + } + }, + "AzureBlobStorageApplicationLogsConfig": { + "description": "Application logs azure blob storage configuration.", + "type": "object", + "properties": { + "level": { + "description": "Log level.", + "enum": [ + "Off", + "Verbose", + "Information", + "Warning", + "Error" + ], + "type": "string", + "x-ms-enum": { + "name": "LogLevel", + "modelAsString": false + } + }, + "sasUrl": { + "description": "SAS url to a azure blob container with read/write/list/delete permissions.", + "type": "string" + }, + "retentionInDays": { + "format": "int32", + "description": "Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention.", + "type": "integer" + } + } + }, + "AzureBlobStorageHttpLogsConfig": { + "description": "Http logs to azure blob storage configuration.", + "type": "object", + "properties": { + "sasUrl": { + "description": "SAS url to a azure blob container with read/write/list/delete permissions.", + "type": "string" + }, + "retentionInDays": { + "format": "int32", + "description": "Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention.", + "type": "integer" + }, + "enabled": { + "description": "True if configuration is enabled, false if it is disabled and null if configuration is not set.", + "type": "boolean" + } + } + }, + "AzureResourceErrorInfo": { + "type": "object", + "description": "The azure resource error info.", + "additionalProperties": false, + "required": [ + "message" + ], + "properties": { + "message": { + "type": "string", + "description": "The error message." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureResourceErrorInfo" + }, + "x-ms-identifiers": [ + "code" + ], + "description": "The error details." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ErrorInfo" + } + ] + }, + "AzureStaticWebApps": { + "description": "The configuration settings of the Azure Static Web Apps provider.", + "type": "object", + "properties": { + "enabled": { + "description": "false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/AzureStaticWebAppsRegistration", + "description": "The configuration settings of the Azure Static Web Apps registration." + } + } + }, + "AzureStaticWebAppsRegistration": { + "description": "The configuration settings of the registration for the Azure Static Web Apps provider", + "type": "object", + "properties": { + "clientId": { + "description": "The Client ID of the app used for login.", + "type": "string" + } + } + }, + "AzureStoragePropertyDictionaryResource": { + "description": "AzureStorageInfo dictionary resource.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "Azure storage accounts.", + "type": "object", + "additionalProperties": { + "$ref": "./CommonDefinitions.json#/definitions/AzureStorageInfoValue" + }, + "x-ms-client-flatten": true + } + } + }, + "AzureTableStorageApplicationLogsConfig": { + "description": "Application logs to Azure table storage configuration.", + "required": [ + "sasUrl" + ], + "type": "object", + "properties": { + "level": { + "description": "Log level.", + "enum": [ + "Off", + "Verbose", + "Information", + "Warning", + "Error" + ], + "type": "string", + "x-ms-enum": { + "name": "LogLevel", + "modelAsString": false + } + }, + "sasUrl": { + "description": "SAS URL to an Azure table with add/query/delete permissions.", + "type": "string" + } + } + }, + "BackupItem": { + "description": "Backup description.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "BackupItem resource specific properties", + "type": "object", + "properties": { + "id": { + "format": "int32", + "description": "Id of the backup.", + "type": "integer", + "readOnly": true, + "x-ms-client-name": "BackupId" + }, + "storageAccountUrl": { + "description": "SAS URL for the storage account container which contains this backup.", + "type": "string", + "readOnly": true + }, + "blobName": { + "description": "Name of the blob which contains data for this backup.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of this backup.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Backup status.", + "enum": [ + "InProgress", + "Failed", + "Succeeded", + "TimedOut", + "Created", + "Skipped", + "PartiallySucceeded", + "DeleteInProgress", + "DeleteFailed", + "Deleted" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BackupItemStatus", + "modelAsString": false + } + }, + "sizeInBytes": { + "format": "int64", + "description": "Size of the backup in bytes.", + "type": "integer", + "readOnly": true + }, + "created": { + "format": "date-time", + "description": "Timestamp of the backup creation.", + "type": "string", + "readOnly": true + }, + "log": { + "description": "Details regarding this backup. Might contain an error message.", + "type": "string", + "readOnly": true + }, + "databases": { + "description": "List of databases included in the backup.", + "type": "array", + "items": { + "$ref": "#/definitions/DatabaseBackupSetting" + }, + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] + }, + "scheduled": { + "description": "True if this backup has been created due to a schedule being triggered.", + "type": "boolean", + "readOnly": true + }, + "lastRestoreTimeStamp": { + "format": "date-time", + "description": "Timestamp of a last restore operation which used this backup.", + "type": "string", + "readOnly": true + }, + "finishedTimeStamp": { + "format": "date-time", + "description": "Timestamp when this backup finished.", + "type": "string", + "readOnly": true + }, + "correlationId": { + "description": "Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support.", + "type": "string", + "readOnly": true + }, + "websiteSizeInBytes": { + "format": "int64", + "description": "Size of the original web app which has been backed up.", + "type": "integer", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "BackupItemCollection": { + "description": "Collection of backup items.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/BackupItem" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "BackupRequest": { + "description": "Description of a backup which will be performed.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "BackupRequest resource specific properties", + "required": [ + "storageAccountUrl" + ], + "type": "object", + "properties": { + "backupName": { + "description": "Name of the backup.", + "type": "string" + }, + "enabled": { + "description": "True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.", + "type": "boolean" + }, + "storageAccountUrl": { + "description": "SAS URL to the container.", + "type": "string" + }, + "backupSchedule": { + "$ref": "#/definitions/BackupSchedule", + "description": "Schedule for the backup if it is executed periodically." + }, + "databases": { + "description": "Databases included in the backup.", + "type": "array", + "items": { + "$ref": "#/definitions/DatabaseBackupSetting" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "x-ms-client-flatten": true + } + } + }, + "BackupSchedule": { + "description": "Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.", + "required": [ + "frequencyInterval", + "frequencyUnit", + "keepAtLeastOneBackup", + "retentionPeriodInDays" + ], + "type": "object", + "properties": { + "frequencyInterval": { + "format": "int32", + "description": "How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)", + "default": 7, + "type": "integer" + }, + "frequencyUnit": { + "description": "The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)", + "default": "Day", + "enum": [ + "Day", + "Hour" + ], + "type": "string", + "x-ms-enum": { + "name": "FrequencyUnit", + "modelAsString": false + } + }, + "keepAtLeastOneBackup": { + "description": "True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.", + "default": true, + "type": "boolean" + }, + "retentionPeriodInDays": { + "format": "int32", + "description": "After how many days backups should be deleted.", + "default": 30, + "type": "integer" + }, + "startTime": { + "format": "date-time", + "description": "When the schedule should start working.", + "type": "string" + }, + "lastExecutionTime": { + "format": "date-time", + "description": "Last time when this schedule was triggered.", + "type": "string", + "readOnly": true + } + } + }, + "BlobStorageTokenStore": { + "description": "The configuration settings of the storage of the tokens if blob storage is used.", + "type": "object", + "properties": { + "sasUrlSettingName": { + "description": "The name of the app setting containing the SAS URL of the blob storage containing the tokens.", + "type": "string" + } + } + }, + "ClientRegistration": { + "description": "The configuration settings of the app registration for providers that have client ids and client secrets", + "type": "object", + "properties": { + "clientId": { + "description": "The Client ID of the app used for login.", + "type": "string" + }, + "clientSecretSettingName": { + "description": "The app setting name that contains the client secret.", + "type": "string" + } + } + }, + "ConnStringValueTypePair": { + "description": "Database connection string value to type pair.", + "required": [ + "value", + "type" + ], + "type": "object", + "properties": { + "value": { + "description": "Value of pair.", + "type": "string" + }, + "type": { + "description": "Type of database.", + "enum": [ + "MySql", + "SQLServer", + "SQLAzure", + "Custom", + "NotificationHub", + "ServiceBus", + "EventHub", + "ApiHub", + "DocDb", + "RedisCache", + "PostgreSQL" + ], + "type": "string", + "x-ms-enum": { + "name": "ConnectionStringType", + "modelAsString": false + } + } + } + }, + "ConnectionStringDictionary": { + "description": "String dictionary resource.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "Connection strings.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ConnStringValueTypePair" + }, + "x-ms-client-flatten": true + } + } + }, + "ContainerCpuStatistics": { + "type": "object", + "properties": { + "cpuUsage": { + "$ref": "#/definitions/ContainerCpuUsage" + }, + "systemCpuUsage": { + "format": "int64", + "type": "integer" + }, + "onlineCpuCount": { + "format": "int32", + "type": "integer" + }, + "throttlingData": { + "$ref": "#/definitions/ContainerThrottlingData" + } + } + }, + "ContainerCpuUsage": { + "type": "object", + "properties": { + "totalUsage": { + "format": "int64", + "type": "integer" + }, + "perCpuUsage": { + "type": "array", + "items": { + "format": "int64", + "type": "integer" + } + }, + "kernelModeUsage": { + "format": "int64", + "type": "integer" + }, + "userModeUsage": { + "format": "int64", + "type": "integer" + } + } + }, + "ContainerInfo": { + "type": "object", + "properties": { + "currentTimeStamp": { + "format": "date-time", + "type": "string" + }, + "previousTimeStamp": { + "format": "date-time", + "type": "string" + }, + "currentCpuStats": { + "$ref": "#/definitions/ContainerCpuStatistics" + }, + "previousCpuStats": { + "$ref": "#/definitions/ContainerCpuStatistics" + }, + "memoryStats": { + "$ref": "#/definitions/ContainerMemoryStatistics" + }, + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "eth0": { + "$ref": "#/definitions/ContainerNetworkInterfaceStatistics" + } + } + }, + "ContainerMemoryStatistics": { + "type": "object", + "properties": { + "usage": { + "format": "int64", + "type": "integer" + }, + "maxUsage": { + "format": "int64", + "type": "integer" + }, + "limit": { + "format": "int64", + "type": "integer" + } + } + }, + "ContainerNetworkInterfaceStatistics": { + "type": "object", + "properties": { + "rxBytes": { + "format": "int64", + "type": "integer" + }, + "rxPackets": { + "format": "int64", + "type": "integer" + }, + "rxErrors": { + "format": "int64", + "type": "integer" + }, + "rxDropped": { + "format": "int64", + "type": "integer" + }, + "txBytes": { + "format": "int64", + "type": "integer" + }, + "txPackets": { + "format": "int64", + "type": "integer" + }, + "txErrors": { + "format": "int64", + "type": "integer" + }, + "txDropped": { + "format": "int64", + "type": "integer" + } + } + }, + "ContainerThrottlingData": { + "type": "object", + "properties": { + "periods": { + "format": "int32", + "type": "integer" + }, + "throttledPeriods": { + "format": "int32", + "type": "integer" + }, + "throttledTime": { + "format": "int32", + "type": "integer" + } + } + }, + "ContentLink": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "The content link URI." + }, + "contentVersion": { + "type": "string", + "description": "The content version.", + "readOnly": true + }, + "contentSize": { + "type": "integer", + "format": "int64", + "description": "The content size.", + "readOnly": true + }, + "contentHash": { + "$ref": "#/definitions/ContentHash", + "description": "The content hash.", + "readOnly": true + }, + "metadata": { + "$ref": "#/definitions/Object", + "description": "The metadata.", + "readOnly": true + } + }, + "description": "The content link." + }, + "ContentHash": { + "type": "object", + "properties": { + "algorithm": { + "type": "string", + "description": "The algorithm of the content hash." + }, + "value": { + "type": "string", + "description": "The value of the content hash." + } + }, + "description": "The content hash." + }, + "ContinuousWebJob": { + "description": "Continuous Web Job Information.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "ContinuousWebJob resource specific properties", + "type": "object", + "properties": { + "status": { + "description": "Job status.", + "enum": [ + "Initializing", + "Starting", + "Running", + "PendingRestart", + "Stopped" + ], + "type": "string", + "x-ms-enum": { + "name": "ContinuousWebJobStatus", + "modelAsString": false + } + }, + "detailed_status": { + "description": "Detailed status.", + "type": "string" + }, + "log_url": { + "description": "Log URL.", + "type": "string" + }, + "run_command": { + "description": "Run command.", + "type": "string" + }, + "url": { + "description": "Job URL.", + "type": "string" + }, + "extra_info_url": { + "description": "Extra Info URL.", + "type": "string" + }, + "web_job_type": { + "description": "Job type.", + "enum": [ + "Continuous", + "Triggered" + ], + "type": "string", + "x-ms-enum": { + "name": "WebJobType", + "modelAsString": false + } + }, + "error": { + "description": "Error information.", + "type": "string" + }, + "using_sdk": { + "description": "Using SDK?", + "type": "boolean" + }, + "settings": { + "description": "Job settings.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "ContinuousWebJobCollection": { + "description": "Collection of Kudu continuous web job information elements.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ContinuousWebJob" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "CookieExpiration": { + "description": "The configuration settings of the session cookie's expiration.", + "type": "object", + "properties": { + "convention": { + "description": "The convention used when determining the session cookie's expiration.", + "enum": [ + "FixedTime", + "IdentityProviderDerived" + ], + "type": "string", + "x-ms-enum": { + "name": "CookieExpirationConvention", + "modelAsString": false + } + }, + "timeToExpiration": { + "description": "The time after the request is made when the session cookie should expire.", + "type": "string" + } + } + }, + "Correlation": { + "type": "object", + "properties": { + "clientTrackingId": { + "type": "string", + "description": "The client tracking id." + } + }, + "description": "The correlation property." + }, + "CsmDeploymentStatus": { + "description": "Deployment status response payload.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "CsmDeploymentStatus resource specific properties", + "type": "object", + "properties": { + "deploymentId": { + "description": "Deployment operation id.", + "type": "string" + }, + "status": { + "description": "Deployment build status.", + "enum": [ + "TimedOut", + "RuntimeFailed", + "BuildAborted", + "BuildFailed", + "BuildRequestReceived", + "BuildPending", + "BuildInProgress", + "BuildSuccessful", + "PostBuildRestartRequired", + "StartPolling", + "StartPollingWithRestart", + "RuntimeStarting", + "RuntimeSuccessful" + ], + "type": "string", + "x-ms-enum": { + "name": "DeploymentBuildStatus", + "modelAsString": true + } + }, + "numberOfInstancesInProgress": { + "format": "int32", + "description": "Number of site instances currently being provisioned.", + "type": "integer" + }, + "numberOfInstancesSuccessful": { + "format": "int32", + "description": "Number of site instances provisioned successfully.", + "type": "integer" + }, + "numberOfInstancesFailed": { + "format": "int32", + "description": "Number of site instances failed to provision.", + "type": "integer" + }, + "failedInstancesLogs": { + "description": "List of URLs pointing to logs for instances which failed to provision.", + "type": "array", + "items": { + "type": "string" + } + }, + "errors": { + "description": "List of errors.", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/ErrorEntity" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-client-flatten": true + } + } + }, + "CsmDeploymentStatusCollection": { + "description": "Deployment status collection ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/CsmDeploymentStatus" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "CsmPublishingCredentialsPoliciesEntity": { + "description": "Publishing Credentials Policies parameters.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "CsmPublishingCredentialsPoliciesEntity resource specific properties", + "required": [ + "allow" + ], + "type": "object", + "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", + "properties": { + "format": { + "description": "Name of the format. Valid values are: \nFileZilla3\nWebDeploy -- default\nFtp", + "enum": [ + "FileZilla3", + "WebDeploy", + "Ftp" + ], + "type": "string", + "x-ms-enum": { + "name": "PublishingProfileFormat", + "modelAsString": true + } + }, + "includeDisasterRecoveryEndpoints": { + "description": "Include the DisasterRecover endpoint if true", + "type": "boolean" + } + } + }, + "CsmSlotEntity": { + "description": "Deployment slot parameters.", + "required": [ + "targetSlot", + "preserveVnet" + ], + "type": "object", + "properties": { + "targetSlot": { + "description": "Destination deployment slot during swap operation.", + "type": "string" + }, + "preserveVnet": { + "description": "true to preserve Virtual Network to the slot during swap; otherwise, false.", + "type": "boolean" + } + } + }, + "CustomHostnameAnalysisResult": { + "description": "Custom domain analysis.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "CustomHostnameAnalysisResult resource specific properties", + "type": "object", + "properties": { + "isHostnameAlreadyVerified": { + "description": "true if hostname is already verified; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "customDomainVerificationTest": { + "description": "DNS verification test result.", + "enum": [ + "Passed", + "Failed", + "Skipped" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DnsVerificationTestResult", + "modelAsString": false + } + }, + "customDomainVerificationFailureInfo": { + "$ref": "./CommonDefinitions.json#/definitions/ErrorEntity", + "description": "Raw failure information if DNS verification fails.", + "readOnly": true + }, + "hasConflictOnScaleUnit": { + "description": "true if there is a conflict on a scale unit; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "hasConflictAcrossSubscription": { + "description": "true if there is a conflict across subscriptions; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "conflictingAppResourceId": { + "description": "Name of the conflicting app on scale unit if it's within the same subscription.", + "type": "string", + "readOnly": true + }, + "cNameRecords": { + "description": "CName records controller can see for this hostname.", + "type": "array", + "items": { + "type": "string" + } + }, + "txtRecords": { + "description": "TXT records controller can see for this hostname.", + "type": "array", + "items": { + "type": "string" + } + }, + "aRecords": { + "description": "A records controller can see for this hostname.", + "type": "array", + "items": { + "type": "string" + } + }, + "alternateCNameRecords": { + "description": "Alternate CName records controller can see for this hostname.", + "type": "array", + "items": { + "type": "string" + } + }, + "alternateTxtRecords": { + "description": "Alternate TXT records controller can see for this hostname.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "CustomOpenIdConnectProvider": { + "description": "The configuration settings of the custom Open ID Connect provider.", + "type": "object", + "properties": { + "enabled": { + "description": "false if the custom Open ID provider provider should not be enabled; otherwise, true.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/OpenIdConnectRegistration", + "description": "The configuration settings of the app registration for the custom Open ID Connect provider." + }, + "login": { + "$ref": "#/definitions/OpenIdConnectLogin", + "description": "The configuration settings of the login flow of the custom Open ID Connect provider." + } + } + }, + "DatabaseBackupSetting": { + "description": "Database backup settings.", + "required": [ + "databaseType" + ], + "type": "object", + "properties": { + "databaseType": { + "description": "Database type (e.g. SqlAzure / MySql).", + "enum": [ + "SqlAzure", + "MySql", + "LocalMySql", + "PostgreSql" + ], + "type": "string", + "x-ms-enum": { + "name": "DatabaseType", + "modelAsString": true + } + }, + "name": { + "type": "string" + }, + "connectionStringName": { + "description": "Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options.", + "type": "string" + }, + "connectionString": { + "description": "Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.", + "type": "string" + } + } + }, + "DayOfWeek": { + "type": "string", + "description": "The day of the week.", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + }, + "DefaultAuthorizationPolicy": { + "description": "The configuration settings of the Azure Active Directory default authorization policy.", + "type": "object", + "properties": { + "allowedPrincipals": { + "$ref": "#/definitions/AllowedPrincipals", + "description": "The configuration settings of the Azure Active Directory allowed principals." + }, + "allowedApplications": { + "description": "The configuration settings of the Azure Active Directory allowed applications.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DeletedAppRestoreRequest": { + "description": "Details about restoring a deleted app.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "DeletedAppRestoreRequest resource specific properties", + "type": "object", + "properties": { + "deletedSiteId": { + "description": "ARM resource ID of the deleted app. Example:\n/subscriptions/{subId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}", + "type": "string" + }, + "recoverConfiguration": { + "description": "If true, deleted site configuration, in addition to content, will be restored.", + "type": "boolean" + }, + "snapshotTime": { + "description": "Point in time to restore the deleted app from, formatted as a DateTime string. \nIf unspecified, default value is the time that the app was deleted.", + "type": "string" + }, + "useDRSecondary": { + "description": "If true, the snapshot is retrieved from DRSecondary endpoint.", + "type": "boolean" + } + }, + "x-ms-client-flatten": true + } + } + }, + "Deployment": { + "description": "User credentials used for publishing activity.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "Deployment resource specific properties", + "type": "object", + "properties": { + "status": { + "format": "int32", + "description": "Deployment status.", + "type": "integer" + }, + "message": { + "description": "Details about deployment status.", + "type": "string" + }, + "author": { + "description": "Who authored the deployment.", + "type": "string" + }, + "deployer": { + "description": "Who performed the deployment.", + "type": "string" + }, + "author_email": { + "description": "Author email.", + "type": "string" + }, + "start_time": { + "format": "date-time", + "description": "Start time.", + "type": "string" + }, + "end_time": { + "format": "date-time", + "description": "End time.", + "type": "string" + }, + "active": { + "description": "True if deployment is currently active, false if completed and null if not started.", + "type": "boolean" + }, + "details": { + "description": "Details on deployment.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "DeploymentCollection": { + "description": "Collection of app deployments.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Deployment" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "EnabledConfig": { + "description": "Enabled configuration.", + "type": "object", + "properties": { + "enabled": { + "description": "True if configuration is enabled, false if it is disabled and null if configuration is not set.", + "type": "boolean" + } + } + }, + "EnvironmentVariable": { + "required": [ + "name", + "value" + ], + "type": "object", + "properties": { + "name": { + "description": "Environment variable name", + "type": "string" + }, + "value": { + "description": "Environment variable value", + "type": "string" + } + } + }, + "ErrorInfo": { + "type": "object", + "description": "The error info.", + "additionalProperties": false, + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "description": "The error code." + } + } + }, + "ErrorResponse": { + "description": "Error response indicates Logic service is not able to process the incoming request. The error property contains the error details.", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorProperties", + "description": "The error properties." + } + } + }, + "ErrorProperties": { + "description": "Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + }, + "ExpressionTraces": { + "description": "The expression traces.", + "type": "object", + "properties": { + "value": {}, + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressionRoot" + }, + "x-ms-identifiers": [ + "path" + ] + }, + "nextLink": { + "description": "The link used to get the next page of recommendations.", + "type": "string" + } + } + }, + "ExpressionRoot": { + "description": "The expression root.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Expression" + } + ] + }, + "Expression": { + "description": "The expression.", + "type": "object", + "additionalProperties": false, + "properties": { + "text": { + "description": "The text.", + "type": "string" + }, + "value": {}, + "subexpressions": { + "type": "array", + "description": "The sub expressions.", + "items": { + "$ref": "#/definitions/Expression" + }, + "x-ms-identifiers": [] + }, + "error": { + "$ref": "#/definitions/AzureResourceErrorInfo" + } + } + }, + "Facebook": { + "description": "The configuration settings of the Facebook provider.", + "type": "object", + "properties": { + "enabled": { + "description": "false if the Facebook provider should not be enabled despite the set registration; otherwise, true.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/AppRegistration", + "description": "The configuration settings of the app registration for the Facebook provider." + }, + "graphApiVersion": { + "description": "The version of the Facebook api to be used while logging in.", + "type": "string" + }, + "login": { + "$ref": "#/definitions/LoginScopes", + "description": "The configuration settings of the login flow." + } + } + }, + "FileSystemApplicationLogsConfig": { + "description": "Application logs to file system configuration.", + "type": "object", + "properties": { + "level": { + "description": "Log level.", + "default": "Off", + "enum": [ + "Off", + "Verbose", + "Information", + "Warning", + "Error" + ], + "type": "string", + "x-ms-enum": { + "name": "LogLevel", + "modelAsString": false + } + } + } + }, + "FileSystemHttpLogsConfig": { + "description": "Http logs to file system configuration.", + "type": "object", + "properties": { + "retentionInMb": { + "format": "int32", + "description": "Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100.", + "maximum": 100, + "minimum": 25, + "type": "integer" + }, + "retentionInDays": { + "format": "int32", + "description": "Retention in days.\nRemove files older than X days.\n0 or lower means no retention.", + "type": "integer" + }, + "enabled": { + "description": "True if configuration is enabled, false if it is disabled and null if configuration is not set.", + "type": "boolean" + } + } + }, + "FileSystemTokenStore": { + "description": "The configuration settings of the storage of the tokens if a file system is used.", + "type": "object", + "properties": { + "directory": { + "description": "The directory in which the tokens will be stored.", + "type": "string" + } + } + }, + "FlowAccessControlConfiguration": { + "type": "object", + "description": "The access control configuration.", + "properties": { + "triggers": { + "$ref": "#/definitions/FlowAccessControlConfigurationPolicy", + "description": "The access control configuration for invoking workflow triggers." + }, + "contents": { + "$ref": "#/definitions/FlowAccessControlConfigurationPolicy", + "description": "The access control configuration for accessing workflow run contents." + }, + "actions": { + "$ref": "#/definitions/FlowAccessControlConfigurationPolicy", + "description": "The access control configuration for workflow actions." + }, + "workflowManagement": { + "$ref": "#/definitions/FlowAccessControlConfigurationPolicy", + "description": "The access control configuration for workflow management." + } + } + }, + "FlowAccessControlConfigurationPolicy": { + "type": "object", + "description": "The access control configuration policy.", + "properties": { + "allowedCallerIpAddresses": { + "type": "array", + "description": "The allowed caller IP address ranges.", + "items": { + "$ref": "#/definitions/IpAddressRange", + "description": "The ip address range." + }, + "x-ms-identifiers": [] + }, + "openAuthenticationPolicies": { + "$ref": "#/definitions/OpenAuthenticationAccessPolicies", + "description": "The authentication policies for workflow." + } + } + }, + "FlowEndpointsConfiguration": { + "type": "object", + "description": "The endpoints configuration.", + "properties": { + "workflow": { + "$ref": "#/definitions/FlowEndpoints", + "description": "The workflow endpoints." + }, + "connector": { + "$ref": "#/definitions/FlowEndpoints", + "description": "The connector endpoints." + } + } + }, + "FlowEndpoints": { + "type": "object", + "description": "The flow endpoints configuration.", + "properties": { + "outgoingIpAddresses": { + "type": "array", + "description": "The outgoing ip address.", + "items": { + "$ref": "#/definitions/IpAddress", + "description": "The ip address." + }, + "x-ms-identifiers": [ + "address" + ] + }, + "accessEndpointIpAddresses": { + "type": "array", + "description": "The access endpoint ip address.", + "items": { + "$ref": "#/definitions/IpAddress", + "description": "The ip address." + }, + "x-ms-identifiers": [ + "address" + ] + } + } + }, + "ForwardProxy": { + "description": "The configuration settings of a forward proxy used to make the requests.", + "type": "object", + "properties": { + "convention": { + "description": "The convention used to determine the url of the request made.", + "enum": [ + "NoProxy", + "Standard", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "ForwardProxyConvention", + "modelAsString": false + } + }, + "customHostHeaderName": { + "description": "The name of the header containing the host of the request.", + "type": "string" + }, + "customProtoHeaderName": { + "description": "The name of the header containing the scheme of the request.", + "type": "string" + } + } + }, + "FunctionEnvelope": { + "description": "Function information.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "FunctionEnvelope resource specific properties", + "type": "object", + "properties": { + "function_app_id": { + "description": "Function App ID.", + "type": "string" + }, + "script_root_path_href": { + "description": "Script root path URI.", + "type": "string" + }, + "script_href": { + "description": "Script URI.", + "type": "string" + }, + "config_href": { + "description": "Config URI.", + "type": "string" + }, + "test_data_href": { + "description": "Test data URI.", + "type": "string" + }, + "secrets_file_href": { + "description": "Secrets file URI.", + "type": "string" + }, + "href": { + "description": "Function URI.", + "type": "string" + }, + "config": { + "description": "Config information.", + "type": "object" + }, + "files": { + "description": "File list.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "test_data": { + "description": "Test data used when testing via the Azure Portal.", + "type": "string" + }, + "invoke_url_template": { + "description": "The invocation URL", + "type": "string" + }, + "language": { + "description": "The function language", + "type": "string" + }, + "isDisabled": { + "description": "Gets or sets a value indicating whether the function is disabled", + "type": "boolean" + } + }, + "x-ms-client-flatten": true + } + } + }, + "FunctionEnvelopeCollection": { + "description": "Collection of Kudu function information elements.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/FunctionEnvelope" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "FunctionSecrets": { + "description": "Function secrets.", + "type": "object", + "properties": { + "key": { + "description": "Secret key.", + "type": "string" + }, + "trigger_url": { + "description": "Trigger URL.", + "type": "string" + } + } + }, + "GitHub": { + "description": "The configuration settings of the GitHub provider.", + "type": "object", + "properties": { + "enabled": { + "description": "false if the GitHub provider should not be enabled despite the set registration; otherwise, true.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/ClientRegistration", + "description": "The configuration settings of the app registration for the GitHub provider." + }, + "login": { + "$ref": "#/definitions/LoginScopes", + "description": "The configuration settings of the login flow." + } + } + }, + "GitHubActionCodeConfiguration": { + "description": "The GitHub action code configuration.", + "type": "object", + "properties": { + "runtimeStack": { + "description": "Runtime stack is used to determine the workflow file content for code base apps.", + "type": "string" + }, + "runtimeVersion": { + "description": "Runtime version is used to determine what build version to set in the workflow file.", + "type": "string" + } + } + }, + "GitHubActionConfiguration": { + "description": "The GitHub action configuration.", + "type": "object", + "properties": { + "codeConfiguration": { + "$ref": "#/definitions/GitHubActionCodeConfiguration", + "description": "GitHub Action code configuration." + }, + "containerConfiguration": { + "$ref": "#/definitions/GitHubActionContainerConfiguration", + "description": "GitHub Action container configuration." + }, + "isLinux": { + "description": "This will help determine the workflow configuration to select.", + "type": "boolean" + }, + "generateWorkflowFile": { + "description": "Workflow option to determine whether the workflow file should be generated and written to the repository.", + "type": "boolean" + } + } + }, + "GitHubActionContainerConfiguration": { + "description": "The GitHub action container configuration.", + "type": "object", + "properties": { + "serverUrl": { + "description": "The server URL for the container registry where the build will be hosted.", + "type": "string" + }, + "imageName": { + "description": "The image name for the build.", + "type": "string" + }, + "username": { + "description": "The username used to upload the image to the container registry.", + "type": "string" + }, + "password": { + "description": "The password used to upload the image to the container registry.", + "type": "string", + "x-ms-secret": true + } + } + }, + "GlobalValidation": { + "description": "The configuration settings that determines the validation flow of users using App Service Authentication/Authorization.", + "type": "object", + "properties": { + "requireAuthentication": { + "description": "true if the authentication flow is required any request is made; otherwise, false.", + "type": "boolean" + }, + "unauthenticatedClientAction": { + "description": "The action to take when an unauthenticated client attempts to access the app.", + "enum": [ + "RedirectToLoginPage", + "AllowAnonymous", + "Return401", + "Return403" + ], + "type": "string", + "x-ms-enum": { + "name": "UnauthenticatedClientActionV2", + "modelAsString": false + } + }, + "redirectToProvider": { + "description": "The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\".", + "type": "string" + }, + "excludedPaths": { + "description": "The paths for which unauthenticated flow would not be redirected to the login page.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Google": { + "description": "The configuration settings of the Google provider.", + "type": "object", + "properties": { + "enabled": { + "description": "false if the Google provider should not be enabled despite the set registration; otherwise, true.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/ClientRegistration", + "description": "The configuration settings of the app registration for the Google provider." + }, + "login": { + "$ref": "#/definitions/LoginScopes", + "description": "The configuration settings of the login flow." + }, + "validation": { + "$ref": "#/definitions/AllowedAudiencesValidation", + "description": "The configuration settings of the Azure Active Directory token validation flow." + } + } + }, + "HostKeys": { + "description": "Functions host level keys.", + "type": "object", + "properties": { + "masterKey": { + "description": "Secret key.", + "type": "string" + }, + "functionKeys": { + "description": "Host level function keys.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "systemKeys": { + "description": "System keys.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "HostNameBinding": { + "description": "A hostname binding object.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "HostNameBinding resource specific properties", + "type": "object", + "properties": { + "siteName": { + "description": "App Service app name.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "domainId": { + "description": "Fully qualified ARM domain resource URI.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "azureResourceName": { + "description": "Azure resource name.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "azureResourceType": { + "description": "Azure resource type.", + "enum": [ + "Website", + "TrafficManager" + ], + "type": "string", + "x-ms-enum": { + "name": "AzureResourceType", + "modelAsString": false + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "customHostNameDnsRecordType": { + "description": "Custom DNS record type.", + "enum": [ + "CName", + "A" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomHostNameDnsRecordType", + "modelAsString": false + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "hostNameType": { + "description": "Hostname type.", + "enum": [ + "Verified", + "Managed" + ], + "type": "string", + "x-ms-enum": { + "name": "HostNameType", + "modelAsString": false + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "sslState": { + "description": "SSL type", + "enum": [ + "Disabled", + "SniEnabled", + "IpBasedEnabled" + ], + "type": "string", + "x-ms-enum": { + "name": "SslState", + "modelAsString": false + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "thumbprint": { + "description": "SSL certificate thumbprint", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "virtualIP": { + "description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "HostNameBindingCollection": { + "description": "Collection of hostname bindings.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/HostNameBinding" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "HttpLogsConfig": { + "description": "Http logs configuration.", + "type": "object", + "properties": { + "fileSystem": { + "$ref": "#/definitions/FileSystemHttpLogsConfig", + "description": "Http logs to file system configuration." + }, + "azureBlobStorage": { + "$ref": "#/definitions/AzureBlobStorageHttpLogsConfig", + "description": "Http logs to azure blob storage configuration." + } + } + }, + "HttpSettings": { + "description": "The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization.", + "type": "object", + "properties": { + "requireHttps": { + "description": "false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true.", + "type": "boolean" + }, + "routes": { + "$ref": "#/definitions/HttpSettingsRoutes", + "description": "The configuration settings of the paths HTTP requests." + }, + "forwardProxy": { + "$ref": "#/definitions/ForwardProxy", + "description": "The configuration settings of a forward proxy used to make the requests." + } + } + }, + "HttpSettingsRoutes": { + "description": "The configuration settings of the paths HTTP requests.", + "type": "object", + "properties": { + "apiPrefix": { + "description": "The prefix that should precede all the authentication/authorization paths.", + "type": "string" + } + } + }, + "IdentityProviders": { + "description": "The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization.", + "type": "object", + "properties": { + "azureActiveDirectory": { + "$ref": "#/definitions/AzureActiveDirectory", + "description": "The configuration settings of the Azure Active directory provider." + }, + "facebook": { + "$ref": "#/definitions/Facebook", + "description": "The configuration settings of the Facebook provider." + }, + "gitHub": { + "$ref": "#/definitions/GitHub", + "description": "The configuration settings of the GitHub provider." + }, + "google": { + "$ref": "#/definitions/Google", + "description": "The configuration settings of the Google provider." + }, + "legacyMicrosoftAccount": { + "$ref": "#/definitions/LegacyMicrosoftAccount", + "description": "The configuration settings of the legacy Microsoft Account provider." + }, + "twitter": { + "$ref": "#/definitions/Twitter", + "description": "The configuration settings of the Twitter provider." + }, + "apple": { + "$ref": "#/definitions/Apple", + "description": "The configuration settings of the Apple provider." + }, + "azureStaticWebApps": { + "$ref": "#/definitions/AzureStaticWebApps", + "description": "The configuration settings of the Azure Static Web Apps provider." + }, + "customOpenIdConnectProviders": { + "description": "The map of the name of the alias of each custom Open ID Connect provider to the\nconfiguration settings of the custom Open ID Connect provider.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/CustomOpenIdConnectProvider" + } + } + } + }, + "IpAddress": { + "type": "object", + "description": "The ip address.", + "properties": { + "address": { + "type": "string", + "description": "The address." + } + } + }, + "IpAddressRange": { + "type": "object", + "description": "The ip address range.", + "properties": { + "addressRange": { + "type": "string", + "description": "The IP address range." + } + } + }, + "JsonSchema": { + "type": "object", + "description": "The JSON schema.", + "properties": { + "title": { + "type": "string", + "description": "The JSON title." + }, + "content": { + "type": "string", + "description": "The JSON content." + } + } + }, + "JwtClaimChecks": { + "description": "The configuration settings of the checks that should be made while validating the JWT Claims.", + "type": "object", + "properties": { + "allowedGroups": { + "description": "The list of the allowed groups.", + "type": "array", + "items": { + "type": "string" + } + }, + "allowedClientApplications": { + "description": "The list of the allowed client applications.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "KeyInfo": { + "description": "Function key info.", + "type": "object", + "properties": { + "name": { + "description": "Key name", + "type": "string" + }, + "value": { + "description": "Key value", + "type": "string" + } + } + }, + "Kind": { + "type": "string", + "enum": [ + "Stateful", + "Stateless" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": true + }, + "description": "The workflow kind." + }, + "KeyType": { + "type": "string", + "description": "The key type.", + "enum": [ + "NotSpecified", + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "KeyType", + "modelAsString": true + } + }, + "LegacyMicrosoftAccount": { + "description": "The configuration settings of the legacy Microsoft Account provider.", + "type": "object", + "properties": { + "enabled": { + "description": "false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/ClientRegistration", + "description": "The configuration settings of the app registration for the legacy Microsoft Account provider." + }, + "login": { + "$ref": "#/definitions/LoginScopes", + "description": "The configuration settings of the login flow." + }, + "validation": { + "$ref": "#/definitions/AllowedAudiencesValidation", + "description": "The configuration settings of the legacy Microsoft Account provider token validation flow." + } + } + }, + "Login": { + "description": "The configuration settings of the login flow of users using App Service Authentication/Authorization.", + "type": "object", + "properties": { + "routes": { + "$ref": "#/definitions/LoginRoutes", + "description": "The routes that specify the endpoints used for login and logout requests." + }, + "tokenStore": { + "$ref": "#/definitions/TokenStore", + "description": "The configuration settings of the token store." + }, + "preserveUrlFragmentsForLogins": { + "description": "true if the fragments from the request are preserved after the login request is made; otherwise, false.", + "type": "boolean" + }, + "allowedExternalRedirectUrls": { + "description": "External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed.", + "type": "array", + "items": { + "type": "string" + } + }, + "cookieExpiration": { + "$ref": "#/definitions/CookieExpiration", + "description": "The configuration settings of the session cookie's expiration." + }, + "nonce": { + "$ref": "#/definitions/Nonce", + "description": "The configuration settings of the nonce used in the login flow." + } + } + }, + "LoginRoutes": { + "description": "The routes that specify the endpoints used for login and logout requests.", + "type": "object", + "properties": { + "logoutEndpoint": { + "description": "The endpoint at which a logout request should be made.", + "type": "string" + } + } + }, + "LoginScopes": { + "description": "The configuration settings of the login flow, including the scopes that should be requested.", + "type": "object", + "properties": { + "scopes": { + "description": "A list of the scopes that should be requested while authenticating.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "MSDeploy": { + "description": "MSDeploy ARM PUT information", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MSDeployCore", + "description": "Core resource properties", + "type": "object", + "properties": { + "addOnPackages": { + "description": "List of Add-On packages. Add-On packages implicitly enable the Do Not Delete MSDeploy rule.", + "type": "array", + "items": { + "$ref": "#/definitions/MSDeployCore" + }, + "x-ms-identifiers": [ + "packageUri" + ] + } + }, + "x-ms-client-flatten": true + } + } + }, + "MSDeployCore": { + "description": "MSDeploy ARM PUT core information", + "type": "object", + "properties": { + "packageUri": { + "description": "Package URI", + "type": "string" + }, + "connectionString": { + "description": "SQL Connection String", + "type": "string" + }, + "dbType": { + "description": "Database Type", + "type": "string" + }, + "setParametersXmlFileUri": { + "description": "URI of MSDeploy Parameters file. Must not be set if SetParameters is used.", + "type": "string" + }, + "setParameters": { + "description": "MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "skipAppData": { + "description": "Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default.", + "type": "boolean" + }, + "appOffline": { + "description": "Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default.", + "type": "boolean" + } + } + }, + "MSDeployLog": { + "description": "MSDeploy log", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "MSDeployLog resource specific properties", + "type": "object", + "properties": { + "entries": { + "description": "List of log entry messages", + "type": "array", + "items": { + "$ref": "#/definitions/MSDeployLogEntry" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + }, + "x-ms-client-flatten": true + } + } + }, + "MSDeployLogEntry": { + "description": "MSDeploy log entry", + "type": "object", + "properties": { + "time": { + "format": "date-time", + "description": "Timestamp of log entry", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Log entry type", + "enum": [ + "Message", + "Warning", + "Error" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MSDeployLogEntryType", + "modelAsString": false + } + }, + "message": { + "description": "Log entry message", + "type": "string", + "readOnly": true + } + } + }, + "MSDeployStatus": { + "description": "MSDeploy ARM response", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "MSDeployStatus resource specific properties", + "type": "object", + "properties": { + "deployer": { + "description": "Username of deployer", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "Provisioning state", + "enum": [ + "accepted", + "running", + "succeeded", + "failed", + "canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MSDeployProvisioningState", + "modelAsString": false + } + }, + "startTime": { + "format": "date-time", + "description": "Start time of deploy operation", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "End time of deploy operation", + "type": "string", + "readOnly": true + }, + "complete": { + "description": "Whether the deployment operation has completed", + "type": "boolean", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "MigrateMySqlRequest": { + "description": "MySQL migration request.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "MigrateMySqlRequest resource specific properties", + "required": [ + "connectionString", + "migrationType" + ], + "type": "object", + "properties": { + "connectionString": { + "description": "Connection string to the remote MySQL database.", + "type": "string" + }, + "migrationType": { + "description": "The type of migration operation to be done", + "enum": [ + "LocalToRemote", + "RemoteToLocal" + ], + "type": "string", + "x-ms-enum": { + "name": "MySqlMigrationType", + "modelAsString": false + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "MigrateMySqlStatus": { + "description": "MySQL migration status.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "MigrateMySqlStatus resource specific properties", + "type": "object", + "properties": { + "migrationOperationStatus": { + "description": "Status of the migration task.", + "enum": [ + "InProgress", + "Failed", + "Succeeded", + "TimedOut", + "Created" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OperationStatus", + "modelAsString": false + } + }, + "operationId": { + "description": "Operation ID for the migration task.", + "type": "string", + "readOnly": true + }, + "localMySqlEnabled": { + "description": "True if the web app has in app MySql enabled", + "type": "boolean", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "NetworkFeatures": { + "description": "Full view of network features for an app (presently VNET integration and Hybrid Connections).", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "NetworkFeatures resource specific properties", + "type": "object", + "properties": { + "virtualNetworkName": { + "description": "The Virtual Network name.", + "type": "string", + "readOnly": true + }, + "virtualNetworkConnection": { + "$ref": "./CommonDefinitions.json#/definitions/VnetInfo", + "description": "The Virtual Network summary view.", + "readOnly": true + }, + "hybridConnections": { + "description": "The Hybrid Connections summary view.", + "type": "array", + "items": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + }, + "readOnly": true + }, + "hybridConnectionsV2": { + "description": "The Hybrid Connection V2 (Service Bus) view.", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + }, + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "NetworkTrace": { + "description": "Network trace", + "type": "object", + "properties": { + "path": { + "description": "Local file path for the captured network trace file.", + "type": "string" + }, + "status": { + "description": "Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed).", + "type": "string" + }, + "message": { + "description": "Detailed message of a network trace operation, e.g. error message in case of failure.", + "type": "string" + } + } + }, + "Nonce": { + "description": "The configuration settings of the nonce used in the login flow.", + "type": "object", + "properties": { + "validateNonce": { + "description": "false if the nonce should not be validated while completing the login flow; otherwise, true.", + "type": "boolean" + }, + "nonceExpirationInterval": { + "description": "The time after the request is made when the nonce should expire.", + "type": "string" + } + } + }, + "Object": { + "type": "object", + "properties": {} + }, + "OpenAuthenticationAccessPolicies": { + "type": "object", + "description": "AuthenticationPolicy of type Open.", + "properties": { + "policies": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/OpenAuthenticationAccessPolicy" + }, + "description": "Open authentication policies." + } + } + }, + "OpenAuthenticationAccessPolicy": { + "type": "object", + "description": "Open authentication access policy defined by user.", + "properties": { + "type": { + "$ref": "#/definitions/OpenAuthenticationProviderType", + "description": "Type of provider for OAuth." + }, + "claims": { + "type": "array", + "description": "The access policy claims.", + "items": { + "$ref": "#/definitions/OpenAuthenticationPolicyClaim", + "description": "The access policy claim." + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "OpenAuthenticationProviderType": { + "type": "string", + "description": "Open authentication policy provider type.", + "enum": [ + "AAD" + ], + "x-ms-enum": { + "name": "OpenAuthenticationProviderType", + "modelAsString": true + } + }, + "OpenAuthenticationPolicyClaim": { + "type": "object", + "description": "Open authentication policy claim.", + "properties": { + "name": { + "type": "string", + "description": "The name of the claim." + }, + "value": { + "type": "string", + "description": "The value of the claim." + } + } + }, + "OpenIdConnectClientCredential": { + "description": "The authentication client credentials of the custom Open ID Connect provider.", + "type": "object", + "properties": { + "method": { + "description": "The method that should be used to authenticate the user.", + "enum": [ + "ClientSecretPost" + ], + "type": "string", + "x-ms-enum": { + "name": "ClientCredentialMethod", + "modelAsString": false + } + }, + "clientSecretSettingName": { + "description": "The app setting that contains the client secret for the custom Open ID Connect provider.", + "type": "string" + } + } + }, + "OpenIdConnectConfig": { + "description": "The configuration settings of the endpoints used for the custom Open ID Connect provider.", + "type": "object", + "properties": { + "authorizationEndpoint": { + "description": "The endpoint to be used to make an authorization request.", + "type": "string" + }, + "tokenEndpoint": { + "description": "The endpoint to be used to request a token.", + "type": "string" + }, + "issuer": { + "description": "The endpoint that issues the token.", + "type": "string" + }, + "certificationUri": { + "description": "The endpoint that provides the keys necessary to validate the token.", + "type": "string" + }, + "wellKnownOpenIdConfiguration": { + "description": "The endpoint that contains all the configuration endpoints for the provider.", + "type": "string" + } + } + }, + "OpenIdConnectLogin": { + "description": "The configuration settings of the login flow of the custom Open ID Connect provider.", + "type": "object", + "properties": { + "nameClaimType": { + "description": "The name of the claim that contains the users name.", + "type": "string" + }, + "scopes": { + "description": "A list of the scopes that should be requested while authenticating.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "OpenIdConnectRegistration": { + "description": "The configuration settings of the app registration for the custom Open ID Connect provider.", + "type": "object", + "properties": { + "clientId": { + "description": "The client id of the custom Open ID Connect provider.", + "type": "string" + }, + "clientCredential": { + "$ref": "#/definitions/OpenIdConnectClientCredential", + "description": "The authentication credentials of the custom Open ID Connect provider." + }, + "openIdConnectConfiguration": { + "$ref": "#/definitions/OpenIdConnectConfig", + "description": "The configuration settings of the endpoints used for the custom Open ID Connect provider." + } + } + }, + "OperationResult": { + "type": "object", + "description": "The operation result definition.", + "additionalProperties": false, + "properties": { + "trackingId": { + "type": "string", + "readOnly": true, + "description": "Gets the tracking id." + }, + "inputs": { + "$ref": "#/definitions/Object", + "readOnly": true, + "description": "Gets the inputs." + }, + "inputsLink": { + "$ref": "#/definitions/ContentLink", + "readOnly": true, + "description": "Gets the link to inputs." + }, + "outputs": { + "$ref": "#/definitions/Object", + "readOnly": true, + "description": "Gets the outputs." + }, + "outputsLink": { + "$ref": "#/definitions/ContentLink", + "readOnly": true, + "description": "Gets the link to outputs." + }, + "trackedProperties": { + "$ref": "#/definitions/Object", + "readOnly": true, + "description": "Gets the tracked properties." + }, + "retryHistory": { + "type": "array", + "items": { + "$ref": "#/definitions/RetryHistory" + }, + "x-ms-identifiers": [], + "description": "Gets the retry histories." + }, + "iterationCount": { + "type": "integer", + "format": "int32" + } + }, + "allOf": [ + { + "$ref": "#/definitions/OperationResultProperties" + } + ] + }, + "OperationResultProperties": { + "type": "object", + "x-abstract": true, + "description": "The run operation result properties.", + "additionalProperties": false, + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the workflow scope repetition." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the workflow scope repetition." + }, + "correlation": { + "$ref": "#/definitions/RunActionCorrelation", + "description": "The correlation properties." + }, + "status": { + "$ref": "#/definitions/WorkflowStatus", + "description": "The status of the workflow scope repetition." + }, + "code": { + "type": "string", + "description": "The workflow scope repetition code." + }, + "error": {} + } + }, + "ParameterType": { + "type": "string", + "description": "The parameter type.", + "enum": [ + "NotSpecified", + "String", + "SecureString", + "Int", + "Float", + "Bool", + "Array", + "Object", + "SecureObject" + ], + "x-ms-enum": { + "name": "ParameterType", + "modelAsString": true + } + }, + "PerfMonCounterCollection": { + "description": "Collection of performance monitor counters.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/PerfMonResponse" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "PerfMonResponse": { + "description": "Performance monitor API response.", + "type": "object", + "properties": { + "code": { + "description": "The response code.", + "type": "string" + }, + "message": { + "description": "The message.", + "type": "string" + }, + "data": { + "$ref": "#/definitions/PerfMonSet", + "description": "The performance monitor counters." + } + } + }, + "PerfMonSample": { + "description": "Performance monitor sample in a set.", + "type": "object", + "properties": { + "time": { + "format": "date-time", + "description": "Point in time for which counter was measured.", + "type": "string" + }, + "instanceName": { + "description": "Name of the server on which the measurement is made.", + "type": "string" + }, + "value": { + "format": "double", + "description": "Value of counter at a certain time.", + "type": "number" + } + } + }, + "PerfMonSet": { + "description": "Metric information.", + "type": "object", + "properties": { + "name": { + "description": "Unique key name of the counter.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "Start time of the period.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "End time of the period.", + "type": "string" + }, + "timeGrain": { + "description": "Presented time grain.", + "type": "string" + }, + "values": { + "description": "Collection of workers that are active during this time.", + "type": "array", + "items": { + "$ref": "#/definitions/PerfMonSample" + }, + "x-ms-identifiers": [] + } + } + }, + "PremierAddOn": { + "description": "Premier add-on.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "PremierAddOn resource specific properties", + "type": "object", + "properties": { + "sku": { + "description": "Premier add on SKU.", + "type": "string" + }, + "product": { + "description": "Premier add on Product.", + "type": "string" + }, + "vendor": { + "description": "Premier add on Vendor.", + "type": "string" + }, + "marketplacePublisher": { + "description": "Premier add on Marketplace publisher.", + "type": "string" + }, + "marketplaceOffer": { + "description": "Premier add on Marketplace offer.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "PremierAddOnPatchResource": { + "description": "ARM resource for a PremierAddOn.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "PremierAddOnPatchResource resource specific properties", + "type": "object", + "properties": { + "sku": { + "description": "Premier add on SKU.", + "type": "string" + }, + "product": { + "description": "Premier add on Product.", + "type": "string" + }, + "vendor": { + "description": "Premier add on Vendor.", + "type": "string" + }, + "marketplacePublisher": { + "description": "Premier add on Marketplace publisher.", + "type": "string" + }, + "marketplaceOffer": { + "description": "Premier add on Marketplace offer.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "PrivateAccess": { + "description": "Description of the parameters of Private Access for a Web Site.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "PrivateAccess resource specific properties", + "type": "object", + "properties": { + "enabled": { + "description": "Whether private access is enabled or not.", + "type": "boolean" + }, + "virtualNetworks": { + "description": "The Virtual Networks (and subnets) allowed to access the site privately.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateAccessVirtualNetwork" + }, + "x-ms-identifiers": [ + "key" + ] + } + }, + "x-ms-client-flatten": true + } + } + }, + "PrivateAccessSubnet": { + "description": "Description of a Virtual Network subnet that is useable for private site access.", + "type": "object", + "properties": { + "name": { + "description": "The name of the subnet.", + "type": "string" + }, + "key": { + "format": "int32", + "description": "The key (ID) of the subnet.", + "type": "integer" + } + } + }, + "PrivateAccessVirtualNetwork": { + "description": "Description of a Virtual Network that is useable for private site access.", + "type": "object", + "properties": { + "name": { + "description": "The name of the Virtual Network.", + "type": "string" + }, + "key": { + "format": "int32", + "description": "The key (ID) of the Virtual Network.", + "type": "integer" + }, + "resourceId": { + "description": "The ARM uri of the Virtual Network", + "type": "string" + }, + "subnets": { + "description": "A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateAccessSubnet" + }, + "x-ms-identifiers": [ + "key" + ] + } + } + }, + "ProcessInfo": { + "description": "Process Information.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "ProcessInfo resource specific properties", + "type": "object", + "properties": { + "identifier": { + "format": "int32", + "description": "ARM Identifier for deployment.", + "type": "integer", + "readOnly": true + }, + "deployment_name": { + "description": "Deployment name.", + "type": "string" + }, + "href": { + "description": "HRef URI.", + "type": "string" + }, + "minidump": { + "description": "Minidump URI.", + "type": "string" + }, + "is_profile_running": { + "description": "Is profile running?", + "type": "boolean" + }, + "is_iis_profile_running": { + "description": "Is the IIS Profile running?", + "type": "boolean" + }, + "iis_profile_timeout_in_seconds": { + "format": "double", + "description": "IIS Profile timeout (seconds).", + "type": "number" + }, + "parent": { + "description": "Parent process.", + "type": "string" + }, + "children": { + "description": "Child process list.", + "type": "array", + "items": { + "type": "string" + } + }, + "threads": { + "description": "Thread list.", + "type": "array", + "items": { + "$ref": "#/definitions/ProcessThreadInfo" + } + }, + "open_file_handles": { + "description": "List of open files.", + "type": "array", + "items": { + "type": "string" + } + }, + "modules": { + "description": "List of modules.", + "type": "array", + "items": { + "$ref": "#/definitions/ProcessModuleInfo" + } + }, + "file_name": { + "description": "File name of this process.", + "type": "string" + }, + "command_line": { + "description": "Command line.", + "type": "string" + }, + "user_name": { + "description": "User name.", + "type": "string" + }, + "handle_count": { + "format": "int32", + "description": "Handle count.", + "type": "integer" + }, + "module_count": { + "format": "int32", + "description": "Module count.", + "type": "integer" + }, + "thread_count": { + "format": "int32", + "description": "Thread count.", + "type": "integer" + }, + "start_time": { + "format": "date-time", + "description": "Start time.", + "type": "string" + }, + "total_cpu_time": { + "description": "Total CPU time.", + "type": "string" + }, + "user_cpu_time": { + "description": "User CPU time.", + "type": "string" + }, + "privileged_cpu_time": { + "description": "Privileged CPU time.", + "type": "string" + }, + "working_set": { + "format": "int64", + "description": "Working set.", + "type": "integer" + }, + "peak_working_set": { + "format": "int64", + "description": "Peak working set.", + "type": "integer" + }, + "private_memory": { + "format": "int64", + "description": "Private memory size.", + "type": "integer" + }, + "virtual_memory": { + "format": "int64", + "description": "Virtual memory size.", + "type": "integer" + }, + "peak_virtual_memory": { + "format": "int64", + "description": "Peak virtual memory usage.", + "type": "integer" + }, + "paged_system_memory": { + "format": "int64", + "description": "Paged system memory.", + "type": "integer" + }, + "non_paged_system_memory": { + "format": "int64", + "description": "Non-paged system memory.", + "type": "integer" + }, + "paged_memory": { + "format": "int64", + "description": "Paged memory.", + "type": "integer" + }, + "peak_paged_memory": { + "format": "int64", + "description": "Peak paged memory.", + "type": "integer" + }, + "time_stamp": { + "format": "date-time", + "description": "Time stamp.", + "type": "string" + }, + "environment_variables": { + "description": "List of environment variables.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "is_scm_site": { + "description": "Is this the SCM site?", + "type": "boolean" + }, + "is_webjob": { + "description": "Is this a Web Job?", + "type": "boolean" + }, + "description": { + "description": "Description of process.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "ProcessInfoCollection": { + "description": "Collection of Kudu process information elements.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ProcessInfo" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ProcessModuleInfo": { + "description": "Process Module Information.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "ProcessModuleInfo resource specific properties", + "type": "object", + "properties": { + "base_address": { + "description": "Base address. Used as module identifier in ARM resource URI.", + "type": "string" + }, + "file_name": { + "description": "File name.", + "type": "string" + }, + "href": { + "description": "HRef URI.", + "type": "string" + }, + "file_path": { + "description": "File path.", + "type": "string" + }, + "module_memory_size": { + "format": "int32", + "description": "Module memory size.", + "type": "integer" + }, + "file_version": { + "description": "File version.", + "type": "string" + }, + "file_description": { + "description": "File description.", + "type": "string" + }, + "product": { + "description": "Product name.", + "type": "string" + }, + "product_version": { + "description": "Product version.", + "type": "string" + }, + "is_debug": { + "description": "Is debug?", + "type": "boolean" + }, + "language": { + "description": "Module language (locale).", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "ProcessModuleInfoCollection": { + "description": "Collection of Kudu thread information elements.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ProcessModuleInfo" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ProcessThreadInfo": { + "description": "Process Thread Information.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "ProcessThreadInfo resource specific properties", + "type": "object", + "properties": { + "identifier": { + "format": "int32", + "description": "Site extension ID.", + "type": "integer", + "readOnly": true + }, + "href": { + "description": "HRef URI.", + "type": "string" + }, + "process": { + "description": "Process URI.", + "type": "string" + }, + "start_address": { + "description": "Start address.", + "type": "string" + }, + "current_priority": { + "format": "int32", + "description": "Current thread priority.", + "type": "integer" + }, + "priority_level": { + "description": "Thread priority level.", + "type": "string" + }, + "base_priority": { + "format": "int32", + "description": "Base priority.", + "type": "integer" + }, + "start_time": { + "format": "date-time", + "description": "Start time.", + "type": "string" + }, + "total_processor_time": { + "description": "Total processor time.", + "type": "string" + }, + "user_processor_time": { + "description": "User processor time.", + "type": "string" + }, + "state": { + "description": "Thread state.", + "type": "string" + }, + "wait_reason": { + "description": "Wait reason.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "ProcessThreadInfoCollection": { + "description": "Collection of Kudu thread information elements.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ProcessThreadInfo" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "PublicCertificate": { + "description": "Public certificate object", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "PublicCertificate resource specific properties", + "type": "object", + "properties": { + "blob": { + "format": "byte", + "description": "Public Certificate byte array", + "type": "string" + }, + "publicCertificateLocation": { + "description": "Public Certificate Location", + "enum": [ + "CurrentUserMy", + "LocalMachineMy", + "Unknown" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicCertificateLocation", + "modelAsString": false + } + }, + "thumbprint": { + "description": "Certificate Thumbprint", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "PublicCertificateCollection": { + "description": "Collection of public certificates", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/PublicCertificate" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "PublishingCredentialsPoliciesCollection": { + "description": "Publishing Credentials Policies entity collection ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "RecurrenceSchedule": { + "type": "object", + "properties": { + "minutes": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "The minutes." + }, + "hours": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "The hours." + }, + "weekDays": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "DaysOfWeek", + "modelAsString": false + } + }, + "description": "The days of the week." + }, + "monthDays": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "The month days." + }, + "monthlyOccurrences": { + "type": "array", + "items": { + "$ref": "#/definitions/RecurrenceScheduleOccurrence" + }, + "x-ms-identifiers": [], + "description": "The monthly occurrences." + } + }, + "description": "The recurrence schedule." + }, + "RecurrenceScheduleOccurrence": { + "type": "object", + "properties": { + "day": { + "$ref": "#/definitions/DayOfWeek", + "description": "The day of the week." + }, + "occurrence": { + "type": "integer", + "format": "int32", + "description": "The occurrence." + } + }, + "description": "The recurrence schedule occurrence." + }, + "RegenerateActionParameter": { + "type": "object", + "properties": { + "keyType": { + "$ref": "#/definitions/KeyType", + "description": "The key type." + } + }, + "description": "The access key regenerate action content." + }, + "RepetitionIndex": { + "type": "object", + "description": "The workflow run action repetition index.", + "additionalProperties": false, + "required": [ + "itemIndex" + ], + "properties": { + "scopeName": { + "type": "string", + "description": "The scope." + }, + "itemIndex": { + "type": "integer", + "format": "int32", + "description": "The index." + } + } + }, + "RelayServiceConnectionEntity": { + "description": "Hybrid Connection for an App Service app.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "RelayServiceConnectionEntity resource specific properties", + "type": "object", + "properties": { + "entityName": { + "type": "string" + }, + "entityConnectionString": { + "type": "string" + }, + "resourceType": { + "type": "string" + }, + "resourceConnectionString": { + "type": "string" + }, + "hostname": { + "type": "string" + }, + "port": { + "format": "int32", + "type": "integer" + }, + "biztalkUri": { + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "Response": { + "type": "object", + "additionalProperties": false, + "description": "A response.", + "properties": { + "headers": { + "$ref": "#/definitions/Object", + "description": "A list of all the headers attached to the response." + }, + "statusCode": { + "type": "integer", + "format": "int32", + "description": "The status code of the response." + }, + "bodyLink": { + "$ref": "#/definitions/ContentLink", + "description": "Details on the location of the body content." + } + } + }, + "ResourceReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The resource id." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the resource name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the resource type." + } + }, + "description": "The resource reference." + }, + "RestoreRequest": { + "description": "Description of a restore request.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "RestoreRequest resource specific properties", + "required": [ + "storageAccountUrl", + "overwrite" + ], + "type": "object", + "properties": { + "storageAccountUrl": { + "description": "SAS URL to the container.", + "type": "string" + }, + "blobName": { + "description": "Name of a blob which contains the backup.", + "type": "string" + }, + "overwrite": { + "description": "true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app.", + "type": "boolean" + }, + "siteName": { + "description": "Name of an app.", + "type": "string" + }, + "databases": { + "description": "Collection of databases which should be restored. This list has to match the list of databases included in the backup.", + "type": "array", + "items": { + "$ref": "#/definitions/DatabaseBackupSetting" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "ignoreConflictingHostNames": { + "description": "Changes a logic when restoring an app with custom domains. true to remove custom domains automatically. If false, custom domains are added to \nthe app's object when it is being restored, but that might fail due to conflicts during the operation.", + "default": false, + "type": "boolean" + }, + "ignoreDatabases": { + "description": "Ignore the databases and only restore the site content", + "default": false, + "type": "boolean" + }, + "appServicePlan": { + "description": "Specify app service plan that will own restored site.", + "type": "string" + }, + "operationType": { + "description": "Operation type.", + "default": "Default", + "enum": [ + "Default", + "Clone", + "Relocation", + "Snapshot", + "CloudFS" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupRestoreOperationType", + "modelAsString": false + } + }, + "adjustConnectionStrings": { + "description": "true if SiteConfig.ConnectionStrings should be set in new app; otherwise, false.", + "type": "boolean" + }, + "hostingEnvironment": { + "description": "App Service Environment name, if needed (only when restoring an app to an App Service Environment).", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "Request": { + "type": "object", + "additionalProperties": false, + "description": "A request.", + "properties": { + "headers": { + "$ref": "#/definitions/Object", + "description": "A list of all the headers attached to the request." + }, + "uri": { + "type": "string", + "description": "The destination for the request." + }, + "method": { + "type": "string", + "description": "The HTTP method used for the request." + } + } + }, + "RequestHistoryListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RequestHistory" + }, + "description": "A list of workflow request histories." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "The list of workflow request histories." + }, + "RequestHistory": { + "type": "object", + "additionalProperties": false, + "description": "The request history.", + "properties": { + "properties": { + "$ref": "#/definitions/RequestHistoryProperties", + "description": "The request history properties." + } + }, + "allOf": [ + { + "$ref": "#/definitions/WorkflowResource" + } + ] + }, + "RequestHistoryProperties": { + "type": "object", + "additionalProperties": false, + "description": "The request history.", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "The time the request started." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The time the request ended." + }, + "request": { + "$ref": "#/definitions/Request", + "description": "The request." + }, + "response": { + "$ref": "#/definitions/Response", + "description": "The response." + } + } + }, + "RetryHistory": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "Gets the start time." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "Gets the end time." + }, + "code": { + "type": "string", + "description": "Gets the status code." + }, + "clientRequestId": { + "type": "string", + "description": "Gets the client request Id." + }, + "serviceRequestId": { + "type": "string", + "description": "Gets the service request Id." + }, + "error": { + "$ref": "#/definitions/ErrorResponse", + "description": "Gets the error response." + } + }, + "description": "The retry history." + }, + "RunActionCorrelation": { + "type": "object", + "description": "The workflow run action correlation properties.", + "additionalProperties": false, + "properties": { + "actionTrackingId": { + "type": "string", + "description": "The action tracking identifier." + } + }, + "allOf": [ + { + "$ref": "#/definitions/RunCorrelation" + } + ] + }, + "RunCorrelation": { + "type": "object", + "description": "The correlation properties.", + "additionalProperties": false, + "properties": { + "clientTrackingId": { + "type": "string", + "description": "The client tracking identifier." + }, + "clientKeywords": { + "type": "array", + "description": "The client keywords.", + "items": { + "type": "string" + } + } + } + }, + "SiteAuthSettings": { + "description": "Configuration settings for the Azure App Service Authentication / Authorization feature.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "SiteAuthSettings resource specific properties", + "type": "object", + "properties": { + "enabled": { + "description": "true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.", + "type": "boolean" + }, + "runtimeVersion": { + "description": "The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module.", + "type": "string" + }, + "unauthenticatedClientAction": { + "description": "The action to take when an unauthenticated client attempts to access the app.", + "enum": [ + "RedirectToLoginPage", + "AllowAnonymous" + ], + "type": "string", + "x-ms-enum": { + "name": "UnauthenticatedClientAction", + "modelAsString": false + } + }, + "tokenStoreEnabled": { + "description": "true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false.", + "type": "boolean" + }, + "allowedExternalRedirectUrls": { + "description": "External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed.", + "type": "array", + "items": { + "type": "string" + } + }, + "defaultProvider": { + "description": "The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\".", + "enum": [ + "AzureActiveDirectory", + "Facebook", + "Google", + "MicrosoftAccount", + "Twitter", + "Github" + ], + "type": "string", + "x-ms-enum": { + "name": "BuiltInAuthenticationProvider", + "modelAsString": false + } + }, + "tokenRefreshExtensionHours": { + "format": "double", + "description": "The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours.", + "type": "number" + }, + "clientId": { + "description": "The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html", + "type": "string" + }, + "clientSecret": { + "description": "The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html", + "type": "string" + }, + "clientSecretSettingName": { + "description": "The app setting name that contains the client secret of the relying party application.", + "type": "string" + }, + "clientSecretCertificateThumbprint": { + "description": "An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional.", + "type": "string" + }, + "issuer": { + "description": "The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html", + "type": "string" + }, + "validateIssuer": { + "description": "Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.", + "type": "boolean" + }, + "allowedAudiences": { + "description": "Allowed audience values to consider when validating JSON Web Tokens issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting.", + "type": "array", + "items": { + "type": "string" + } + }, + "additionalLoginParams": { + "description": "Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\".", + "type": "array", + "items": { + "type": "string" + } + }, + "aadClaimsAuthorization": { + "description": "Gets a JSON string containing the Azure AD Acl settings.", + "type": "string" + }, + "googleClientId": { + "description": "The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/", + "type": "string" + }, + "googleClientSecret": { + "description": "The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/", + "type": "string" + }, + "googleClientSecretSettingName": { + "description": "The app setting name that contains the client secret associated with \nthe Google web application.", + "type": "string" + }, + "googleOAuthScopes": { + "description": "The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/", + "type": "array", + "items": { + "type": "string" + } + }, + "facebookAppId": { + "description": "The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login", + "type": "string" + }, + "facebookAppSecret": { + "description": "The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login", + "type": "string" + }, + "facebookAppSecretSettingName": { + "description": "The app setting name that contains the app secret used for Facebook Login.", + "type": "string" + }, + "facebookOAuthScopes": { + "description": "The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login", + "type": "array", + "items": { + "type": "string" + } + }, + "gitHubClientId": { + "description": "The Client Id of the GitHub app used for login.\nThis setting is required for enabling Github login", + "type": "string" + }, + "gitHubClientSecret": { + "description": "The Client Secret of the GitHub app used for Github Login.\nThis setting is required for enabling Github login.", + "type": "string" + }, + "gitHubClientSecretSettingName": { + "description": "The app setting name that contains the client secret of the Github\napp used for GitHub Login.", + "type": "string" + }, + "gitHubOAuthScopes": { + "description": "The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.\nThis setting is optional", + "type": "array", + "items": { + "type": "string" + } + }, + "twitterConsumerKey": { + "description": "The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in", + "type": "string" + }, + "twitterConsumerSecret": { + "description": "The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in", + "type": "string" + }, + "twitterConsumerSecretSettingName": { + "description": "The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in.", + "type": "string" + }, + "microsoftAccountClientId": { + "description": "The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm", + "type": "string" + }, + "microsoftAccountClientSecret": { + "description": "The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm", + "type": "string" + }, + "microsoftAccountClientSecretSettingName": { + "description": "The app setting name containing the OAuth 2.0 client secret that was created for the\napp used for authentication.", + "type": "string" + }, + "microsoftAccountOAuthScopes": { + "description": "The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx", + "type": "array", + "items": { + "type": "string" + } + }, + "isAuthFromFile": { + "description": "\"true\" if the auth config settings should be read from a file,\n\"false\" otherwise", + "type": "string" + }, + "authFilePath": { + "description": "The path of the config file containing auth settings.\nIf the path is relative, base will the site's root directory.", + "type": "string" + }, + "configVersion": { + "description": "The ConfigVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of the control plane for Authentication / Authorization.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "SiteAuthSettingsV2": { + "description": "Configuration settings for the Azure App Service Authentication / Authorization V2 feature.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "SiteAuthSettingsV2 resource specific properties", + "type": "object", + "properties": { + "platform": { + "$ref": "#/definitions/AuthPlatform", + "description": "The configuration settings of the platform of App Service Authentication/Authorization." + }, + "globalValidation": { + "$ref": "#/definitions/GlobalValidation", + "description": "The configuration settings that determines the validation flow of users using App Service Authentication/Authorization." + }, + "identityProviders": { + "$ref": "#/definitions/IdentityProviders", + "description": "The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization." + }, + "login": { + "$ref": "#/definitions/Login", + "description": "The configuration settings of the login flow of users using App Service Authentication/Authorization." + }, + "httpSettings": { + "$ref": "#/definitions/HttpSettings", + "description": "The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization." + } + }, + "x-ms-client-flatten": true + } + } + }, + "SiteCloneability": { + "description": "Represents whether or not an app is cloneable.", + "type": "object", + "properties": { + "result": { + "description": "Name of app.", + "enum": [ + "Cloneable", + "PartiallyCloneable", + "NotCloneable" + ], + "type": "string", + "x-ms-enum": { + "name": "CloneAbilityResult", + "modelAsString": false + } + }, + "blockingFeatures": { + "description": "List of features enabled on app that prevent cloning.", + "type": "array", + "items": { + "$ref": "#/definitions/SiteCloneabilityCriterion" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "unsupportedFeatures": { + "description": "List of features enabled on app that are non-blocking but cannot be cloned. The app can still be cloned\nbut the features in this list will not be set up on cloned app.", + "type": "array", + "items": { + "$ref": "#/definitions/SiteCloneabilityCriterion" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "blockingCharacteristics": { + "description": "List of blocking application characteristics.", + "type": "array", + "items": { + "$ref": "#/definitions/SiteCloneabilityCriterion" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "SiteCloneabilityCriterion": { + "description": "An app cloneability criterion.", + "type": "object", + "properties": { + "name": { + "description": "Name of criterion.", + "type": "string" + }, + "description": { + "description": "Description of criterion.", + "type": "string" + } + } + }, + "SiteConfigResource": { + "description": "Web app configuration ARM resource.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "$ref": "./CommonDefinitions.json#/definitions/SiteConfig", + "description": "Core resource properties", + "type": "object", + "x-ms-client-flatten": true + } + } + }, + "SiteConfigResourceCollection": { + "description": "Collection of site configurations.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SiteConfigResource" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "SiteConfigurationSnapshotInfo": { + "description": "A snapshot of a web app configuration.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "SiteConfigurationSnapshotInfo resource specific properties", + "type": "object", + "properties": { + "time": { + "format": "date-time", + "description": "The time the snapshot was taken.", + "type": "string", + "readOnly": true + }, + "snapshotId": { + "format": "int32", + "description": "The id of the snapshot", + "type": "integer", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "SiteConfigurationSnapshotInfoCollection": { + "description": "Collection of metadata for the app configuration snapshots that can be restored.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SiteConfigurationSnapshotInfo" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "SiteContainer": { + "description": "Container of a site", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "SiteContainer resource specific properties", + "required": [ + "image", + "isMain" + ], + "type": "object", + "properties": { + "image": { + "description": "Image Name", + "type": "string" + }, + "targetPort": { + "description": "Target Port", + "type": "string" + }, + "isMain": { + "description": "true if the container is the main site container; false otherwise.", + "type": "boolean" + }, + "startUpCommand": { + "description": "StartUp Command", + "type": "string" + }, + "authType": { + "description": "Auth Type", + "enum": [ + "Anonymous", + "UserCredentials", + "SystemIdentity", + "UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthType", + "modelAsString": false + } + }, + "userName": { + "description": "User Name", + "type": "string" + }, + "passwordSecret": { + "description": "Password Secret", + "type": "string", + "x-ms-secret": true + }, + "userManagedIdentityClientId": { + "description": "UserManagedIdentity ClientId", + "type": "string" + }, + "createdTime": { + "format": "date-time", + "description": "Created Time", + "type": "string", + "readOnly": true + }, + "lastModifiedTime": { + "format": "date-time", + "description": "Last Modified Time", + "type": "string", + "readOnly": true + }, + "volumeMounts": { + "description": "List of volume mounts", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeMount" + } + }, + "environmentVariables": { + "description": "List of environment variables", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "SiteContainerCollection": { + "description": "Collection of site containers", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SiteContainer" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "SiteExtensionInfo": { + "description": "Site Extension Information.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "SiteExtensionInfo resource specific properties", + "type": "object", + "properties": { + "extension_id": { + "description": "Site extension ID.", + "type": "string" + }, + "title": { + "type": "string" + }, + "extension_type": { + "description": "Site extension type.", + "enum": [ + "Gallery", + "WebRoot" + ], + "type": "string", + "x-ms-enum": { + "name": "SiteExtensionType", + "modelAsString": false + } + }, + "summary": { + "description": "Summary description.", + "type": "string" + }, + "description": { + "description": "Detailed description.", + "type": "string" + }, + "version": { + "description": "Version information.", + "type": "string" + }, + "extension_url": { + "description": "Extension URL.", + "type": "string" + }, + "project_url": { + "description": "Project URL.", + "type": "string" + }, + "icon_url": { + "description": "Icon URL.", + "type": "string" + }, + "license_url": { + "description": "License URL.", + "type": "string" + }, + "feed_url": { + "description": "Feed URL.", + "type": "string" + }, + "authors": { + "description": "List of authors.", + "type": "array", + "items": { + "type": "string" + } + }, + "installer_command_line_params": { + "description": "Installer command line parameters.", + "type": "string" + }, + "published_date_time": { + "format": "date-time", + "description": "Published timestamp.", + "type": "string" + }, + "download_count": { + "format": "int32", + "description": "Count of downloads.", + "type": "integer" + }, + "local_is_latest_version": { + "description": "true if the local version is the latest version; false otherwise.", + "type": "boolean" + }, + "local_path": { + "description": "Local path.", + "type": "string" + }, + "installed_date_time": { + "format": "date-time", + "description": "Installed timestamp.", + "type": "string" + }, + "provisioningState": { + "description": "Provisioning state.", + "type": "string" + }, + "comment": { + "description": "Site Extension comment.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "SiteExtensionInfoCollection": { + "description": "Collection of Kudu site extension information elements.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SiteExtensionInfo" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "SiteLogsConfig": { + "description": "Configuration of App Service site logs.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "SiteLogsConfig resource specific properties", + "type": "object", + "properties": { + "applicationLogs": { + "$ref": "#/definitions/ApplicationLogsConfig", + "description": "Application logs configuration." + }, + "httpLogs": { + "$ref": "#/definitions/HttpLogsConfig", + "description": "HTTP logs configuration." + }, + "failedRequestsTracing": { + "$ref": "#/definitions/EnabledConfig", + "description": "Failed requests tracing configuration." + }, + "detailedErrorMessages": { + "$ref": "#/definitions/EnabledConfig", + "description": "Detailed error messages configuration." + } + }, + "x-ms-client-flatten": true + } + } + }, + "SitePatchResource": { + "description": "ARM resource for a site.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "SitePatchResource resource specific properties", + "type": "object", + "properties": { + "state": { + "description": "Current state of the app.", + "type": "string", + "readOnly": true + }, + "hostNames": { + "description": "Hostnames associated with the app.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "repositorySiteName": { + "description": "Name of the repository site.", + "type": "string", + "readOnly": true + }, + "usageState": { + "description": "State indicating whether the app has exceeded its quota usage. Read-only.", + "enum": [ + "Normal", + "Exceeded" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "UsageState", + "modelAsString": false + } + }, + "enabled": { + "description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).", + "type": "boolean" + }, + "enabledHostNames": { + "description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "availabilityState": { + "description": "Management information availability state for the app.", + "enum": [ + "Normal", + "Limited", + "DisasterRecoveryMode" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SiteAvailabilityState", + "modelAsString": false + } + }, + "hostNameSslStates": { + "description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/HostNameSslState" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "serverFarmId": { + "description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".", + "type": "string" + }, + "reserved": { + "description": "true if reserved; otherwise, false.", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "isXenon": { + "description": "Obsolete: Hyper-V sandbox.", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "hyperV": { + "description": "Hyper-V sandbox.", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "lastModifiedTimeUtc": { + "format": "date-time", + "description": "Last time the app was modified, in UTC. Read-only.", + "type": "string", + "readOnly": true + }, + "dnsConfiguration": { + "$ref": "./CommonDefinitions.json#/definitions/SiteDnsConfig", + "description": "Property to configure various DNS related settings for a site." + }, + "siteConfig": { + "$ref": "./CommonDefinitions.json#/definitions/SiteConfig", + "description": "Configuration of the app." + }, + "trafficManagerHostNames": { + "description": "Azure Traffic Manager hostnames associated with the app. Read-only.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "scmSiteAlsoStopped": { + "description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.", + "default": false, + "type": "boolean" + }, + "targetSwapSlot": { + "description": "Specifies which deployment slot this app will swap into. Read-only.", + "type": "string", + "readOnly": true + }, + "hostingEnvironmentProfile": { + "$ref": "./CommonDefinitions.json#/definitions/HostingEnvironmentProfile", + "description": "App Service Environment to use for the app.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "clientAffinityEnabled": { + "description": "true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.", + "type": "boolean" + }, + "clientCertEnabled": { + "description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.", + "type": "boolean" + }, + "clientCertMode": { + "description": "This composes with ClientCertEnabled setting.\n- ClientCertEnabled: false means ClientCert is ignored.\n- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.\n- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.", + "enum": [ + "Required", + "Optional", + "OptionalInteractiveUser" + ], + "type": "string", + "x-ms-enum": { + "name": "ClientCertMode", + "modelAsString": false + } + }, + "clientCertExclusionPaths": { + "description": "client certificate authentication comma-separated exclusion paths", + "type": "string" + }, + "hostNamesDisabled": { + "description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.", + "type": "boolean" + }, + "customDomainVerificationId": { + "description": "Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.", + "type": "string" + }, + "outboundIpAddresses": { + "description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.", + "type": "string", + "readOnly": true + }, + "possibleOutboundIpAddresses": { + "description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.", + "type": "string", + "readOnly": true + }, + "containerSize": { + "format": "int32", + "description": "Size of the function container.", + "type": "integer" + }, + "dailyMemoryTimeQuota": { + "format": "int32", + "description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only).", + "type": "integer" + }, + "suspendedTill": { + "format": "date-time", + "description": "App suspended till in case memory-time quota is exceeded.", + "type": "string", + "readOnly": true + }, + "maxNumberOfWorkers": { + "format": "int32", + "description": "Maximum number of workers.\nThis only applies to Functions container.", + "type": "integer", + "readOnly": true + }, + "cloningInfo": { + "$ref": "./CommonDefinitions.json#/definitions/CloningInfo", + "description": "If specified during app creation, the app is cloned from a source app.", + "x-ms-mutability": [ + "create" + ] + }, + "resourceGroup": { + "description": "Name of the resource group the app belongs to. Read-only.", + "type": "string", + "readOnly": true + }, + "isDefaultContainer": { + "description": "true if the app is a default container; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "defaultHostName": { + "description": "Default hostname of the app. Read-only.", + "type": "string", + "readOnly": true + }, + "slotSwapStatus": { + "$ref": "./CommonDefinitions.json#/definitions/SlotSwapStatus", + "description": "Status of the last deployment slot swap operation.", + "readOnly": true + }, + "httpsOnly": { + "description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests", + "type": "boolean" + }, + "redundancyMode": { + "description": "Site redundancy mode", + "enum": [ + "None", + "Manual", + "Failover", + "ActiveActive", + "GeoRedundant" + ], + "type": "string", + "x-ms-enum": { + "name": "RedundancyMode", + "modelAsString": false + } + }, + "inProgressOperationId": { + "format": "uuid", + "description": "Specifies an operation id if this site has a pending operation.", + "type": "string", + "readOnly": true, + "example": "00000000-0000-0000-0000-000000000000" + }, + "storageAccountRequired": { + "description": "Checks if Customer provided storage account is required", + "type": "boolean" + }, + "keyVaultReferenceIdentity": { + "description": "Identity to use for Key Vault Reference authentication.", + "type": "string" + }, + "virtualNetworkSubnetId": { + "description": "Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration.\nThis must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}", + "type": "string" + } + }, + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "./CommonDefinitions.json#/definitions/ManagedServiceIdentity" + } + } + }, + "SitePhpErrorLogFlag": { + "description": "Used for getting PHP error logging flag.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "SitePhpErrorLogFlag resource specific properties", + "type": "object", + "properties": { + "localLogErrors": { + "description": "Local log_errors setting.", + "type": "string" + }, + "masterLogErrors": { + "description": "Master log_errors setting.", + "type": "string" + }, + "localLogErrorsMaxLength": { + "description": "Local log_errors_max_len setting.", + "type": "string" + }, + "masterLogErrorsMaxLength": { + "description": "Master log_errors_max_len setting.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "SiteSourceControl": { + "description": "Source control configuration for an app.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "SiteSourceControl resource specific properties", + "type": "object", + "properties": { + "repoUrl": { + "description": "Repository or source control URL.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "branch": { + "description": "Name of branch to use for deployment.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "isManualIntegration": { + "description": "true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub).", + "type": "boolean", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "isGitHubAction": { + "description": "true if this is deployed via GitHub action.", + "type": "boolean", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "deploymentRollbackEnabled": { + "description": "true to enable deployment rollback; otherwise, false.", + "type": "boolean", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "isMercurial": { + "description": "true for a Mercurial repository; false for a Git repository.", + "type": "boolean", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "gitHubActionConfiguration": { + "$ref": "#/definitions/GitHubActionConfiguration", + "description": "If GitHub Action is selected, than the associated configuration." + } + }, + "x-ms-client-flatten": true + } + } + }, + "SlotConfigNames": { + "description": "Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app.", + "type": "object", + "properties": { + "connectionStringNames": { + "description": "List of connection string names.", + "type": "array", + "items": { + "type": "string" + } + }, + "appSettingNames": { + "description": "List of application settings names.", + "type": "array", + "items": { + "type": "string" + } + }, + "azureStorageConfigNames": { + "description": "List of external Azure storage account identifiers.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SlotConfigNamesResource": { + "description": "Slot Config names azure resource.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SlotConfigNames", + "description": "Core resource properties", + "type": "object", + "x-ms-client-flatten": true + } + } + }, + "SlotDifference": { + "description": "A setting difference between two deployment slots of an app.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "SlotDifference resource specific properties", + "type": "object", + "properties": { + "level": { + "description": "Level of the difference: Information, Warning or Error.", + "type": "string", + "readOnly": true + }, + "settingType": { + "description": "The type of the setting: General, AppSetting or ConnectionString.", + "type": "string", + "readOnly": true + }, + "diffRule": { + "description": "Rule that describes how to process the setting difference during a slot swap.", + "type": "string", + "readOnly": true + }, + "settingName": { + "description": "Name of the setting.", + "type": "string", + "readOnly": true + }, + "valueInCurrentSlot": { + "description": "Value of the setting in the current slot.", + "type": "string", + "readOnly": true + }, + "valueInTargetSlot": { + "description": "Value of the setting in the target slot.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "Description of the setting difference.", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "SlotDifferenceCollection": { + "description": "Collection of slot differences.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SlotDifference" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "SnapshotCollection": { + "description": "Collection of snapshots which can be used to revert an app to a previous time.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/Snapshot" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "SnapshotRecoverySource": { + "description": "Specifies the web app that snapshot contents will be retrieved from.", + "type": "object", + "properties": { + "location": { + "description": "Geographical location of the source web app, e.g. SouthEastAsia, SouthCentralUS", + "type": "string" + }, + "id": { + "description": "ARM resource ID of the source app. \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.", + "type": "string" + } + } + }, + "SnapshotRestoreRequest": { + "description": "Details about app recovery operation.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "SnapshotRestoreRequest resource specific properties", + "required": [ + "overwrite" + ], + "type": "object", + "properties": { + "snapshotTime": { + "description": "Point in time in which the app restore should be done, formatted as a DateTime string.", + "type": "string" + }, + "recoverySource": { + "$ref": "#/definitions/SnapshotRecoverySource", + "description": "Optional. Specifies the web app that snapshot contents will be retrieved from.\nIf empty, the targeted web app will be used as the source." + }, + "overwrite": { + "description": "If true the restore operation can overwrite source app; otherwise, false.", + "type": "boolean" + }, + "recoverConfiguration": { + "description": "If true, site configuration, in addition to content, will be reverted.", + "type": "boolean" + }, + "ignoreConflictingHostNames": { + "description": "If true, custom hostname conflicts will be ignored when recovering to a target web app.\nThis setting is only necessary when RecoverConfiguration is enabled.", + "type": "boolean" + }, + "useDRSecondary": { + "description": "If true, the snapshot is retrieved from DRSecondary endpoint.", + "type": "boolean" + } + }, + "x-ms-client-flatten": true + } + } + }, + "StorageMigrationOptions": { + "description": "Options for app content migration.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "StorageMigrationOptions resource specific properties", + "required": [ + "azurefilesConnectionString", + "azurefilesShare" + ], + "type": "object", + "properties": { + "azurefilesConnectionString": { + "description": "AzureFiles connection string.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "azurefilesShare": { + "description": "AzureFiles share.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "switchSiteAfterMigration": { + "description": "trueif the app should be switched over; otherwise, false.", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create" + ] + }, + "blockWriteAccessToSite": { + "description": "true if the app should be read only during copy operation; otherwise, false.", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create" + ] + } + }, + "x-ms-client-flatten": true + } + } + }, + "StorageMigrationResponse": { + "description": "Response for a migration of app content request.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "StorageMigrationResponse resource specific properties", + "type": "object", + "properties": { + "operationId": { + "description": "When server starts the migration process, it will return an operation ID identifying that particular migration operation.", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "SubResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The resource id." + } + }, + "x-ms-azure-resource": true, + "description": "The sub resource type." + }, + "SwiftVirtualNetwork": { + "description": "Swift Virtual Network Contract. This is used to enable the new Swift way of doing virtual network integration.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "SwiftVirtualNetwork resource specific properties", + "type": "object", + "properties": { + "subnetResourceId": { + "description": "The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first.", + "type": "string" + }, + "swiftSupported": { + "description": "A flag that specifies if the scale unit this Web App is on supports Swift integration.", + "type": "boolean" + } + }, + "x-ms-client-flatten": true + } + } + }, + "TokenStore": { + "description": "The configuration settings of the token store.", + "type": "object", + "properties": { + "enabled": { + "description": "true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false.", + "type": "boolean" + }, + "tokenRefreshExtensionHours": { + "format": "double", + "description": "The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours.", + "type": "number" + }, + "fileSystem": { + "$ref": "#/definitions/FileSystemTokenStore", + "description": "The configuration settings of the storage of the tokens if a file system is used." + }, + "azureBlobStorage": { + "$ref": "#/definitions/BlobStorageTokenStore", + "description": "The configuration settings of the storage of the tokens if blob storage is used." + } + } + }, + "TriggeredJobHistory": { + "description": "Triggered Web Job History. List of Triggered Web Job Run Information elements.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "TriggeredJobHistory resource specific properties", + "type": "object", + "properties": { + "runs": { + "description": "List of triggered web job runs.", + "type": "array", + "items": { + "$ref": "#/definitions/TriggeredJobRun" + }, + "x-ms-identifiers": [ + "web_job_id" + ] + } + }, + "x-ms-client-flatten": true + } + } + }, + "TriggeredJobHistoryCollection": { + "description": "Collection of Kudu continuous web job information elements.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/TriggeredJobHistory" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "TriggeredJobRun": { + "description": "Triggered Web Job Run Information.", + "type": "object", + "properties": { + "web_job_id": { + "description": "Job ID.", + "type": "string" + }, + "web_job_name": { + "description": "Job name.", + "type": "string" + }, + "status": { + "description": "Job status.", + "enum": [ + "Success", + "Failed", + "Error" + ], + "type": "string", + "x-ms-enum": { + "name": "TriggeredWebJobStatus", + "modelAsString": false + } + }, + "start_time": { + "format": "date-time", + "description": "Start time.", + "type": "string" + }, + "end_time": { + "format": "date-time", + "description": "End time.", + "type": "string" + }, + "duration": { + "description": "Job duration.", + "type": "string" + }, + "output_url": { + "description": "Output URL.", + "type": "string" + }, + "error_url": { + "description": "Error URL.", + "type": "string" + }, + "url": { + "description": "Job URL.", + "type": "string" + }, + "job_name": { + "description": "Job name.", + "type": "string" + }, + "trigger": { + "description": "Job trigger.", + "type": "string" + } + } + }, + "TriggeredWebJob": { + "description": "Triggered Web Job Information.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "TriggeredWebJob resource specific properties", + "type": "object", + "properties": { + "latest_run": { + "$ref": "#/definitions/TriggeredJobRun", + "description": "Latest job run information." + }, + "history_url": { + "description": "History URL.", + "type": "string" + }, + "scheduler_logs_url": { + "description": "Scheduler Logs URL.", + "type": "string" + }, + "run_command": { + "description": "Run command.", + "type": "string" + }, + "url": { + "description": "Job URL.", + "type": "string" + }, + "extra_info_url": { + "description": "Extra Info URL.", + "type": "string" + }, + "web_job_type": { + "description": "Job type.", + "enum": [ + "Continuous", + "Triggered" + ], + "type": "string", + "x-ms-enum": { + "name": "WebJobType", + "modelAsString": false + } + }, + "error": { + "description": "Error information.", + "type": "string" + }, + "using_sdk": { + "description": "Using SDK?", + "type": "boolean" + }, + "publicNetworkAccess": { + "description": "Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string.", + "type": "string" + }, + "storageAccountRequired": { + "description": "Checks if Customer provided storage account is required", + "type": "boolean" + }, + "settings": { + "description": "Job settings.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "TriggeredWebJobCollection": { + "description": "Collection of Kudu continuous web job information elements.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/TriggeredWebJob" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "Twitter": { + "description": "The configuration settings of the Twitter provider.", + "type": "object", + "properties": { + "enabled": { + "description": "false if the Twitter provider should not be enabled despite the set registration; otherwise, true.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/TwitterRegistration", + "description": "The configuration settings of the app registration for the Twitter provider." + } + } + }, + "TwitterRegistration": { + "description": "The configuration settings of the app registration for the Twitter provider.", + "type": "object", + "properties": { + "consumerKey": { + "description": "The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in", + "type": "string" + }, + "consumerSecretSettingName": { + "description": "The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in.", + "type": "string" + } + } + }, + "VolumeMount": { + "required": [ + "volumeSubPath", + "containerMountPath" + ], + "type": "object", + "properties": { + "volumeSubPath": { + "description": "Sub path in the volume where volume is mounted from.", + "type": "string" + }, + "containerMountPath": { + "description": "Target path on the container where volume is mounted on", + "type": "string" + }, + "data": { + "description": "Config Data to be mounted on the volume", + "type": "string" + }, + "readOnly": { + "description": "Boolean to specify if the mount is read only on the container", + "type": "boolean" + } + } + }, + "WebAppInstanceStatusCollection": { + "description": "Collection of app instances.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/WebSiteInstanceStatus" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "WebJob": { + "description": "Web Job Information.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "WebJob resource specific properties", + "type": "object", + "properties": { + "run_command": { + "description": "Run command.", + "type": "string" + }, + "url": { + "description": "Job URL.", + "type": "string" + }, + "extra_info_url": { + "description": "Extra Info URL.", + "type": "string" + }, + "web_job_type": { + "description": "Job type.", + "enum": [ + "Continuous", + "Triggered" + ], + "type": "string", + "x-ms-enum": { + "name": "WebJobType", + "modelAsString": false + } + }, + "error": { + "description": "Error information.", + "type": "string" + }, + "using_sdk": { + "description": "Using SDK?", + "type": "boolean" + }, + "settings": { + "description": "Job settings.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "WebJobCollection": { + "description": "Collection of Kudu web job information elements.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/WebJob" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "WebSiteInstanceStatus": { + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "WebSiteInstanceStatus resource specific properties", + "type": "object", + "properties": { + "state": { + "enum": [ + "READY", + "STOPPED", + "UNKNOWN" + ], + "type": "string", + "x-ms-enum": { + "name": "SiteRuntimeState", + "modelAsString": false + } + }, + "statusUrl": { + "description": "Link to the GetStatusApi in Kudu", + "type": "string" + }, + "detectorUrl": { + "description": "Link to the Diagnose and Solve Portal", + "type": "string" + }, + "consoleUrl": { + "description": "Link to the console to web app instance", + "type": "string" + }, + "healthCheckUrl": { + "description": "Link to the console to web app instance", + "type": "string" + }, + "containers": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ContainerInfo" + } + }, + "physicalZone": { + "description": "The physical zone that the instance is in", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "Workflow": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkflowProperties", + "description": "The workflow properties." + }, + "identity": { + "$ref": "./CommonDefinitions.json#/definitions/ManagedServiceIdentity" + } + }, + "description": "The workflow type.", + "allOf": [ + { + "$ref": "#/definitions/WorkflowResource" + } + ] + }, + "WorkflowArtifacts": { + "type": "object", + "properties": { + "appSettings": { + "$ref": "#/definitions/Object", + "description": "Application settings of the workflow." + }, + "files": { + "$ref": "#/definitions/WorkflowFiles", + "description": "Files of the app." + }, + "filesToDelete": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Files of the app to delete." + } + }, + "description": "The workflow filter." + }, + "WorkflowFilter": { + "type": "object", + "properties": { + "state": { + "$ref": "#/definitions/WorkflowState", + "description": "The state of workflows." + } + }, + "description": "The workflow filter." + }, + "WorkflowParameter": { + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/ParameterType", + "description": "The type." + }, + "value": { + "$ref": "#/definitions/Object", + "description": "The value." + }, + "metadata": { + "$ref": "#/definitions/Object", + "description": "The metadata." + }, + "description": { + "type": "string", + "description": "The description." + } + }, + "description": "The workflow parameters." + }, + "WorkflowProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/WorkflowProvisioningState", + "readOnly": true, + "description": "Gets the provisioning state." + }, + "createdTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the created time." + }, + "changedTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the changed time." + }, + "state": { + "$ref": "#/definitions/WorkflowState", + "description": "The state." + }, + "version": { + "type": "string", + "readOnly": true, + "description": "Gets the version." + }, + "accessEndpoint": { + "type": "string", + "readOnly": true, + "description": "Gets the access endpoint." + }, + "endpointsConfiguration": { + "$ref": "#/definitions/FlowEndpointsConfiguration", + "description": "The endpoints configuration." + }, + "accessControl": { + "$ref": "#/definitions/FlowAccessControlConfiguration", + "description": "The access control configuration." + }, + "sku": { + "$ref": "#/definitions/WorkflowSku", + "readOnly": true, + "description": "The sku." + }, + "integrationAccount": { + "$ref": "#/definitions/ResourceReference", + "description": "The integration account." + }, + "integrationServiceEnvironment": { + "$ref": "#/definitions/ResourceReference", + "description": "The integration service environment." + }, + "definition": { + "$ref": "#/definitions/Object", + "description": "The definition." + }, + "parameters": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/WorkflowParameter" + }, + "description": "The parameters." + }, + "kind": { + "$ref": "#/definitions/Kind", + "description": "The workflow kind." + } + }, + "description": "The workflow properties." + }, + "WorkflowProvisioningState": { + "type": "string", + "description": "The workflow provisioning state.", + "enum": [ + "NotSpecified", + "Accepted", + "Running", + "Ready", + "Creating", + "Created", + "Deleting", + "Deleted", + "Canceled", + "Failed", + "Succeeded", + "Moving", + "Updating", + "Registering", + "Registered", + "Unregistering", + "Unregistered", + "Completed", + "Renewing", + "Pending", + "Waiting", + "InProgress" + ], + "x-ms-enum": { + "name": "WorkflowProvisioningState", + "modelAsString": true + } + }, + "WorkflowListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Workflow" + }, + "description": "The list of workflows." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "The list of workflows." + }, + "WorkflowOutputParameter": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/Object", + "readOnly": true, + "description": "Gets the error." + } + }, + "description": "The workflow output parameter.", + "allOf": [ + { + "$ref": "#/definitions/WorkflowParameter" + } + ] + }, + "RecurrenceFrequency": { + "type": "string", + "description": "The recurrence frequency.", + "enum": [ + "NotSpecified", + "Second", + "Minute", + "Hour", + "Day", + "Week", + "Month", + "Year" + ], + "x-ms-enum": { + "name": "RecurrenceFrequency", + "modelAsString": true + } + }, + "WorkflowEnvelope": { + "description": "Workflow properties definition.", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The resource id." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the resource name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the resource type." + }, + "kind": { + "type": "string", + "description": "The resource kind." + }, + "location": { + "type": "string", + "description": "The resource location.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "properties": { + "description": "Additional workflow properties.", + "type": "object", + "properties": { + "files": { + "description": "Gets or sets the files.", + "$ref": "#/definitions/WorkflowFiles" + }, + "flowState": { + "description": "Gets or sets the state of the workflow.", + "$ref": "#/definitions/WorkflowState" + }, + "health": { + "$ref": "#/definitions/WorkflowHealth", + "description": "Gets or sets workflow health." + } + } + } + } + }, + "WorkflowEnvelopeCollection": { + "description": "Collection of Kudu workflow information elements.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/WorkflowEnvelope" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "WorkflowFiles": { + "description": "Gets or sets the files.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "WorkflowHealth": { + "description": "Represents the workflow health.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Gets or sets the workflow health state.", + "enum": [ + "NotSpecified", + "Healthy", + "Unhealthy", + "Unknown" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkflowHealthState", + "modelAsString": false + } + }, + "error": { + "$ref": "./CommonDefinitions.json#/definitions/ErrorEntity", + "description": "Gets or sets the workflow error." + } + } + }, + "WorkflowResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The resource id." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the resource name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the resource type." + }, + "location": { + "type": "string", + "description": "The resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + }, + "x-ms-azure-resource": true, + "description": "The base resource type." + }, + "WorkflowRun": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkflowRunProperties", + "description": "The workflow run properties." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the workflow run name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the workflow run type." + } + }, + "description": "The workflow run.", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ] + }, + "WorkflowRunAction": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkflowRunActionProperties", + "description": "The workflow run action properties." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the workflow run action name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the workflow run action type." + } + }, + "description": "The workflow run action.", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ] + }, + "WorkflowRunActionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkflowRunAction" + }, + "description": "A list of workflow run actions." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "The list of workflow run actions." + }, + "WorkflowRunActionProperties": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the start time." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the end time." + }, + "status": { + "$ref": "#/definitions/WorkflowStatus", + "readOnly": true, + "description": "Gets the status." + }, + "code": { + "type": "string", + "readOnly": true, + "description": "Gets the code." + }, + "error": { + "$ref": "#/definitions/Object", + "readOnly": true, + "description": "Gets the error." + }, + "trackingId": { + "type": "string", + "readOnly": true, + "description": "Gets the tracking id." + }, + "correlation": { + "$ref": "#/definitions/RunActionCorrelation", + "description": "The correlation properties." + }, + "inputsLink": { + "$ref": "#/definitions/ContentLink", + "readOnly": true, + "description": "Gets the link to inputs." + }, + "outputsLink": { + "$ref": "#/definitions/ContentLink", + "readOnly": true, + "description": "Gets the link to outputs." + }, + "trackedProperties": { + "$ref": "#/definitions/Object", + "readOnly": true, + "description": "Gets the tracked properties." + }, + "retryHistory": { + "type": "array", + "items": { + "$ref": "#/definitions/RetryHistory" + }, + "x-ms-identifiers": [], + "description": "Gets the retry histories." + } + }, + "description": "The workflow run action properties." + }, + "WorkflowRunActionRepetitionDefinitionCollection": { + "type": "object", + "description": "A collection of workflow run action repetitions.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of recommendations.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkflowRunActionRepetitionDefinition" + } + } + } + }, + "WorkflowRunActionRepetitionDefinition": { + "type": "object", + "description": "The workflow run action repetition definition.", + "additionalProperties": false, + "required": [ + "properties" + ], + "properties": { + "properties": { + "$ref": "#/definitions/WorkflowRunActionRepetitionProperties", + "description": "The workflow run action repetition properties definition.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/WorkflowResource" + } + ] + }, + "WorkflowRunActionRepetitionProperties": { + "type": "object", + "description": "The workflow run action repetition properties definition.", + "additionalProperties": false, + "properties": { + "repetitionIndexes": { + "type": "array", + "description": "The repetition indexes.", + "items": { + "$ref": "#/definitions/RepetitionIndex" + }, + "x-ms-identifiers": [ + "itemIndex" + ] + } + }, + "allOf": [ + { + "$ref": "#/definitions/OperationResult" + } + ] + }, + "WorkflowRunListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkflowRun" + }, + "description": "A list of workflow runs." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "The list of workflow runs." + }, + "WorkflowRunProperties": { + "type": "object", + "properties": { + "waitEndTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the wait end time." + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the start time." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the end time." + }, + "status": { + "$ref": "#/definitions/WorkflowStatus", + "readOnly": true, + "description": "Gets the status." + }, + "code": { + "type": "string", + "readOnly": true, + "description": "Gets the code." + }, + "error": { + "$ref": "#/definitions/Object", + "readOnly": true, + "description": "Gets the error." + }, + "correlationId": { + "type": "string", + "readOnly": true, + "description": "Gets the correlation id." + }, + "correlation": { + "$ref": "#/definitions/Correlation", + "description": "The run correlation." + }, + "workflow": { + "$ref": "#/definitions/ResourceReference", + "readOnly": true, + "description": "Gets the reference to workflow version." + }, + "trigger": { + "$ref": "#/definitions/WorkflowRunTrigger", + "readOnly": true, + "description": "Gets the fired trigger." + }, + "outputs": { + "type": "object", + "readOnly": true, + "additionalProperties": { + "$ref": "#/definitions/WorkflowOutputParameter", + "description": "The workflow output parameter." + }, + "description": "Gets the outputs." + }, + "response": { + "$ref": "#/definitions/WorkflowRunTrigger", + "readOnly": true, + "description": "Gets the response of the flow run." + } + }, + "description": "The workflow run properties." + }, + "WorkflowRunActionFilter": { + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/WorkflowStatus", + "description": "The status of workflow run action." + } + }, + "description": "The workflow run action filter." + }, + "WorkflowRunFilter": { + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/WorkflowStatus", + "description": "The status of workflow run." + } + }, + "description": "The workflow run filter." + }, + "WorkflowRunTrigger": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the name." + }, + "inputs": { + "$ref": "#/definitions/Object", + "readOnly": true, + "description": "Gets the inputs." + }, + "inputsLink": { + "$ref": "#/definitions/ContentLink", + "readOnly": true, + "description": "Gets the link to inputs." + }, + "outputs": { + "$ref": "#/definitions/Object", + "readOnly": true, + "description": "Gets the outputs." + }, + "outputsLink": { + "$ref": "#/definitions/ContentLink", + "readOnly": true, + "description": "Gets the link to outputs." + }, + "scheduledTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the scheduled time." + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the start time." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the end time." + }, + "trackingId": { + "type": "string", + "readOnly": true, + "description": "Gets the tracking id." + }, + "correlation": { + "$ref": "#/definitions/Correlation", + "description": "The run correlation." + }, + "code": { + "type": "string", + "readOnly": true, + "description": "Gets the code." + }, + "status": { + "$ref": "#/definitions/WorkflowStatus", + "readOnly": true, + "description": "Gets the status." + }, + "error": { + "$ref": "#/definitions/Object", + "readOnly": true, + "description": "Gets the error." + }, + "trackedProperties": { + "$ref": "#/definitions/Object", + "readOnly": true, + "description": "Gets the tracked properties." + } + }, + "description": "The workflow run trigger." + }, + "WorkflowSku": { + "type": "object", + "description": "The sku type.", + "required": [ + "name" + ], + "properties": { + "name": { + "$ref": "#/definitions/WorkflowSkuName", + "description": "The name." + }, + "plan": { + "$ref": "#/definitions/ResourceReference", + "description": "The reference to plan." + } + } + }, + "WorkflowSkuName": { + "type": "string", + "enum": [ + "NotSpecified", + "Free", + "Shared", + "Basic", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "WorkflowSkuName", + "modelAsString": true + }, + "description": "The sku name." + }, + "WorkflowState": { + "type": "string", + "description": "The workflow state.", + "enum": [ + "NotSpecified", + "Completed", + "Enabled", + "Disabled", + "Deleted", + "Suspended" + ], + "x-ms-enum": { + "name": "WorkflowState", + "modelAsString": true + } + }, + "WorkflowStatus": { + "type": "string", + "description": "The workflow status.", + "enum": [ + "NotSpecified", + "Paused", + "Running", + "Waiting", + "Succeeded", + "Skipped", + "Suspended", + "Cancelled", + "Failed", + "Faulted", + "TimedOut", + "Aborted", + "Ignored" + ], + "x-ms-enum": { + "name": "WorkflowStatus", + "modelAsString": true + } + }, + "WorkflowTrigger": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkflowTriggerProperties", + "description": "The workflow trigger properties." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the workflow trigger name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the workflow trigger type." + } + }, + "description": "The workflow trigger.", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ] + }, + "WorkflowTriggerCallbackUrl": { + "type": "object", + "properties": { + "value": { + "type": "string", + "readOnly": true, + "description": "Gets the workflow trigger callback URL." + }, + "method": { + "type": "string", + "readOnly": true, + "description": "Gets the workflow trigger callback URL HTTP method." + }, + "basePath": { + "type": "string", + "readOnly": true, + "description": "Gets the workflow trigger callback URL base path." + }, + "relativePath": { + "type": "string", + "readOnly": true, + "description": "Gets the workflow trigger callback URL relative path." + }, + "relativePathParameters": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets the workflow trigger callback URL relative path parameters." + }, + "queries": { + "$ref": "#/definitions/WorkflowTriggerListCallbackUrlQueries", + "description": "Gets the workflow trigger callback URL query parameters." + } + }, + "description": "The workflow trigger callback URL." + }, + "WorkflowTriggerFilter": { + "type": "object", + "properties": { + "state": { + "$ref": "#/definitions/WorkflowState", + "description": "The state of workflow trigger." + } + }, + "description": "The workflow trigger filter." + }, + "WorkflowTriggerListCallbackUrlQueries": { + "type": "object", + "properties": { + "api-version": { + "type": "string", + "description": "The api version." + }, + "sp": { + "type": "string", + "description": "The SAS permissions." + }, + "sv": { + "type": "string", + "description": "The SAS version." + }, + "sig": { + "type": "string", + "description": "The SAS signature." + }, + "se": { + "type": "string", + "description": "The SAS timestamp." + } + }, + "description": "Gets the workflow trigger callback URL query parameters." + }, + "WorkflowTriggerHistory": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkflowTriggerHistoryProperties", + "description": "Gets the workflow trigger history properties." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the workflow trigger history name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the workflow trigger history type." + } + }, + "description": "The workflow trigger history.", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ] + }, + "WorkflowTriggerHistoryFilter": { + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/WorkflowStatus", + "description": "The status of workflow trigger history." + } + }, + "description": "The workflow trigger history filter." + }, + "WorkflowTriggerHistoryProperties": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the start time." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the end time." + }, + "scheduledTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The scheduled time." + }, + "status": { + "$ref": "#/definitions/WorkflowStatus", + "readOnly": true, + "description": "Gets the status." + }, + "code": { + "type": "string", + "readOnly": true, + "description": "Gets the code." + }, + "error": { + "$ref": "#/definitions/Object", + "readOnly": true, + "description": "Gets the error." + }, + "trackingId": { + "type": "string", + "readOnly": true, + "description": "Gets the tracking id." + }, + "correlation": { + "$ref": "#/definitions/Correlation", + "description": "The run correlation." + }, + "inputsLink": { + "$ref": "#/definitions/ContentLink", + "readOnly": true, + "description": "Gets the link to input parameters." + }, + "outputsLink": { + "$ref": "#/definitions/ContentLink", + "readOnly": true, + "description": "Gets the link to output parameters." + }, + "fired": { + "type": "boolean", + "readOnly": true, + "description": "The value indicating whether trigger was fired." + }, + "run": { + "$ref": "#/definitions/ResourceReference", + "readOnly": true, + "description": "Gets the reference to workflow run." + } + }, + "description": "The workflow trigger history properties." + }, + "WorkflowTriggerHistoryListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkflowTriggerHistory" + }, + "description": "A list of workflow trigger histories." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "The list of workflow trigger histories." + }, + "WorkflowTriggerProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/WorkflowTriggerProvisioningState", + "readOnly": true, + "description": "Gets the provisioning state." + }, + "createdTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the created time." + }, + "changedTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the changed time." + }, + "state": { + "$ref": "#/definitions/WorkflowState", + "readOnly": true, + "description": "Gets the state." + }, + "status": { + "$ref": "#/definitions/WorkflowStatus", + "readOnly": true, + "description": "Gets the status." + }, + "lastExecutionTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the last execution time." + }, + "nextExecutionTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the next execution time." + }, + "recurrence": { + "$ref": "#/definitions/WorkflowTriggerRecurrence", + "readOnly": true, + "description": "Gets the workflow trigger recurrence." + }, + "workflow": { + "$ref": "#/definitions/ResourceReference", + "readOnly": true, + "description": "Gets the reference to workflow." + } + }, + "description": "The workflow trigger properties." + }, + "WorkflowTriggerProvisioningState": { + "type": "string", + "description": "The workflow trigger provisioning state.", + "enum": [ + "NotSpecified", + "Accepted", + "Running", + "Ready", + "Creating", + "Created", + "Deleting", + "Deleted", + "Canceled", + "Failed", + "Succeeded", + "Moving", + "Updating", + "Registering", + "Registered", + "Unregistering", + "Unregistered", + "Completed" + ], + "x-ms-enum": { + "name": "WorkflowTriggerProvisioningState", + "modelAsString": true + } + }, + "WorkflowTriggerListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkflowTrigger" + }, + "description": "A list of workflow triggers." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "The list of workflow triggers." + }, + "WorkflowTriggerRecurrence": { + "type": "object", + "properties": { + "frequency": { + "$ref": "#/definitions/RecurrenceFrequency", + "description": "The frequency." + }, + "interval": { + "type": "integer", + "format": "int32", + "description": "The interval." + }, + "startTime": { + "type": "string", + "description": "The start time." + }, + "endTime": { + "type": "string", + "description": "The end time." + }, + "timeZone": { + "type": "string", + "description": "The time zone." + }, + "schedule": { + "$ref": "#/definitions/RecurrenceSchedule", + "description": "The recurrence schedule." + } + }, + "description": "The workflow trigger recurrence." + }, + "WorkflowVersion": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkflowVersionProperties", + "description": "The workflow version properties." + } + }, + "description": "The workflow version.", + "allOf": [ + { + "$ref": "#/definitions/WorkflowResource" + } + ] + }, + "WorkflowVersionProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/WorkflowProvisioningState", + "readOnly": true, + "description": "The provisioning state." + }, + "createdTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the created time." + }, + "changedTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the changed time." + }, + "state": { + "$ref": "#/definitions/WorkflowState", + "description": "The state." + }, + "version": { + "type": "string", + "readOnly": true, + "description": "Gets the version." + }, + "accessEndpoint": { + "type": "string", + "readOnly": true, + "description": "Gets the access endpoint." + }, + "endpointsConfiguration": { + "$ref": "#/definitions/FlowEndpointsConfiguration", + "description": "The endpoints configuration." + }, + "accessControl": { + "$ref": "#/definitions/FlowAccessControlConfiguration", + "description": "The access control configuration." + }, + "sku": { + "$ref": "#/definitions/WorkflowSku", + "readOnly": true, + "description": "The sku." + }, + "integrationAccount": { + "$ref": "#/definitions/ResourceReference", + "description": "The integration account." + }, + "definition": { + "$ref": "#/definitions/Object", + "description": "The definition." + }, + "parameters": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/WorkflowParameter" + }, + "description": "The parameters." + } + }, + "description": "The workflow version properties." + }, + "WorkflowVersionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkflowVersion", + "description": "The workflow version." + }, + "description": "A list of workflow versions." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "The list of workflow versions." + } + }, + "parameters": { + "siteNameParameter": { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "slotNameParameter": { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group to which the resource belongs.", + "required": true, + "type": "string", + "maxLength": 90, + "minLength": 1, + "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$", + "x-ms-parameter-location": "method" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API Version", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + } + }, + "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/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ActivateRevision.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ActivateRevision.json new file mode 100644 index 000000000000..bc4213ef077c --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ActivateRevision.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "name": "testcontainerApp0-pjxhsye", + "api-version": "2024-04-01" + }, + "responses": { + "200": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AnalyzeCustomHostName.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AnalyzeCustomHostName.json new file mode 100644 index 000000000000..bdb3ec29a16f --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AnalyzeCustomHostName.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141", + "name": "sitef6141", + "type": "Microsoft.Web/sites", + "properties": { + "isHostnameAlreadyVerified": true, + "customDomainVerificationTest": "Passed", + "customDomainVerificationFailureInfo": { + "code": "07198", + "message": "Custom domain verification failed on conflicting CNAMEs." + }, + "hasConflictOnScaleUnit": false, + "hasConflictAcrossSubscription": true, + "conflictingAppResourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/siteog", + "cNameRecords": [ + "siteog.azurewebsites.net" + ] + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AnalyzeCustomHostNameSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AnalyzeCustomHostNameSlot.json new file mode 100644 index 000000000000..3e85f897db43 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AnalyzeCustomHostNameSlot.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "slot": "staging", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/slots/staging", + "name": "sitef6141/staging", + "type": "Microsoft.Web/sites/stagings", + "properties": { + "isHostnameAlreadyVerified": true, + "customDomainVerificationTest": "Passed", + "customDomainVerificationFailureInfo": { + "code": "07198", + "message": "Custom domain verification failed on conflicting CNAMEs." + }, + "hasConflictOnScaleUnit": false, + "hasConflictAcrossSubscription": true, + "conflictingAppResourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/siteog/slots/qa", + "cNameRecords": [ + "siteog.azurewebsites.net" + ] + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ApproveOrRejectPrivateEndpointConnection.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ApproveOrRejectPrivateEndpointConnection.json new file mode 100644 index 000000000000..34984c0a8966 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ApproveOrRejectPrivateEndpointConnection.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "privateEndpointConnectionName": "fa38656c-034e-43d8-adce-fe06ce039c98", + "privateEndpointWrapper": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com" + } + } + }, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "fa38656c-034e-43d8-adce-fe06ce039c98", + "type": "Microsoft.Web/hostingEnvironments/privateEndpointConnections", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/privateEndpointConnections/fa38656c-034e-43d8-adce-fe06ce039c98", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/test-privateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com", + "actionsRequired": "None" + }, + "ipAddresses": [] + } + } + }, + "202": { + "headers": {}, + "body": { + "name": "fa38656c-034e-43d8-adce-fe06ce039c98", + "type": "Microsoft.Web/hostingEnvironments/privateEndpointConnections", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/privateEndpointConnections/fa38656c-034e-43d8-adce-fe06ce039c98", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/test-privateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com", + "actionsRequired": "None" + }, + "ipAddresses": [] + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ChangeVnet.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ChangeVnet.json new file mode 100644 index 000000000000..17f315a80e5b --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ChangeVnet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01", + "vnetInfo": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default" + } + }, + "responses": { + "202": { + "headers": { + "x-ms-routing-request-id": "NORTHCENTRALUS:20220408T212612Z:79bd0bce-5524-4fd1-ada0-1d8c86263d17", + "Location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/operations/f6a27306-3ee3-4e6b-997d-3ba2024b85e6?api-version=2019-08-01" + }, + "body": { + "value": [] + } + }, + "200": { + "headers": {}, + "body": { + "value": [] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_CreateOrUpdate.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_CreateOrUpdate.json new file mode 100644 index 000000000000..20dbfa5e5140 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_CreateOrUpdate.json @@ -0,0 +1,185 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01", + "location": "South Central US", + "hostingEnvironmentEnvelope": { + "kind": "Asev3", + "location": "South Central US", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/delegated" + } + } + } + }, + "responses": { + "202": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase", + "name": "test-ase", + "type": "Microsoft.Web/hostingEnvironments", + "kind": "ASEV3", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "status": "Ready", + "virtualNetwork": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated", + "name": "delegated", + "type": "Microsoft.Network/virtualNetworks/subnets", + "subnet": "" + }, + "internalLoadBalancingMode": "None", + "multiSize": "Standard_D2d_v4", + "multiRoleCount": null, + "ipsslAddressCount": 0, + "dnsSuffix": "test-ase.p.azurewebsites.net", + "maximumNumberOfMachines": 250, + "frontEndScaleFactor": 15, + "suspended": false, + "clusterSettings": null, + "userWhitelistedIpRanges": null, + "hasLinuxWorkers": true, + "dedicatedHostCount": 0, + "zoneRedundant": false, + "networkingConfiguration": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking", + "properties": { + "windowsOutboundIpAddresses": [ + "20.88.241.56", + "20.88.241.9" + ], + "linuxOutboundIpAddresses": [ + "20.88.241.56", + "20.88.241.9" + ], + "externalInboundIpAddresses": [ + "52.153.248.36" + ], + "internalInboundIpAddresses": [], + "allowNewPrivateEndpointConnections": false, + "ftpEnabled": false, + "remoteDebugEnabled": false, + "inboundIpAddressOverride": null + } + } + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase", + "name": "test-ase", + "type": "Microsoft.Web/hostingEnvironments", + "kind": "ASEV3", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "status": "Ready", + "virtualNetwork": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated", + "name": "delegated", + "type": "Microsoft.Network/virtualNetworks/subnets", + "subnet": "" + }, + "internalLoadBalancingMode": "None", + "multiSize": "Standard_D2d_v4", + "multiRoleCount": null, + "ipsslAddressCount": 0, + "dnsSuffix": "test-ase.p.azurewebsites.net", + "maximumNumberOfMachines": 250, + "frontEndScaleFactor": 15, + "suspended": false, + "clusterSettings": null, + "userWhitelistedIpRanges": null, + "hasLinuxWorkers": true, + "dedicatedHostCount": 0, + "zoneRedundant": false, + "networkingConfiguration": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking", + "properties": { + "windowsOutboundIpAddresses": [ + "20.88.241.56", + "20.88.241.9" + ], + "linuxOutboundIpAddresses": [ + "20.88.241.56", + "20.88.241.9" + ], + "externalInboundIpAddresses": [ + "52.153.248.36" + ], + "internalInboundIpAddresses": [], + "allowNewPrivateEndpointConnections": false, + "ftpEnabled": false, + "remoteDebugEnabled": false, + "inboundIpAddressOverride": null + } + } + } + } + }, + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase", + "name": "test-ase", + "type": "Microsoft.Web/hostingEnvironments", + "kind": "ASEV3", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "status": "Ready", + "virtualNetwork": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated", + "name": "delegated", + "type": "Microsoft.Network/virtualNetworks/subnets", + "subnet": "" + }, + "internalLoadBalancingMode": "None", + "multiSize": "Standard_D2d_v4", + "multiRoleCount": null, + "ipsslAddressCount": 0, + "dnsSuffix": "test-ase.p.azurewebsites.net", + "maximumNumberOfMachines": 250, + "frontEndScaleFactor": 15, + "suspended": false, + "clusterSettings": null, + "userWhitelistedIpRanges": null, + "hasLinuxWorkers": true, + "dedicatedHostCount": 0, + "zoneRedundant": false, + "networkingConfiguration": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking", + "properties": { + "windowsOutboundIpAddresses": [ + "20.88.241.56", + "20.88.241.9" + ], + "linuxOutboundIpAddresses": [ + "20.88.241.56", + "20.88.241.9" + ], + "externalInboundIpAddresses": [ + "52.153.248.36" + ], + "internalInboundIpAddresses": [], + "allowNewPrivateEndpointConnections": false, + "ftpEnabled": false, + "remoteDebugEnabled": false, + "inboundIpAddressOverride": null + } + } + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_CreateOrUpdateMultiRolePool.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_CreateOrUpdateMultiRolePool.json new file mode 100644 index 000000000000..fc88d24734ce --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_CreateOrUpdateMultiRolePool.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "multiRolePoolEnvelope": { + "properties": { + "workerSize": "Medium", + "workerCount": 3 + } + }, + "api-version": "2024-04-01" + }, + "responses": { + "202": { + "headers": {}, + "body": {} + }, + "200": { + "headers": {}, + "body": {} + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_CreateOrUpdateWorkerPool.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_CreateOrUpdateWorkerPool.json new file mode 100644 index 000000000000..6221c7d3f16b --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_CreateOrUpdateWorkerPool.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "workerPoolName": "0", + "workerPoolEnvelope": { + "properties": { + "workerSize": "Small", + "workerCount": 3 + } + }, + "api-version": "2024-04-01" + }, + "responses": { + "202": { + "headers": {}, + "body": {} + }, + "200": { + "headers": {}, + "body": {} + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Delete.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Delete.json new file mode 100644 index 000000000000..8aa03b8749c0 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01" + }, + "responses": { + "202": { + "headers": { + "x-ms-routing-request-id": "NORTHCENTRALUS:20220408T212612Z:79bd0bce-5524-4fd1-ada0-1d8c86263d17", + "Location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/operations/f6a27306-3ee3-4e6b-997d-3ba2024b85e6?api-version=2019-08-01" + } + }, + "204": { + "headers": {} + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_DeletePrivateEndpointConnection.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_DeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..5a3b94cf8581 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_DeletePrivateEndpointConnection.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "privateEndpointConnectionName": "fa38656c-034e-43d8-adce-fe06ce039c98", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": {} + }, + "202": { + "headers": { + "x-ms-routing-request-id": "NORTHCENTRALUS:20220408T212612Z:79bd0bce-5524-4fd1-ada0-1d8c86263d17", + "Location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/operations/f6a27306-3ee3-4e6b-997d-3ba2024b85e6?api-version=2019-08-01" + }, + "body": {} + }, + "204": { + "headers": {}, + "body": {} + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Get.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Get.json new file mode 100644 index 000000000000..2be8909153ae --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Get.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase", + "name": "test-ase", + "type": "Microsoft.Web/hostingEnvironments", + "kind": "ASEV3", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "status": "Ready", + "virtualNetwork": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated", + "name": "delegated", + "type": "Microsoft.Network/virtualNetworks/subnets", + "subnet": "" + }, + "internalLoadBalancingMode": "None", + "multiSize": "Standard_D2d_v4", + "multiRoleCount": null, + "ipsslAddressCount": 0, + "dnsSuffix": "test-ase.p.azurewebsites.net", + "maximumNumberOfMachines": 250, + "frontEndScaleFactor": 15, + "suspended": false, + "clusterSettings": null, + "userWhitelistedIpRanges": null, + "hasLinuxWorkers": true, + "dedicatedHostCount": 0, + "zoneRedundant": false, + "networkingConfiguration": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking", + "properties": { + "windowsOutboundIpAddresses": [ + "20.88.241.56", + "20.88.241.9" + ], + "linuxOutboundIpAddresses": [ + "20.88.241.56", + "20.88.241.9" + ], + "externalInboundIpAddresses": [ + "52.153.248.36" + ], + "internalInboundIpAddresses": [], + "allowNewPrivateEndpointConnections": false, + "ftpEnabled": false, + "remoteDebugEnabled": false, + "inboundIpAddressOverride": null + } + } + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetAseV3NetworkingConfiguration.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetAseV3NetworkingConfiguration.json new file mode 100644 index 000000000000..e5e4c1294457 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetAseV3NetworkingConfiguration.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking", + "name": "networking", + "type": "Microsoft.Web/hostingEnvironments/configurations/networking", + "properties": { + "windowsOutboundIpAddresses": [ + "20.88.241.56", + "20.88.241.9" + ], + "linuxOutboundIpAddresses": [ + "20.88.241.56", + "20.88.241.9" + ], + "externalInboundIpAddresses": [ + "52.153.248.36" + ], + "internalInboundIpAddresses": [], + "allowNewPrivateEndpointConnections": false, + "ftpEnabled": false, + "remoteDebugEnabled": false, + "inboundIpAddressOverride": null + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetDiagnosticsItem.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetDiagnosticsItem.json new file mode 100644 index 000000000000..de7ac42cb545 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetDiagnosticsItem.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "diagnosticsName": "test-diagnostic", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "test-diagnostic" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetMultiRolePool.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetMultiRolePool.json new file mode 100644 index 000000000000..0aab356f9cb7 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetMultiRolePool.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/multiRolePools/default", + "name": "default", + "type": "Microsoft.Web/hostingEnvironments/multiRolePools", + "properties": { + "workerSize": "Standard_D1_V2", + "workerCount": 2, + "instanceNames": [ + "10.7.1.8", + "10.7.1.9" + ] + }, + "sku": { + "name": "Q1", + "tier": "Quantum", + "size": "Q1", + "family": "Q", + "capacity": 2 + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetPrivateEndpointConnection.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetPrivateEndpointConnection.json new file mode 100644 index 000000000000..c0e62a95724d --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetPrivateEndpointConnection.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "privateEndpointConnectionName": "fa38656c-034e-43d8-adce-fe06ce039c98", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "fa38656c-034e-43d8-adce-fe06ce039c98", + "type": "Microsoft.Web/hostingEnvironments/privateEndpointConnections", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/privateEndpointConnections/fa38656c-034e-43d8-adce-fe06ce039c98", + "properties": { + "provisioningState": "Pending", + "privateEndpoint": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/test-privateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Disconnecting", + "description": "Please approve my connection, thanks!", + "actionsRequired": "None" + }, + "ipAddresses": [] + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetPrivateEndpointConnectionList.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetPrivateEndpointConnectionList.json new file mode 100644 index 000000000000..d9293ff61db6 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetPrivateEndpointConnectionList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "fa38656c-034e-43d8-adce-fe06ce039c98", + "type": "Microsoft.Web/hostingEnvironments/privateEndpointConnections", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/privateEndpointConnections/fa38656c-034e-43d8-adce-fe06ce039c98", + "properties": { + "provisioningState": "Pending", + "privateEndpoint": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/test-privateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Disconnecting", + "description": "Please approve my connection, thanks!", + "actionsRequired": "None" + }, + "ipAddresses": [] + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetPrivateLinkResources.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetPrivateLinkResources.json new file mode 100644 index 000000000000..48fa5edb5dc4 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetPrivateLinkResources.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetVipInfo.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetVipInfo.json new file mode 100644 index 000000000000..891dcac0b382 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetVipInfo.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/Microsoft.Web/hostingEnvironments/test-ase/capacities/virtualip", + "name": "test-ase", + "type": "Microsoft.Web/hostingEnvironments/capacities", + "properties": { + "serviceIpAddress": "20.112.141.120", + "internalIpAddress": null, + "outboundIpAddresses": [ + "20.112.141.120" + ], + "vipMappings": [ + { + "virtualIP": "20.112.141.135", + "internalHttpPort": 20003, + "internalHttpsPort": 20001, + "inUse": false, + "serviceName": null + }, + { + "virtualIP": "20.112.141.150", + "internalHttpPort": 20004, + "internalHttpsPort": 20002, + "inUse": false, + "serviceName": null + } + ] + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetWorkerPool.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetWorkerPool.json new file mode 100644 index 000000000000..99ed34c96853 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_GetWorkerPool.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "workerPoolName": "workerPool1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/workerPool1", + "name": "workerPool1", + "type": "Microsoft.Web/hostingEnvironments/workerPools", + "kind": "ASEV1", + "properties": { + "workerSizeId": 0, + "workerSize": "Small", + "workerCount": 2, + "instanceNames": [] + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_List.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_List.json new file mode 100644 index 000000000000..a5fb8a55f559 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_List.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase", + "name": "test-ase", + "type": "Microsoft.Web/hostingEnvironments", + "kind": "ASEV3", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "status": "Ready", + "virtualNetwork": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated", + "name": "delegated", + "type": "Microsoft.Network/virtualNetworks/subnets", + "subnet": "" + }, + "internalLoadBalancingMode": "None", + "multiSize": "Standard_D2d_v4", + "multiRoleCount": null, + "ipsslAddressCount": 0, + "dnsSuffix": "test-ase.p.azurewebsites.net", + "maximumNumberOfMachines": 250, + "frontEndScaleFactor": 15, + "suspended": false, + "clusterSettings": null, + "userWhitelistedIpRanges": null, + "hasLinuxWorkers": true, + "dedicatedHostCount": 0, + "zoneRedundant": false, + "networkingConfiguration": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking", + "properties": { + "windowsOutboundIpAddresses": [ + "20.88.241.56", + "20.88.241.9" + ], + "linuxOutboundIpAddresses": [ + "20.88.241.56", + "20.88.241.9" + ], + "externalInboundIpAddresses": [ + "52.153.248.36" + ], + "internalInboundIpAddresses": [], + "allowNewPrivateEndpointConnections": false, + "ftpEnabled": false, + "remoteDebugEnabled": false, + "inboundIpAddressOverride": null + } + } + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListAppServicePlans.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListAppServicePlans.json new file mode 100644 index 000000000000..9b96606fab44 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListAppServicePlans.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/serverfarms/test-asp", + "name": "test-asp", + "type": "Microsoft.Web/serverfarms", + "kind": "app", + "location": "Central US EUAP", + "tags": {}, + "properties": { + "workerTierName": null, + "status": "Ready", + "subscription": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "hostingEnvironmentProfile": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase", + "name": "test-ase", + "type": "Microsoft.Web/hostingEnvironments" + }, + "maximumNumberOfWorkers": 100, + "geoRegion": "Central US EUAP", + "perSiteScaling": false, + "elasticScaleEnabled": false, + "maximumElasticWorkerCount": 0, + "numberOfSites": 0, + "isSpot": false, + "spotExpirationTime": null, + "freeOfferExpirationTime": null, + "resourceGroup": "test-rg", + "reserved": false, + "isXenon": false, + "hyperV": false, + "targetWorkerCount": 1, + "targetWorkerSizeId": 0, + "provisioningState": null, + "kubeEnvironmentProfile": null, + "zoneRedundant": false + }, + "sku": { + "name": "I1", + "tier": "Isolated", + "size": "I1", + "family": "I", + "capacity": 0 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListByResourceGroup.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListByResourceGroup.json new file mode 100644 index 000000000000..e56058944395 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListByResourceGroup.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase", + "name": "test-ase", + "type": "Microsoft.Web/hostingEnvironments", + "kind": "ASEV3", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "status": "Ready", + "virtualNetwork": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated", + "name": "delegated", + "type": "Microsoft.Network/virtualNetworks/subnets", + "subnet": "" + }, + "internalLoadBalancingMode": "None", + "multiSize": "Standard_D2d_v4", + "multiRoleCount": null, + "ipsslAddressCount": 0, + "dnsSuffix": "test-ase.p.azurewebsites.net", + "maximumNumberOfMachines": 250, + "frontEndScaleFactor": 15, + "suspended": false, + "clusterSettings": null, + "userWhitelistedIpRanges": null, + "hasLinuxWorkers": true, + "dedicatedHostCount": 0, + "zoneRedundant": false, + "networkingConfiguration": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking", + "properties": { + "windowsOutboundIpAddresses": [ + "20.88.241.56", + "20.88.241.9" + ], + "linuxOutboundIpAddresses": [ + "20.88.241.56", + "20.88.241.9" + ], + "externalInboundIpAddresses": [ + "52.153.248.36" + ], + "internalInboundIpAddresses": [], + "allowNewPrivateEndpointConnections": false, + "ftpEnabled": false, + "remoteDebugEnabled": false, + "inboundIpAddressOverride": null + } + } + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListCapacities.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListCapacities.json new file mode 100644 index 000000000000..fde144ec7dad --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListCapacities.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": null, + "availableCapacity": 0, + "totalCapacity": 1, + "unit": null, + "computeMode": "Dedicated", + "workerSize": null, + "workerSizeId": 0, + "excludeFromCapacityAllocation": false, + "isApplicableForAllComputeModes": false, + "siteMode": null, + "isLinux": false + }, + { + "name": null, + "availableCapacity": 0, + "totalCapacity": 1, + "unit": null, + "computeMode": "Dedicated", + "workerSize": null, + "workerSizeId": 1, + "excludeFromCapacityAllocation": false, + "isApplicableForAllComputeModes": false, + "siteMode": null, + "isLinux": false + }, + { + "name": null, + "availableCapacity": 0, + "totalCapacity": 1, + "unit": null, + "computeMode": "Dedicated", + "workerSize": null, + "workerSizeId": 2, + "excludeFromCapacityAllocation": false, + "isApplicableForAllComputeModes": false, + "siteMode": null, + "isLinux": false + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListDiagnostics.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListDiagnostics.json new file mode 100644 index 000000000000..671d015954d9 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListDiagnostics.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [], + "nextLink": null, + "id": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListMultiRoleMetricDefinitions.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListMultiRoleMetricDefinitions.json new file mode 100644 index 000000000000..dbc17abd87bd --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListMultiRoleMetricDefinitions.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "CpuPercentage", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/metricdefinitions/cpupercentage" + }, + { + "name": "MemoryPercentage", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/metricdefinitions/MemoryPercentage" + }, + { + "name": "DiskQueueLength", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/metricdefinitions/DiskQueueLength" + }, + { + "name": "HttpQueueLength", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/metricdefinitions/HttpQueueLength" + }, + { + "name": "BytesReceived", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/metricdefinitions/BytesReceived" + }, + { + "name": "BytesSent", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/metricdefinitions/BytesSent" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListMultiRolePoolInstanceMetricDefinitions.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListMultiRolePoolInstanceMetricDefinitions.json new file mode 100644 index 000000000000..7355197fc16f --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListMultiRolePoolInstanceMetricDefinitions.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "instance": "10.7.1.8", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "CpuPercentage", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/metricdefinitions/cpupercentage" + }, + { + "name": "MemoryPercentage", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/metricdefinitions/MemoryPercentage" + }, + { + "name": "DiskQueueLength", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/metricdefinitions/DiskQueueLength" + }, + { + "name": "HttpQueueLength", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/metricdefinitions/HttpQueueLength" + }, + { + "name": "BytesReceived", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/metricdefinitions/BytesReceived" + }, + { + "name": "BytesSent", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/metricdefinitions/BytesSent" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListMultiRolePoolSkus.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListMultiRolePoolSkus.json new file mode 100644 index 000000000000..f49a87ccca0d --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListMultiRolePoolSkus.json @@ -0,0 +1,158 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "resourceType": "Microsoft.Web/hostingEnvironments/multiRolePools", + "sku": { + "name": "S2", + "tier": "Standard" + }, + "capacity": { + "minimum": 2, + "maximum": 247, + "default": 2, + "scaleType": "automatic", + "elasticMaximum": null + } + }, + { + "resourceType": "Microsoft.Web/hostingEnvironments/multiRolePools", + "sku": { + "name": "S3", + "tier": "Standard" + }, + "capacity": { + "minimum": 2, + "maximum": 247, + "default": 2, + "scaleType": "automatic", + "elasticMaximum": null + } + }, + { + "resourceType": "Microsoft.Web/hostingEnvironments/multiRolePools", + "sku": { + "name": "S4", + "tier": "Standard" + }, + "capacity": { + "minimum": 2, + "maximum": 247, + "default": 2, + "scaleType": "automatic", + "elasticMaximum": null + } + }, + { + "resourceType": "Microsoft.Web/hostingEnvironments/multiRolePools", + "sku": { + "name": "O2", + "tier": "Optimized" + }, + "capacity": { + "minimum": 2, + "maximum": 247, + "default": 2, + "scaleType": "automatic", + "elasticMaximum": null + } + }, + { + "resourceType": "Microsoft.Web/hostingEnvironments/multiRolePools", + "sku": { + "name": "O3", + "tier": "Optimized" + }, + "capacity": { + "minimum": 2, + "maximum": 247, + "default": 2, + "scaleType": "automatic", + "elasticMaximum": null + } + }, + { + "resourceType": "Microsoft.Web/hostingEnvironments/multiRolePools", + "sku": { + "name": "O4", + "tier": "Optimized" + }, + "capacity": { + "minimum": 2, + "maximum": 247, + "default": 2, + "scaleType": "automatic", + "elasticMaximum": null + } + }, + { + "resourceType": "Microsoft.Web/hostingEnvironments/multiRolePools", + "sku": { + "name": "Q1", + "tier": "Quantum" + }, + "capacity": { + "minimum": 2, + "maximum": 247, + "default": 2, + "scaleType": "automatic", + "elasticMaximum": null + } + }, + { + "resourceType": "Microsoft.Web/hostingEnvironments/multiRolePools", + "sku": { + "name": "Q2", + "tier": "Quantum" + }, + "capacity": { + "minimum": 2, + "maximum": 247, + "default": 2, + "scaleType": "automatic", + "elasticMaximum": null + } + }, + { + "resourceType": "Microsoft.Web/hostingEnvironments/multiRolePools", + "sku": { + "name": "Q3", + "tier": "Quantum" + }, + "capacity": { + "minimum": 2, + "maximum": 247, + "default": 2, + "scaleType": "automatic", + "elasticMaximum": null + } + }, + { + "resourceType": "Microsoft.Web/hostingEnvironments/multiRolePools", + "sku": { + "name": "Q4", + "tier": "Quantum" + }, + "capacity": { + "minimum": 2, + "maximum": 247, + "default": 2, + "scaleType": "automatic", + "elasticMaximum": null + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListMultiRolePools.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListMultiRolePools.json new file mode 100644 index 000000000000..faa4854fec50 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListMultiRolePools.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/multiRolePools/default", + "name": "default", + "type": "Microsoft.Web/hostingEnvironments/multiRolePools", + "properties": { + "workerSize": "Standard_D1_V2", + "workerCount": 2, + "instanceNames": [ + "10.7.1.8", + "10.7.1.9" + ] + }, + "sku": { + "name": "Q1", + "tier": "Quantum", + "size": "Q1", + "family": "Q", + "capacity": 2 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListMultiRoleUsages.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListMultiRoleUsages.json new file mode 100644 index 000000000000..0b809668d4c2 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListMultiRoleUsages.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListOperations.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListOperations.json new file mode 100644 index 000000000000..d1f60c089c58 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListOperations.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": [] + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListUsages.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListUsages.json new file mode 100644 index 000000000000..fdef1c630ac6 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListUsages.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "unit": "Bytes", + "nextResetTime": "9999-12-31T23:59:59.9999999Z", + "currentValue": 37888, + "limit": 1099511627776, + "name": { + "value": "FileSystemStorage", + "localizedValue": "File System Storage" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListWebApps.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListWebApps.json new file mode 100644 index 000000000000..60b482d0bc6f --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListWebApps.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-site", + "name": "test-site", + "location": "Central US EUAP", + "type": "Microsoft.Web/sites", + "properties": { + "state": "Running", + "hostNames": [ + "test-site.test-ase.p.azurewebsites.net" + ], + "repositorySiteName": "test-site", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "test-site.test-ase.p.azurewebsites.net", + "test-site.scm.test-ase.p.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "test-site.test-ase.p.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "test-site.scm.test-ase.p.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/serverfarms/test-serverfarm", + "reserved": false, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2022-04-08T20:41:04.1233333", + "siteConfig": { + "numberOfWorkers": 1, + "linuxFxVersion": "", + "functionAppScaleLimit": 0, + "minimumElasticInstanceCount": 0 + }, + "scmSiteAlsoStopped": false, + "hostingEnvironmentProfile": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase", + "name": "test-ase", + "type": "Microsoft.Web/hostingEnvironments" + }, + "clientAffinityEnabled": true, + "clientCertEnabled": false, + "clientCertMode": "Required", + "hostNamesDisabled": false, + "customDomainVerificationId": "2982A67AD520FBCD070650FC77814FB03B62927C6EFCA2F5FF3BF5DC60088845", + "outboundIpAddresses": "20.112.141.120", + "possibleOutboundIpAddresses": "20.112.141.120", + "containerSize": 0, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "test-rg", + "defaultHostName": "test-site.test-ase.p.azurewebsites.net", + "httpsOnly": false, + "redundancyMode": "None", + "storageAccountRequired": false, + "keyVaultReferenceIdentity": "SystemAssigned" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListWebWorkerMetricDefinitions.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListWebWorkerMetricDefinitions.json new file mode 100644 index 000000000000..006585c4c702 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListWebWorkerMetricDefinitions.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "workerPoolName": "0", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "CpuPercentage", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/0/metricDefinitions/CpuPercentage", + "properties": null + }, + { + "name": "MemoryPercentage", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/0/metricDefinitions/MemoryPercentage", + "properties": null + }, + { + "name": "DiskQueueLength", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/0/metricDefinitions/DiskQueueLength", + "properties": null + }, + { + "name": "HttpQueueLength", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/0/metricDefinitions/HttpQueueLength", + "properties": null + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListWebWorkerUsages.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListWebWorkerUsages.json new file mode 100644 index 000000000000..514c3d94f542 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListWebWorkerUsages.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "workerPoolName": "0", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListWorkerPoolInstanceMetricDefinitions.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListWorkerPoolInstanceMetricDefinitions.json new file mode 100644 index 000000000000..4b932cf2de19 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListWorkerPoolInstanceMetricDefinitions.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "workerPoolName": "0", + "instance": "10.8.0.7", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "CpuPercentage", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/0/metricDefinitions/CpuPercentage", + "properties": null + }, + { + "name": "MemoryPercentage", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/0/metricDefinitions/MemoryPercentage", + "properties": null + }, + { + "name": "DiskQueueLength", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/0/metricDefinitions/DiskQueueLength", + "properties": null + }, + { + "name": "HttpQueueLength", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/0/metricDefinitions/HttpQueueLength", + "properties": null + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListWorkerPoolSkus.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListWorkerPoolSkus.json new file mode 100644 index 000000000000..7e95957c3611 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListWorkerPoolSkus.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "workerPoolName": "workerPool1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "resourceType": "Microsoft.Web/hostingEnvironments/workerPools", + "sku": { + "name": "S1", + "tier": "Standard" + }, + "capacity": { + "minimum": 2, + "maximum": 53, + "default": 2, + "scaleType": "automatic", + "elasticMaximum": null + } + }, + { + "resourceType": "Microsoft.Web/hostingEnvironments/workerPools", + "sku": { + "name": "S2", + "tier": "Standard" + }, + "capacity": { + "minimum": 2, + "maximum": 53, + "default": 2, + "scaleType": "automatic", + "elasticMaximum": null + } + }, + { + "resourceType": "Microsoft.Web/hostingEnvironments/workerPools", + "sku": { + "name": "S3", + "tier": "Standard" + }, + "capacity": { + "minimum": 2, + "maximum": 53, + "default": 2, + "scaleType": "automatic", + "elasticMaximum": null + } + }, + { + "resourceType": "Microsoft.Web/hostingEnvironments/workerPools", + "sku": { + "name": "S4", + "tier": "Standard" + }, + "capacity": { + "minimum": 2, + "maximum": 53, + "default": 2, + "scaleType": "automatic", + "elasticMaximum": null + } + }, + { + "resourceType": "Microsoft.Web/hostingEnvironments/workerPools", + "sku": { + "name": "O1", + "tier": "Optimized" + }, + "capacity": { + "minimum": 2, + "maximum": 53, + "default": 2, + "scaleType": "automatic", + "elasticMaximum": null + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListWorkerPools.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListWorkerPools.json new file mode 100644 index 000000000000..23f3b4264ed3 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_ListWorkerPools.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/workerPool1", + "name": "workerPool1", + "type": "Microsoft.Web/hostingEnvironments/workerPools", + "kind": "ASEV1", + "properties": { + "workerSizeId": 0, + "workerSize": "Small", + "workerCount": 2, + "instanceNames": [] + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/workerPool2", + "name": "workerPool2", + "type": "Microsoft.Web/hostingEnvironments/workerPools", + "kind": "ASEV1", + "properties": { + "workerSizeId": 1, + "workerSize": "Small", + "workerCount": 0, + "instanceNames": [] + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/workerPool3", + "name": "workerPool3", + "type": "Microsoft.Web/hostingEnvironments/workerPools", + "kind": "ASEV1", + "properties": { + "workerSizeId": 2, + "workerSize": "Small", + "workerCount": 0, + "instanceNames": [] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Reboot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Reboot.json new file mode 100644 index 000000000000..3051df4c481b --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Reboot.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01" + }, + "responses": { + "202": { + "headers": {} + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Resume.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Resume.json new file mode 100644 index 000000000000..f684d6892ec9 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Resume.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01" + }, + "responses": { + "202": { + "headers": { + "x-ms-routing-request-id": "NORTHCENTRALUS:20220408T212612Z:79bd0bce-5524-4fd1-ada0-1d8c86263d17", + "Location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/operations/f6a27306-3ee3-4e6b-997d-3ba2024b85e6?api-version=2019-08-01" + }, + "body": { + "value": [] + } + }, + "200": { + "headers": {}, + "body": { + "value": [] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Suspend.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Suspend.json new file mode 100644 index 000000000000..f684d6892ec9 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Suspend.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01" + }, + "responses": { + "202": { + "headers": { + "x-ms-routing-request-id": "NORTHCENTRALUS:20220408T212612Z:79bd0bce-5524-4fd1-ada0-1d8c86263d17", + "Location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/operations/f6a27306-3ee3-4e6b-997d-3ba2024b85e6?api-version=2019-08-01" + }, + "body": { + "value": [] + } + }, + "200": { + "headers": {}, + "body": { + "value": [] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_TestUpgradeAvailableNotification.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_TestUpgradeAvailableNotification.json new file mode 100644 index 000000000000..5ee16177d66b --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_TestUpgradeAvailableNotification.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "SampleHostingEnvironment", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {} + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Update.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Update.json new file mode 100644 index 000000000000..3b62247d6f96 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Update.json @@ -0,0 +1,183 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01", + "hostingEnvironmentEnvelope": { + "properties": { + "frontEndScaleFactor": 20, + "virtualNetwork": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase", + "name": "test-ase", + "type": "Microsoft.Web/hostingEnvironments", + "kind": "ASEV3", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "status": "Ready", + "virtualNetwork": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated", + "name": "delegated", + "type": "Microsoft.Network/virtualNetworks/subnets", + "subnet": "" + }, + "internalLoadBalancingMode": "None", + "multiSize": "Standard_D2d_v4", + "multiRoleCount": null, + "ipsslAddressCount": 0, + "dnsSuffix": "test-ase.p.azurewebsites.net", + "maximumNumberOfMachines": 250, + "frontEndScaleFactor": 15, + "suspended": false, + "clusterSettings": null, + "userWhitelistedIpRanges": null, + "hasLinuxWorkers": true, + "dedicatedHostCount": 0, + "zoneRedundant": false, + "networkingConfiguration": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking", + "properties": { + "windowsOutboundIpAddresses": [ + "20.88.241.56", + "20.88.241.9" + ], + "linuxOutboundIpAddresses": [ + "20.88.241.56", + "20.88.241.9" + ], + "externalInboundIpAddresses": [ + "52.153.248.36" + ], + "internalInboundIpAddresses": [], + "allowNewPrivateEndpointConnections": false, + "ftpEnabled": false, + "remoteDebugEnabled": false, + "inboundIpAddressOverride": null + } + } + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase", + "name": "test-ase", + "type": "Microsoft.Web/hostingEnvironments", + "kind": "ASEV3", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "status": "Ready", + "virtualNetwork": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated", + "name": "delegated", + "type": "Microsoft.Network/virtualNetworks/subnets", + "subnet": "" + }, + "internalLoadBalancingMode": "None", + "multiSize": "Standard_D2d_v4", + "multiRoleCount": null, + "ipsslAddressCount": 0, + "dnsSuffix": "test-ase.p.azurewebsites.net", + "maximumNumberOfMachines": 250, + "frontEndScaleFactor": 15, + "suspended": false, + "clusterSettings": null, + "userWhitelistedIpRanges": null, + "hasLinuxWorkers": true, + "dedicatedHostCount": 0, + "zoneRedundant": false, + "networkingConfiguration": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking", + "properties": { + "windowsOutboundIpAddresses": [ + "20.88.241.56", + "20.88.241.9" + ], + "linuxOutboundIpAddresses": [ + "20.88.241.56", + "20.88.241.9" + ], + "externalInboundIpAddresses": [ + "52.153.248.36" + ], + "internalInboundIpAddresses": [], + "allowNewPrivateEndpointConnections": false, + "ftpEnabled": false, + "remoteDebugEnabled": false, + "inboundIpAddressOverride": null + } + } + } + } + }, + "202": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase", + "name": "test-ase", + "type": "Microsoft.Web/hostingEnvironments", + "kind": "ASEV3", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "status": "Ready", + "virtualNetwork": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated", + "name": "delegated", + "type": "Microsoft.Network/virtualNetworks/subnets", + "subnet": "" + }, + "internalLoadBalancingMode": "None", + "multiSize": "Standard_D2d_v4", + "multiRoleCount": null, + "ipsslAddressCount": 0, + "dnsSuffix": "test-ase.p.azurewebsites.net", + "maximumNumberOfMachines": 250, + "frontEndScaleFactor": 15, + "suspended": false, + "clusterSettings": null, + "userWhitelistedIpRanges": null, + "hasLinuxWorkers": true, + "dedicatedHostCount": 0, + "zoneRedundant": false, + "networkingConfiguration": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking", + "properties": { + "windowsOutboundIpAddresses": [ + "20.88.241.56", + "20.88.241.9" + ], + "linuxOutboundIpAddresses": [ + "20.88.241.56", + "20.88.241.9" + ], + "externalInboundIpAddresses": [ + "52.153.248.36" + ], + "internalInboundIpAddresses": [], + "allowNewPrivateEndpointConnections": false, + "ftpEnabled": false, + "remoteDebugEnabled": false, + "inboundIpAddressOverride": null + } + } + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_UpdateAseNetworkingConfiguration.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_UpdateAseNetworkingConfiguration.json new file mode 100644 index 000000000000..2d31e0a011dd --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_UpdateAseNetworkingConfiguration.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01", + "aseNetworkingConfiguration": { + "properties": { + "ftpEnabled": true, + "remoteDebugEnabled": true + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking", + "name": "networking", + "type": "Microsoft.Web/hostingEnvironments/configurations/networking", + "properties": { + "windowsOutboundIpAddresses": [ + "20.88.241.56", + "20.88.241.9" + ], + "linuxOutboundIpAddresses": [ + "20.88.241.56", + "20.88.241.9" + ], + "externalInboundIpAddresses": [ + "52.153.248.36" + ], + "internalInboundIpAddresses": [], + "allowNewPrivateEndpointConnections": false, + "ftpEnabled": true, + "remoteDebugEnabled": true, + "inboundIpAddressOverride": null + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Upgrade.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Upgrade.json new file mode 100644 index 000000000000..c7ad42874576 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Upgrade.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "SampleHostingEnvironment", + "api-version": "2024-04-01" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus2/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2019-01-01" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ApplySlotConfig.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ApplySlotConfig.json new file mode 100644 index 000000000000..8297d7aef5bf --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ApplySlotConfig.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "api-version": "2024-04-01", + "slotSwapEntity": { + "targetSlot": "staging", + "preserveVnet": true + } + }, + "responses": { + "200": { + "headers": {} + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ApproveRejectSitePrivateEndpointConnection.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ApproveRejectSitePrivateEndpointConnection.json new file mode 100644 index 000000000000..175cdf6653a8 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ApproveRejectSitePrivateEndpointConnection.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testSite", + "privateEndpointConnectionName": "connection", + "api-version": "2024-04-01", + "privateEndpointWrapper": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin.", + "actionsRequired": "" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/privateEndpointConnections/connection", + "name": "connection", + "type": "Microsoft.Web/sites/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin.", + "actionsRequired": "" + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus2/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2019-01-01" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/privateEndpointConnections/connection", + "name": "connection", + "type": "Microsoft.Web/sites/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin.", + "actionsRequired": "" + } + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ApproveRejectSitePrivateEndpointConnectionSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ApproveRejectSitePrivateEndpointConnectionSlot.json new file mode 100644 index 000000000000..0c8a33dab52b --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ApproveRejectSitePrivateEndpointConnectionSlot.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testSite", + "slot": "stage", + "privateEndpointConnectionName": "connection", + "api-version": "2024-04-01", + "privateEndpointWrapper": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin.", + "actionsRequired": "" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/slots/stage/privateEndpointConnections/connection", + "name": "connection", + "type": "Microsoft.Web/sites/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin.", + "actionsRequired": "" + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus2/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2019-01-01" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/slots/stage/privateEndpointConnections/connection", + "name": "connection", + "type": "Microsoft.Web/sites/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin.", + "actionsRequired": "" + } + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/BackupWebApp.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/BackupWebApp.json new file mode 100644 index 000000000000..d1c940190d6c --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/BackupWebApp.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "api-version": "2024-04-01", + "request": { + "properties": { + "storageAccountUrl": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "backupName": "abcdwe", + "enabled": true, + "databases": [ + { + "databaseType": "SqlAzure", + "name": "backenddb", + "connectionStringName": "backend", + "connectionString": "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;=]" + }, + { + "databaseType": "SqlAzure", + "name": "statsdb", + "connectionStringName": "stats", + "connectionString": "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;=]" + } + ], + "backupSchedule": { + "frequencyInterval": 7, + "frequencyUnit": "Day", + "keepAtLeastOneBackup": true, + "retentionPeriodInDays": 30, + "startTime": "2022-09-02T17:33:11.641Z" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141", + "name": "sitef6141", + "type": "Microsoft.Web/sites", + "properties": { + "id": 12345, + "storageAccountUrl": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "blobName": "sitef6141_2024-04-01", + "name": "sitef6141_2024-04-01", + "status": "InProgress", + "sizeInBytes": 56091883, + "created": "2022-09-03T17:33:11.641Z", + "log": "Succeeded", + "databases": [ + { + "databaseType": "SqlAzure", + "name": "backenddb", + "connectionStringName": "backend", + "connectionString": "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;=]" + }, + { + "databaseType": "SqlAzure", + "name": "statsdb", + "connectionStringName": "stats", + "connectionString": "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;=]" + } + ], + "scheduled": true, + "lastRestoreTimeStamp": "2022-09-04T17:33:11.641Z", + "finishedTimeStamp": "2022-09-02T17:33:11.641Z", + "websiteSizeInBytes": 56091883 + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CloneWebApp.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CloneWebApp.json new file mode 100644 index 000000000000..a2b217a1f632 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CloneWebApp.json @@ -0,0 +1,253 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "api-version": "2024-04-01", + "siteEnvelope": { + "kind": "app", + "location": "East US", + "properties": { + "cloningInfo": { + "cloneCustomHostNames": true, + "cloneSourceControl": true, + "sourceWebAppId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg456/providers/Microsoft.Web/sites/srcsiteg478", + "sourceWebAppLocation": "West Europe", + "hostingEnvironment": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg456/providers/Microsoft.Web/hostingenvironments/aseforsites", + "appSettingsOverrides": { + "Setting1": "NewValue1", + "Setting3": "NewValue5" + }, + "configureLoadBalancing": false, + "overwrite": false + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141", + "name": "sitef6141", + "type": "Microsoft.Web/sites", + "kind": "app", + "location": "East US", + "properties": { + "state": "Running", + "hostNames": [ + "sitef6141.azurewebsites.net" + ], + "repositorySiteName": "sitef6141", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "sitef6141.azurewebsites.net", + "sitef6141.scm.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "sitef6141.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "sitef6141.scm.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp", + "reserved": false, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2020-03-04T17:33:11.641Z", + "vnetRouteAllEnabled": false, + "vnetImagePullEnabled": false, + "vnetContentShareEnabled": false, + "siteConfig": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php", + "hostingstart.html" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + }, + "scmSiteAlsoStopped": false, + "clientAffinityEnabled": true, + "clientCertEnabled": false, + "clientCertMode": "Required", + "hostNamesDisabled": false, + "customDomainVerificationId": "7F3BB652450EF7AD0B6AA33064586E4A9CE823A46DF0B2EC6443A68086E84153", + "outboundIpAddresses": "70.37.102.201,20.225.43.144", + "possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188", + "containerSize": 0, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "testrg123", + "defaultHostName": "sitef6141.azurewebsites.net", + "httpsOnly": false, + "redundancyMode": "None", + "storageAccountRequired": false, + "keyVaultReferenceIdentity": "SystemAssigned" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/sites/sitef6141/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-04-01" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141", + "name": "sitef6141", + "type": "Microsoft.Web/sites", + "kind": "app", + "location": "East US", + "properties": { + "state": "Running", + "hostNames": [ + "sitef6141.azurewebsites.net" + ], + "repositorySiteName": "sitef6141", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "sitef6141.azurewebsites.net", + "sitef6141.scm.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "sitef6141.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "sitef6141.scm.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp", + "reserved": false, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2020-03-04T17:33:11.641Z", + "vnetRouteAllEnabled": false, + "vnetImagePullEnabled": false, + "vnetContentShareEnabled": false, + "siteConfig": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php", + "hostingstart.html" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + }, + "scmSiteAlsoStopped": false, + "clientAffinityEnabled": true, + "clientCertEnabled": false, + "clientCertMode": "Required", + "hostNamesDisabled": false, + "customDomainVerificationId": "7F3BB652450EF7AD0B6AA33064586E4A9CE823A46DF0B2EC6443A68086E84153", + "outboundIpAddresses": "70.37.102.201,20.225.43.144", + "possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188", + "containerSize": 0, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "testrg123", + "defaultHostName": "sitef6141.azurewebsites.net", + "httpsOnly": false, + "redundancyMode": "None", + "storageAccountRequired": false, + "keyVaultReferenceIdentity": "SystemAssigned" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CloneWebAppSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CloneWebAppSlot.json new file mode 100644 index 000000000000..0169e32cb4f7 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CloneWebAppSlot.json @@ -0,0 +1,254 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "slot": "staging", + "api-version": "2024-04-01", + "siteEnvelope": { + "kind": "app", + "location": "East US", + "properties": { + "cloningInfo": { + "cloneCustomHostNames": true, + "cloneSourceControl": true, + "sourceWebAppId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg456/providers/Microsoft.Web/sites/srcsiteg478/slot/qa", + "sourceWebAppLocation": "West Europe", + "hostingEnvironment": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg456/providers/Microsoft.Web/hostingenvironments/aseforsites", + "appSettingsOverrides": { + "Setting1": "NewValue1", + "Setting3": "NewValue5" + }, + "configureLoadBalancing": false, + "overwrite": false + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/slots/staging", + "name": "sitef6141/staging", + "type": "Microsoft.Web/sites/slots", + "kind": "app", + "location": "East US", + "properties": { + "state": "Running", + "hostNames": [ + "sitef6141-staging.azurewebsites.net" + ], + "repositorySiteName": "sitef6141", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "sitef6141-staging.azurewebsites.net", + "sitef6141-staging.scm.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "sitef6141-staging.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "sitef6141-staging.scm.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp", + "reserved": false, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2020-03-04T17:33:11.641Z", + "vnetRouteAllEnabled": false, + "vnetImagePullEnabled": false, + "vnetContentShareEnabled": false, + "siteConfig": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php", + "hostingstart.html" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + }, + "scmSiteAlsoStopped": false, + "clientAffinityEnabled": true, + "clientCertEnabled": false, + "clientCertMode": "Required", + "hostNamesDisabled": false, + "customDomainVerificationId": "7F3BB652450EF7AD0B6AA33064586E4A9CE823A46DF0B2EC6443A68086E84153", + "outboundIpAddresses": "70.37.102.201,20.225.43.144", + "possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188", + "containerSize": 0, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "testrg123", + "defaultHostName": "sitef6141-staging.azurewebsites.net", + "httpsOnly": false, + "redundancyMode": "None", + "storageAccountRequired": false, + "keyVaultReferenceIdentity": "SystemAssigned" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/sites/sitef6141/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-04-01" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/slots/staging", + "name": "sitef6141/staging", + "type": "Microsoft.Web/sites/slots", + "kind": "app", + "location": "East US", + "properties": { + "state": "Running", + "hostNames": [ + "sitef6141-staging.azurewebsites.net" + ], + "repositorySiteName": "sitef6141", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "sitef6141-staging.azurewebsites.net", + "sitef6141-staging.scm.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "sitef6141-staging.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "sitef6141-staging.scm.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp", + "reserved": false, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2020-03-04T17:33:11.641Z", + "vnetRouteAllEnabled": false, + "vnetImagePullEnabled": false, + "vnetContentShareEnabled": false, + "siteConfig": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php", + "hostingstart.html" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + }, + "scmSiteAlsoStopped": false, + "clientAffinityEnabled": true, + "clientCertEnabled": false, + "clientCertMode": "Required", + "hostNamesDisabled": false, + "customDomainVerificationId": "7F3BB652450EF7AD0B6AA33064586E4A9CE823A46DF0B2EC6443A68086E84153", + "outboundIpAddresses": "70.37.102.201,20.225.43.144", + "possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188", + "containerSize": 0, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "testrg123", + "defaultHostName": "sitef6141-staging.azurewebsites.net", + "httpsOnly": false, + "redundancyMode": "None", + "storageAccountRequired": false, + "keyVaultReferenceIdentity": "SystemAssigned" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateAppServicePlan.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateAppServicePlan.json new file mode 100644 index 000000000000..c12c4843b19f --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateAppServicePlan.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "testsf6141", + "api-version": "2024-04-01", + "appServicePlan": { + "kind": "app", + "location": "East US", + "properties": {}, + "sku": { + "name": "P1", + "tier": "Premium", + "size": "P1", + "family": "P", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141", + "name": "testsf6141", + "type": "Microsoft.Web/serverfarms", + "kind": "app", + "location": "East US", + "properties": { + "status": "Ready", + "maximumNumberOfWorkers": 20, + "geoRegion": "East US", + "numberOfSites": 4, + "reserved": false, + "targetWorkerCount": 0, + "targetWorkerSizeId": 0, + "provisioningState": "Succeeded" + }, + "sku": { + "name": "P1", + "tier": "Premium", + "size": "P1", + "family": "P", + "capacity": 1 + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141/operationresults/F0C6B8EC-0D53-432C-913B-1CD9E8CDE3A0", + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141/operationresults/F0C6B8EC-0D53-432C-913B-1CD9E8CDE3A0" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141", + "name": "testsf6141", + "type": "Microsoft.Web/serverfarms", + "kind": "app", + "location": "East US", + "properties": { + "status": "Ready", + "maximumNumberOfWorkers": 20, + "geoRegion": "East US", + "numberOfSites": 4, + "isSpot": false, + "reserved": false, + "targetWorkerCount": 0, + "targetWorkerSizeId": 0, + "provisioningState": "Succeeded" + }, + "sku": { + "name": "P1", + "tier": "Premium", + "size": "P1", + "family": "P", + "capacity": 1 + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateCertificate.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateCertificate.json new file mode 100644 index 000000000000..6bbe7b0e149e --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateCertificate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "testc6282", + "api-version": "2024-04-01", + "certificateEnvelope": { + "location": "East US", + "properties": { + "hostNames": [ + "ServerCert" + ], + "password": "" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/certificates/testc6282", + "name": "testc6282", + "type": "Microsoft.Web/certificates", + "location": "East US", + "properties": { + "friendlyName": "", + "subjectName": "ServerCert", + "hostNames": [ + "ServerCert" + ], + "issuer": "CACert", + "issueDate": "2015-11-12T23:40:25+00:00", + "expirationDate": "2039-12-31T23:59:59+00:00", + "thumbprint": "FE703D7411A44163B6D32B3AD9B03E175886EBFE" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateContainerApp.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateContainerApp.json new file mode 100644 index 000000000000..2285c0873950 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateContainerApp.json @@ -0,0 +1,156 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testcontainerApp0", + "api-version": "2024-04-01", + "containerAppEnvelope": { + "kind": "containerApp", + "location": "East US", + "properties": { + "kubeEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/kubeEnvironments/demokube", + "configuration": { + "ingress": { + "external": true, + "targetPort": 3000 + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v1", + "name": "testcontainerApp0" + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "custom": { + "type": "http", + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + }, + "dapr": { + "enabled": true, + "appPort": 3000 + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.Web/containerApps", + "kind": "containerApp", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "kubeEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/kubeEnvironments/demokube", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto" + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + }, + "dapr": { + "enabled": true, + "appPort": 3000 + } + } + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.Web/containerApps", + "kind": "containerApp", + "location": "East US", + "properties": { + "provisioningState": "InProgress", + "kubeEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/kubeEnvironments/demokube", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto" + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + }, + "dapr": { + "enabled": true, + "appPort": 3000 + } + } + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateFunctionAppFlexConsumption.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateFunctionAppFlexConsumption.json new file mode 100644 index 000000000000..e3b3a1cd3064 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateFunctionAppFlexConsumption.json @@ -0,0 +1,334 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "api-version": "2024-04-01", + "siteEnvelope": { + "location": "East US", + "kind": "functionapp,linux", + "properties": { + "siteConfig": { + "appSettings": [ + { + "name": "AzureWebJobsStorage", + "value": "DefaultEndpointsProtocol=https;AccountName=StorageAccountName;AccountKey=Sanitized;EndpointSuffix=core.windows.net" + }, + { + "name": "APPLICATIONINSIGHTS_CONNECTION_STRING", + "value": "InstrumentationKey=Sanitized;IngestionEndpoint=Sanitized;LiveEndpoint=Sanitized" + } + ] + }, + "functionAppConfig": { + "deployment": { + "storage": { + "type": "blobContainer", + "value": "https://storageAccountName.blob.core.windows.net/containername", + "authentication": { + "type": "StorageAccountConnectionString", + "storageAccountConnectionStringName": "TheAppSettingName" + } + } + }, + "runtime": { + "name": "python", + "version": "3.11" + }, + "scaleAndConcurrency": { + "maximumInstanceCount": 100, + "instanceMemoryMB": 2048 + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141", + "name": "sitef6141", + "type": "Microsoft.Web/sites", + "location": "East US", + "properties": { + "state": "Running", + "hostNames": [ + "sitef6141.azurewebsites.net" + ], + "repositorySiteName": "sitef6141", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "sitef6141.azurewebsites.net", + "sitef6141.scm.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "sitef6141.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "sitef6141.scm.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp", + "reserved": null, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2024-01-09T00:24:54.8", + "vnetRouteAllEnabled": false, + "vnetImagePullEnabled": false, + "vnetContentShareEnabled": false, + "siteConfig": { + "numberOfWorkers": 1, + "netFrameworkVersion": "", + "phpVersion": "", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": false, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "keyVaultReferenceIdentity": "", + "ipSecurityRestrictions": [ + { + "ipAddress": "Any", + "action": "Allow", + "priority": 2147483647, + "name": "Allow all", + "description": "Allow all access" + } + ], + "scmIpSecurityRestrictions": [ + { + "ipAddress": "Any", + "action": "Allow", + "priority": 2147483647, + "name": "Allow all", + "description": "Allow all access" + } + ], + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + }, + "functionAppConfig": { + "deployment": { + "storage": { + "type": "blobContainer", + "value": "https://storageAccountName.blob.core.windows.net/containername", + "authentication": { + "type": "StorageAccountConnectionString", + "storageAccountConnectionStringName": "TheAppSettingName" + } + } + }, + "runtime": { + "name": "python", + "version": "3.11" + }, + "scaleAndConcurrency": { + "alwaysReady": null, + "maximumInstanceCount": 100, + "instanceMemoryMB": 2048, + "triggers": null + } + }, + "scmSiteAlsoStopped": false, + "clientAffinityEnabled": false, + "clientCertEnabled": false, + "vnetBackupRestoreEnabled": false, + "resourceConfig": { + "cpu": 1.0, + "memory": "2.0Gi" + }, + "outboundIpAddresses": "70.37.102.201,20.225.43.144", + "possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188", + "containerSize": 2048, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "testrg123", + "defaultHostName": "sitef6141.azurewebsites.net", + "httpsOnly": true, + "redundancyMode": "None", + "publicNetworkAccess": "Enabled", + "storageAccountRequired": false + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/sites/sitef6141/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-04-01" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141", + "name": "sitef6141", + "type": "Microsoft.Web/sites", + "location": "East US", + "properties": { + "state": "Running", + "hostNames": [ + "sitef6141.azurewebsites.net" + ], + "repositorySiteName": "sitef6141", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "sitef6141.azurewebsites.net", + "sitef6141.scm.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "sitef6141.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "sitef6141.scm.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp", + "reserved": null, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2024-01-09T00:24:54.8", + "vnetRouteAllEnabled": false, + "vnetImagePullEnabled": false, + "vnetContentShareEnabled": false, + "siteConfig": { + "numberOfWorkers": 1, + "netFrameworkVersion": "", + "phpVersion": "", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": false, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "keyVaultReferenceIdentity": "", + "ipSecurityRestrictions": [ + { + "ipAddress": "Any", + "action": "Allow", + "priority": 2147483647, + "name": "Allow all", + "description": "Allow all access" + } + ], + "scmIpSecurityRestrictions": [ + { + "ipAddress": "Any", + "action": "Allow", + "priority": 2147483647, + "name": "Allow all", + "description": "Allow all access" + } + ], + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + }, + "functionAppConfig": { + "deployment": { + "storage": { + "type": "blobContainer", + "value": "https://storageAccountName.blob.core.windows.net/containername", + "authentication": { + "type": "StorageAccountConnectionString", + "storageAccountConnectionStringName": "TheAppSettingName" + } + } + }, + "runtime": { + "name": "python", + "version": "3.11" + }, + "scaleAndConcurrency": { + "alwaysReady": null, + "maximumInstanceCount": 100, + "instanceMemoryMB": 2048, + "triggers": null + } + }, + "scmSiteAlsoStopped": false, + "clientAffinityEnabled": false, + "clientCertEnabled": false, + "vnetBackupRestoreEnabled": false, + "resourceConfig": { + "cpu": 1.0, + "memory": "2.0Gi" + }, + "outboundIpAddresses": "70.37.102.201,20.225.43.144", + "possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188", + "containerSize": 2048, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "testrg123", + "defaultHostName": "sitef6141.azurewebsites.net", + "httpsOnly": true, + "redundancyMode": "None", + "publicNetworkAccess": "Enabled", + "storageAccountRequired": false + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateFunctionAppFlexConsumptionWithDetails.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateFunctionAppFlexConsumptionWithDetails.json new file mode 100644 index 000000000000..9f0ce3741c5a --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateFunctionAppFlexConsumptionWithDetails.json @@ -0,0 +1,363 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "api-version": "2024-04-01", + "siteEnvelope": { + "location": "East US", + "kind": "functionapp,linux", + "properties": { + "siteConfig": { + "appSettings": [ + { + "name": "AzureWebJobsStorage", + "value": "DefaultEndpointsProtocol=https;AccountName=StorageAccountName;AccountKey=Sanitized;EndpointSuffix=core.windows.net" + }, + { + "name": "APPLICATIONINSIGHTS_CONNECTION_STRING", + "value": "InstrumentationKey=Sanitized;IngestionEndpoint=Sanitized;LiveEndpoint=Sanitized" + } + ] + }, + "functionAppConfig": { + "deployment": { + "storage": { + "type": "blobContainer", + "value": "https://storageAccountName.blob.core.windows.net/containername", + "authentication": { + "type": "StorageAccountConnectionString", + "storageAccountConnectionStringName": "TheAppSettingName" + } + } + }, + "runtime": { + "name": "python", + "version": "3.11" + }, + "scaleAndConcurrency": { + "alwaysReady": [ + { + "name": "http", + "instanceCount": 2 + } + ], + "maximumInstanceCount": 100, + "instanceMemoryMB": 2048, + "triggers": { + "http": { + "perInstanceConcurrency": 16 + } + } + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141", + "name": "sitef6141", + "type": "Microsoft.Web/sites", + "location": "East US", + "properties": { + "state": "Running", + "hostNames": [ + "sitef6141.azurewebsites.net" + ], + "repositorySiteName": "sitef6141", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "sitef6141.azurewebsites.net", + "sitef6141.scm.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "sitef6141.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "sitef6141.scm.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp", + "reserved": null, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2024-01-09T00:24:54.8", + "vnetRouteAllEnabled": false, + "vnetImagePullEnabled": false, + "vnetContentShareEnabled": false, + "siteConfig": { + "numberOfWorkers": 1, + "netFrameworkVersion": "", + "phpVersion": "", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": false, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "keyVaultReferenceIdentity": "", + "ipSecurityRestrictions": [ + { + "ipAddress": "Any", + "action": "Allow", + "priority": 2147483647, + "name": "Allow all", + "description": "Allow all access" + } + ], + "scmIpSecurityRestrictions": [ + { + "ipAddress": "Any", + "action": "Allow", + "priority": 2147483647, + "name": "Allow all", + "description": "Allow all access" + } + ], + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + }, + "functionAppConfig": { + "deployment": { + "storage": { + "type": "blobContainer", + "value": "https://storageAccountName.blob.core.windows.net/containername", + "authentication": { + "type": "StorageAccountConnectionString", + "storageAccountConnectionStringName": "TheAppSettingName" + } + } + }, + "runtime": { + "name": "python", + "version": "3.11" + }, + "scaleAndConcurrency": { + "alwaysReady": [ + { + "name": "http", + "instanceCount": 2 + } + ], + "maximumInstanceCount": 100, + "instanceMemoryMB": 2048, + "triggers": { + "http": { + "perInstanceConcurrency": 16 + } + } + } + }, + "scmSiteAlsoStopped": false, + "clientAffinityEnabled": false, + "clientCertEnabled": false, + "vnetBackupRestoreEnabled": false, + "resourceConfig": { + "cpu": 1.0, + "memory": "2.0Gi" + }, + "outboundIpAddresses": "70.37.102.201,20.225.43.144", + "possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188", + "containerSize": 2048, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "testrg123", + "defaultHostName": "sitef6141.azurewebsites.net", + "httpsOnly": true, + "redundancyMode": "None", + "publicNetworkAccess": "Enabled", + "storageAccountRequired": false + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/sites/sitef6141/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-04-01" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141", + "name": "sitef6141", + "type": "Microsoft.Web/sites", + "location": "East US", + "properties": { + "state": "Running", + "hostNames": [ + "sitef6141.azurewebsites.net" + ], + "repositorySiteName": "sitef6141", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "sitef6141.azurewebsites.net", + "sitef6141.scm.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "sitef6141.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "sitef6141.scm.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp", + "reserved": null, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2024-01-09T00:24:54.8", + "vnetRouteAllEnabled": false, + "vnetImagePullEnabled": false, + "vnetContentShareEnabled": false, + "siteConfig": { + "numberOfWorkers": 1, + "netFrameworkVersion": "", + "phpVersion": "", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": false, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "keyVaultReferenceIdentity": "", + "ipSecurityRestrictions": [ + { + "ipAddress": "Any", + "action": "Allow", + "priority": 2147483647, + "name": "Allow all", + "description": "Allow all access" + } + ], + "scmIpSecurityRestrictions": [ + { + "ipAddress": "Any", + "action": "Allow", + "priority": 2147483647, + "name": "Allow all", + "description": "Allow all access" + } + ], + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + }, + "functionAppConfig": { + "deployment": { + "storage": { + "type": "blobContainer", + "value": "https://storageAccountName.blob.core.windows.net/containername", + "authentication": { + "type": "StorageAccountConnectionString", + "storageAccountConnectionStringName": "TheAppSettingName" + } + } + }, + "runtime": { + "name": "python", + "version": "3.11" + }, + "scaleAndConcurrency": { + "alwaysReady": [ + { + "name": "http", + "instanceCount": 2 + } + ], + "maximumInstanceCount": 100, + "instanceMemoryMB": 2048, + "triggers": { + "http": { + "perInstanceConcurrency": 16 + } + } + } + }, + "scmSiteAlsoStopped": false, + "clientAffinityEnabled": false, + "clientCertEnabled": false, + "vnetBackupRestoreEnabled": false, + "resourceConfig": { + "cpu": 1.0, + "memory": "2.0Gi" + }, + "outboundIpAddresses": "70.37.102.201,20.225.43.144", + "possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188", + "containerSize": 2048, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "testrg123", + "defaultHostName": "sitef6141.azurewebsites.net", + "httpsOnly": true, + "redundancyMode": "None", + "publicNetworkAccess": "Enabled", + "storageAccountRequired": false + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSite.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSite.json new file mode 100644 index 000000000000..78fd8ffb8347 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSite.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "api-version": "2024-04-01", + "staticSiteEnvelope": { + "location": "West US 2", + "properties": { + "repositoryUrl": "https://github.com/username/RepoName", + "branch": "master", + "repositoryToken": "repoToken123", + "buildProperties": { + "appLocation": "app", + "apiLocation": "api", + "appArtifactLocation": "build" + } + }, + "sku": { + "name": "Basic", + "tier": "Basic" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0", + "name": "testStaticSite0", + "type": "Microsoft.Web/staticSites", + "location": "West US 2", + "properties": { + "defaultHostname": "happy-sea-15afae3e.azurestaticwebsites.net", + "repositoryUrl": "https://github.com/username/RepoName", + "branch": "demo", + "customDomains": [], + "privateEndpointConnections": [], + "contentDistributionEndpoint": "", + "keyVaultReferenceIdentity": "SystemAssigned", + "userProvidedFunctionApps": null, + "linkedBackends": [], + "stagingEnvironmentPolicy": "Enabled", + "allowConfigFileUpdates": true + }, + "sku": { + "name": "Basic", + "tier": "Basic" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus2/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2019-01-01" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0", + "name": "testStaticSite0", + "type": "Microsoft.Web/staticSites", + "location": "West US 2", + "properties": { + "defaultHostname": "happy-sea-15afae3e.azurestaticwebsites.net", + "repositoryUrl": "https://github.com/username/RepoName", + "branch": "demo", + "customDomains": [], + "privateEndpointConnections": [], + "contentDistributionEndpoint": "", + "keyVaultReferenceIdentity": "SystemAssigned", + "userProvidedFunctionApps": null, + "linkedBackends": [], + "stagingEnvironmentPolicy": "Enabled", + "allowConfigFileUpdates": true + }, + "sku": { + "name": "Basic", + "tier": "Basic" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteAppSettings.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteAppSettings.json new file mode 100644 index 000000000000..978873a0ffba --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteAppSettings.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "api-version": "2024-04-01", + "appSettings": { + "properties": { + "setting1": "someval", + "setting2": "someval2" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/config/appSettings", + "properties": { + "setting1": "someval", + "setting2": "someval2" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteBasicAuth.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteBasicAuth.json new file mode 100644 index 000000000000..c1c11871ca9d --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteBasicAuth.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "basicAuthName": "default", + "api-version": "2024-04-01", + "basicAuthEnvelope": { + "properties": { + "environments": null, + "password": "**********************", + "secretUrl": null, + "applicableEnvironmentsMode": "AllEnvironments" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/basicAuth/default", + "properties": { + "environments": null, + "secretUrl": null, + "applicableEnvironmentsMode": "AllEnvironments", + "secretState": "Password" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteBuildAppSettings.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteBuildAppSettings.json new file mode 100644 index 000000000000..b7f7f325c56a --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteBuildAppSettings.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "environmentName": "12", + "api-version": "2024-04-01", + "appSettings": { + "properties": { + "setting1": "someval", + "setting2": "someval2" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/12/config/appSettings", + "properties": { + "setting1": "someval", + "setting2": "someval2" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteBuildDatabaseConnection.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteBuildDatabaseConnection.json new file mode 100644 index 000000000000..1fc3077fb23c --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteBuildDatabaseConnection.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "environmentName": "default", + "databaseConnectionName": "default", + "api-version": "2024-04-01", + "databaseConnectionRequestEnvelope": { + "properties": { + "resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName", + "connectionIdentity": "SystemAssigned", + "connectionString": "AccountEndpoint=https://exampleDatabaseName.documents.azure.com:443/;Database=mydb;", + "region": "West US 2" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/databaseConnections/default", + "name": "default", + "type": "Microsoft.Web/staticSites/builds/databaseConnections", + "properties": { + "resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName", + "connectionIdentity": "SystemAssigned", + "region": "West US 2" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteBuildFunctionAppSettings.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteBuildFunctionAppSettings.json new file mode 100644 index 000000000000..b7f7f325c56a --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteBuildFunctionAppSettings.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "environmentName": "12", + "api-version": "2024-04-01", + "appSettings": { + "properties": { + "setting1": "someval", + "setting2": "someval2" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/12/config/appSettings", + "properties": { + "setting1": "someval", + "setting2": "someval2" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteCustomDomain.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteCustomDomain.json new file mode 100644 index 000000000000..fc2c3cfdf000 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteCustomDomain.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "domainName": "custom.domain.net", + "api-version": "2024-04-01", + "staticSiteCustomDomainRequestPropertiesEnvelope": { + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSitesBuilds/testStaticSite0/customDomains/custom.domain.net", + "properties": { + "domainName": "custom.domain.net", + "createdOn": "2020-03-04T17:33:11.641Z" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus2/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2019-01-01" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSitesBuilds/testStaticSite0/customDomains/custom.domain.net", + "properties": { + "domainName": "custom.domain.net", + "createdOn": "2020-03-04T17:33:11.641Z" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteDatabaseConnection.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteDatabaseConnection.json new file mode 100644 index 000000000000..1e49305cbc46 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteDatabaseConnection.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "databaseConnectionName": "default", + "api-version": "2024-04-01", + "databaseConnectionRequestEnvelope": { + "properties": { + "resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName", + "connectionIdentity": "SystemAssigned", + "connectionString": "AccountEndpoint=https://exampleDatabaseName.documents.azure.com:443/;Database=mydb;", + "region": "West US 2" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/databaseConnections/default", + "name": "default", + "type": "Microsoft.Web/staticSites/databaseConnections", + "properties": { + "resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName", + "connectionIdentity": "SystemAssigned", + "region": "West US 2" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteFunctionAppSettings.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteFunctionAppSettings.json new file mode 100644 index 000000000000..978873a0ffba --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateStaticSiteFunctionAppSettings.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "api-version": "2024-04-01", + "appSettings": { + "properties": { + "setting1": "someval", + "setting2": "someval2" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/config/appSettings", + "properties": { + "setting1": "someval", + "setting2": "someval2" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateWebApp.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateWebApp.json new file mode 100644 index 000000000000..15769c27a0e4 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateWebApp.json @@ -0,0 +1,251 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "api-version": "2024-04-01", + "siteEnvelope": { + "kind": "app", + "location": "East US", + "properties": { + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141", + "name": "sitef6141", + "type": "Microsoft.Web/sites", + "kind": "app", + "location": "East US", + "properties": { + "state": "Running", + "hostNames": [ + "sitef6141.azurewebsites.net" + ], + "repositorySiteName": "sitef6141", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "sitef6141.azurewebsites.net", + "sitef6141.scm.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "sitef6141.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "sitef6141.scm.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp", + "reserved": false, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2020-03-04T17:33:11.641Z", + "vnetRouteAllEnabled": false, + "vnetImagePullEnabled": false, + "vnetContentShareEnabled": false, + "siteConfig": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php", + "hostingstart.html" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + }, + "scmSiteAlsoStopped": false, + "clientAffinityEnabled": true, + "clientCertEnabled": false, + "clientCertMode": "Required", + "hostNamesDisabled": false, + "customDomainVerificationId": "7F3BB652450EF7AD0B6AA33064586E4A9CE823A46DF0B2EC6443A68086E84153", + "outboundIpAddresses": "70.37.102.201,20.225.43.144", + "possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188", + "containerSize": 0, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "testrg123", + "defaultHostName": "sitef6141.azurewebsites.net", + "httpsOnly": false, + "redundancyMode": "None", + "storageAccountRequired": false, + "keyVaultReferenceIdentity": "SystemAssigned", + "workloadProfileName": "myd4wp", + "resourceConfig": { + "cpu": 1.0, + "memory": "2.0Gi" + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/sites/sitef6141/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-04-01" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141", + "name": "sitef6141", + "type": "Microsoft.Web/sites", + "kind": "app", + "location": "East US", + "properties": { + "state": "Running", + "hostNames": [ + "sitef6141.azurewebsites.net" + ], + "repositorySiteName": "sitef6141", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "sitef6141.azurewebsites.net", + "sitef6141.scm.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "sitef6141.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "sitef6141.scm.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp", + "reserved": false, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2020-03-04T17:33:11.641Z", + "vnetRouteAllEnabled": false, + "vnetImagePullEnabled": false, + "vnetContentShareEnabled": false, + "siteConfig": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php", + "hostingstart.html" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + }, + "scmSiteAlsoStopped": false, + "clientAffinityEnabled": true, + "clientCertEnabled": false, + "clientCertMode": "Required", + "hostNamesDisabled": false, + "customDomainVerificationId": "7F3BB652450EF7AD0B6AA33064586E4A9CE823A46DF0B2EC6443A68086E84153", + "outboundIpAddresses": "70.37.102.201,20.225.43.144", + "possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188", + "containerSize": 0, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "testrg123", + "defaultHostName": "sitef6141.azurewebsites.net", + "httpsOnly": false, + "redundancyMode": "None", + "storageAccountRequired": false, + "keyVaultReferenceIdentity": "SystemAssigned", + "workloadProfileName": "myd4wp", + "resourceConfig": { + "cpu": 1.0, + "memory": "2.0Gi" + } + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateWebAppSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateWebAppSlot.json new file mode 100644 index 000000000000..7cab8683e478 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateOrUpdateWebAppSlot.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "slot": "staging", + "api-version": "2024-04-01", + "siteEnvelope": { + "kind": "app", + "location": "East US", + "properties": { + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/slots/staging", + "name": "sitef6141/staging", + "type": "Microsoft.Web/sites/slots", + "kind": "app", + "location": "East US", + "properties": { + "state": "Running", + "hostNames": [ + "sitef6141-staging.azurewebsites.net" + ], + "repositorySiteName": "sitef6141", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "sitef6141-staging.azurewebsites.net", + "sitef6141-staging.scm.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "sitef6141-staging.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "sitef6141-staging.scm.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp", + "reserved": false, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2020-03-04T17:33:11.641Z", + "vnetRouteAllEnabled": false, + "vnetImagePullEnabled": false, + "vnetContentShareEnabled": false, + "siteConfig": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php", + "hostingstart.html" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + }, + "scmSiteAlsoStopped": false, + "clientAffinityEnabled": true, + "clientCertEnabled": false, + "clientCertMode": "Required", + "hostNamesDisabled": false, + "customDomainVerificationId": "7F3BB652450EF7AD0B6AA33064586E4A9CE823A46DF0B2EC6443A68086E84153", + "outboundIpAddresses": "70.37.102.201,20.225.43.144", + "possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188", + "containerSize": 0, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "testrg123", + "defaultHostName": "sitef6141.azurewebsites.net", + "httpsOnly": false, + "redundancyMode": "None", + "storageAccountRequired": false, + "keyVaultReferenceIdentity": "SystemAssigned" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/sites/sitef6141/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-04-01" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/slots/staging", + "name": "sitef6141/staging", + "type": "Microsoft.Web/sites/slots", + "kind": "app", + "location": "East US", + "properties": { + "state": "Running", + "hostNames": [ + "sitef6141-staging.azurewebsites.net" + ], + "repositorySiteName": "sitef6141", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "sitef6141-staging.azurewebsites.net", + "sitef6141-staging.scm.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "sitef6141-staging.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "sitef6141-staging.scm.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp", + "reserved": false, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2020-03-04T17:33:11.641Z", + "vnetRouteAllEnabled": false, + "vnetImagePullEnabled": false, + "vnetContentShareEnabled": false, + "siteConfig": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php", + "hostingstart.html" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + }, + "scmSiteAlsoStopped": false, + "clientAffinityEnabled": true, + "clientCertEnabled": false, + "clientCertMode": "Required", + "hostNamesDisabled": false, + "customDomainVerificationId": "7F3BB652450EF7AD0B6AA33064586E4A9CE823A46DF0B2EC6443A68086E84153", + "outboundIpAddresses": "70.37.102.201,20.225.43.144", + "possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188", + "containerSize": 0, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "testrg123", + "defaultHostName": "sitef6141-staging.azurewebsites.net", + "httpsOnly": false, + "redundancyMode": "None", + "storageAccountRequired": false, + "keyVaultReferenceIdentity": "SystemAssigned" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateUserRolesInvitationLink.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateUserRolesInvitationLink.json new file mode 100644 index 000000000000..d2e8f47d99f3 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/CreateUserRolesInvitationLink.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "api-version": "2024-04-01", + "staticSiteUserRolesInvitationEnvelope": { + "properties": { + "domain": "happy-sea-15afae3e.azurestaticwebsites.net", + "provider": "aad", + "userDetails": "username", + "roles": "admin,contributor", + "numHoursToExpiration": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "invitationUrl": "https://happy-sea-15afae3e.azurestaticwebsites.net?invite=asdf", + "expiresOn": "2020-02-28T16:53:56.211Z" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeactivateRevision.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeactivateRevision.json new file mode 100644 index 000000000000..bc4213ef077c --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeactivateRevision.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "name": "testcontainerApp0-pjxhsye", + "api-version": "2024-04-01" + }, + "responses": { + "200": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteAppServicePlan.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteAppServicePlan.json new file mode 100644 index 000000000000..61ffb5684c42 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteAppServicePlan.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "testsf6141", + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteAseCustomDnsSuffixConfiguration.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteAseCustomDnsSuffixConfiguration.json new file mode 100644 index 000000000000..7cadf4f64e29 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteAseCustomDnsSuffixConfiguration.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": {} + }, + "204": { + "headers": {}, + "body": {} + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteCertificate.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteCertificate.json new file mode 100644 index 000000000000..4649bfee24ca --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteCertificate.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "testc6282", + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteContainerApp.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteContainerApp.json new file mode 100644 index 000000000000..f38695630bfe --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteContainerApp.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testWorkerApp0", + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/workerApps/testWorkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-04-01" + } + }, + "204": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteDeployWorkflowArtifacts.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteDeployWorkflowArtifacts.json new file mode 100644 index 000000000000..a8e69d2c017d --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteDeployWorkflowArtifacts.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "testsite2", + "api-version": "2024-04-01", + "workflowArtifacts": { + "filesToDelete": [ + "test/workflow.json", + "test/" + ] + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteSitePrivateEndpointConnection.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteSitePrivateEndpointConnection.json new file mode 100644 index 000000000000..1f80f6accc8a --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteSitePrivateEndpointConnection.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testSite", + "privateEndpointConnectionName": "connection", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus2/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2019-01-01" + }, + "body": {} + }, + "204": { + "body": {} + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteSitePrivateEndpointConnectionSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteSitePrivateEndpointConnectionSlot.json new file mode 100644 index 000000000000..89ce0d3da452 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteSitePrivateEndpointConnectionSlot.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testSite", + "slot": "stage", + "privateEndpointConnectionName": "connection", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus2/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2019-01-01" + }, + "body": {} + }, + "204": { + "body": {} + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteStaticSite.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteStaticSite.json new file mode 100644 index 000000000000..0ffc97178b0a --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteStaticSite.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus2/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2019-01-01" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteStaticSiteBuild.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteStaticSiteBuild.json new file mode 100644 index 000000000000..2183343c854e --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteStaticSiteBuild.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "environmentName": "12", + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus2/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2019-01-01" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteStaticSiteBuildDatabaseConnection.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteStaticSiteBuildDatabaseConnection.json new file mode 100644 index 000000000000..a16b4a6a2728 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteStaticSiteBuildDatabaseConnection.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "environmentName": "default", + "databaseConnectionName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "204": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteStaticSiteCustomDomain.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteStaticSiteCustomDomain.json new file mode 100644 index 000000000000..87fd8ecfe1e5 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteStaticSiteCustomDomain.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "domainName": "custom.domain.net", + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus2/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2019-01-01" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteStaticSiteDatabaseConnection.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteStaticSiteDatabaseConnection.json new file mode 100644 index 000000000000..63a95df1ad57 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteStaticSiteDatabaseConnection.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "databaseConnectionName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "204": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteStaticSiteUser.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteStaticSiteUser.json new file mode 100644 index 000000000000..9ae0e1238e64 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteStaticSiteUser.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "authprovider": "aad", + "userid": "1234", + "api-version": "2024-04-01" + }, + "responses": { + "200": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteWebApp.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteWebApp.json new file mode 100644 index 000000000000..1260f260cac5 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteWebApp.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "204": {}, + "404": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteWebAppBackup.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteWebAppBackup.json new file mode 100644 index 000000000000..a50a11eeb8e8 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteWebAppBackup.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "backupId": "12345", + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteWebAppSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteWebAppSlot.json new file mode 100644 index 000000000000..6d24183c6cba --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DeleteWebAppSlot.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "slot": "staging", + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "204": {}, + "404": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DetachStaticSite.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DetachStaticSite.json new file mode 100644 index 000000000000..0ffc97178b0a --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DetachStaticSite.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus2/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2019-01-01" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DetachUserProvidedFunctionAppFromStaticSite.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DetachUserProvidedFunctionAppFromStaticSite.json new file mode 100644 index 000000000000..baa83594084f --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DetachUserProvidedFunctionAppFromStaticSite.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "functionAppName": "testFunctionApp", + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DetachUserProvidedFunctionAppFromStaticSiteBuild.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DetachUserProvidedFunctionAppFromStaticSiteBuild.json new file mode 100644 index 000000000000..1a57ed97097d --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/DetachUserProvidedFunctionAppFromStaticSiteBuild.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "environmentName": "12", + "functionAppName": "testFunctionApp", + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ExecuteSiteAnalysis.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ExecuteSiteAnalysis.json new file mode 100644 index 000000000000..4efbcac73e70 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ExecuteSiteAnalysis.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "siteName": "SampleApp", + "slot": "Production", + "diagnosticCategory": "availability", + "analysisName": "apprestartanalyses", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability/analyses/apprestartanalyses", + "name": "apprestartanalysis", + "properties": { + "startTime": "2017-11-05T22:50:00Z", + "endTime": "2017-11-06T22:50:00Z", + "abnormalTimePeriods": [ + { + "startTime": "2017-11-05T22:50:00Z", + "endTime": "2017-11-06T22:50:00Z", + "events": [ + { + "startTime": "2017-11-06T22:21:50Z", + "endTime": "2017-11-06T22:21:48Z", + "message": "Your application process was restarted as application environment variables changed. This can most likely occur due to update in app settings or swap operation. This event occurred multiple times during the day.", + "source": null, + "priority": 0, + "metaData": [ + [ + { + "name": "feature", + "value": "auditlogs" + }, + { + "name": "displayedName", + "value": "Check Audit Logs" + } + ] + ], + "type": "ServiceIncident", + "solutions": [] + } + ], + "solutions": [] + } + ], + "payload": [ + { + "source": "workerprocessrecycle", + "metrics": [ + { + "name": "All Application Stop Events", + "unit": null, + "startTime": "2017-11-05T22:50:00Z", + "endTime": "2017-11-06T22:50:00Z", + "timeGrain": "00:05:00", + "values": [ + { + "timestamp": "2017-11-06T00:00:00Z", + "roleInstance": "RD00155D3C15BE", + "total": 2 + }, + { + "timestamp": "2017-11-06T00:00:00Z", + "total": 2, + "isAggregated": true + }, + { + "timestamp": "2017-11-06T00:10:00Z", + "roleInstance": "RD00155D3C15C1", + "total": 2 + }, + { + "timestamp": "2017-11-06T00:10:00Z", + "roleInstance": "RD00155D3BE0FB", + "total": 2 + }, + { + "timestamp": "2017-11-06T00:10:00Z", + "total": 4, + "isAggregated": true + } + ] + }, + { + "name": "User Events", + "unit": "", + "startTime": "2017-11-05T22:50:00Z", + "endTime": "2017-11-06T22:50:00Z", + "timeGrain": "00:05:00", + "values": [ + { + "timestamp": "2017-11-06T22:20:00Z", + "total": 3, + "isAggregated": true + }, + { + "timestamp": "2017-11-06T22:20:00Z", + "roleInstance": "RD00155D3C09FC", + "total": 1 + }, + { + "timestamp": "2017-11-06T22:20:00Z", + "roleInstance": "RD00155D3C2ADC", + "total": 1 + }, + { + "timestamp": "2017-11-06T22:20:00Z", + "roleInstance": "RD00155D3C214E", + "total": 1 + } + ] + } + ], + "data": [], + "detectorMetaData": null + } + ], + "nonCorrelatedDetectors": [] + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ExecuteSiteAnalysisSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ExecuteSiteAnalysisSlot.json new file mode 100644 index 000000000000..223299edd00d --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ExecuteSiteAnalysisSlot.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "siteName": "SampleApp", + "slot": "staging", + "diagnosticCategory": "availability", + "analysisName": "apprestartanalyses", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/slots/staging/diagnostics/availability/analyses/apprestartanalyses", + "name": "apprestartanalysis", + "properties": { + "startTime": "2017-11-05T22:50:00Z", + "endTime": "2017-11-06T22:50:00Z", + "abnormalTimePeriods": [ + { + "startTime": "2017-11-05T22:50:00Z", + "endTime": "2017-11-06T22:50:00Z", + "events": [ + { + "startTime": "2017-11-06T22:21:50Z", + "endTime": "2017-11-06T22:21:48Z", + "message": "Your application process was restarted as application environment variables changed. This can most likely occur due to update in app settings or swap operation. This event occurred multiple times during the day.", + "source": null, + "priority": 0, + "metaData": [ + [ + { + "name": "feature", + "value": "auditlogs" + }, + { + "name": "displayedName", + "value": "Check Audit Logs" + } + ] + ], + "type": "ServiceIncident", + "solutions": [] + } + ], + "solutions": [] + } + ], + "payload": [ + { + "source": "workerprocessrecycle", + "metrics": [ + { + "name": "All Application Stop Events", + "unit": null, + "startTime": "2017-11-05T22:50:00Z", + "endTime": "2017-11-06T22:50:00Z", + "timeGrain": "00:05:00", + "values": [ + { + "timestamp": "2017-11-06T00:00:00Z", + "roleInstance": "RD00155D3C15BE", + "total": 2 + }, + { + "timestamp": "2017-11-06T00:00:00Z", + "total": 2, + "isAggregated": true + }, + { + "timestamp": "2017-11-06T00:10:00Z", + "roleInstance": "RD00155D3C15C1", + "total": 2 + }, + { + "timestamp": "2017-11-06T00:10:00Z", + "roleInstance": "RD00155D3BE0FB", + "total": 2 + }, + { + "timestamp": "2017-11-06T00:10:00Z", + "total": 4, + "isAggregated": true + } + ] + }, + { + "name": "User Events", + "unit": "", + "startTime": "2017-11-05T22:50:00Z", + "endTime": "2017-11-06T22:50:00Z", + "timeGrain": "00:05:00", + "values": [ + { + "timestamp": "2017-11-06T22:20:00Z", + "total": 3, + "isAggregated": true + }, + { + "timestamp": "2017-11-06T22:20:00Z", + "roleInstance": "RD00155D3C09FC", + "total": 1 + }, + { + "timestamp": "2017-11-06T22:20:00Z", + "roleInstance": "RD00155D3C2ADC", + "total": 1 + }, + { + "timestamp": "2017-11-06T22:20:00Z", + "roleInstance": "RD00155D3C214E", + "total": 1 + } + ] + } + ], + "data": [], + "detectorMetaData": null + } + ], + "nonCorrelatedDetectors": [] + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ExecuteSiteDetector.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ExecuteSiteDetector.json new file mode 100644 index 000000000000..fd47e6c85051 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ExecuteSiteDetector.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "siteName": "SampleApp", + "slot": "Production", + "diagnosticCategory": "availability", + "detectorName": "sitecrashes", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability/detectors/sitecrashes", + "name": "sitecrashes", + "properties": { + "startTime": "2017-11-05T22:50:00Z", + "endTime": "2017-11-06T22:50:00Z", + "abnormalTimePeriods": [ + { + "startTime": "2017-11-05T22:50:00Z", + "endTime": "2017-11-06T22:50:00Z", + "solutions": [] + } + ] + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ExecuteSiteDetectorSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ExecuteSiteDetectorSlot.json new file mode 100644 index 000000000000..6d3b70c8aecb --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ExecuteSiteDetectorSlot.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "siteName": "SampleApp", + "slot": "staging", + "diagnosticCategory": "availability", + "detectorName": "sitecrashes", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/slots/staging/diagnostics/availability/detectors/sitecrashes", + "name": "sitecrashes", + "properties": { + "startTime": "2017-11-05T22:50:00Z", + "endTime": "2017-11-06T22:50:00Z", + "abnormalTimePeriods": [ + { + "startTime": "2017-11-05T22:50:00Z", + "endTime": "2017-11-06T22:50:00Z", + "solutions": [] + } + ] + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetHostingEnvironmentDetectorResponse.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetHostingEnvironmentDetectorResponse.json new file mode 100644 index 000000000000..0b4a9db44b97 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetHostingEnvironmentDetectorResponse.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "name": "SampleAppServiceEnvironment", + "detectorName": "runtimeavailability", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/hostingEnvironments/SampleAppServiceEnvironment/detectors/runtimeavailability", + "name": "runtimeavailability", + "properties": { + "metadata": { + "description": "This detector analyzes all the requests to all applications running on this app service environment.", + "category": "Availability and Performance" + }, + "dataset": [ + { + "table": { + "tableName": "Table_0", + "columns": [ + { + "columnName": "PreciseTimeStamp", + "dataType": "DateTime", + "columnType": "datetime" + }, + { + "columnName": "count_Http2xx", + "dataType": "Int64", + "columnType": "long" + }, + { + "columnName": "count_Http3xx", + "dataType": "Int64", + "columnType": "long" + }, + { + "columnName": "count_Http4xx", + "dataType": "Int64", + "columnType": "long" + }, + { + "columnName": "count_Http5xx", + "dataType": "Int64", + "columnType": "long" + } + ], + "rows": [ + [ + "2018-03-27T00:25:00Z", + "772705", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:30:00Z", + "787069", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:35:00Z", + "781627", + "0", + "1", + "0" + ], + [ + "2018-03-27T00:40:00Z", + "785017", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:45:00Z", + "783518", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:50:00Z", + "785783", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:55:00Z", + "772874", + "0", + "0", + "0" + ], + [ + "2018-03-27T01:00:00Z", + "787162", + "0", + "0", + "0" + ], + [ + "2018-03-27T01:05:00Z", + "782036", + "0", + "0", + "0" + ], + [ + "2018-03-27T01:10:00Z", + "784642", + "0", + "0", + "0" + ] + ] + }, + "renderingProperties": { + "title": "Requests by Status Code", + "description": "This detector breaks down the number of requests that your apps on this app service environment received for each status code." + } + } + ] + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteAnalysis.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteAnalysis.json new file mode 100644 index 000000000000..d5afd0ddb2b6 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteAnalysis.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "siteName": "SampleApp", + "diagnosticCategory": "availability", + "analysisName": "appanalysis", + "slot": "Production", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/slots/staging/diagnostics/availability/analyses/appanalysis", + "name": "appanalysis", + "properties": { + "description": "Determine causes of availability loss as well as solutions for these problems" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteAnalysisSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteAnalysisSlot.json new file mode 100644 index 000000000000..331ff9dfed01 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteAnalysisSlot.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "siteName": "SampleApp", + "slot": "staging", + "diagnosticCategory": "availability", + "analysisName": "appanalysis", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/slots/staging/diagnostics/availability/analyses/appanalysis", + "name": "appanalysis", + "properties": { + "description": "Determine causes of availability loss as well as solutions for these problems" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteDetector.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteDetector.json new file mode 100644 index 000000000000..19f2d0551a07 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteDetector.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "siteName": "SampleApp", + "slot": "Production", + "diagnosticCategory": "availability", + "detectorName": "sitecrashes", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/diagnostics/availability/detectors/sitecrashes", + "name": "sitecrashes", + "properties": { + "displayName": "Site Crash Events", + "description": null, + "rank": 9, + "isEnabled": true + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteDetectorResponse.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteDetectorResponse.json new file mode 100644 index 000000000000..99233ad2c61d --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteDetectorResponse.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "siteName": "SampleApp", + "slot": "staging", + "detectorName": "runtimeavailability", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/detectors/runtimeavailability", + "name": "runtimeavailability", + "properties": { + "metadata": { + "description": "This detector analyzes the requests to your application.", + "category": "Availability and Performance" + }, + "dataset": [ + { + "table": { + "tableName": "Table_0", + "columns": [ + { + "columnName": "PreciseTimeStamp", + "dataType": "DateTime", + "columnType": "datetime" + }, + { + "columnName": "count_Http2xx", + "dataType": "Int64", + "columnType": "long" + }, + { + "columnName": "count_Http3xx", + "dataType": "Int64", + "columnType": "long" + }, + { + "columnName": "count_Http4xx", + "dataType": "Int64", + "columnType": "long" + }, + { + "columnName": "count_Http5xx", + "dataType": "Int64", + "columnType": "long" + } + ], + "rows": [ + [ + "2018-03-27T00:25:00Z", + "772705", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:30:00Z", + "787069", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:35:00Z", + "781627", + "0", + "1", + "0" + ], + [ + "2018-03-27T00:40:00Z", + "785017", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:45:00Z", + "783518", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:50:00Z", + "785783", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:55:00Z", + "772874", + "0", + "0", + "0" + ], + [ + "2018-03-27T01:00:00Z", + "787162", + "0", + "0", + "0" + ], + [ + "2018-03-27T01:05:00Z", + "782036", + "0", + "0", + "0" + ], + [ + "2018-03-27T01:10:00Z", + "784642", + "0", + "0", + "0" + ] + ] + }, + "renderingProperties": { + "title": "Requests by Status Code", + "description": "This detector breaks down the number of requests that your app received for each status code." + } + } + ] + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteDetectorResponseSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteDetectorResponseSlot.json new file mode 100644 index 000000000000..98135e05afdc --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteDetectorResponseSlot.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "siteName": "SampleApp", + "slot": "staging", + "detectorName": "runtimeavailability", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/slots/staging/detectors/runtimeavailability", + "name": "runtimeavailability", + "properties": { + "metadata": { + "description": "This detector analyzes the requests to your application.", + "category": "Availability and Performance" + }, + "dataset": [ + { + "table": { + "tableName": "Table_0", + "columns": [ + { + "columnName": "PreciseTimeStamp", + "dataType": "DateTime", + "columnType": "datetime" + }, + { + "columnName": "count_Http2xx", + "dataType": "Int64", + "columnType": "long" + }, + { + "columnName": "count_Http3xx", + "dataType": "Int64", + "columnType": "long" + }, + { + "columnName": "count_Http4xx", + "dataType": "Int64", + "columnType": "long" + }, + { + "columnName": "count_Http5xx", + "dataType": "Int64", + "columnType": "long" + } + ], + "rows": [ + [ + "2018-03-27T00:25:00Z", + "772705", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:30:00Z", + "787069", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:35:00Z", + "781627", + "0", + "1", + "0" + ], + [ + "2018-03-27T00:40:00Z", + "785017", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:45:00Z", + "783518", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:50:00Z", + "785783", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:55:00Z", + "772874", + "0", + "0", + "0" + ], + [ + "2018-03-27T01:00:00Z", + "787162", + "0", + "0", + "0" + ], + [ + "2018-03-27T01:05:00Z", + "782036", + "0", + "0", + "0" + ], + [ + "2018-03-27T01:10:00Z", + "784642", + "0", + "0", + "0" + ] + ] + }, + "renderingProperties": { + "title": "Requests by Status Code", + "description": "This detector breaks down the number of requests that your app received for each status code." + } + } + ] + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteDetectorSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteDetectorSlot.json new file mode 100644 index 000000000000..b02b0e489b4e --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteDetectorSlot.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "siteName": "SampleApp", + "slot": "staging", + "diagnosticCategory": "availability", + "detectorName": "sitecrashes", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/slots/staging/diagnostics/availability/detectors/sitecrashes", + "name": "sitecrashes", + "properties": { + "displayName": "Site Crash Events", + "description": null, + "rank": 9, + "isEnabled": true + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteDiagnosticCategory.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteDiagnosticCategory.json new file mode 100644 index 000000000000..c938dbf87e20 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteDiagnosticCategory.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "siteName": "SampleApp", + "slot": "Production", + "diagnosticCategory": "availability", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability", + "name": "availability", + "properties": { + "description": "Availability and Perfomance Diagnostics" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteDiagnosticCategorySlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteDiagnosticCategorySlot.json new file mode 100644 index 000000000000..87c54dc5b267 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_GetSiteDiagnosticCategorySlot.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "siteName": "SampleApp", + "slot": "staging", + "diagnosticCategory": "availability", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability", + "name": "availability", + "properties": { + "description": "Availability and Perfomance Diagnostics" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListHostingEnvironmentDetectorResponses.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListHostingEnvironmentDetectorResponses.json new file mode 100644 index 000000000000..13ed261a9bc4 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListHostingEnvironmentDetectorResponses.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "name": "SampleAppServiceEnvironment", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/hostingEnvironments/SampleAppServiceEnvironment/detectors/runtimeavailability", + "name": "runtimeavailability", + "properties": { + "metadata": { + "description": "This detector analyzes all the requests to all applications running on this app service environment.", + "category": "Availability and Performance" + }, + "dataset": [] + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteAnalyses.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteAnalyses.json new file mode 100644 index 000000000000..bd4ef2ee152c --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteAnalyses.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "siteName": "SampleApp", + "slot": "Production", + "diagnosticCategory": "availability", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability/analyses/appanalysis", + "name": "appanalysis", + "properties": { + "description": "Determine causes of availability loss as well as solutions for these problems" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability/analyses/apprestartanalyses", + "name": "apprestartanalysis", + "properties": { + "description": "Find the reasons that your app restarted" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability/analyses/memoryanalysis", + "name": "memoryanalysis", + "properties": { + "description": "Detect issues with memory as well as suggest ways to troubleshoot memory problems" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability/analyses/tcpconnectionsanalysis", + "name": "tcpconnectionsanalysis", + "properties": { + "description": "Analyze port usage and find out if a high number of connections is causing problems for your web app" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability/analyses/perfanalysis", + "name": "perfanalysis", + "properties": { + "description": "Determine causes of performance degredation as well as solutions for these problems" + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteAnalysesSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteAnalysesSlot.json new file mode 100644 index 000000000000..154e9be8a0df --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteAnalysesSlot.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "siteName": "SampleApp", + "slot": "staging", + "diagnosticCategory": "availability", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/slots/staging/diagnostics/availability/analyses/appanalysis", + "name": "appanalysis", + "properties": { + "description": "Determine causes of availability loss as well as solutions for these problems" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/slots/staging/diagnostics/availability/analyses/apprestartanalyses", + "name": "apprestartanalysis", + "properties": { + "description": "Find the reasons that your app restarted" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/slots/staging/diagnostics/availability/analyses/memoryanalysis", + "name": "memoryanalysis", + "properties": { + "description": "Detect issues with memory as well as suggest ways to troubleshoot memory problems" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/slots/staging/diagnostics/availability/analyses/tcpconnectionsanalysis", + "name": "tcpconnectionsanalysis", + "properties": { + "description": "Analyze port usage and find out if a high number of connections is causing problems for your web app" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/slots/staging/diagnostics/availability/analyses/perfanalysis", + "name": "perfanalysis", + "properties": { + "description": "Determine causes of performance degredation as well as solutions for these problems" + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteDetectorResponses.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteDetectorResponses.json new file mode 100644 index 000000000000..fad79bfec061 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteDetectorResponses.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "siteName": "SampleApp", + "slot": "staging", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/detectors/runtimeavailability", + "name": "runtimeavailability", + "properties": { + "metadata": { + "description": "This detector analyzes the requests to your application.", + "category": "Availability and Performance" + }, + "dataset": [] + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteDetectorResponsesSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteDetectorResponsesSlot.json new file mode 100644 index 000000000000..8eae8b3621e2 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteDetectorResponsesSlot.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "siteName": "SampleApp", + "slot": "staging", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/slots/staging/detectors/runtimeavailability", + "name": "runtimeavailability", + "properties": { + "metadata": { + "description": "This detector analyzes the requests to your application.", + "category": "Availability and Performance" + }, + "dataset": [] + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteDetectors.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteDetectors.json new file mode 100644 index 000000000000..ae31d75d39fd --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteDetectors.json @@ -0,0 +1,198 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "siteName": "SampleApp", + "slot": "Production", + "diagnosticCategory": "availability", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/diagnostics/availability/detectors/servicehealth", + "name": "servicehealth", + "properties": { + "displayName": "Service Health", + "description": null, + "rank": 1, + "isEnabled": true + } + }, + { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/diagnostics/availability/detectors/siteswap", + "name": "siteswap", + "properties": { + "displayName": "Site Swap Operations", + "description": null, + "rank": 8, + "isEnabled": true + } + }, + { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/diagnostics/availability/detectors/sitecrashes", + "name": "sitecrashes", + "properties": { + "displayName": "Site Crash Events", + "description": null, + "rank": 9, + "isEnabled": true + } + }, + { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/diagnostics/availability/detectors/deployment", + "name": "deployment", + "properties": { + "displayName": "Site Deployments", + "description": null, + "rank": 7, + "isEnabled": true + } + }, + { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/diagnostics/availability/detectors/sitecpuanalysis", + "name": "sitecpuanalysis", + "properties": { + "displayName": "CPU Analysis", + "description": null, + "rank": 3, + "isEnabled": true + } + }, + { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/diagnostics/availability/detectors/sitememoryanalysis", + "name": "sitememoryanalysis", + "properties": { + "displayName": "Physical Memory Analysis", + "description": null, + "rank": 3, + "isEnabled": true + } + }, + { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/diagnostics/availability/detectors/committedmemoryusage", + "name": "committedmemoryusage", + "properties": { + "displayName": "Committed Memory Usage", + "description": null, + "rank": 7, + "isEnabled": true + } + }, + { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/diagnostics/availability/detectors/pagefileoperations", + "name": "pagefileoperations", + "properties": { + "displayName": "Page File Operations", + "description": null, + "rank": 3, + "isEnabled": true + } + }, + { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/diagnostics/availability/detectors/siterestartuserinitiated", + "name": "siterestartuserinitiated", + "properties": { + "displayName": "User Initiated Site Restarts", + "description": null, + "rank": 14, + "isEnabled": true + } + }, + { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/diagnostics/availability/detectors/siterestartsettingupdate", + "name": "siterestartsettingupdate", + "properties": { + "displayName": "Config Update Site Restarts", + "description": null, + "rank": 12, + "isEnabled": true + } + }, + { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/diagnostics/availability/detectors/frebanalysis", + "name": "frebanalysis", + "properties": { + "displayName": "Freb Logs Analysis", + "description": null, + "rank": 6, + "isEnabled": true + } + }, + { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/diagnostics/availability/detectors/workeravailability", + "name": "workeravailability", + "properties": { + "displayName": "Worker Availability", + "description": null, + "rank": 11, + "isEnabled": true + } + }, + { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/diagnostics/availability/detectors/sitelatency", + "name": "sitelatency", + "properties": { + "displayName": "Site Latency", + "description": null, + "rank": 1005, + "isEnabled": false + } + }, + { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/diagnostics/availability/detectors/threadcount", + "name": "threadcount", + "properties": { + "displayName": "Thread Count", + "description": null, + "rank": 23, + "isEnabled": true + } + }, + { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/diagnostics/availability/detectors/failedrequestsperuri", + "name": "failedrequestsperuri", + "properties": { + "displayName": "Failed Requests Per URI", + "description": null, + "rank": 998, + "isEnabled": true + } + }, + { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/diagnostics/availability/detectors/autoheal", + "name": "autoheal", + "properties": { + "displayName": "AutoHeal", + "description": null, + "rank": 21, + "isEnabled": true + } + }, + { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/diagnostics/availability/detectors/loganalyzer", + "name": "loganalyzer", + "properties": { + "displayName": "PHP Log Analyzer", + "description": null, + "rank": 26, + "isEnabled": true + } + }, + { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/diagnostics/availability/detectors/aspnetcore", + "name": "aspnetcore", + "properties": { + "displayName": "ASP.NET Core", + "description": null, + "rank": 5, + "isEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteDetectorsSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteDetectorsSlot.json new file mode 100644 index 000000000000..9fc3fc910aea --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteDetectorsSlot.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "siteName": "SampleApp", + "slot": "staging", + "diagnosticCategory": "availability", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/slots/staging/diagnostics/availability/detectors/servicehealth", + "name": "servicehealth", + "properties": { + "displayName": "Service Health", + "description": null, + "rank": 1, + "isEnabled": true + } + }, + { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/slots/staging/diagnostics/availability/detectors/siteswap", + "name": "siteswap", + "properties": { + "displayName": "Site Swap Operations", + "description": null, + "rank": 8, + "isEnabled": true + } + }, + { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/slots/staging/diagnostics/availability/detectors/sitecrashes", + "name": "sitecrashes", + "properties": { + "displayName": "Site Crash Events", + "description": null, + "rank": 9, + "isEnabled": true + } + }, + { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/slots/staging/diagnostics/availability/detectors/deployment", + "name": "deployment", + "properties": { + "displayName": "Site Deployments", + "description": null, + "rank": 7, + "isEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteDiagnosticCategories.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteDiagnosticCategories.json new file mode 100644 index 000000000000..b7fdeaf9c85e --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteDiagnosticCategories.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "siteName": "SampleApp", + "slot": "Production", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability", + "name": "availability", + "properties": { + "description": "Availability and Perfomance Diagnostics" + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteDiagnosticCategoriesSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteDiagnosticCategoriesSlot.json new file mode 100644 index 000000000000..f3bb572930f6 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Diagnostics_ListSiteDiagnosticCategoriesSlot.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "siteName": "SampleApp", + "slot": "staging", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/slots/staging/diagnostics/availability", + "name": "availability", + "properties": { + "description": "Availability and Perfomance Diagnostics" + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GenerateStaticSiteWorkflowPreview.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GenerateStaticSiteWorkflowPreview.json new file mode 100644 index 000000000000..0de763b1c6e5 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GenerateStaticSiteWorkflowPreview.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "location": "West US 2", + "api-version": "2024-04-01", + "staticSitesWorkflowPreviewRequest": { + "properties": { + "repositoryUrl": "https://github.com/username/RepoName", + "branch": "master", + "buildProperties": { + "appLocation": "app", + "apiLocation": "api", + "appArtifactLocation": "build" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "path": ".github/workflows/azure-static-web-apps-.yml", + "contents": "base64encodedworkflowcontentspreview" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetAllStaticSites.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetAllStaticSites.json new file mode 100644 index 000000000000..e533204dc050 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetAllStaticSites.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0", + "name": "testStaticSite0", + "type": "Microsoft.Web/staticSites", + "location": "West US 2", + "properties": { + "defaultHostname": "happy-sea-15afae3e.azurestaticwebsites.net", + "repositoryUrl": "https://github.com/username/repo", + "branch": "demo", + "customDomains": [], + "privateEndpointConnections": [], + "contentDistributionEndpoint": "", + "keyVaultReferenceIdentity": "SystemAssigned", + "userProvidedFunctionApps": [], + "stagingEnvironmentPolicy": "Enabled", + "allowConfigFileUpdates": true + }, + "sku": { + "name": "Standard", + "tier": "Standard" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetAppServicePlan.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetAppServicePlan.json new file mode 100644 index 000000000000..06098c6600c7 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetAppServicePlan.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "testsf6141", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141", + "name": "testsf6141", + "type": "Microsoft.Web/serverfarms", + "kind": "app", + "location": "East US", + "properties": { + "status": "Ready", + "maximumNumberOfWorkers": 20, + "numberOfWorkers": 19, + "geoRegion": "East US", + "numberOfSites": 4, + "isSpot": false, + "reserved": false, + "targetWorkerCount": 0, + "targetWorkerSizeId": 0, + "provisioningState": "Succeeded" + }, + "sku": { + "name": "P1", + "tier": "Premium", + "size": "P1", + "family": "P", + "capacity": 1 + } + } + }, + "404": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetAseCustomDnsSuffixConfiguration.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetAseCustomDnsSuffixConfiguration.json new file mode 100644 index 000000000000..a4336bd53c59 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetAseCustomDnsSuffixConfiguration.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/customdnssuffix", + "name": "customDnsSuffix", + "type": "Microsoft.Web/hostingEnvironments/configurations/customdnssuffix", + "properties": { + "provisioningState": "Succeeded", + "provisioningDetails": null, + "dnsSuffix": "contoso.com", + "certificateUrl": "https://test-kv.vault.azure.net/secrets/contosocert", + "keyVaultReferenceIdentity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetAuthSettingsV2WithoutSecrets.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetAuthSettingsV2WithoutSecrets.json new file mode 100644 index 000000000000..e7665ae30287 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetAuthSettingsV2WithoutSecrets.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettingsv2", + "name": "authsettingsv2", + "type": "Microsoft.Web/sites/authsettingsv2", + "kind": "app", + "properties": { + "platform": { + "enabled": true, + "runtimeVersion": "~1", + "configFilePath": "/auth/config.json" + }, + "globalValidation": { + "requireAuthentication": true, + "unauthenticatedClientAction": "Return403", + "excludedPaths": [ + "/nosecrets/Path" + ] + }, + "identityProviders": { + "google": { + "enabled": true, + "registration": { + "clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com", + "clientSecretSettingName": "ClientSecret" + }, + "login": { + "scopes": [ + "admin" + ] + }, + "validation": { + "allowedAudiences": [ + "https://example.com" + ] + } + } + }, + "login": { + "routes": { + "logoutEndpoint": "https://app.com/logout" + }, + "tokenStore": { + "enabled": true, + "tokenRefreshExtensionHours": 96, + "fileSystem": { + "directory": "/wwwroot/sites/example" + } + }, + "preserveUrlFragmentsForLogins": true, + "allowedExternalRedirectUrls": [ + "https://someurl.com" + ], + "cookieExpiration": { + "convention": "IdentityProviderDerived", + "timeToExpiration": "2022:09-01T00:00Z" + }, + "nonce": { + "validateNonce": true + } + }, + "httpSettings": { + "requireHttps": true, + "routes": { + "apiPrefix": "/authv2/" + }, + "forwardProxy": { + "convention": "Standard", + "customHostHeaderName": "authHeader", + "customProtoHeaderName": "customProtoHeader" + } + } + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetCertificate.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetCertificate.json new file mode 100644 index 000000000000..e3394a0d388c --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetCertificate.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "testc6282", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/certificates/testc6282", + "name": "testc6282", + "type": "Microsoft.Web/certificates", + "location": "East US", + "properties": { + "friendlyName": "", + "subjectName": "ServerCert", + "hostNames": [ + "ServerCert" + ], + "issuer": "CACert", + "issueDate": "2015-11-12T23:40:25+00:00", + "expirationDate": "2039-12-31T23:59:59+00:00", + "thumbprint": "FE703D7411A44163B6D32B3AD9B03E175886EBFE" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetContainerApp.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetContainerApp.json new file mode 100644 index 000000000000..104749b7f130 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetContainerApp.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testcontainerApp0", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.Web/containerApps", + "kind": "containerApp", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "kubeEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/kubeEnvironments/demokube", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto" + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + }, + "dapr": { + "enabled": true, + "appPort": 3000 + } + } + } + } + }, + "404": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetDeletedWebApp.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetDeletedWebApp.json new file mode 100644 index 000000000000..72938278843f --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetDeletedWebApp.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "deletedSiteId": "9", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg1/providers/Microsoft.Web/locations/West US 2/deletedwebapps/wussite6", + "name": "wussite6", + "type": "Microsoft.Web/deletedSites", + "properties": { + "deletedSiteId": 9, + "deletedTimestamp": "2019-05-09T22:29:05.1337007", + "subscription": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroup": "rg1", + "deletedSiteName": "wussite6", + "slot": "Production", + "kind": "app", + "geoRegionName": "West US 2" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetDeletedWebAppByLocation.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetDeletedWebAppByLocation.json new file mode 100644 index 000000000000..e18b6034086e --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetDeletedWebAppByLocation.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "location": "West US 2", + "deletedSiteId": "9", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg1/providers/Microsoft.Web/locations/West US 2/deletedwebapps/wussite6", + "name": "wussite6", + "type": "Microsoft.Web/locations/deletedSites", + "properties": { + "deletedSiteId": 9, + "deletedTimestamp": "2019-05-09T22:29:05.1337007", + "subscription": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroup": "rg1", + "deletedSiteName": "wussite6", + "slot": "Production", + "kind": "app", + "geoRegionName": "West US 2" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetDeletedWebAppSnapshots.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetDeletedWebAppSnapshots.json new file mode 100644 index 000000000000..3c1a094f1fb6 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetDeletedWebAppSnapshots.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "deletedSiteId": "9", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "name": "wussite6", + "type": "Microsoft.Web/locations/deletedSites", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg1/providers/Microsoft.Web/locations/West US 2/deletedwebapps/wussite6/snapshots/9", + "properties": { + "time": "2019-05-09T22:29:05.1337007" + } + } + ] + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetFunctionAppStacks.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetFunctionAppStacks.json new file mode 100644 index 000000000000..99cbf8be3136 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetFunctionAppStacks.json @@ -0,0 +1,779 @@ +{ + "parameters": { + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/providers/Microsoft.Web/functionAppStacks/dotnet", + "name": "dotnet", + "type": "Microsoft.Web/functionAppStacks", + "properties": { + "displayText": ".NET", + "value": "dotnet", + "preferredOs": "Windows", + "majorVersions": [ + { + "displayText": ".NET Core 3", + "value": "3", + "minorVersions": [ + { + "displayText": ".NET Core 3.1", + "value": "3.1", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "3.1", + "appInsightsSettings": { + "isSupported": true + }, + "remoteDebuggingSupported": false, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.1.301" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "dotnet" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true + }, + "supportedFunctionsExtensionVersions": [ + "~3" + ] + }, + "linuxRuntimeSettings": { + "runtimeVersion": "dotnet|3.1", + "appInsightsSettings": { + "isSupported": true + }, + "remoteDebuggingSupported": false, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.1.301" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "dotnet" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": false, + "linuxFxVersion": "dotnet|3.1" + }, + "supportedFunctionsExtensionVersions": [ + "~3" + ] + } + } + } + ] + }, + { + "displayText": ".NET Core 2", + "value": "2", + "minorVersions": [ + { + "displayText": ".NET Core 2.2", + "value": "2.2", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "2.2", + "appInsightsSettings": { + "isSupported": true + }, + "remoteDebuggingSupported": false, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "2.2.207" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "dotnet" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true + }, + "supportedFunctionsExtensionVersions": [ + "~2" + ] + }, + "linuxRuntimeSettings": { + "runtimeVersion": "dotnet|2.2", + "appInsightsSettings": { + "isSupported": true + }, + "remoteDebuggingSupported": false, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "2.2.207" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "dotnet" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": false, + "linuxFxVersion": "dotnet|2.2" + }, + "supportedFunctionsExtensionVersions": [ + "~2" + ] + } + } + } + ] + }, + { + "displayText": ".NET Framework 4", + "value": "2", + "minorVersions": [ + { + "displayText": ".NET Framework 4.7", + "value": "4.7", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "4.7", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": false + }, + "appSettingsDictionary": {}, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true + }, + "supportedFunctionsExtensionVersions": [ + "~1" + ] + } + } + } + ] + } + ] + } + }, + { + "id": "/providers/Microsoft.Web/functionAppStacks/node", + "name": "node", + "type": "Microsoft.Web/functionAppStacks", + "properties": { + "displayText": "Node.js", + "value": "node", + "preferredOs": "Windows", + "majorVersions": [ + { + "displayText": "Node.js 14", + "value": "14", + "minorVersions": [ + { + "displayText": "Node.js 14 LTS", + "value": "14 LTS", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "~14", + "isPreview": true, + "isHidden": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "14.x" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "node", + "WEBSITE_NODE_DEFAULT_VERSION": "~14" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true + }, + "supportedFunctionsExtensionVersions": [ + "~3" + ] + }, + "linuxRuntimeSettings": { + "runtimeVersion": "Node|14", + "isPreview": true, + "isHidden": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "14.x" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "node" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": false, + "linuxFxVersion": "Node|14" + }, + "supportedFunctionsExtensionVersions": [ + "~3" + ] + } + } + } + ] + }, + { + "displayText": "Node.js 12", + "value": "12", + "minorVersions": [ + { + "displayText": "Node.js 12 LTS", + "value": "12 LTS", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "~12", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "12.x" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "node", + "WEBSITE_NODE_DEFAULT_VERSION": "~12" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true + }, + "supportedFunctionsExtensionVersions": [ + "~3" + ] + }, + "linuxRuntimeSettings": { + "runtimeVersion": "Node|12", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "12.x" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "node" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": false, + "linuxFxVersion": "Node|12" + }, + "supportedFunctionsExtensionVersions": [ + "~3" + ] + } + } + } + ] + }, + { + "displayText": "Node.js 10", + "value": "10", + "minorVersions": [ + { + "displayText": "Node.js 10 LTS", + "value": "10 LTS", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "~10", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "10.x" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "node", + "WEBSITE_NODE_DEFAULT_VERSION": "~10" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true + }, + "supportedFunctionsExtensionVersions": [ + "~2", + "~3" + ] + }, + "linuxRuntimeSettings": { + "runtimeVersion": "Node|10", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "10.x" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "node" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": false, + "linuxFxVersion": "Node|10" + }, + "supportedFunctionsExtensionVersions": [ + "~2", + "~3" + ] + } + } + } + ] + }, + { + "displayText": "Node.js 8", + "value": "8", + "minorVersions": [ + { + "displayText": "Node.js 8 LTS", + "value": "8 LTS", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "~8", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8.x" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "node", + "WEBSITE_NODE_DEFAULT_VERSION": "~8" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true + }, + "supportedFunctionsExtensionVersions": [ + "~2" + ] + } + } + } + ] + }, + { + "displayText": "Node.js 6", + "value": "6", + "minorVersions": [ + { + "displayText": "Node.js 6 LTS", + "value": "6 LTS", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "~6", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": false + }, + "appSettingsDictionary": { + "WEBSITE_NODE_DEFAULT_VERSION": "~6" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true + }, + "supportedFunctionsExtensionVersions": [ + "~1" + ] + } + } + } + ] + } + ] + } + }, + { + "id": "/providers/Microsoft.Web/functionAppStacks/python", + "name": "python", + "type": "Microsoft.Web/functionAppStacks", + "properties": { + "displayText": "Python", + "value": "python", + "preferredOs": "Linux", + "majorVersions": [ + { + "displayText": "Python 3", + "value": "3", + "minorVersions": [ + { + "displayText": "Python 3.8", + "value": "3.8", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "Python|3.8", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.8" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "python" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": false, + "linuxFxVersion": "Python|3.8" + }, + "supportedFunctionsExtensionVersions": [ + "~3" + ] + } + } + }, + { + "displayText": "Python 3.7", + "value": "3.7", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "Python|3.7", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.7" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "python" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": false, + "linuxFxVersion": "Python|3.7" + }, + "supportedFunctionsExtensionVersions": [ + "~2", + "~3" + ] + } + } + }, + { + "displayText": "Python 3.6", + "value": "3.6", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "Python|3.6", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.6" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "python" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": false, + "linuxFxVersion": "Python|3.6" + }, + "supportedFunctionsExtensionVersions": [ + "~2", + "~3" + ] + } + } + } + ] + } + ] + } + }, + { + "id": "/providers/Microsoft.Web/functionAppStacks/java", + "name": "java", + "type": "Microsoft.Web/functionAppStacks", + "properties": { + "displayText": "Java", + "value": "java", + "preferredOs": "Windows", + "majorVersions": [ + { + "displayText": "Java 11", + "value": "11", + "minorVersions": [ + { + "displayText": "Java 11", + "value": "11.0", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "11", + "isAutoUpdate": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "11" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "java" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true, + "javaVersion": "11" + }, + "supportedFunctionsExtensionVersions": [ + "~3" + ] + }, + "linuxRuntimeSettings": { + "runtimeVersion": "Java|11", + "isAutoUpdate": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "11" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "java" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": false, + "linuxFxVersion": "Java|11" + }, + "supportedFunctionsExtensionVersions": [ + "~3" + ] + } + } + } + ] + }, + { + "displayText": "Java 8", + "value": "8", + "minorVersions": [ + { + "displayText": "Java 8", + "value": "8.0", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8", + "isAutoUpdate": true, + "isDefault": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "java" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true, + "javaVersion": "1.8" + }, + "supportedFunctionsExtensionVersions": [ + "~2", + "~3" + ] + }, + "linuxRuntimeSettings": { + "runtimeVersion": "Java|8", + "isAutoUpdate": true, + "isDefault": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "java" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": false, + "linuxFxVersion": "Java|8" + }, + "supportedFunctionsExtensionVersions": [ + "~3" + ] + } + } + } + ] + } + ] + } + }, + { + "id": "/providers/Microsoft.Web/functionAppStacks/powershell", + "name": "powershell", + "type": "Microsoft.Web/functionAppStacks", + "properties": { + "displayText": "PowerShell Core", + "value": "powershell", + "preferredOs": "Windows", + "majorVersions": [ + { + "displayText": "PowerShell 7", + "value": "7", + "minorVersions": [ + { + "displayText": "PowerShell 7.0", + "value": "7.0", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "~7", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": false + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "powershell" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true, + "powerShellVersion": "~7" + }, + "supportedFunctionsExtensionVersions": [ + "~3" + ] + } + } + } + ] + }, + { + "displayText": "PowerShell Core 6", + "value": "6", + "minorVersions": [ + { + "displayText": "PowerShell Core 6.2", + "value": "6.2", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "~6", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": false + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "powershell" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true, + "powerShellVersion": "~6" + }, + "isDeprecated": true, + "supportedFunctionsExtensionVersions": [ + "~2", + "~3" + ], + "endOfLifeDate": "2020-10-04T00:00:00+00:00" + } + } + } + ] + } + ] + } + }, + { + "id": "/providers/Microsoft.Web/functionAppStacks/custom", + "name": "custom", + "type": "Microsoft.Web/functionAppStacks", + "properties": { + "displayText": "Custom", + "value": "custom", + "preferredOs": "Windows", + "majorVersions": [ + { + "displayText": "Custom", + "value": "custom", + "minorVersions": [ + { + "displayText": "Custom Handler", + "value": "custom", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "custom", + "isPreview": true, + "appInsightsSettings": { + "isSupported": true + }, + "remoteDebuggingSupported": false, + "gitHubActionSettings": { + "isSupported": false + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "custom" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true + }, + "supportedFunctionsExtensionVersions": [ + "~3", + "~2" + ] + }, + "linuxRuntimeSettings": { + "runtimeVersion": "", + "isPreview": true, + "appInsightsSettings": { + "isSupported": true + }, + "remoteDebuggingSupported": false, + "gitHubActionSettings": { + "isSupported": false + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "custom" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": false, + "linuxFxVersion": "" + }, + "supportedFunctionsExtensionVersions": [ + "~3", + "~2" + ] + } + } + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetFunctionAppStacksForLocation.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetFunctionAppStacksForLocation.json new file mode 100644 index 000000000000..cec09f14db66 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetFunctionAppStacksForLocation.json @@ -0,0 +1,786 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/providers/Microsoft.Web/locations/functionAppStacks/dotnet", + "name": "dotnet", + "type": "Microsoft.Web/locations/functionAppStacks", + "location": "westus", + "properties": { + "displayText": ".NET", + "value": "dotnet", + "preferredOs": "Windows", + "majorVersions": [ + { + "displayText": ".NET Core 3", + "value": "3", + "minorVersions": [ + { + "displayText": ".NET Core 3.1", + "value": "3.1", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "3.1", + "appInsightsSettings": { + "isSupported": true + }, + "remoteDebuggingSupported": false, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.1.301" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "dotnet" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true + }, + "supportedFunctionsExtensionVersions": [ + "~3" + ] + }, + "linuxRuntimeSettings": { + "runtimeVersion": "dotnet|3.1", + "appInsightsSettings": { + "isSupported": true + }, + "remoteDebuggingSupported": false, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.1.301" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "dotnet" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": false, + "linuxFxVersion": "dotnet|3.1" + }, + "supportedFunctionsExtensionVersions": [ + "~3" + ] + } + } + } + ] + }, + { + "displayText": ".NET Core 2", + "value": "2", + "minorVersions": [ + { + "displayText": ".NET Core 2.2", + "value": "2.2", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "2.2", + "appInsightsSettings": { + "isSupported": true + }, + "remoteDebuggingSupported": false, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "2.2.207" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "dotnet" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true + }, + "supportedFunctionsExtensionVersions": [ + "~2" + ] + }, + "linuxRuntimeSettings": { + "runtimeVersion": "dotnet|2.2", + "appInsightsSettings": { + "isSupported": true + }, + "remoteDebuggingSupported": false, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "2.2.207" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "dotnet" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": false, + "linuxFxVersion": "dotnet|2.2" + }, + "supportedFunctionsExtensionVersions": [ + "~2" + ] + } + } + } + ] + }, + { + "displayText": ".NET Framework 4", + "value": "2", + "minorVersions": [ + { + "displayText": ".NET Framework 4.7", + "value": "4.7", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "4.7", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": false + }, + "appSettingsDictionary": {}, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true + }, + "supportedFunctionsExtensionVersions": [ + "~1" + ] + } + } + } + ] + } + ] + } + }, + { + "id": "/providers/Microsoft.Web/locations/functionAppStacks/node", + "name": "node", + "type": "Microsoft.Web/locations/functionAppStacks", + "location": "westus", + "properties": { + "displayText": "Node.js", + "value": "node", + "preferredOs": "Windows", + "majorVersions": [ + { + "displayText": "Node.js 14", + "value": "14", + "minorVersions": [ + { + "displayText": "Node.js 14 LTS", + "value": "14 LTS", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "~14", + "isPreview": true, + "isHidden": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "14.x" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "node", + "WEBSITE_NODE_DEFAULT_VERSION": "~14" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true + }, + "supportedFunctionsExtensionVersions": [ + "~3" + ] + }, + "linuxRuntimeSettings": { + "runtimeVersion": "Node|14", + "isPreview": true, + "isHidden": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "14.x" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "node" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": false, + "linuxFxVersion": "Node|14" + }, + "supportedFunctionsExtensionVersions": [ + "~3" + ] + } + } + } + ] + }, + { + "displayText": "Node.js 12", + "value": "12", + "minorVersions": [ + { + "displayText": "Node.js 12 LTS", + "value": "12 LTS", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "~12", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "12.x" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "node", + "WEBSITE_NODE_DEFAULT_VERSION": "~12" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true + }, + "supportedFunctionsExtensionVersions": [ + "~3" + ] + }, + "linuxRuntimeSettings": { + "runtimeVersion": "Node|12", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "12.x" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "node" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": false, + "linuxFxVersion": "Node|12" + }, + "supportedFunctionsExtensionVersions": [ + "~3" + ] + } + } + } + ] + }, + { + "displayText": "Node.js 10", + "value": "10", + "minorVersions": [ + { + "displayText": "Node.js 10 LTS", + "value": "10 LTS", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "~10", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "10.x" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "node", + "WEBSITE_NODE_DEFAULT_VERSION": "~10" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true + }, + "supportedFunctionsExtensionVersions": [ + "~2", + "~3" + ] + }, + "linuxRuntimeSettings": { + "runtimeVersion": "Node|10", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "10.x" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "node" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": false, + "linuxFxVersion": "Node|10" + }, + "supportedFunctionsExtensionVersions": [ + "~2", + "~3" + ] + } + } + } + ] + }, + { + "displayText": "Node.js 8", + "value": "8", + "minorVersions": [ + { + "displayText": "Node.js 8 LTS", + "value": "8 LTS", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "~8", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8.x" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "node", + "WEBSITE_NODE_DEFAULT_VERSION": "~8" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true + }, + "supportedFunctionsExtensionVersions": [ + "~2" + ] + } + } + } + ] + }, + { + "displayText": "Node.js 6", + "value": "6", + "minorVersions": [ + { + "displayText": "Node.js 6 LTS", + "value": "6 LTS", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "~6", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": false + }, + "appSettingsDictionary": { + "WEBSITE_NODE_DEFAULT_VERSION": "~6" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true + }, + "supportedFunctionsExtensionVersions": [ + "~1" + ] + } + } + } + ] + } + ] + } + }, + { + "id": "/providers/Microsoft.Web/locations/functionAppStacks/python", + "name": "python", + "type": "Microsoft.Web/locations/functionAppStacks", + "location": "westus", + "properties": { + "displayText": "Python", + "value": "python", + "preferredOs": "Linux", + "majorVersions": [ + { + "displayText": "Python 3", + "value": "3", + "minorVersions": [ + { + "displayText": "Python 3.8", + "value": "3.8", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "Python|3.8", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.8" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "python" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": false, + "linuxFxVersion": "Python|3.8" + }, + "supportedFunctionsExtensionVersions": [ + "~3" + ] + } + } + }, + { + "displayText": "Python 3.7", + "value": "3.7", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "Python|3.7", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.7" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "python" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": false, + "linuxFxVersion": "Python|3.7" + }, + "supportedFunctionsExtensionVersions": [ + "~2", + "~3" + ] + } + } + }, + { + "displayText": "Python 3.6", + "value": "3.6", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "Python|3.6", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.6" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "python" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": false, + "linuxFxVersion": "Python|3.6" + }, + "supportedFunctionsExtensionVersions": [ + "~2", + "~3" + ] + } + } + } + ] + } + ] + } + }, + { + "id": "/providers/Microsoft.Web/locations/functionAppStacks/java", + "name": "java", + "type": "Microsoft.Web/locations/functionAppStacks", + "location": "westus", + "properties": { + "displayText": "Java", + "value": "java", + "preferredOs": "Windows", + "majorVersions": [ + { + "displayText": "Java 11", + "value": "11", + "minorVersions": [ + { + "displayText": "Java 11", + "value": "11.0", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "11", + "isAutoUpdate": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "11" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "java" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true, + "javaVersion": "11" + }, + "supportedFunctionsExtensionVersions": [ + "~3" + ] + }, + "linuxRuntimeSettings": { + "runtimeVersion": "Java|11", + "isAutoUpdate": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "11" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "java" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": false, + "linuxFxVersion": "Java|11" + }, + "supportedFunctionsExtensionVersions": [ + "~3" + ] + } + } + } + ] + }, + { + "displayText": "Java 8", + "value": "8", + "minorVersions": [ + { + "displayText": "Java 8", + "value": "8.0", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8", + "isAutoUpdate": true, + "isDefault": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "java" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true, + "javaVersion": "1.8" + }, + "supportedFunctionsExtensionVersions": [ + "~2", + "~3" + ] + }, + "linuxRuntimeSettings": { + "runtimeVersion": "Java|8", + "isAutoUpdate": true, + "isDefault": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "java" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": false, + "linuxFxVersion": "Java|8" + }, + "supportedFunctionsExtensionVersions": [ + "~3" + ] + } + } + } + ] + } + ] + } + }, + { + "id": "/providers/Microsoft.Web/locations/functionAppStacks/powershell", + "name": "powershell", + "type": "Microsoft.Web/locations/functionAppStacks", + "location": "westus", + "properties": { + "displayText": "PowerShell Core", + "value": "powershell", + "preferredOs": "Windows", + "majorVersions": [ + { + "displayText": "PowerShell 7", + "value": "7", + "minorVersions": [ + { + "displayText": "PowerShell 7.0", + "value": "7.0", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "~7", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": false + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "powershell" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true, + "powerShellVersion": "~7" + }, + "supportedFunctionsExtensionVersions": [ + "~3" + ] + } + } + } + ] + }, + { + "displayText": "PowerShell Core 6", + "value": "6", + "minorVersions": [ + { + "displayText": "PowerShell Core 6.2", + "value": "6.2", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "~6", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": false + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "powershell" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true, + "powerShellVersion": "~6" + }, + "isDeprecated": true, + "supportedFunctionsExtensionVersions": [ + "~2", + "~3" + ], + "endOfLifeDate": "2020-10-04T00:00:00+00:00" + } + } + } + ] + } + ] + } + }, + { + "id": "/providers/Microsoft.Web/locations/functionAppStacks/custom", + "name": "custom", + "type": "Microsoft.Web/locations/functionAppStacks", + "location": "westus", + "properties": { + "displayText": "Custom", + "value": "custom", + "preferredOs": "Windows", + "majorVersions": [ + { + "displayText": "Custom", + "value": "custom", + "minorVersions": [ + { + "displayText": "Custom Handler", + "value": "custom", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "custom", + "isPreview": true, + "appInsightsSettings": { + "isSupported": true + }, + "remoteDebuggingSupported": false, + "gitHubActionSettings": { + "isSupported": false + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "custom" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": true + }, + "supportedFunctionsExtensionVersions": [ + "~3", + "~2" + ] + }, + "linuxRuntimeSettings": { + "runtimeVersion": "", + "isPreview": true, + "appInsightsSettings": { + "isSupported": true + }, + "remoteDebuggingSupported": false, + "gitHubActionSettings": { + "isSupported": false + }, + "appSettingsDictionary": { + "FUNCTIONS_WORKER_RUNTIME": "custom" + }, + "siteConfigPropertiesDictionary": { + "use32BitWorkerProcess": false, + "linuxFxVersion": "" + }, + "supportedFunctionsExtensionVersions": [ + "~3", + "~2" + ] + } + } + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetInboundNetworkDependenciesEndpoints.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetInboundNetworkDependenciesEndpoints.json new file mode 100644 index 000000000000..5e4639db979e --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetInboundNetworkDependenciesEndpoints.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "name": "SampleAse", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "description": "App Service management", + "endpoints": [ + "70.37.57.58/32", + "157.55.208.185/32", + "23.102.188.65/32", + "191.236.154.88/32", + "52.174.22.21/32", + "13.94.149.179/32", + "13.94.143.126/32", + "13.94.141.115/32", + "52.178.195.197/32", + "52.178.190.65/32", + "52.178.184.149/32", + "52.178.177.147/32", + "13.75.127.117/32", + "40.83.125.161/32", + "40.83.121.56/32", + "40.83.120.64/32", + "52.187.56.50/32", + "52.187.63.37/32", + "52.187.59.251/32", + "52.187.63.19/32", + "52.165.158.140/32", + "52.165.152.214/32", + "52.165.154.193/32", + "52.165.153.122/32", + "104.44.129.255/32", + "104.44.134.255/32", + "104.44.129.243/32", + "104.44.129.141/32", + "65.52.193.203/32", + "70.37.89.222/32", + "13.64.115.203/32", + "52.225.177.153/32", + "65.52.172.237/32" + ], + "ports": [ + "454", + "455" + ] + }, + { + "description": "App Service Environment VIP", + "endpoints": [ + "52.247.209.18/32" + ], + "ports": [ + "454", + "455", + "16001" + ] + }, + { + "description": "App Service Environment subnet", + "endpoints": [ + "192.168.250.0/24" + ], + "ports": [ + "All" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetKeyVaultReferencesForAppSetting.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetKeyVaultReferencesForAppSetting.json new file mode 100644 index 000000000000..0d73e4823462 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetKeyVaultReferencesForAppSetting.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "testc6282", + "appSettingKey": "setting", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testc6282/config/configreferences/appsettings/setting", + "properties": { + "vaultName": "keyVaultName", + "secretName": "secretName", + "secretVersion": "secretVersion" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetKeyVaultReferencesForAppSettingSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetKeyVaultReferencesForAppSettingSlot.json new file mode 100644 index 000000000000..2aef5b67d9b1 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetKeyVaultReferencesForAppSettingSlot.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "testc6282", + "slot": "stage", + "appSettingKey": "setting", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testc6282/slots/stage/config/configreferences/appsettings/setting", + "properties": { + "vaultName": "keyVaultName", + "secretName": "secretName", + "secretVersion": "secretVersion" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetKeyVaultReferencesForAppSettings.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetKeyVaultReferencesForAppSettings.json new file mode 100644 index 000000000000..9c60008cd259 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetKeyVaultReferencesForAppSettings.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "testc6282", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testc6282/config/configreferences/appsettings/secretName", + "properties": { + "vaultName": "keyVaultName", + "secretName": "secretName", + "secretVersion": "secretVersion" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testc6282/config/configreferences/appsettings/secretName2", + "properties": { + "vaultName": "keyVaultName", + "secretName": "secretName2", + "secretVersion": "secretVersion2" + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetKeyVaultReferencesForAppSettingsSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetKeyVaultReferencesForAppSettingsSlot.json new file mode 100644 index 000000000000..81c1c628df15 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetKeyVaultReferencesForAppSettingsSlot.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "testc6282", + "slot": "stage", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testc6282/slots/stage/config/configreferences/appsettings/secretName", + "properties": { + "vaultName": "keyVaultName", + "secretName": "secretName", + "secretVersion": "secretVersion" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testc6282/slots/stage/config/configreferences/appsettings/secretName2", + "properties": { + "vaultName": "keyVaultName", + "secretName": "secretName2", + "secretVersion": "secretVersion2" + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetLinkedBackendForStaticSite.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetLinkedBackendForStaticSite.json new file mode 100644 index 000000000000..43bed8571826 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetLinkedBackendForStaticSite.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "linkedBackendName": "testBackend", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/linkedBackends/testBackend", + "name": "testBackend", + "type": "Microsoft.Web/staticSites/builds/linkedBackends", + "properties": { + "backendResourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/backendRg/providers/Microsoft.Web/sites/testBackend", + "region": "West US 2", + "createdOn": "2021-12-24T17:33:11.641Z", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetLinkedBackendForStaticSiteBuild.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetLinkedBackendForStaticSiteBuild.json new file mode 100644 index 000000000000..cdc2d1b6fd31 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetLinkedBackendForStaticSiteBuild.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "environmentName": "default", + "linkedBackendName": "testBackend", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/linkedBackends/testBackend", + "name": "testBackend", + "type": "Microsoft.Web/staticSites/builds/linkedBackends", + "properties": { + "backendResourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/backendRg/providers/Microsoft.Web/sites/testBackend", + "region": "West US 2", + "createdOn": "2021-12-24T17:33:11.641Z", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetLinkedBackendsForStaticSite.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetLinkedBackendsForStaticSite.json new file mode 100644 index 000000000000..cdc0c00eea44 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetLinkedBackendsForStaticSite.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/linkedBackends/testBackend", + "name": "testBackend", + "type": "Microsoft.Web/staticSites/builds/linkedBackends", + "properties": { + "backendResourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/functionRG/providers/Microsoft.Web/sites/testBackend", + "region": "West US 2", + "createdOn": "2020-03-04T17:33:11.641Z", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetLinkedBackendsForStaticSiteBuild.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetLinkedBackendsForStaticSiteBuild.json new file mode 100644 index 000000000000..07a8a56a0cbd --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetLinkedBackendsForStaticSiteBuild.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "environmentName": "default", + "linkedBackendName": "testBackend", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/linkedBackends/testBackend", + "name": "testBackend", + "type": "Microsoft.Web/staticSites/builds/linkedBackends", + "properties": { + "backendResourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/functionRG/providers/Microsoft.Web/sites/testBackend", + "region": "West US 2", + "createdOn": "2020-03-04T17:33:11.641Z", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetOutboundNetworkDependenciesEndpoints.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetOutboundNetworkDependenciesEndpoints.json new file mode 100644 index 000000000000..8285d0e5cc76 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetOutboundNetworkDependenciesEndpoints.json @@ -0,0 +1,802 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "name": "SampleAse", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "Azure Storage", + "endpoints": [ + { + "domainName": "blob.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "52.183.104.36", + "port": 80, + "latency": 42.0469, + "isAccessible": true + }, + { + "ipAddress": "52.183.104.36", + "port": 443, + "latency": 41.7038, + "isAccessible": true + } + ] + }, + { + "domainName": "queue.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "52.183.104.25", + "port": 80, + "latency": 37.326, + "isAccessible": true + }, + { + "ipAddress": "52.183.104.25", + "port": 443, + "latency": 37.513600000000004, + "isAccessible": true + } + ] + }, + { + "domainName": "table.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "52.183.104.26", + "port": 80, + "latency": 32.789, + "isAccessible": true + }, + { + "ipAddress": "52.183.104.26", + "port": 443, + "latency": 1.8702, + "isAccessible": true + } + ] + }, + { + "domainName": "file.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "52.183.104.28", + "port": 80, + "latency": 36.7378, + "isAccessible": true + }, + { + "ipAddress": "52.183.104.28", + "port": 443, + "latency": 36.7108, + "isAccessible": true + } + ] + }, + { + "domainName": "blob.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.77.184.64", + "port": 80, + "latency": 4.0261000000000005, + "isAccessible": true + }, + { + "ipAddress": "13.77.184.64", + "port": 443, + "latency": 3.8264, + "isAccessible": true + } + ] + }, + { + "domainName": "queue.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.77.184.73", + "port": 80, + "latency": 40.8523, + "isAccessible": true + }, + { + "ipAddress": "13.77.184.73", + "port": 443, + "latency": 40.7501, + "isAccessible": true + } + ] + }, + { + "domainName": "table.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.77.184.74", + "port": 80, + "latency": 1.2071, + "isAccessible": true + }, + { + "ipAddress": "13.77.184.74", + "port": 443, + "latency": 38.2975, + "isAccessible": true + } + ] + }, + { + "domainName": "file.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.77.184.76", + "port": 80, + "latency": 59.383700000000005, + "isAccessible": true + }, + { + "ipAddress": "13.77.184.76", + "port": 443, + "latency": 60.0775, + "isAccessible": true + } + ] + }, + { + "domainName": "blob.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.77.184.64", + "port": 80, + "latency": 3.5512, + "isAccessible": true + }, + { + "ipAddress": "13.77.184.64", + "port": 443, + "latency": 2.6777, + "isAccessible": true + } + ] + }, + { + "domainName": "queue.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.77.184.73", + "port": 80, + "latency": 3.5204, + "isAccessible": true + }, + { + "ipAddress": "13.77.184.73", + "port": 443, + "latency": 2.8193, + "isAccessible": true + } + ] + }, + { + "domainName": "table.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.77.184.74", + "port": 80, + "latency": 3.2720000000000002, + "isAccessible": true + }, + { + "ipAddress": "13.77.184.74", + "port": 443, + "latency": 3.0147, + "isAccessible": true + } + ] + }, + { + "domainName": "file.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.77.184.76", + "port": 80, + "latency": 3.2387, + "isAccessible": true + }, + { + "ipAddress": "13.77.184.76", + "port": 443, + "latency": 3.2804, + "isAccessible": true + } + ] + }, + { + "domainName": "blob.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.66.176.16", + "port": 80, + "latency": 43.025200000000005, + "isAccessible": true + }, + { + "ipAddress": "13.66.176.16", + "port": 443, + "latency": 43.1683, + "isAccessible": true + } + ] + }, + { + "domainName": "queue.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.66.176.25", + "port": 80, + "latency": 41.8598, + "isAccessible": true + }, + { + "ipAddress": "13.66.176.25", + "port": 443, + "latency": 41.9805, + "isAccessible": true + } + ] + }, + { + "domainName": "table.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.66.176.26", + "port": 80, + "latency": 30.542900000000003, + "isAccessible": true + }, + { + "ipAddress": "13.66.176.26", + "port": 443, + "latency": 0.98320000000000007, + "isAccessible": true + } + ] + }, + { + "domainName": "file.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.66.176.28", + "port": 80, + "latency": 35.9562, + "isAccessible": true + }, + { + "ipAddress": "13.66.176.28", + "port": 443, + "latency": 36.0643, + "isAccessible": true + } + ] + }, + { + "domainName": "blob.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.77.184.64", + "port": 80, + "latency": 3.2829, + "isAccessible": true + }, + { + "ipAddress": "13.77.184.64", + "port": 443, + "latency": 2.3393, + "isAccessible": true + } + ] + }, + { + "domainName": "queue.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.77.184.73", + "port": 80, + "latency": 3.4103000000000003, + "isAccessible": true + }, + { + "ipAddress": "13.77.184.73", + "port": 443, + "latency": 4.1032, + "isAccessible": true + } + ] + }, + { + "domainName": "table.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.77.184.74", + "port": 80, + "latency": 3.1141, + "isAccessible": true + }, + { + "ipAddress": "13.77.184.74", + "port": 443, + "latency": 3.0247, + "isAccessible": true + } + ] + }, + { + "domainName": "file.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.77.184.76", + "port": 80, + "latency": 2.834, + "isAccessible": true + }, + { + "ipAddress": "13.77.184.76", + "port": 443, + "latency": 2.8198000000000003, + "isAccessible": true + } + ] + }, + { + "domainName": "blob.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.77.184.64", + "port": 80, + "latency": 1.3855000000000002, + "isAccessible": true + }, + { + "ipAddress": "13.77.184.64", + "port": 443, + "latency": 1.0594000000000001, + "isAccessible": true + } + ] + }, + { + "domainName": "queue.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.77.184.73", + "port": 80, + "latency": 2.4717000000000002, + "isAccessible": true + }, + { + "ipAddress": "13.77.184.73", + "port": 443, + "latency": 2.4827, + "isAccessible": true + } + ] + }, + { + "domainName": "table.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.77.184.74", + "port": 80, + "latency": 3.395, + "isAccessible": true + }, + { + "ipAddress": "13.77.184.74", + "port": 443, + "latency": 3.1701, + "isAccessible": true + } + ] + }, + { + "domainName": "file.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.77.184.76", + "port": 80, + "latency": 1.4308, + "isAccessible": true + }, + { + "ipAddress": "13.77.184.76", + "port": 443, + "latency": 22.5866, + "isAccessible": true + } + ] + }, + { + "domainName": "blob.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.77.184.64", + "port": 80, + "latency": 2.5372, + "isAccessible": true + }, + { + "ipAddress": "13.77.184.64", + "port": 443, + "latency": 2.4626, + "isAccessible": true + } + ] + }, + { + "domainName": "queue.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.77.184.73", + "port": 80, + "latency": 3.7873, + "isAccessible": true + }, + { + "ipAddress": "13.77.184.73", + "port": 443, + "latency": 4.1911000000000005, + "isAccessible": true + } + ] + }, + { + "domainName": "table.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.77.184.74", + "port": 80, + "latency": 2.9162000000000003, + "isAccessible": true + }, + { + "ipAddress": "13.77.184.74", + "port": 443, + "latency": 2.7896, + "isAccessible": true + } + ] + }, + { + "domainName": "file.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.77.184.76", + "port": 80, + "latency": 26.723100000000002, + "isAccessible": true + }, + { + "ipAddress": "13.77.184.76", + "port": 443, + "latency": 26.735200000000003, + "isAccessible": true + } + ] + } + ] + }, + { + "category": "Azure SQL Database", + "endpoints": [ + { + "domainName": "database.windows.net", + "endpointDetails": [ + { + "ipAddress": "13.66.226.202", + "port": 1433, + "latency": 1.5964, + "isAccessible": true + } + ] + } + ] + }, + { + "category": "Azure Management", + "endpoints": [ + { + "domainName": "management.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "23.102.135.246", + "port": 443, + "latency": 46.5764, + "isAccessible": true + } + ] + }, + { + "domainName": "admin.core.windows.net", + "endpointDetails": [ + { + "ipAddress": "23.102.135.247", + "port": 443, + "latency": 47.408, + "isAccessible": true + } + ] + }, + { + "domainName": "management.azure.com", + "endpointDetails": [ + { + "ipAddress": "52.151.25.45", + "port": 443, + "latency": 3.9529, + "isAccessible": true + } + ] + } + ] + }, + { + "category": "Azure Active Directory", + "endpoints": [ + { + "domainName": "graph.windows.net", + "endpointDetails": [ + { + "ipAddress": "20.190.133.83", + "port": 443, + "latency": 3.2264, + "isAccessible": true + }, + { + "ipAddress": "20.190.133.81", + "port": 443, + "latency": 3.2264, + "isAccessible": true + }, + { + "ipAddress": "20.190.133.67", + "port": 443, + "latency": 3.2264, + "isAccessible": true + }, + { + "ipAddress": "40.126.5.34", + "port": 443, + "latency": 3.2264, + "isAccessible": true + } + ] + } + ] + }, + { + "category": "Regional Service", + "endpoints": [ + { + "domainName": "gr-prod-mwh.cloudapp.net", + "endpointDetails": [ + { + "ipAddress": "13.66.225.188", + "port": 443, + "latency": 3.3826, + "isAccessible": true + } + ] + }, + { + "domainName": "az-prod.metrics.nsatc.net", + "endpointDetails": [ + { + "ipAddress": "40.77.24.27", + "port": 443, + "latency": 38.5647, + "isAccessible": true + } + ] + } + ] + }, + { + "category": "SSL Certificate Verification", + "endpoints": [ + { + "domainName": "ocsp.msocsp.com", + "endpointDetails": [ + { + "ipAddress": "104.18.25.243", + "port": 80, + "latency": 6.0651, + "isAccessible": true + }, + { + "ipAddress": "104.18.25.243", + "port": 443, + "latency": 12.888, + "isAccessible": true + }, + { + "ipAddress": "104.18.24.243", + "port": 80, + "latency": 6.0651, + "isAccessible": true + }, + { + "ipAddress": "104.18.24.243", + "port": 443, + "latency": 12.888, + "isAccessible": true + } + ] + }, + { + "domainName": "mscrl.microsoft.com", + "endpointDetails": [ + { + "ipAddress": "152.199.4.33", + "port": 80, + "latency": 6.7429000000000006, + "isAccessible": true + }, + { + "ipAddress": "152.199.4.33", + "port": 443, + "latency": 7.4361000000000006, + "isAccessible": true + } + ] + }, + { + "domainName": "crl.microsoft.com", + "endpointDetails": [ + { + "ipAddress": "23.215.102.10", + "port": 80, + "latency": 25.136200000000002, + "isAccessible": true + }, + { + "ipAddress": "23.215.102.10", + "port": 443, + "latency": 25.0085, + "isAccessible": true + }, + { + "ipAddress": "23.215.102.42", + "port": 80, + "latency": 25.136200000000002, + "isAccessible": true + }, + { + "ipAddress": "23.215.102.42", + "port": 443, + "latency": 25.0085, + "isAccessible": true + } + ] + }, + { + "domainName": "www.microsoft.com", + "endpointDetails": [ + { + "ipAddress": "23.49.13.56", + "port": 80, + "latency": 7.9229, + "isAccessible": true + }, + { + "ipAddress": "23.49.13.56", + "port": 443, + "latency": 8.4871, + "isAccessible": true + } + ] + }, + { + "domainName": "crl3.digicert.com", + "endpointDetails": [ + { + "ipAddress": "72.21.91.29", + "port": 80, + "latency": 5.4074, + "isAccessible": true + }, + { + "ipAddress": "72.21.91.29", + "port": 443, + "latency": 5.577, + "isAccessible": true + } + ] + }, + { + "domainName": "ocsp.digicert.com", + "endpointDetails": [ + { + "ipAddress": "72.21.91.29", + "port": 80, + "latency": 6.8989, + "isAccessible": true + }, + { + "ipAddress": "72.21.91.29", + "port": 443, + "latency": 5.6674000000000007, + "isAccessible": true + } + ] + }, + { + "domainName": "cacerts.digicert.com", + "endpointDetails": [ + { + "ipAddress": "104.18.11.39", + "port": 80, + "latency": 10.772400000000001, + "isAccessible": true + }, + { + "ipAddress": "104.18.11.39", + "port": 443, + "latency": 10.7705, + "isAccessible": true + }, + { + "ipAddress": "104.18.10.39", + "port": 80, + "latency": 10.772400000000001, + "isAccessible": true + }, + { + "ipAddress": "104.18.10.39", + "port": 443, + "latency": 10.7705, + "isAccessible": true + } + ] + }, + { + "domainName": "www.thawte.com", + "endpointDetails": [ + { + "ipAddress": "54.69.98.161", + "port": 80, + "latency": 47.532900000000005, + "isAccessible": true + }, + { + "ipAddress": "54.69.98.161", + "port": 443, + "latency": 48.5362, + "isAccessible": true + }, + { + "ipAddress": "35.167.62.148", + "port": 80, + "latency": 47.532900000000005, + "isAccessible": true + }, + { + "ipAddress": "35.167.62.148", + "port": 443, + "latency": 48.5362, + "isAccessible": true + } + ] + } + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetPublishingCredentialsPolicy.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetPublishingCredentialsPolicy.json new file mode 100644 index 000000000000..ee14c20f372a --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetPublishingCredentialsPolicy.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testSite", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/basicPublishingCredentialsPolicies/ftp", + "properties": { + "allow": false + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetPublishingCredentialsPolicySlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetPublishingCredentialsPolicySlot.json new file mode 100644 index 000000000000..1be0a601b43f --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetPublishingCredentialsPolicySlot.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testSite", + "slot": "stage", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/slots/stage/basicPublishingCredentialsPolicies/ftp", + "properties": { + "allow": false + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetResourceHealthMetadataBySite.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetResourceHealthMetadataBySite.json new file mode 100644 index 000000000000..1205b437cab0 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetResourceHealthMetadataBySite.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "name": "newsiteinnewASE-NCUS", + "slot": "Production", + "resourceGroupName": "Default-Web-NorthCentralUS", + "subscriptionId": "4adb32ad-8327-4cbb-b775-b84b4465bb38", + "metadataName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "category": "Shared", + "signalAvailability": true + }, + "id": "/subscriptions/4adb32ad-8327-4cbb-b775-b84b4465bb38/resourceGroups/Default-Web-NorthCentralUS/providers/Microsoft.Web/sites/newsiteinnewASE-NCUS/resourceHealthMetadata/default", + "name": "default", + "type": "Microsoft.Web/sites/resourceHealthMetadata" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetRevision.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetRevision.json new file mode 100644 index 000000000000..e273ea29d5d8 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetRevision.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "name": "testcontainerApp0-pjxhsye", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.WebcontainerApps/testcontainerApp0/revisions/testcontainerApp0-pjxhsye", + "name": "testcontainerApp0-pjxhsye", + "type": "Microsoft.Web/containerApps/revisions", + "location": "East US", + "properties": { + "createdTime": "2021-05-24T21:24:22+00:00", + "fqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v2", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + }, + "dapr": { + "enabled": true, + "appPort": 3000 + } + }, + "active": true, + "replicas": 1 + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSiteConfig.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSiteConfig.json new file mode 100644 index 000000000000..60b70e71b358 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSiteConfig.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/web", + "name": "web", + "type": "Microsoft.Web/sites/config", + "kind": "app", + "properties": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php", + "hostingstart.html" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSiteDeploymentStatus.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSiteDeploymentStatus.json new file mode 100644 index 000000000000..7e6efaab1a54 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSiteDeploymentStatus.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testSite", + "deploymentStatusId": "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/deploymentStatus/eacfd68b-3bbd-4ad9-99c5-98614d89c8e5", + "name": "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5", + "type": "Microsoft.Web/sites/deploymentStatus", + "properties": { + "deploymentId": "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5", + "status": "RuntimeSuccessful", + "numberOfInstancesInProgress": 0, + "numberOfInstancesSuccessful": 1, + "numberOfInstancesFailed": 0, + "failedInstancesLogs": [], + "errors": null + } + } + }, + "202": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/deploymentStatus/eacfd68b-3bbd-4ad9-99c5-98614d89c8e5", + "name": "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5", + "type": "Microsoft.Web/sites/deploymentStatus", + "properties": { + "deploymentId": "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5", + "status": "RuntimeStarting", + "numberOfInstancesInProgress": 1, + "numberOfInstancesSuccessful": 0, + "numberOfInstancesFailed": 0, + "failedInstancesLogs": [], + "errors": null + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSiteDeploymentStatusSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSiteDeploymentStatusSlot.json new file mode 100644 index 000000000000..b1293374c38e --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSiteDeploymentStatusSlot.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testSite", + "slot": "stage", + "deploymentStatusId": "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/slots/stage/deploymentStatus/eacfd68b-3bbd-4ad9-99c5-98614d89c8e5", + "name": "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5", + "type": "Microsoft.Web/sites/slots/deploymentStatus", + "properties": { + "deploymentId": "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5", + "status": "RuntimeSuccessful", + "numberOfInstancesInProgress": 0, + "numberOfInstancesSuccessful": 1, + "numberOfInstancesFailed": 0, + "failedInstancesLogs": [], + "errors": null + } + } + }, + "202": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/slots/stage/deploymentStatus/eacfd68b-3bbd-4ad9-99c5-98614d89c8e5", + "name": "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5", + "type": "Microsoft.Web/sites/slots/deploymentStatus", + "properties": { + "deploymentId": "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5", + "status": "RuntimeStarting", + "numberOfInstancesInProgress": 1, + "numberOfInstancesSuccessful": 0, + "numberOfInstancesFailed": 0, + "failedInstancesLogs": [], + "errors": null + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSiteInstanceInfo.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSiteInstanceInfo.json new file mode 100644 index 000000000000..e6ecb19d2dbb --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSiteInstanceInfo.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "tests346", + "instanceId": "134987120", + "slot": "staging", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/tests346/slot/staging/instances/134987120", + "name": "134987120", + "type": "Microsoft.Web/sites/instances", + "properties": { + "state": "READY", + "statusUrl": "https://sampleurl", + "detectorUrl": "testsec579", + "containers": { + "c1": { + "currentTimeStamp": "2013-10-21T13:28:06.419Z" + } + } + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSitePrivateEndpointConnection.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSitePrivateEndpointConnection.json new file mode 100644 index 000000000000..f73c4919ec38 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSitePrivateEndpointConnection.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testSite", + "privateEndpointConnectionName": "connection", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/privateEndpointConnections/connection", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin.", + "actionsRequired": "" + } + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSitePrivateEndpointConnectionList.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSitePrivateEndpointConnectionList.json new file mode 100644 index 000000000000..4f6a4751605d --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSitePrivateEndpointConnectionList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/privateEndpointConnections/connection", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin.", + "actionsRequired": "" + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSitePrivateEndpointConnectionSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSitePrivateEndpointConnectionSlot.json new file mode 100644 index 000000000000..44689f70ee29 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSitePrivateEndpointConnectionSlot.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testSite", + "slot": "stage", + "privateEndpointConnectionName": "connection", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/slot/stage/privateEndpointConnections/connection", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin.", + "actionsRequired": "" + } + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSitePrivateLinkResources.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSitePrivateLinkResources.json new file mode 100644 index 000000000000..32da32e60b0e --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSitePrivateLinkResources.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testSite", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/privateLinkResources/site", + "name": "site", + "type": "Microsoft.Web/sites/privateLinkResources", + "properties": { + "groupId": "sites", + "requiredMembers": [ + "sites" + ], + "requiredZoneNames": [ + "privatelink.testsite.azurewebsites.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSitePrivateLinkResourcesSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSitePrivateLinkResourcesSlot.json new file mode 100644 index 000000000000..408cc9702831 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSitePrivateLinkResourcesSlot.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testSite", + "slot": "stage", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/privateLinkResources/site", + "name": "site", + "type": "Microsoft.Web/sites/privateLinkResources", + "properties": { + "groupId": "sites", + "requiredMembers": [ + "sites" + ], + "requiredZoneNames": [ + "privatelink.testsite.azurewebsites.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSite.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSite.json new file mode 100644 index 000000000000..6a58d1ec52b3 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSite.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0", + "name": "testStaticSite0", + "type": "Microsoft.Web/staticSites", + "location": "West US 2", + "properties": { + "defaultHostname": "happy-sea-15afae3e.azurestaticwebsites.net", + "repositoryUrl": "https://github.com/username/repo", + "branch": "demo", + "customDomains": [], + "privateEndpointConnections": [], + "contentDistributionEndpoint": "", + "keyVaultReferenceIdentity": "SystemAssigned", + "userProvidedFunctionApps": null, + "linkedBackends": [ + { + "backendResourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.ApiManagement/service/apimService0", + "region": null, + "createdOn": "2022-03-27T04:57:24.8058474", + "provisioningState": "Succeeded" + } + ], + "stagingEnvironmentPolicy": "Enabled", + "allowConfigFileUpdates": true + }, + "sku": { + "name": "Basic", + "tier": "Basic" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBasicAuth.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBasicAuth.json new file mode 100644 index 000000000000..bec1561363c8 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBasicAuth.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "basicAuthName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/basicAuth/default", + "name": "default", + "properties": { + "environments": null, + "secretUrl": null, + "applicableEnvironmentsMode": "AllEnvironments", + "secretState": "Password" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBuild.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBuild.json new file mode 100644 index 000000000000..b6ab4718cf2c --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBuild.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "environmentName": "12", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/12", + "properties": { + "buildId": "12", + "sourceBranch": "pr-branch", + "pullRequestTitle": "Update README.md", + "hostname": "happy-sea-15afae3e-12.westus2.azurestaticwebsites.net", + "createdTimeUtc": "2020-03-04T17:33:11.641Z", + "lastUpdatedOn": "2020-03-04T17:33:11.641Z", + "status": "Uploading", + "userProvidedFunctionApps": null, + "linkedBackends": [ + { + "backendResourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.ApiManagement/service/apimService0", + "region": null, + "createdOn": "2022-03-27T04:57:24.8058474", + "provisioningState": "Succeeded" + } + ] + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBuildDatabaseConnection.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBuildDatabaseConnection.json new file mode 100644 index 000000000000..0f3dc6d44483 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBuildDatabaseConnection.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "environmentName": "default", + "databaseConnectionName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/databaseConnections/default", + "name": "default", + "type": "Microsoft.Web/staticSites/builds/databaseConnections", + "properties": { + "resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName", + "connectionIdentity": "SystemAssigned", + "region": "West US 2" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBuildDatabaseConnectionWithDetails.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBuildDatabaseConnectionWithDetails.json new file mode 100644 index 000000000000..0901b9bb315f --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBuildDatabaseConnectionWithDetails.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "environmentName": "default", + "databaseConnectionName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/databaseConnections/default", + "name": "default", + "type": "Microsoft.Web/staticSites/builds/databaseConnections", + "properties": { + "resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName", + "connectionIdentity": "SystemAssigned", + "connectionString": "AccountEndpoint=https://exampleDatabaseName.documents.azure.com:443/;Database=mydb;", + "region": "West US 2", + "configurationFiles": [ + { + "fileName": "staticwebapp.database.config.json", + "contents": "base64encodeddatabaseconfiguration", + "type": "configuration" + }, + { + "fileName": "staticwebapp.database.schema.gql", + "contents": "base64encodeddatabasegraphqlschema", + "type": "graphqlschema" + } + ] + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBuildDatabaseConnections.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBuildDatabaseConnections.json new file mode 100644 index 000000000000..94c398ed9c3f --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBuildDatabaseConnections.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "environmentName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/databaseConnections/default", + "name": "default", + "type": "Microsoft.Web/staticSites/builds/databaseConnections", + "properties": { + "resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName", + "connectionIdentity": "SystemAssigned", + "region": "West US 2" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBuildDatabaseConnectionsWithDetails.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBuildDatabaseConnectionsWithDetails.json new file mode 100644 index 000000000000..52b653899f7a --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBuildDatabaseConnectionsWithDetails.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "environmentName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/databaseConnections/default", + "name": "default", + "type": "Microsoft.Web/staticSites/builds/databaseConnections", + "properties": { + "resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName", + "connectionIdentity": "SystemAssigned", + "connectionString": "AccountEndpoint=https://exampleDatabaseName.documents.azure.com:443/;Database=mydb;", + "region": "West US 2", + "configurationFiles": [ + { + "fileName": "staticwebapp.database.config.json", + "contents": "base64encodeddatabaseconfiguration", + "type": "configuration" + }, + { + "fileName": "staticwebapp.database.schema.gql", + "contents": "base64encodeddatabasegraphqlschema", + "type": "graphqlschema" + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBuilds.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBuilds.json new file mode 100644 index 000000000000..d4512522cb8b --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteBuilds.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default", + "properties": { + "buildId": "default", + "sourceBranch": "demo", + "pullRequestTitle": null, + "hostname": "happy-sea-15afae3e.azurestaticwebsites.net", + "createdTimeUtc": "2020-03-04T17:33:11.641Z", + "lastUpdatedOn": "2020-03-04T17:33:11.641Z", + "status": "Ready", + "userProvidedFunctionApps": null, + "linkedBackends": [] + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/12", + "properties": { + "buildId": "12", + "sourceBranch": "demo-patch2", + "pullRequestTitle": "Update README.md", + "hostname": "happy-sea-15afae3e-12.westus2.azurestaticwebsites.net", + "createdTimeUtc": "2020-03-04T17:33:11.641Z", + "lastUpdatedOn": "2020-03-04T17:33:11.641Z", + "status": "Ready", + "userProvidedFunctionApps": null, + "linkedBackends": [ + { + "backendResourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.ApiManagement/service/apimService0", + "region": null, + "createdOn": "2022-03-27T04:57:24.8058474", + "provisioningState": "Succeeded" + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteCustomDomain.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteCustomDomain.json new file mode 100644 index 000000000000..b588ce6464ea --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteCustomDomain.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "domainName": "custom.domain.net", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSitesBuilds/testStaticSite0/customDomains/custom.domain.net", + "properties": { + "domainName": "custom.domain.net", + "createdOn": "2020-03-04T17:33:11.641Z" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteCustomDomains.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteCustomDomains.json new file mode 100644 index 000000000000..4e457fdfda0c --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteCustomDomains.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSitesBuilds/testStaticSite0/customDomains/custom.domain.net", + "properties": { + "domainName": "custom.domain.net", + "createdOn": "2020-03-04T17:33:11.641Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteDatabaseConnection.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteDatabaseConnection.json new file mode 100644 index 000000000000..3e6b6c9440c7 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteDatabaseConnection.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "databaseConnectionName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/databaseConnections/default", + "name": "default", + "type": "Microsoft.Web/staticSites/databaseConnections", + "properties": { + "resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName", + "connectionIdentity": "SystemAssigned", + "region": "West US 2" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteDatabaseConnectionWithDetails.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteDatabaseConnectionWithDetails.json new file mode 100644 index 000000000000..e25d64402507 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteDatabaseConnectionWithDetails.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "databaseConnectionName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/databaseConnections/default", + "name": "default", + "type": "Microsoft.Web/staticSites/databaseConnections", + "properties": { + "resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName", + "connectionIdentity": "SystemAssigned", + "connectionString": "AccountEndpoint=https://exampleDatabaseName.documents.azure.com:443/;Database=mydb;", + "region": "West US 2", + "configurationFiles": [ + { + "fileName": "staticwebapp.database.config.json", + "contents": "base64encodeddatabaseconfiguration", + "type": "configuration" + }, + { + "fileName": "staticwebapp.database.schema.gql", + "contents": "base64encodeddatabasegraphqlschema", + "type": "graphqlschema" + } + ] + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteDatabaseConnections.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteDatabaseConnections.json new file mode 100644 index 000000000000..4a1258d686b3 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteDatabaseConnections.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/databaseConnections/default", + "name": "default", + "type": "Microsoft.Web/staticSites/databaseConnections", + "properties": { + "resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName", + "connectionIdentity": "SystemAssigned", + "region": "West US 2" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteDatabaseConnectionsWithDetails.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteDatabaseConnectionsWithDetails.json new file mode 100644 index 000000000000..d4d18b27d51e --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSiteDatabaseConnectionsWithDetails.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/databaseConnections/default", + "name": "default", + "type": "Microsoft.Web/staticSites/databaseConnections", + "properties": { + "resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName", + "connectionIdentity": "SystemAssigned", + "connectionString": "AccountEndpoint=https://exampleDatabaseName.documents.azure.com:443/;Database=mydb;", + "region": "West US 2", + "configurationFiles": [ + { + "fileName": "staticwebapp.database.config.json", + "contents": "base64encodeddatabaseconfiguration", + "type": "configuration" + }, + { + "fileName": "staticwebapp.database.schema.gql", + "contents": "base64encodeddatabasegraphqlschema", + "type": "graphqlschema" + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSites.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSites.json new file mode 100644 index 000000000000..17152bd5e805 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetStaticSites.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0", + "name": "testStaticSite0", + "type": "Microsoft.Web/staticSites", + "location": "West US 2", + "properties": { + "defaultHostname": "happy-sea-15afae3e.azurestaticwebsites.net", + "repositoryUrl": "https://github.com/username/repo", + "branch": "demo", + "customDomains": [], + "privateEndpointConnections": [], + "contentDistributionEndpoint": "", + "keyVaultReferenceIdentity": "SystemAssigned", + "userProvidedFunctionApps": null, + "linkedBackends": [], + "stagingEnvironmentPolicy": "Enabled", + "allowConfigFileUpdates": true + }, + "sku": { + "name": "Standard", + "tier": "Standard" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSubscriptionOperationWithAsyncResponse.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSubscriptionOperationWithAsyncResponse.json new file mode 100644 index 000000000000..55b5095d1e1d --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSubscriptionOperationWithAsyncResponse.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "location": "West US", + "operationId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab5d5", + "api-version": "2024-04-01" + }, + "responses": { + "204": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetUsagesInLocation.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetUsagesInLocation.json new file mode 100644 index 000000000000..87571af0f399 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetUsagesInLocation.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "location": "West US", + "quotaType": "regional", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "unit": "Core Count", + "currentValue": 55, + "limit": 250, + "name": { + "value": "Cores usage in West US", + "localizedValue": "Cores usage in West US" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetUserProvidedFunctionAppForStaticSite.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetUserProvidedFunctionAppForStaticSite.json new file mode 100644 index 000000000000..290c9633b9c3 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetUserProvidedFunctionAppForStaticSite.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "functionAppName": "testFunctionApp", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/userProvidedFunctionApps/testFunctionApp", + "name": "testFunctionApp", + "type": "Microsoft.Web/staticSites/builds/userProvidedFunctionApps", + "properties": { + "functionAppResourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/functionRG/providers/Microsoft.Web/sites/testFunctionApp", + "functionAppRegion": "West US 2", + "createdOn": "2020-03-04T17:33:11.641Z" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetUserProvidedFunctionAppForStaticSiteBuild.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetUserProvidedFunctionAppForStaticSiteBuild.json new file mode 100644 index 000000000000..181bd2559b39 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetUserProvidedFunctionAppForStaticSiteBuild.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "environmentName": "default", + "functionAppName": "testFunctionApp", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/userProvidedFunctionApps/testFunctionApp", + "name": "testFunctionApp", + "type": "Microsoft.Web/staticSites/builds/userProvidedFunctionApps", + "properties": { + "functionAppResourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/functionRG/providers/Microsoft.Web/sites/testFunctionApp", + "functionAppRegion": "West US 2", + "createdOn": "2020-03-04T17:33:11.641Z" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetUserProvidedFunctionAppsForStaticSite.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetUserProvidedFunctionAppsForStaticSite.json new file mode 100644 index 000000000000..abac10418420 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetUserProvidedFunctionAppsForStaticSite.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/userProvidedFunctionApps/testFunctionApp", + "name": "testFunctionApp", + "type": "Microsoft.Web/staticSites/builds/userProvidedFunctionApps", + "properties": { + "functionAppResourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/functionRG/providers/Microsoft.Web/sites/testFunctionApp", + "functionAppRegion": "West US 2", + "createdOn": "2020-03-04T17:33:11.641Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetUserProvidedFunctionAppsForStaticSiteBuild.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetUserProvidedFunctionAppsForStaticSiteBuild.json new file mode 100644 index 000000000000..6b591530f45a --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetUserProvidedFunctionAppsForStaticSiteBuild.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "environmentName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/userProvidedFunctionApps/testFunctionApp", + "name": "testFunctionApp", + "type": "Microsoft.Web/staticSites/builds/userProvidedFunctionApps", + "properties": { + "functionAppResourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/functionRG/providers/Microsoft.Web/sites/testFunctionApp", + "functionAppRegion": "West US 2", + "createdOn": "2020-03-04T17:33:11.641Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebApp.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebApp.json new file mode 100644 index 000000000000..a3bae7c72b62 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebApp.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141", + "name": "sitef6141", + "type": "Microsoft.Web/sites", + "kind": "app", + "location": "East US", + "properties": { + "state": "Running", + "hostNames": [ + "sitef6141.azurewebsites.net" + ], + "repositorySiteName": "sitef6141", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "sitef6141.azurewebsites.net", + "sitef6141.scm.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "sitef6141.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "sitef6141.scm.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp", + "reserved": false, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2020-03-04T17:33:11.641Z", + "vnetRouteAllEnabled": false, + "vnetImagePullEnabled": false, + "vnetContentShareEnabled": false, + "siteConfig": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php", + "hostingstart.html" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + }, + "scmSiteAlsoStopped": false, + "clientAffinityEnabled": true, + "clientCertEnabled": false, + "clientCertMode": "Required", + "hostNamesDisabled": false, + "customDomainVerificationId": "7F3BB652450EF7AD0B6AA33064586E4A9CE823A46DF0B2EC6443A68086E84153", + "outboundIpAddresses": "70.37.102.201,20.225.43.144", + "possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188", + "containerSize": 0, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "testrg123", + "defaultHostName": "sitef6141.azurewebsites.net", + "httpsOnly": false, + "redundancyMode": "None", + "storageAccountRequired": false, + "keyVaultReferenceIdentity": "SystemAssigned", + "workloadProfileName": "myd4wp", + "resourceConfig": { + "cpu": 1.0, + "memory": "2.0Gi" + }, + "sku": "Standard" + } + } + }, + "404": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebAppBackup.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebAppBackup.json new file mode 100644 index 000000000000..d8d58cd3f9d3 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebAppBackup.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "backupId": "12345", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/backups/12345", + "name": "sitef6141", + "type": "Microsoft.Web/sites", + "properties": { + "id": 12345, + "storageAccountUrl": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "blobName": "sitef6141_2024-04-01", + "name": "sitef6141_2024-04-01", + "status": "InProgress", + "sizeInBytes": 56091883, + "created": "2022-09-03T17:33:11.641Z", + "log": "Succeeded", + "databases": [ + { + "databaseType": "SqlAzure", + "name": "backenddb", + "connectionStringName": "backend", + "connectionString": "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;=]" + }, + { + "databaseType": "SqlAzure", + "name": "statsdb", + "connectionStringName": "stats", + "connectionString": "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;=]" + } + ], + "scheduled": true, + "lastRestoreTimeStamp": "2022-09-04T17:33:11.641Z", + "finishedTimeStamp": "2022-09-05T17:33:11.641Z", + "websiteSizeInBytes": 56091883 + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebAppBackupWithSecrets.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebAppBackupWithSecrets.json new file mode 100644 index 000000000000..aaa06c46f279 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebAppBackupWithSecrets.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "backupId": "12345", + "api-version": "2024-04-01", + "request": { + "properties": { + "storageAccountUrl": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "backupName": "abcdwe", + "enabled": true, + "databases": [ + { + "databaseType": "SqlAzure", + "name": "backenddb", + "connectionStringName": "backend", + "connectionString": "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;=]" + }, + { + "databaseType": "SqlAzure", + "name": "statsdb", + "connectionStringName": "stats", + "connectionString": "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;=]" + } + ], + "backupSchedule": { + "frequencyInterval": 7, + "frequencyUnit": "Day", + "keepAtLeastOneBackup": true, + "retentionPeriodInDays": 30, + "startTime": "2022-09-02T17:33:11.641Z" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/backups/12345", + "name": "sitef6141", + "type": "Microsoft.Web/sites", + "properties": { + "id": 12345, + "storageAccountUrl": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "blobName": "sitef6141_2024-04-01", + "name": "sitef6141_2024-04-01", + "status": "InProgress", + "sizeInBytes": 56091883, + "created": "2022-09-03T17:33:11.641Z", + "log": "Succeeded", + "databases": [ + { + "databaseType": "SqlAzure", + "name": "backenddb", + "connectionStringName": "backend", + "connectionString": "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;=]" + }, + { + "databaseType": "SqlAzure", + "name": "statsdb", + "connectionStringName": "stats", + "connectionString": "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;=]" + } + ], + "scheduled": true, + "lastRestoreTimeStamp": "2022-09-04T17:33:11.641Z", + "finishedTimeStamp": "2022-09-05T17:33:11.641Z", + "websiteSizeInBytes": 56091883 + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebAppSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebAppSlot.json new file mode 100644 index 000000000000..ba1ce82066af --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebAppSlot.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "slot": "staging", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/slots/staging", + "name": "sitef6141/staging", + "type": "Microsoft.Web/sites/slots", + "kind": "app", + "location": "East US", + "properties": { + "state": "Running", + "hostNames": [ + "sitef6141-staging.azurewebsites.net" + ], + "repositorySiteName": "sitef6141", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "sitef6141-staging.azurewebsites.net", + "sitef6141-staging.scm.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "sitef6141-staging.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "sitef6141-staging.scm.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp", + "reserved": false, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2020-03-04T17:33:11.641Z", + "vnetRouteAllEnabled": false, + "vnetImagePullEnabled": false, + "vnetContentShareEnabled": false, + "siteConfig": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php", + "hostingstart.html" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + }, + "scmSiteAlsoStopped": false, + "clientAffinityEnabled": true, + "clientCertEnabled": false, + "clientCertMode": "Required", + "hostNamesDisabled": false, + "customDomainVerificationId": "7F3BB652450EF7AD0B6AA33064586E4A9CE823A46DF0B2EC6443A68086E84153", + "outboundIpAddresses": "70.37.102.201,20.225.43.144", + "possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188", + "containerSize": 0, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "testrg123", + "defaultHostName": "sitef6141-staging.azurewebsites.net", + "httpsOnly": false, + "redundancyMode": "None", + "storageAccountRequired": false, + "keyVaultReferenceIdentity": "SystemAssigned", + "sku": "Standard" + } + } + }, + "404": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebAppStacks.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebAppStacks.json new file mode 100644 index 000000000000..7021db7af1e7 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebAppStacks.json @@ -0,0 +1,2915 @@ +{ + "parameters": { + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/providers/Microsoft.Web/webAppStacks/dotnet", + "name": "dotnet", + "type": "Microsoft.Web/webAppStacks", + "properties": { + "displayText": ".NET", + "value": "dotnet", + "preferredOs": "Windows", + "majorVersions": [ + { + "displayText": ".NET 5", + "value": "5", + "minorVersions": [ + { + "displayText": ".NET 5", + "value": "5", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "v5.0", + "isEarlyAccess": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "5.0.x" + } + }, + "linuxRuntimeSettings": { + "runtimeVersion": "DOTNETCORE|5.0", + "isEarlyAccess": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "5.0.x" + } + } + } + } + ] + }, + { + "displayText": ".NET Core 3", + "value": "3", + "minorVersions": [ + { + "displayText": ".NET Core 3.1 (LTS)", + "value": "3.1", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "3.1", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.1.301" + } + }, + "linuxRuntimeSettings": { + "runtimeVersion": "DOTNETCORE|3.1", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.1.301" + } + } + } + }, + { + "displayText": ".NET Core 3.0", + "value": "3.0", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "3.0", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.0.103" + }, + "endOfLifeDate": "2020-04-03T00:00:00+00:00" + }, + "linuxRuntimeSettings": { + "runtimeVersion": "DOTNETCORE|3.0", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.0.103" + }, + "endOfLifeDate": "2020-04-03T00:00:00+00:00" + } + } + } + ] + }, + { + "displayText": ".NET Core 2", + "value": "dotnetcore2", + "minorVersions": [ + { + "displayText": ".NET Core 2.2", + "value": "2.2", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "2.2", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "2.2.207" + }, + "endOfLifeDate": "2020-01-23T00:00:00+00:00" + }, + "linuxRuntimeSettings": { + "runtimeVersion": "DOTNETCORE|2.2", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "2.2.207" + }, + "endOfLifeDate": "2020-01-23T00:00:00+00:00" + } + } + }, + { + "displayText": ".NET Core 2.1 (LTS)", + "value": "2.1", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "2.1", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "2.1.807" + }, + "endOfLifeDate": "2021-09-21T00:00:00+00:00" + }, + "linuxRuntimeSettings": { + "runtimeVersion": "DOTNETCORE|2.1", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "2.1.807" + }, + "endOfLifeDate": "2021-09-21T00:00:00+00:00" + } + } + }, + { + "displayText": ".NET Core 2.0", + "value": "2.0", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "2.0", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "2.1.202" + }, + "endOfLifeDate": "2018-11-01T00:00:00+00:00" + }, + "linuxRuntimeSettings": { + "runtimeVersion": "DOTNETCORE|2.0", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "2.1.202" + }, + "endOfLifeDate": "2018-11-01T00:00:00+00:00" + } + } + } + ] + }, + { + "displayText": ".NET Core 1", + "value": "1", + "minorVersions": [ + { + "displayText": ".NET Core 1.1", + "value": "1.1", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.1", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "1.1.14" + }, + "endOfLifeDate": "2019-07-27T00:00:00+00:00" + }, + "linuxRuntimeSettings": { + "runtimeVersion": "DOTNETCORE|1.1", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "1.1.14" + }, + "endOfLifeDate": "2019-07-27T00:00:00+00:00" + } + } + }, + { + "displayText": ".NET Core 1.0", + "value": "1.0", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.0", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "1.1.14" + }, + "endOfLifeDate": "2019-07-27T00:00:00+00:00" + }, + "linuxRuntimeSettings": { + "runtimeVersion": "DOTNETCORE|1.0", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "1.1.14" + }, + "endOfLifeDate": "2019-07-27T00:00:00+00:00" + } + } + } + ] + }, + { + "displayText": "ASP.NET V4", + "value": "v4", + "minorVersions": [ + { + "displayText": "ASP.NET V4.8", + "value": "v4.8", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "v4.0", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.1" + } + } + } + } + ] + }, + { + "displayText": "ASP.NET V3", + "value": "v3", + "minorVersions": [ + { + "displayText": "ASP.NET V3.5", + "value": "v3.5", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "v2.0", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "2.1" + } + } + } + } + ] + } + ] + } + }, + { + "id": "/providers/Microsoft.Web/webAppStacks/node", + "name": "node", + "type": "Microsoft.Web/webAppStacks", + "properties": { + "displayText": "Node", + "value": "node", + "preferredOs": "Linux", + "majorVersions": [ + { + "displayText": "Node LTS", + "value": "lts", + "minorVersions": [ + { + "displayText": "Node LTS", + "value": "lts", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|lts", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + } + } + } + } + ] + }, + { + "displayText": "Node 14", + "value": "14", + "minorVersions": [ + { + "displayText": "Node 14 LTS", + "value": "14-lts", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|14-lts", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "14.x" + }, + "isPreview": true, + "endOfLifeDate": "2023-05-30T00:00:00+00:00" + } + } + } + ] + }, + { + "displayText": "Node 12", + "value": "12", + "minorVersions": [ + { + "displayText": "Node 12 LTS", + "value": "12-lts", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|12-lts", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "12.x" + }, + "endOfLifeDate": "2022-05-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "12.13.0", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2022-05-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 12.9", + "value": "12.9", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|12.9", + "isDeprecated": true, + "remoteDebuggingSupported": true, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "12.x" + }, + "endOfLifeDate": "2022-05-01T00:00:00+00:00" + } + } + } + ] + }, + { + "displayText": "Node 10", + "value": "10", + "minorVersions": [ + { + "displayText": "Node 10 LTS", + "value": "10-LTS", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|10-lts", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "10.x" + }, + "endOfLifeDate": "2021-05-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 10.16", + "value": "10.16", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|10.16", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "10.x" + }, + "endOfLifeDate": "2021-05-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 10.15", + "value": "10.15", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "10.15.2", + "isPreview": true, + "isHidden": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "10.x" + }, + "endOfLifeDate": "2021-05-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 10.14", + "value": "10.14", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|10.14", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "10.x" + }, + "endOfLifeDate": "2021-05-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "10.14.1", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "10.x" + }, + "endOfLifeDate": "2021-05-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 10.12", + "value": "10.12", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|10.12", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "10.x" + }, + "endOfLifeDate": "2021-05-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 10.10", + "value": "10.10", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|10.10", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "10.x" + }, + "endOfLifeDate": "2021-05-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "10.0.0", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "10.x" + }, + "endOfLifeDate": "2021-05-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 10.6", + "value": "10.6", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|10.6", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "10.x" + }, + "endOfLifeDate": "2021-05-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "10.6.0", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2021-05-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 10.1", + "value": "10.1", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|10.1", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "10.x" + }, + "endOfLifeDate": "2021-05-01T00:00:00+00:00" + } + } + } + ] + }, + { + "displayText": "Node 9", + "value": "9", + "minorVersions": [ + { + "displayText": "Node 9.4", + "value": "9.4", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|9.4", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2019-07-30T00:00:00+00:00" + } + } + } + ] + }, + { + "displayText": "Node 8", + "value": "8", + "minorVersions": [ + { + "displayText": "Node 8 LTS", + "value": "8-lts", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|8-lts", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 8.12", + "value": "8.12", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|8.12", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 8.11", + "value": "8.11", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|8.11", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "8.11", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 8.10", + "value": "8.10", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "8.10", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 8.9", + "value": "8.9", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|8.9", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "8.9", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 8.8", + "value": "8.8", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|8.8", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 8.5", + "value": "8.5", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "8.5", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 8.4", + "value": "8.4", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "8.4", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 8.2", + "value": "8.2", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|8.2", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 8.1", + "value": "8.1", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|8.1", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "8.1.4", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 8.0", + "value": "8.0", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|8.0", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + } + } + } + ] + }, + { + "displayText": "Node 7", + "value": "7", + "minorVersions": [ + { + "displayText": "Node 7.10", + "value": "7.10", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "7.10.1", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2017-07-30T00:00:00+00:00" + } + } + } + ] + }, + { + "displayText": "Node 6", + "value": "6", + "minorVersions": [ + { + "displayText": "Node 6 LTS", + "value": "6-LTS", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|6-lts", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2019-05-30T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 6.12", + "value": "6.12", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "6.12", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2019-05-30T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 6.11", + "value": "6.11", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|6.11", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2019-05-30T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 6.10", + "value": "6.10", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|6.10", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2019-05-30T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 6.9", + "value": "6.9", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|6.9", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2019-05-30T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "6.9.5", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2019-05-30T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 6.6", + "value": "6.6", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|6.6", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2019-05-30T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 6.5", + "value": "6.5", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "6.5.0", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2019-05-30T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 6.2", + "value": "6.2", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|6.2", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2019-05-30T00:00:00+00:00" + } + } + } + ] + }, + { + "displayText": "Node 4", + "value": "4", + "minorVersions": [ + { + "displayText": "Node 4.8", + "value": "4.8", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|4.8", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2018-05-30T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "4.8", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2018-05-30T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 4.5", + "value": "4.5", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|4.5", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2018-05-30T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 4.4", + "value": "4.4", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|4.4", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2018-05-30T00:00:00+00:00" + } + } + } + ] + } + ] + } + }, + { + "id": "/providers/Microsoft.Web/webAppStacks/python", + "name": "python", + "type": "Microsoft.Web/webAppStacks", + "properties": { + "displayText": "Python", + "value": "python", + "preferredOs": "Linux", + "majorVersions": [ + { + "displayText": "Python 3", + "value": "3", + "minorVersions": [ + { + "displayText": "Python 3.8", + "value": "3.8", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "PYTHON|3.8", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.8" + } + } + } + }, + { + "displayText": "Python 3.7", + "value": "3.7", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "PYTHON|3.7", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.7" + } + } + } + }, + { + "displayText": "Python 3.6", + "value": "3.6", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "PYTHON|3.6", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.6" + } + }, + "windowsRuntimeSettings": { + "runtimeVersion": "3.4.0", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.6" + } + } + } + } + ] + }, + { + "displayText": "Python 2", + "value": "2", + "minorVersions": [ + { + "displayText": "Python 2.7", + "value": "2.7", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "PYTHON|2.7", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "2.7" + }, + "endOfLifeDate": "2020-02-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "2.7.3", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "2.7" + }, + "endOfLifeDate": "2020-02-01T00:00:00+00:00" + } + } + } + ] + } + ] + } + }, + { + "id": "/providers/Microsoft.Web/webAppStacks/php", + "name": "php", + "type": "Microsoft.Web/webAppStacks", + "properties": { + "displayText": "PHP", + "value": "php", + "preferredOs": "Linux", + "majorVersions": [ + { + "displayText": "PHP 7", + "value": "7", + "minorVersions": [ + { + "displayText": "PHP 7.4", + "value": "7.4", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "7.4", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2022-12-28T00:00:00+00:00" + }, + "linuxRuntimeSettings": { + "runtimeVersion": "PHP|7.4", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2022-12-28T00:00:00+00:00" + } + } + }, + { + "displayText": "PHP 7.3", + "value": "7.3", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "PHP|7.3", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2022-01-06T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "7.3", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2022-01-06T00:00:00+00:00" + } + } + }, + { + "displayText": "PHP 7.2", + "value": "7.2", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "PHP|7.2", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2020-12-30T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "7.2", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2020-12-30T00:00:00+00:00" + } + } + }, + { + "displayText": "PHP 7.1", + "value": "7.1", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "7.1", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2020-03-01T00:00:00+00:00" + } + } + }, + { + "displayText": "7.0", + "value": "7.0", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "PHP|7.0", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2020-03-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "7.0", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2020-03-01T00:00:00+00:00" + } + } + } + ] + }, + { + "displayText": "PHP 5", + "value": "5", + "minorVersions": [ + { + "displayText": "PHP 5.6", + "value": "5.6", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "PHP|5.6", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2024-04-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "5.6", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2024-04-01T00:00:00+00:00" + } + } + } + ] + } + ] + } + }, + { + "id": "/providers/Microsoft.Web/webAppStacks/ruby", + "name": "ruby", + "type": "Microsoft.Web/webAppStacks", + "properties": { + "displayText": "Ruby", + "value": "ruby", + "preferredOs": "Linux", + "majorVersions": [ + { + "displayText": "Ruby 2", + "value": "2", + "minorVersions": [ + { + "displayText": "Ruby 2.6", + "value": "2.6", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "RUBY|2.6", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + } + } + } + }, + { + "displayText": "Ruby 2.6.2", + "value": "2.6.2", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "RUBY|2.6.2", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + } + } + } + }, + { + "displayText": "Ruby 2.5", + "value": "2.5", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "RUBY|2.5", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + } + } + } + }, + { + "displayText": "Ruby 2.5.5", + "value": "2.5.5", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "RUBY|2.5.5", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + } + } + } + }, + { + "displayText": "Ruby 2.4", + "value": "2.4", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "RUBY|2.4", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2020-05-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Ruby 2.4.5", + "value": "2.4.5", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "RUBY|2.4.5", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2020-05-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Ruby 2.3", + "value": "2.3", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "RUBY|2.3", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2019-05-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Ruby 2.3.8", + "value": "2.3.8", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "RUBY|2.3.8", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2019-05-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Ruby 2.3.3", + "value": "2.3.3", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "RUBY|2.3.3", + "remoteDebuggingSupported": false, + "isDeprecated": true, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2019-05-01T00:00:00+00:00" + } + } + } + ] + } + ] + } + }, + { + "id": "/providers/Microsoft.Web/webAppStacks/java", + "name": "java", + "type": "Microsoft.Web/webAppStacks", + "properties": { + "displayText": "Java", + "value": "java", + "preferredOs": "Linux", + "majorVersions": [ + { + "displayText": "Java 11", + "value": "11", + "minorVersions": [ + { + "displayText": "Java 11", + "value": "11.0", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "", + "isAutoUpdate": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "11" + }, + "endOfLifeDate": "2026-10-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "11", + "isAutoUpdate": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "11" + }, + "endOfLifeDate": "2026-10-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 11.0.7", + "value": "11.0.7", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "11" + }, + "endOfLifeDate": "2026-10-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "11.0.7", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "11" + }, + "endOfLifeDate": "2026-10-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 11.0.6", + "value": "11.0.6", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "11" + }, + "endOfLifeDate": "2026-10-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "11.0.6", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "11" + }, + "endOfLifeDate": "2026-10-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 11.0.5", + "value": "11.0.5", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "11" + }, + "endOfLifeDate": "2026-10-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "11.0.5_ZULU", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "11" + }, + "endOfLifeDate": "2026-10-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 11.0.3", + "value": "11.0.3", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "11.0.3_ZULU", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "11" + }, + "endOfLifeDate": "2026-10-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 11.0.2", + "value": "11.0.2", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "11.0.2_ZULU", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "11" + }, + "endOfLifeDate": "2026-10-01T00:00:00+00:00" + } + } + } + ] + }, + { + "displayText": "Java 8", + "value": "8", + "minorVersions": [ + { + "displayText": "Java 8", + "value": "8.0", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "", + "isAutoUpdate": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "1.8", + "isAutoUpdate": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.8.0_252", + "value": "8.0.252", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_252", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.8.0_242", + "value": "8.0.242", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_242", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.8.0_232", + "value": "8.0.232", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_232_ZULU", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.8.0_212", + "value": "8.0.212", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_212_ZULU", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.8.0_202", + "value": "8.0.202", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_202_ZULU", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.8.0_202 (Oracle)", + "value": "8.0.202 (Oracle)", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_202", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + } + } + } + }, + { + "displayText": "Java 1.8.0_181", + "value": "8.0.181", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_181_ZULU", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.8.0_181 (Oracle)", + "value": "8.0.181 (Oracle)", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_181", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + } + } + } + }, + { + "displayText": "Java 1.8.0_172", + "value": "8.0.172", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_172_ZULU", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.8.0_172 (Oracle)", + "value": "8.0.172 (Oracle)", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_172", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + } + } + } + }, + { + "displayText": "Java 1.8.0_144", + "value": "8.0.144", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_144", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.8.0_111 (Oracle)", + "value": "8.0.111 (Oracle)", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_111", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + } + } + } + }, + { + "displayText": "Java 1.8.0_102", + "value": "8.0.102", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_102", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.8.0_92", + "value": "8.0.92", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_92", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.8.0_73 (Oracle)", + "value": "8.0.73 (Oracle)", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_73", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + } + } + } + }, + { + "displayText": "Java 1.8.0_60 (Oracle)", + "value": "8.0.60 (Oracle)", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_60", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + } + } + } + }, + { + "displayText": "Java 1.8.0_25 (Oracle)", + "value": "8.0.25 (Oracle)", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_25", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + } + } + } + } + ] + }, + { + "displayText": "Java 7", + "value": "7", + "minorVersions": [ + { + "displayText": "Java 7", + "value": "7.0", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.7", + "isAutoUpdate": true, + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2023-08-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.7.0_262", + "value": "7.0.262", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.7.0_262_ZULU", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2023-08-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.7.0_242", + "value": "7.0.242", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.7.0_242_ZULU", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2023-08-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.7.0_222", + "value": "7.0.222", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.7.0_222_ZULU", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2023-08-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.7.0_191", + "value": "7.0.191", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.7.0_191_ZULU", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2023-08-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.7.0_80 (Oracle)", + "value": "7.0.80 (Oracle)", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.7.0_80", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + } + } + } + }, + { + "displayText": "Java 1.7.0_71 (Oracle)", + "value": "7.0.71 (Oracle)", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.7.0_71", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + } + } + } + }, + { + "displayText": "Java 1.7.0_51 (Oracle)", + "value": "7.0.51 (Oracle)", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.7.0_51", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + } + } + } + } + ] + } + ] + } + }, + { + "id": "/providers/Microsoft.Web/webAppStacks/javacontainers", + "name": "javacontainers", + "type": "Microsoft.Web/webAppStacks", + "properties": { + "displayText": "Java Containers", + "value": "javacontainers", + "majorVersions": [ + { + "displayText": "Java SE (Embedded Web Server)", + "value": "javase", + "minorVersions": [ + { + "displayText": "Java SE (Embedded Web Server)", + "value": "SE", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "JAVA", + "javaContainerVersion": "SE", + "isAutoUpdate": true + }, + "linuxContainerSettings": { + "java11Runtime": "JAVA|11-java11", + "java8Runtime": "JAVA|8-jre8", + "isAutoUpdate": true + } + } + }, + { + "displayText": "Java SE 11.0.7", + "value": "11.0.7", + "stackSettings": { + "linuxContainerSettings": { + "java11Runtime": "JAVA|11.0.7" + } + } + }, + { + "displayText": "Java SE 11.0.6", + "value": "11.0.6", + "stackSettings": { + "linuxContainerSettings": { + "java11Runtime": "JAVA|11.0.6" + } + } + }, + { + "displayText": "Java SE 11.0.5", + "value": "11.0.5", + "stackSettings": { + "linuxContainerSettings": { + "java11Runtime": "JAVA|11.0.5" + } + } + }, + { + "displayText": "Java SE 8u252", + "value": "1.8.252", + "stackSettings": { + "linuxContainerSettings": { + "java8Runtime": "JAVA|8u252" + } + } + }, + { + "displayText": "Java SE 8u242", + "value": "1.8.242", + "stackSettings": { + "linuxContainerSettings": { + "java8Runtime": "JAVA|8u242" + } + } + }, + { + "displayText": "Java SE 8u232", + "value": "1.8.232", + "stackSettings": { + "linuxContainerSettings": { + "java8Runtime": "JAVA|8u232" + } + } + } + ] + }, + { + "displayText": "JBoss EAP", + "value": "jbosseap", + "minorVersions": [ + { + "displayText": "JBoss EAP 7.2", + "value": "7.2", + "stackSettings": { + "linuxContainerSettings": { + "java8Runtime": "JBOSSEAP|7.2-java8", + "isPreview": true + } + } + } + ] + }, + { + "displayText": "Tomcat 9.0", + "value": "tomcat9.0", + "minorVersions": [ + { + "displayText": "Tomcat 9.0", + "value": "9.0", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "9.0", + "isAutoUpdate": true + }, + "linuxContainerSettings": { + "java11Runtime": "TOMCAT|9.0-java11", + "java8Runtime": "TOMCAT|9.0-jre8", + "isAutoUpdate": true + } + } + }, + { + "displayText": "Tomcat 9.0.37", + "value": "9.0.37", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "9.0.37" + }, + "linuxContainerSettings": { + "java11Runtime": "TOMCAT|9.0.37-java11", + "java8Runtime": "TOMCAT|9.0.37-java8" + } + } + }, + { + "displayText": "Tomcat 9.0.33", + "value": "9.0.33", + "stackSettings": { + "linuxContainerSettings": { + "java11Runtime": "TOMCAT|9.0.33-java11", + "java8Runtime": "TOMCAT|9.0.33-java8" + } + } + }, + { + "displayText": "Tomcat 9.0.31", + "value": "9.0.31", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "9.0.31" + } + } + }, + { + "displayText": "Tomcat 9.0.27", + "value": "9.0.27", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "9.0.27" + } + } + }, + { + "displayText": "Tomcat 9.0.21", + "value": "9.0.21", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "9.0.21" + } + } + }, + { + "displayText": "Tomcat 9.0.20", + "value": "9.0.20", + "stackSettings": { + "linuxContainerSettings": { + "java11Runtime": "TOMCAT|9.0.20-java11", + "java8Runtime": "TOMCAT|9.0.20-java8" + } + } + }, + { + "displayText": "Tomcat 9.0.14", + "value": "9.0.14", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "9.0.14" + } + } + }, + { + "displayText": "Tomcat 9.0.12", + "value": "9.0.12", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "9.0.12" + } + } + }, + { + "displayText": "Tomcat 9.0.8", + "value": "9.0.8", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "9.0.8" + } + } + }, + { + "displayText": "Tomcat 9.0.0", + "value": "9.0.0", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "9.0.0" + } + } + } + ] + }, + { + "displayText": "Tomcat 8.5", + "value": "tomcat8.5", + "minorVersions": [ + { + "displayText": "Tomcat 8.5", + "value": "8.5", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.5", + "isAutoUpdate": true + }, + "linuxContainerSettings": { + "java11Runtime": "TOMCAT|8.5-java11", + "java8Runtime": "TOMCAT|8.5-jre8", + "isAutoUpdate": true + } + } + }, + { + "displayText": "Tomcat 8.5.6", + "value": "8.5.6", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.5.6" + } + } + }, + { + "displayText": "Tomcat 8.5.57", + "value": "8.5.57", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.5.57" + }, + "linuxContainerSettings": { + "java11Runtime": "TOMCAT|8.5.57-java11", + "java8Runtime": "TOMCAT|8.5.57-java8" + } + } + }, + { + "displayText": "Tomcat 8.5.53", + "value": "8.5.53", + "stackSettings": { + "linuxContainerSettings": { + "java11Runtime": "TOMCAT|8.5.53-java11", + "java8Runtime": "TOMCAT|8.5.53-java8" + } + } + }, + { + "displayText": "Tomcat 8.5.51", + "value": "8.5.51", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.5.51" + } + } + }, + { + "displayText": "Tomcat 8.5.47", + "value": "8.5.47", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.5.47" + } + } + }, + { + "displayText": "Tomcat 8.5.42", + "value": "8.5.42", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.5.42" + } + } + }, + { + "displayText": "Tomcat 8.5.41", + "value": "8.5.41", + "stackSettings": { + "linuxContainerSettings": { + "java11Runtime": "TOMCAT|8.5.41-java11", + "java8Runtime": "TOMCAT|8.5.41-java8" + } + } + }, + { + "displayText": "Tomcat 8.5.37", + "value": "8.5.37", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.5.37" + } + } + }, + { + "displayText": "Tomcat 8.5.34", + "value": "8.5.34", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.5.34" + } + } + }, + { + "displayText": "Tomcat 8.5.31", + "value": "8.5.31", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.5.31" + } + } + }, + { + "displayText": "Tomcat 8.5.20", + "value": "8.5.20", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.5.20" + } + } + } + ] + }, + { + "displayText": "Tomcat 8.0", + "value": "tomcat8.0", + "minorVersions": [ + { + "displayText": "Tomcat 8.0", + "value": "8.0", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.0", + "isAutoUpdate": true + } + } + }, + { + "displayText": "Tomcat 8.0.53", + "value": "8.0.53", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.0.53" + } + } + }, + { + "displayText": "Tomcat 8.0.46", + "value": "8.0.46", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.0.46" + } + } + }, + { + "displayText": "Tomcat 8.0.23", + "value": "8.0.23", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.0.23" + } + } + } + ] + }, + { + "displayText": "Tomcat 7.0", + "value": "tomcat7.0", + "minorVersions": [ + { + "displayText": "Tomcat 7.0", + "value": "7.0", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "7.0", + "isAutoUpdate": true + } + } + }, + { + "displayText": "Tomcat 7.0.94", + "value": "7.0.94", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "7.0.94" + } + } + }, + { + "displayText": "Tomcat 7.0.81", + "value": "7.0.81", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "7.0.81" + } + } + }, + { + "displayText": "Tomcat 7.0.62", + "value": "7.0.62", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "7.0.62" + } + } + }, + { + "displayText": "Tomcat 7.0.50", + "value": "7.0.50", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "7.0.50" + } + } + } + ] + }, + { + "displayText": "Jetty 9.3", + "value": "jetty9.3", + "minorVersions": [ + { + "displayText": "Jetty 9.3", + "value": "9.3", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "JETTY", + "javaContainerVersion": "9.3", + "isAutoUpdate": true, + "isDeprecated": true + } + } + }, + { + "displayText": "Jetty 9.3.25", + "value": "9.3.25", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "JETTY", + "javaContainerVersion": "9.3.25", + "isDeprecated": true + } + } + }, + { + "displayText": "Jetty 9.3.13", + "value": "9.3.13", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "JETTY", + "javaContainerVersion": "9.3.13", + "isDeprecated": true + } + } + } + ] + }, + { + "displayText": "Jetty 9.1", + "value": "jetty9.1", + "minorVersions": [ + { + "displayText": "Jetty 9.1", + "value": "9.1", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "JETTY", + "javaContainerVersion": "9.1", + "isAutoUpdate": true, + "isDeprecated": true + } + } + }, + { + "displayText": "Jetty 9.1.0", + "value": "9.1.0", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "JETTY", + "javaContainerVersion": "9.1.0", + "isDeprecated": true + } + } + } + ] + }, + { + "displayText": "WildFly 14", + "value": "wildfly14", + "minorVersions": [ + { + "displayText": "WildFly 14", + "value": "14", + "stackSettings": { + "linuxContainerSettings": { + "java8Runtime": "WILDFLY|14-jre8", + "isDeprecated": true, + "isAutoUpdate": true + } + } + }, + { + "displayText": "WildFly 14.0.1", + "value": "14.0.1", + "stackSettings": { + "linuxContainerSettings": { + "isDeprecated": true, + "java8Runtime": "WILDFLY|14.0.1-java8" + } + } + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebAppStacksForLocation.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebAppStacksForLocation.json new file mode 100644 index 000000000000..eb1ef7a389e8 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebAppStacksForLocation.json @@ -0,0 +1,2923 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/providers/Microsoft.Web/locations/webAppStacks/dotnet", + "name": "dotnet", + "type": "Microsoft.Web/locations/webAppStacks", + "location": "westus", + "properties": { + "displayText": ".NET", + "value": "dotnet", + "preferredOs": "Windows", + "majorVersions": [ + { + "displayText": ".NET 5", + "value": "5", + "minorVersions": [ + { + "displayText": ".NET 5", + "value": "5", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "v5.0", + "isEarlyAccess": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "5.0.x" + } + }, + "linuxRuntimeSettings": { + "runtimeVersion": "DOTNETCORE|5.0", + "isEarlyAccess": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "5.0.x" + } + } + } + } + ] + }, + { + "displayText": ".NET Core 3", + "value": "3", + "minorVersions": [ + { + "displayText": ".NET Core 3.1 (LTS)", + "value": "3.1", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "3.1", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.1.301" + } + }, + "linuxRuntimeSettings": { + "runtimeVersion": "DOTNETCORE|3.1", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.1.301" + } + } + } + }, + { + "displayText": ".NET Core 3.0", + "value": "3.0", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "3.0", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.0.103" + }, + "endOfLifeDate": "2020-04-03T00:00:00+00:00" + }, + "linuxRuntimeSettings": { + "runtimeVersion": "DOTNETCORE|3.0", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.0.103" + }, + "endOfLifeDate": "2020-04-03T00:00:00+00:00" + } + } + } + ] + }, + { + "displayText": ".NET Core 2", + "value": "dotnetcore2", + "minorVersions": [ + { + "displayText": ".NET Core 2.2", + "value": "2.2", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "2.2", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "2.2.207" + }, + "endOfLifeDate": "2020-01-23T00:00:00+00:00" + }, + "linuxRuntimeSettings": { + "runtimeVersion": "DOTNETCORE|2.2", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "2.2.207" + }, + "endOfLifeDate": "2020-01-23T00:00:00+00:00" + } + } + }, + { + "displayText": ".NET Core 2.1 (LTS)", + "value": "2.1", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "2.1", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "2.1.807" + }, + "endOfLifeDate": "2021-09-21T00:00:00+00:00" + }, + "linuxRuntimeSettings": { + "runtimeVersion": "DOTNETCORE|2.1", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "2.1.807" + }, + "endOfLifeDate": "2021-09-21T00:00:00+00:00" + } + } + }, + { + "displayText": ".NET Core 2.0", + "value": "2.0", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "2.0", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "2.1.202" + }, + "endOfLifeDate": "2018-11-01T00:00:00+00:00" + }, + "linuxRuntimeSettings": { + "runtimeVersion": "DOTNETCORE|2.0", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "2.1.202" + }, + "endOfLifeDate": "2018-11-01T00:00:00+00:00" + } + } + } + ] + }, + { + "displayText": ".NET Core 1", + "value": "1", + "minorVersions": [ + { + "displayText": ".NET Core 1.1", + "value": "1.1", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.1", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "1.1.14" + }, + "endOfLifeDate": "2019-07-27T00:00:00+00:00" + }, + "linuxRuntimeSettings": { + "runtimeVersion": "DOTNETCORE|1.1", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "1.1.14" + }, + "endOfLifeDate": "2019-07-27T00:00:00+00:00" + } + } + }, + { + "displayText": ".NET Core 1.0", + "value": "1.0", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.0", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "1.1.14" + }, + "endOfLifeDate": "2019-07-27T00:00:00+00:00" + }, + "linuxRuntimeSettings": { + "runtimeVersion": "DOTNETCORE|1.0", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "1.1.14" + }, + "endOfLifeDate": "2019-07-27T00:00:00+00:00" + } + } + } + ] + }, + { + "displayText": "ASP.NET V4", + "value": "v4", + "minorVersions": [ + { + "displayText": "ASP.NET V4.8", + "value": "v4.8", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "v4.0", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.1" + } + } + } + } + ] + }, + { + "displayText": "ASP.NET V3", + "value": "v3", + "minorVersions": [ + { + "displayText": "ASP.NET V3.5", + "value": "v3.5", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "v2.0", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "2.1" + } + } + } + } + ] + } + ] + } + }, + { + "id": "/providers/Microsoft.Web/locations/webAppStacks/node", + "name": "node", + "type": "Microsoft.Web/locations/webAppStacks", + "location": "westus", + "properties": { + "displayText": "Node", + "value": "node", + "preferredOs": "Linux", + "majorVersions": [ + { + "displayText": "Node LTS", + "value": "lts", + "minorVersions": [ + { + "displayText": "Node LTS", + "value": "lts", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|lts", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + } + } + } + } + ] + }, + { + "displayText": "Node 14", + "value": "14", + "minorVersions": [ + { + "displayText": "Node 14 LTS", + "value": "14-lts", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|14-lts", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "14.x" + }, + "isPreview": true, + "endOfLifeDate": "2023-05-30T00:00:00+00:00" + } + } + } + ] + }, + { + "displayText": "Node 12", + "value": "12", + "minorVersions": [ + { + "displayText": "Node 12 LTS", + "value": "12-lts", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|12-lts", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "12.x" + }, + "endOfLifeDate": "2022-05-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "12.13.0", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2022-05-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 12.9", + "value": "12.9", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|12.9", + "isDeprecated": true, + "remoteDebuggingSupported": true, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "12.x" + }, + "endOfLifeDate": "2022-05-01T00:00:00+00:00" + } + } + } + ] + }, + { + "displayText": "Node 10", + "value": "10", + "minorVersions": [ + { + "displayText": "Node 10 LTS", + "value": "10-LTS", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|10-lts", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "10.x" + }, + "endOfLifeDate": "2021-05-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 10.16", + "value": "10.16", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|10.16", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "10.x" + }, + "endOfLifeDate": "2021-05-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 10.15", + "value": "10.15", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "10.15.2", + "isPreview": true, + "isHidden": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "10.x" + }, + "endOfLifeDate": "2021-05-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 10.14", + "value": "10.14", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|10.14", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "10.x" + }, + "endOfLifeDate": "2021-05-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "10.14.1", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "10.x" + }, + "endOfLifeDate": "2021-05-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 10.12", + "value": "10.12", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|10.12", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "10.x" + }, + "endOfLifeDate": "2021-05-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 10.10", + "value": "10.10", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|10.10", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "10.x" + }, + "endOfLifeDate": "2021-05-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "10.0.0", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "10.x" + }, + "endOfLifeDate": "2021-05-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 10.6", + "value": "10.6", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|10.6", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "10.x" + }, + "endOfLifeDate": "2021-05-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "10.6.0", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2021-05-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 10.1", + "value": "10.1", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|10.1", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "10.x" + }, + "endOfLifeDate": "2021-05-01T00:00:00+00:00" + } + } + } + ] + }, + { + "displayText": "Node 9", + "value": "9", + "minorVersions": [ + { + "displayText": "Node 9.4", + "value": "9.4", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|9.4", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2019-07-30T00:00:00+00:00" + } + } + } + ] + }, + { + "displayText": "Node 8", + "value": "8", + "minorVersions": [ + { + "displayText": "Node 8 LTS", + "value": "8-lts", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|8-lts", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 8.12", + "value": "8.12", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|8.12", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 8.11", + "value": "8.11", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|8.11", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "8.11", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 8.10", + "value": "8.10", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "8.10", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 8.9", + "value": "8.9", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|8.9", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "8.9", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 8.8", + "value": "8.8", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|8.8", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 8.5", + "value": "8.5", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "8.5", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 8.4", + "value": "8.4", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "8.4", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 8.2", + "value": "8.2", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|8.2", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 8.1", + "value": "8.1", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|8.1", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "8.1.4", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 8.0", + "value": "8.0", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|8.0", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2020-01-31T00:00:00+00:00" + } + } + } + ] + }, + { + "displayText": "Node 7", + "value": "7", + "minorVersions": [ + { + "displayText": "Node 7.10", + "value": "7.10", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "7.10.1", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2017-07-30T00:00:00+00:00" + } + } + } + ] + }, + { + "displayText": "Node 6", + "value": "6", + "minorVersions": [ + { + "displayText": "Node 6 LTS", + "value": "6-LTS", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|6-lts", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2019-05-30T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 6.12", + "value": "6.12", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "6.12", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2019-05-30T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 6.11", + "value": "6.11", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|6.11", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2019-05-30T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 6.10", + "value": "6.10", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|6.10", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2019-05-30T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 6.9", + "value": "6.9", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|6.9", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2019-05-30T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "6.9.5", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2019-05-30T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 6.6", + "value": "6.6", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|6.6", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2019-05-30T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 6.5", + "value": "6.5", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "6.5.0", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2019-05-30T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 6.2", + "value": "6.2", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|6.2", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2019-05-30T00:00:00+00:00" + } + } + } + ] + }, + { + "displayText": "Node 4", + "value": "4", + "minorVersions": [ + { + "displayText": "Node 4.8", + "value": "4.8", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|4.8", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2018-05-30T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "4.8", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2018-05-30T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 4.5", + "value": "4.5", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|4.5", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2018-05-30T00:00:00+00:00" + } + } + }, + { + "displayText": "Node 4.4", + "value": "4.4", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "NODE|4.4", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true + }, + "endOfLifeDate": "2018-05-30T00:00:00+00:00" + } + } + } + ] + } + ] + } + }, + { + "id": "/providers/Microsoft.Web/locations/webAppStacks/python", + "name": "python", + "type": "Microsoft.Web/locations/webAppStacks", + "location": "westus", + "properties": { + "displayText": "Python", + "value": "python", + "preferredOs": "Linux", + "majorVersions": [ + { + "displayText": "Python 3", + "value": "3", + "minorVersions": [ + { + "displayText": "Python 3.8", + "value": "3.8", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "PYTHON|3.8", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.8" + } + } + } + }, + { + "displayText": "Python 3.7", + "value": "3.7", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "PYTHON|3.7", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.7" + } + } + } + }, + { + "displayText": "Python 3.6", + "value": "3.6", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "PYTHON|3.6", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.6" + } + }, + "windowsRuntimeSettings": { + "runtimeVersion": "3.4.0", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": true + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "3.6" + } + } + } + } + ] + }, + { + "displayText": "Python 2", + "value": "2", + "minorVersions": [ + { + "displayText": "Python 2.7", + "value": "2.7", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "PYTHON|2.7", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "2.7" + }, + "endOfLifeDate": "2020-02-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "2.7.3", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "2.7" + }, + "endOfLifeDate": "2020-02-01T00:00:00+00:00" + } + } + } + ] + } + ] + } + }, + { + "id": "/providers/Microsoft.Web/locations/webAppStacks/php", + "name": "php", + "type": "Microsoft.Web/locations/webAppStacks", + "location": "westus", + "properties": { + "displayText": "PHP", + "value": "php", + "preferredOs": "Linux", + "majorVersions": [ + { + "displayText": "PHP 7", + "value": "7", + "minorVersions": [ + { + "displayText": "PHP 7.4", + "value": "7.4", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "7.4", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2022-12-28T00:00:00+00:00" + }, + "linuxRuntimeSettings": { + "runtimeVersion": "PHP|7.4", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2022-12-28T00:00:00+00:00" + } + } + }, + { + "displayText": "PHP 7.3", + "value": "7.3", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "PHP|7.3", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2022-01-06T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "7.3", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2022-01-06T00:00:00+00:00" + } + } + }, + { + "displayText": "PHP 7.2", + "value": "7.2", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "PHP|7.2", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2020-12-30T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "7.2", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2020-12-30T00:00:00+00:00" + } + } + }, + { + "displayText": "PHP 7.1", + "value": "7.1", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "7.1", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2020-03-01T00:00:00+00:00" + } + } + }, + { + "displayText": "7.0", + "value": "7.0", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "PHP|7.0", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2020-03-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "7.0", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2020-03-01T00:00:00+00:00" + } + } + } + ] + }, + { + "displayText": "PHP 5", + "value": "5", + "minorVersions": [ + { + "displayText": "PHP 5.6", + "value": "5.6", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "PHP|5.6", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2024-04-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "5.6", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2024-04-01T00:00:00+00:00" + } + } + } + ] + } + ] + } + }, + { + "id": "/providers/Microsoft.Web/locations/webAppStacks/ruby", + "name": "ruby", + "type": "Microsoft.Web/locations/webAppStacks", + "location": "westus", + "properties": { + "displayText": "Ruby", + "value": "ruby", + "preferredOs": "Linux", + "majorVersions": [ + { + "displayText": "Ruby 2", + "value": "2", + "minorVersions": [ + { + "displayText": "Ruby 2.6", + "value": "2.6", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "RUBY|2.6", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + } + } + } + }, + { + "displayText": "Ruby 2.6.2", + "value": "2.6.2", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "RUBY|2.6.2", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + } + } + } + }, + { + "displayText": "Ruby 2.5", + "value": "2.5", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "RUBY|2.5", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + } + } + } + }, + { + "displayText": "Ruby 2.5.5", + "value": "2.5.5", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "RUBY|2.5.5", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + } + } + } + }, + { + "displayText": "Ruby 2.4", + "value": "2.4", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "RUBY|2.4", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2020-05-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Ruby 2.4.5", + "value": "2.4.5", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "RUBY|2.4.5", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2020-05-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Ruby 2.3", + "value": "2.3", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "RUBY|2.3", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2019-05-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Ruby 2.3.8", + "value": "2.3.8", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "RUBY|2.3.8", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2019-05-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Ruby 2.3.3", + "value": "2.3.3", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "RUBY|2.3.3", + "remoteDebuggingSupported": false, + "isDeprecated": true, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2019-05-01T00:00:00+00:00" + } + } + } + ] + } + ] + } + }, + { + "id": "/providers/Microsoft.Web/locations/webAppStacks/java", + "name": "java", + "type": "Microsoft.Web/locations/webAppStacks", + "location": "westus", + "properties": { + "displayText": "Java", + "value": "java", + "preferredOs": "Linux", + "majorVersions": [ + { + "displayText": "Java 11", + "value": "11", + "minorVersions": [ + { + "displayText": "Java 11", + "value": "11.0", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "", + "isAutoUpdate": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "11" + }, + "endOfLifeDate": "2026-10-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "11", + "isAutoUpdate": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "11" + }, + "endOfLifeDate": "2026-10-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 11.0.7", + "value": "11.0.7", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "11" + }, + "endOfLifeDate": "2026-10-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "11.0.7", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "11" + }, + "endOfLifeDate": "2026-10-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 11.0.6", + "value": "11.0.6", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "11" + }, + "endOfLifeDate": "2026-10-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "11.0.6", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "11" + }, + "endOfLifeDate": "2026-10-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 11.0.5", + "value": "11.0.5", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "11" + }, + "endOfLifeDate": "2026-10-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "11.0.5_ZULU", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "11" + }, + "endOfLifeDate": "2026-10-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 11.0.3", + "value": "11.0.3", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "11.0.3_ZULU", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "11" + }, + "endOfLifeDate": "2026-10-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 11.0.2", + "value": "11.0.2", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "11.0.2_ZULU", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "11" + }, + "endOfLifeDate": "2026-10-01T00:00:00+00:00" + } + } + } + ] + }, + { + "displayText": "Java 8", + "value": "8", + "minorVersions": [ + { + "displayText": "Java 8", + "value": "8.0", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "", + "isAutoUpdate": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "1.8", + "isAutoUpdate": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.8.0_252", + "value": "8.0.252", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_252", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.8.0_242", + "value": "8.0.242", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_242", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.8.0_232", + "value": "8.0.232", + "stackSettings": { + "linuxRuntimeSettings": { + "runtimeVersion": "", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + }, + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_232_ZULU", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.8.0_212", + "value": "8.0.212", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_212_ZULU", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.8.0_202", + "value": "8.0.202", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_202_ZULU", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.8.0_202 (Oracle)", + "value": "8.0.202 (Oracle)", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_202", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + } + } + } + }, + { + "displayText": "Java 1.8.0_181", + "value": "8.0.181", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_181_ZULU", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.8.0_181 (Oracle)", + "value": "8.0.181 (Oracle)", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_181", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + } + } + } + }, + { + "displayText": "Java 1.8.0_172", + "value": "8.0.172", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_172_ZULU", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.8.0_172 (Oracle)", + "value": "8.0.172 (Oracle)", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_172", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + } + } + } + }, + { + "displayText": "Java 1.8.0_144", + "value": "8.0.144", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_144", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.8.0_111 (Oracle)", + "value": "8.0.111 (Oracle)", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_111", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + } + } + } + }, + { + "displayText": "Java 1.8.0_102", + "value": "8.0.102", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_102", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.8.0_92", + "value": "8.0.92", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_92", + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + }, + "endOfLifeDate": "2025-04-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.8.0_73 (Oracle)", + "value": "8.0.73 (Oracle)", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_73", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + } + } + } + }, + { + "displayText": "Java 1.8.0_60 (Oracle)", + "value": "8.0.60 (Oracle)", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_60", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + } + } + } + }, + { + "displayText": "Java 1.8.0_25 (Oracle)", + "value": "8.0.25 (Oracle)", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.8.0_25", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": true, + "supportedVersion": "8" + } + } + } + } + ] + }, + { + "displayText": "Java 7", + "value": "7", + "minorVersions": [ + { + "displayText": "Java 7", + "value": "7.0", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.7", + "isAutoUpdate": true, + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2023-08-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.7.0_262", + "value": "7.0.262", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.7.0_262_ZULU", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2023-08-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.7.0_242", + "value": "7.0.242", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.7.0_242_ZULU", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2023-08-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.7.0_222", + "value": "7.0.222", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.7.0_222_ZULU", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2023-08-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.7.0_191", + "value": "7.0.191", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.7.0_191_ZULU", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + }, + "endOfLifeDate": "2023-08-01T00:00:00+00:00" + } + } + }, + { + "displayText": "Java 1.7.0_80 (Oracle)", + "value": "7.0.80 (Oracle)", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.7.0_80", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + } + } + } + }, + { + "displayText": "Java 1.7.0_71 (Oracle)", + "value": "7.0.71 (Oracle)", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.7.0_71", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + } + } + } + }, + { + "displayText": "Java 1.7.0_51 (Oracle)", + "value": "7.0.51 (Oracle)", + "stackSettings": { + "windowsRuntimeSettings": { + "runtimeVersion": "1.7.0_51", + "isDeprecated": true, + "remoteDebuggingSupported": false, + "appInsightsSettings": { + "isSupported": false + }, + "gitHubActionSettings": { + "isSupported": false + } + } + } + } + ] + } + ] + } + }, + { + "id": "/providers/Microsoft.Web/locations/webAppStacks/javacontainers", + "name": "javacontainers", + "type": "Microsoft.Web/locations/webAppStacks", + "location": "westus", + "properties": { + "displayText": "Java Containers", + "value": "javacontainers", + "majorVersions": [ + { + "displayText": "Java SE (Embedded Web Server)", + "value": "javase", + "minorVersions": [ + { + "displayText": "Java SE (Embedded Web Server)", + "value": "SE", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "JAVA", + "javaContainerVersion": "SE", + "isAutoUpdate": true + }, + "linuxContainerSettings": { + "java11Runtime": "JAVA|11-java11", + "java8Runtime": "JAVA|8-jre8", + "isAutoUpdate": true + } + } + }, + { + "displayText": "Java SE 11.0.7", + "value": "11.0.7", + "stackSettings": { + "linuxContainerSettings": { + "java11Runtime": "JAVA|11.0.7" + } + } + }, + { + "displayText": "Java SE 11.0.6", + "value": "11.0.6", + "stackSettings": { + "linuxContainerSettings": { + "java11Runtime": "JAVA|11.0.6" + } + } + }, + { + "displayText": "Java SE 11.0.5", + "value": "11.0.5", + "stackSettings": { + "linuxContainerSettings": { + "java11Runtime": "JAVA|11.0.5" + } + } + }, + { + "displayText": "Java SE 8u252", + "value": "1.8.252", + "stackSettings": { + "linuxContainerSettings": { + "java8Runtime": "JAVA|8u252" + } + } + }, + { + "displayText": "Java SE 8u242", + "value": "1.8.242", + "stackSettings": { + "linuxContainerSettings": { + "java8Runtime": "JAVA|8u242" + } + } + }, + { + "displayText": "Java SE 8u232", + "value": "1.8.232", + "stackSettings": { + "linuxContainerSettings": { + "java8Runtime": "JAVA|8u232" + } + } + } + ] + }, + { + "displayText": "JBoss EAP", + "value": "jbosseap", + "minorVersions": [ + { + "displayText": "JBoss EAP 7.2", + "value": "7.2", + "stackSettings": { + "linuxContainerSettings": { + "java8Runtime": "JBOSSEAP|7.2-java8", + "isPreview": true + } + } + } + ] + }, + { + "displayText": "Tomcat 9.0", + "value": "tomcat9.0", + "minorVersions": [ + { + "displayText": "Tomcat 9.0", + "value": "9.0", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "9.0", + "isAutoUpdate": true + }, + "linuxContainerSettings": { + "java11Runtime": "TOMCAT|9.0-java11", + "java8Runtime": "TOMCAT|9.0-jre8", + "isAutoUpdate": true + } + } + }, + { + "displayText": "Tomcat 9.0.37", + "value": "9.0.37", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "9.0.37" + }, + "linuxContainerSettings": { + "java11Runtime": "TOMCAT|9.0.37-java11", + "java8Runtime": "TOMCAT|9.0.37-java8" + } + } + }, + { + "displayText": "Tomcat 9.0.33", + "value": "9.0.33", + "stackSettings": { + "linuxContainerSettings": { + "java11Runtime": "TOMCAT|9.0.33-java11", + "java8Runtime": "TOMCAT|9.0.33-java8" + } + } + }, + { + "displayText": "Tomcat 9.0.31", + "value": "9.0.31", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "9.0.31" + } + } + }, + { + "displayText": "Tomcat 9.0.27", + "value": "9.0.27", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "9.0.27" + } + } + }, + { + "displayText": "Tomcat 9.0.21", + "value": "9.0.21", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "9.0.21" + } + } + }, + { + "displayText": "Tomcat 9.0.20", + "value": "9.0.20", + "stackSettings": { + "linuxContainerSettings": { + "java11Runtime": "TOMCAT|9.0.20-java11", + "java8Runtime": "TOMCAT|9.0.20-java8" + } + } + }, + { + "displayText": "Tomcat 9.0.14", + "value": "9.0.14", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "9.0.14" + } + } + }, + { + "displayText": "Tomcat 9.0.12", + "value": "9.0.12", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "9.0.12" + } + } + }, + { + "displayText": "Tomcat 9.0.8", + "value": "9.0.8", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "9.0.8" + } + } + }, + { + "displayText": "Tomcat 9.0.0", + "value": "9.0.0", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "9.0.0" + } + } + } + ] + }, + { + "displayText": "Tomcat 8.5", + "value": "tomcat8.5", + "minorVersions": [ + { + "displayText": "Tomcat 8.5", + "value": "8.5", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.5", + "isAutoUpdate": true + }, + "linuxContainerSettings": { + "java11Runtime": "TOMCAT|8.5-java11", + "java8Runtime": "TOMCAT|8.5-jre8", + "isAutoUpdate": true + } + } + }, + { + "displayText": "Tomcat 8.5.6", + "value": "8.5.6", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.5.6" + } + } + }, + { + "displayText": "Tomcat 8.5.57", + "value": "8.5.57", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.5.57" + }, + "linuxContainerSettings": { + "java11Runtime": "TOMCAT|8.5.57-java11", + "java8Runtime": "TOMCAT|8.5.57-java8" + } + } + }, + { + "displayText": "Tomcat 8.5.53", + "value": "8.5.53", + "stackSettings": { + "linuxContainerSettings": { + "java11Runtime": "TOMCAT|8.5.53-java11", + "java8Runtime": "TOMCAT|8.5.53-java8" + } + } + }, + { + "displayText": "Tomcat 8.5.51", + "value": "8.5.51", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.5.51" + } + } + }, + { + "displayText": "Tomcat 8.5.47", + "value": "8.5.47", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.5.47" + } + } + }, + { + "displayText": "Tomcat 8.5.42", + "value": "8.5.42", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.5.42" + } + } + }, + { + "displayText": "Tomcat 8.5.41", + "value": "8.5.41", + "stackSettings": { + "linuxContainerSettings": { + "java11Runtime": "TOMCAT|8.5.41-java11", + "java8Runtime": "TOMCAT|8.5.41-java8" + } + } + }, + { + "displayText": "Tomcat 8.5.37", + "value": "8.5.37", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.5.37" + } + } + }, + { + "displayText": "Tomcat 8.5.34", + "value": "8.5.34", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.5.34" + } + } + }, + { + "displayText": "Tomcat 8.5.31", + "value": "8.5.31", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.5.31" + } + } + }, + { + "displayText": "Tomcat 8.5.20", + "value": "8.5.20", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.5.20" + } + } + } + ] + }, + { + "displayText": "Tomcat 8.0", + "value": "tomcat8.0", + "minorVersions": [ + { + "displayText": "Tomcat 8.0", + "value": "8.0", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.0", + "isAutoUpdate": true + } + } + }, + { + "displayText": "Tomcat 8.0.53", + "value": "8.0.53", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.0.53" + } + } + }, + { + "displayText": "Tomcat 8.0.46", + "value": "8.0.46", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.0.46" + } + } + }, + { + "displayText": "Tomcat 8.0.23", + "value": "8.0.23", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "8.0.23" + } + } + } + ] + }, + { + "displayText": "Tomcat 7.0", + "value": "tomcat7.0", + "minorVersions": [ + { + "displayText": "Tomcat 7.0", + "value": "7.0", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "7.0", + "isAutoUpdate": true + } + } + }, + { + "displayText": "Tomcat 7.0.94", + "value": "7.0.94", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "7.0.94" + } + } + }, + { + "displayText": "Tomcat 7.0.81", + "value": "7.0.81", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "7.0.81" + } + } + }, + { + "displayText": "Tomcat 7.0.62", + "value": "7.0.62", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "7.0.62" + } + } + }, + { + "displayText": "Tomcat 7.0.50", + "value": "7.0.50", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "TOMCAT", + "javaContainerVersion": "7.0.50" + } + } + } + ] + }, + { + "displayText": "Jetty 9.3", + "value": "jetty9.3", + "minorVersions": [ + { + "displayText": "Jetty 9.3", + "value": "9.3", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "JETTY", + "javaContainerVersion": "9.3", + "isAutoUpdate": true, + "isDeprecated": true + } + } + }, + { + "displayText": "Jetty 9.3.25", + "value": "9.3.25", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "JETTY", + "javaContainerVersion": "9.3.25", + "isDeprecated": true + } + } + }, + { + "displayText": "Jetty 9.3.13", + "value": "9.3.13", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "JETTY", + "javaContainerVersion": "9.3.13", + "isDeprecated": true + } + } + } + ] + }, + { + "displayText": "Jetty 9.1", + "value": "jetty9.1", + "minorVersions": [ + { + "displayText": "Jetty 9.1", + "value": "9.1", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "JETTY", + "javaContainerVersion": "9.1", + "isAutoUpdate": true, + "isDeprecated": true + } + } + }, + { + "displayText": "Jetty 9.1.0", + "value": "9.1.0", + "stackSettings": { + "windowsContainerSettings": { + "javaContainer": "JETTY", + "javaContainerVersion": "9.1.0", + "isDeprecated": true + } + } + } + ] + }, + { + "displayText": "WildFly 14", + "value": "wildfly14", + "minorVersions": [ + { + "displayText": "WildFly 14", + "value": "14", + "stackSettings": { + "linuxContainerSettings": { + "java8Runtime": "WILDFLY|14-jre8", + "isDeprecated": true, + "isAutoUpdate": true + } + } + }, + { + "displayText": "WildFly 14.0.1", + "value": "14.0.1", + "stackSettings": { + "linuxContainerSettings": { + "isDeprecated": true, + "java8Runtime": "WILDFLY|14.0.1-java8" + } + } + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebSiteNetworkTraceOperation.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebSiteNetworkTraceOperation.json new file mode 100644 index 000000000000..dff928d34dde --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebSiteNetworkTraceOperation.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "SampleApp", + "slot": "Production", + "operationId": "c291433b-53ad-4c49-8cae-0a293eae1c6d", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip", + "status": "Succeeded", + "message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip" + } + ] + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/networktraces/current/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d", + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/networktraces/current/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d" + }, + "body": [ + { + "path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip", + "status": "Succeeded", + "message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip" + } + ] + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebSiteNetworkTraces.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebSiteNetworkTraces.json new file mode 100644 index 000000000000..5913ece2cd2b --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebSiteNetworkTraces.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "SampleApp", + "slot": "Production", + "operationId": "c291433b-53ad-4c49-8cae-0a293eae1c6d", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip", + "status": "Succeeded", + "message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip" + } + ] + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWorkflow.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWorkflow.json new file mode 100644 index 000000000000..7d19ee806d15 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWorkflow.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "testsite2", + "workflowName": "stateful1", + "slot": "staging", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testsite2/workflows/stateful1", + "name": "testsite2/stateful1", + "type": "Microsoft.Web/sites/workflows", + "kind": "Stateful", + "location": "USAAnywhere", + "properties": { + "files": { + "workflow.json": { + "definition": { + "$schema": "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#", + "actions": {}, + "contentVersion": "1.0.0.0", + "outputs": {}, + "parameters": {}, + "triggers": {} + } + }, + "connections.json": { + "managedApiConnections": { + "office365": { + "api": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/brazilsouth/managedApis/office365" + }, + "connection": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/connections/office365-1" + }, + "connectionRuntimeUrl": "string", + "authentication": { + "type": "Raw", + "scheme": "Key", + "parameter": "@appsetting('office365-connectionKey')" + } + } + } + } + }, + "flowState": "Enabled", + "health": { + "state": "Healthy" + } + } + } + }, + "404": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_CreateOrUpdate.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_CreateOrUpdate.json new file mode 100644 index 000000000000..2d7ec40b9d2f --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_CreateOrUpdate.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "name": "testkubeenv", + "api-version": "2024-04-01", + "kind": "kubernetes", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "customLocation" + }, + "kubeEnvironmentEnvelope": { + "location": "East US", + "properties": { + "staticIp": "1.2.3.4" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/testkubeenv", + "name": "testkubeenv", + "type": "Microsoft.Web/kubeEnvironments", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "customLocation" + }, + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "internalLoadBalancerEnabled": false, + "defaultDomain": "testkubeenv.k4apps.io", + "staticIp": "1.2.3.4", + "arcConfiguration": null, + "appLogsConfiguration": null, + "aksResourceID": "test" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/testkubeenv", + "name": "testkubeenv", + "type": "Microsoft.Web/kubeEnvironments", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "customLocation" + }, + "tags": {}, + "properties": { + "provisioningState": "InitializationInProgress", + "deploymentErrors": null, + "internalLoadBalancerEnabled": false, + "defaultDomain": "testkubeenv.k4apps.io", + "staticIp": "1.2.3.4", + "arcConfiguration": null, + "appLogsConfiguration": null, + "aksResourceID": "test" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_Delete.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_Delete.json new file mode 100644 index 000000000000..302f6e1ac167 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "name": "examplekenv", + "api-version": "2024-04-01", + "kind": "kubernetes", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "customLocation" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/operationresults?api-version=2024-04-01" + } + }, + "204": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_Get.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_Get.json new file mode 100644 index 000000000000..a5552bf2d5cd --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "name": "jlaw-demo1", + "location": "North Central US", + "extendedLocation": { + "name": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "customLocation" + }, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.Web/kubeEnvironments", + "location": "North Central US", + "extendedLocation": { + "name": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "customLocation" + }, + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "internalLoadBalancerEnabled": false, + "defaultDomain": "jlaw-demo1.k4apps.io", + "staticIp": "20.42.33.145", + "arcConfiguration": null, + "appLogsConfiguration": null, + "aksResourceID": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ContainerService/managedClusters/jlaw-demo1" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_ListByResourceGroup.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_ListByResourceGroup.json new file mode 100644 index 000000000000..c994b8fac983 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_ListByResourceGroup.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "name": "Samplek8se", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.Web/kubeEnvironments", + "location": "North Central US", + "extendedLocation": { + "name": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "customLocation" + }, + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "internalLoadBalancerEnabled": false, + "defaultDomain": "jlaw-demo1.k4apps.io", + "staticIp": "20.42.33.145", + "arcConfiguration": null, + "appLogsConfiguration": null + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/demo1", + "name": "demo1", + "type": "Microsoft.Web/kubeEnvironments", + "location": "North Central US", + "extendedLocation": { + "name": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "customLocation" + }, + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "internalLoadBalancerEnabled": false, + "defaultDomain": "demo1.k4apps.io", + "staticIp": "52.142.21.61", + "arcConfiguration": null, + "appLogsConfiguration": null + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_ListBySubscription.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_ListBySubscription.json new file mode 100644 index 000000000000..b0afe3057855 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_ListBySubscription.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "name": "examplekenv", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.Web/kubeEnvironments", + "location": "North Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "internalLoadBalancerEnabled": false, + "defaultDomain": "jlaw-demo1.k4apps.io", + "staticIp": "20.42.33.145", + "arcConfiguration": null, + "appLogsConfiguration": null + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/DemoRG/providers/Microsoft.Web/kubeEnvironments/demo1", + "name": "demo1", + "type": "Microsoft.Web/kubeEnvironments", + "location": "North Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "internalLoadBalancerEnabled": false, + "defaultDomain": "demo1.k4apps.io", + "staticIp": "52.142.21.61", + "arcConfiguration": null, + "appLogsConfiguration": null + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_Update.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_Update.json new file mode 100644 index 000000000000..8ee265432c59 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_Update.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "name": "testkubeenv", + "api-version": "2024-04-01", + "kind": "kubernetes", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "customLocation" + }, + "kubeEnvironmentEnvelope": { + "properties": { + "staticIp": "1.2.3.4" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/testkubeenv", + "name": "testkubeenv", + "type": "Microsoft.Web/kubeEnvironments", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "customLocation" + }, + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "internalLoadBalancerEnabled": false, + "defaultDomain": "testkubeenv.k4apps.io", + "staticIp": "1.2.3.4", + "arcConfiguration": null, + "appLogsConfiguration": null, + "aksResourceID": "test" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/testkubeenv", + "name": "testkubeenv", + "type": "Microsoft.Web/kubeEnvironments", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "customLocation" + }, + "tags": {}, + "properties": { + "provisioningState": "InitializationInProgress", + "deploymentErrors": null, + "internalLoadBalancerEnabled": false, + "defaultDomain": "testkubeenv.k4apps.io", + "staticIp": "1.2.3.4", + "arcConfiguration": null, + "appLogsConfiguration": null, + "aksResourceID": "test" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/LinkBackendToStaticSite.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/LinkBackendToStaticSite.json new file mode 100644 index 000000000000..0c9de75a7e38 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/LinkBackendToStaticSite.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "linkedBackendName": "testBackend", + "api-version": "2024-04-01", + "staticSiteLinkedBackendEnvelope": { + "properties": { + "backendResourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/backendRg/providers/Microsoft.Web/sites/testBackend", + "region": "West US 2" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/linkedBackends/testBackend", + "name": "testBackend", + "type": "Microsoft.Web/staticSites/builds/linkedBackends", + "properties": { + "backendResourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/backendRg/providers/Microsoft.Web/sites/testBackend", + "region": "West US 2", + "createdOn": "2021-12-24T17:33:11.641Z", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/LinkBackendToStaticSiteBuild.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/LinkBackendToStaticSiteBuild.json new file mode 100644 index 000000000000..47cd9c331c90 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/LinkBackendToStaticSiteBuild.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "environmentName": "default", + "linkedBackendName": "testBackend", + "api-version": "2024-04-01", + "staticSiteLinkedBackendEnvelope": { + "properties": { + "backendResourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/backendRg/providers/Microsoft.Web/sites/testBackend", + "region": "West US 2" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/linkedBackends/testBackend", + "name": "testBackend", + "type": "Microsoft.Web/staticSites/builds/linkedBackends", + "properties": { + "backendResourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/backendRg/providers/Microsoft.Web/sites/testBackend", + "region": "West US 2", + "createdOn": "2021-12-24T17:33:11.641Z", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAppServicePlans.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAppServicePlans.json new file mode 100644 index 000000000000..39aa75868533 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAppServicePlans.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141", + "name": "testsf6141", + "type": "Microsoft.Web/serverfarms", + "kind": "app", + "location": "East US", + "properties": { + "status": "Ready", + "maximumNumberOfWorkers": 20, + "numberOfWorkers": 19, + "geoRegion": "East US", + "numberOfSites": 4, + "isSpot": false, + "reserved": false, + "targetWorkerCount": 0, + "targetWorkerSizeId": 0, + "provisioningState": "Succeeded" + }, + "sku": { + "name": "P1", + "tier": "Premium", + "size": "P1", + "family": "P", + "capacity": 1 + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf7252", + "name": "testsf7252", + "type": "Microsoft.Web/serverfarms", + "kind": "app", + "location": "East US", + "properties": { + "status": "Ready", + "maximumNumberOfWorkers": 20, + "numberOfWorkers": 19, + "geoRegion": "East US", + "numberOfSites": 4, + "isSpot": false, + "reserved": false, + "targetWorkerCount": 0, + "targetWorkerSizeId": 0, + "provisioningState": "Succeeded" + }, + "sku": { + "name": "P1", + "tier": "Premium", + "size": "P1", + "family": "P", + "capacity": 1 + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAppServicePlansByResourceGroup.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAppServicePlansByResourceGroup.json new file mode 100644 index 000000000000..87376eeef331 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAppServicePlansByResourceGroup.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141", + "name": "testsf6141", + "type": "Microsoft.Web/serverfarms", + "kind": "app", + "location": "East US", + "properties": { + "status": "Ready", + "maximumNumberOfWorkers": 20, + "numberOfWorkers": 19, + "geoRegion": "East US", + "numberOfSites": 4, + "isSpot": false, + "reserved": false, + "targetWorkerCount": 0, + "targetWorkerSizeId": 0, + "provisioningState": "Succeeded" + }, + "sku": { + "name": "P1", + "tier": "Premium", + "size": "P1", + "family": "P", + "capacity": 1 + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf7252", + "name": "testsf7252", + "type": "Microsoft.Web/serverfarms", + "kind": "app", + "location": "East US", + "properties": { + "status": "Ready", + "maximumNumberOfWorkers": 20, + "numberOfWorkers": 19, + "geoRegion": "East US", + "numberOfSites": 4, + "isSpot": false, + "reserved": false, + "targetWorkerCount": 0, + "targetWorkerSizeId": 0, + "provisioningState": "Succeeded" + }, + "sku": { + "name": "P1", + "tier": "Premium", + "size": "P1", + "family": "P", + "capacity": 1 + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAppSettings.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAppSettings.json new file mode 100644 index 000000000000..fb3d13b1965d --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAppSettings.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/appsettings", + "name": "appsettings", + "type": "Microsoft.Web/sites/config", + "kind": "app", + "properties": { + "Setting1": "Value1", + "Setting2": "Value2" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAseRegions.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAseRegions.json new file mode 100644 index 000000000000..808753d6d420 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAseRegions.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/aseRegions", + "type": "Microsoft.Web/aseRegions", + "properties": { + "displayName": "southcentralus", + "standard": true, + "dedicatedHost": true, + "zoneRedundant": true, + "availableSku": [ + "I1v2", + "I2v2", + "I3v2" + ], + "availableOS": [ + "Windows", + "Linux", + "HyperV" + ] + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/aseRegions", + "type": "Microsoft.Web/aseRegions", + "properties": { + "displayName": "northcentralus", + "standard": true, + "dedicatedHost": true, + "zoneRedundant": true, + "availableSku": [ + "I1v4", + "I2v2", + "I3v2" + ], + "availableOS": [ + "Windows", + "Linux" + ] + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettings.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettings.json new file mode 100644 index 000000000000..772b90dd63c0 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettings.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettings", + "name": "authsettings", + "type": "Microsoft.Web/sites/authsettings", + "kind": "app", + "properties": { + "enabled": true, + "runtimeVersion": "~1", + "unauthenticatedClientAction": "RedirectToLoginPage", + "tokenStoreEnabled": true, + "allowedExternalRedirectUrls": [ + "sitef6141.customdomain.net", + "sitef6141.customdomain.info" + ], + "defaultProvider": "Google", + "tokenRefreshExtensionHours": 120, + "clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettingsV2.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettingsV2.json new file mode 100644 index 000000000000..e7665ae30287 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettingsV2.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettingsv2", + "name": "authsettingsv2", + "type": "Microsoft.Web/sites/authsettingsv2", + "kind": "app", + "properties": { + "platform": { + "enabled": true, + "runtimeVersion": "~1", + "configFilePath": "/auth/config.json" + }, + "globalValidation": { + "requireAuthentication": true, + "unauthenticatedClientAction": "Return403", + "excludedPaths": [ + "/nosecrets/Path" + ] + }, + "identityProviders": { + "google": { + "enabled": true, + "registration": { + "clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com", + "clientSecretSettingName": "ClientSecret" + }, + "login": { + "scopes": [ + "admin" + ] + }, + "validation": { + "allowedAudiences": [ + "https://example.com" + ] + } + } + }, + "login": { + "routes": { + "logoutEndpoint": "https://app.com/logout" + }, + "tokenStore": { + "enabled": true, + "tokenRefreshExtensionHours": 96, + "fileSystem": { + "directory": "/wwwroot/sites/example" + } + }, + "preserveUrlFragmentsForLogins": true, + "allowedExternalRedirectUrls": [ + "https://someurl.com" + ], + "cookieExpiration": { + "convention": "IdentityProviderDerived", + "timeToExpiration": "2022:09-01T00:00Z" + }, + "nonce": { + "validateNonce": true + } + }, + "httpSettings": { + "requireHttps": true, + "routes": { + "apiPrefix": "/authv2/" + }, + "forwardProxy": { + "convention": "Standard", + "customHostHeaderName": "authHeader", + "customProtoHeaderName": "customProtoHeader" + } + } + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListCertificates.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListCertificates.json new file mode 100644 index 000000000000..a124f40bf228 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListCertificates.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/certificates/testc6282", + "name": "testc6282", + "type": "Microsoft.Web/certificates", + "location": "East US", + "properties": { + "friendlyName": "", + "subjectName": "ServerCert", + "hostNames": [ + "ServerCert" + ], + "issuer": "CACert", + "issueDate": "2015-11-12T23:40:25+00:00", + "expirationDate": "2039-12-31T23:59:59+00:00", + "thumbprint": "FE703D7411A44163B6D32B3AD9B03E175886EBFE" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/certificates/testc4912", + "name": "testc4912", + "type": "Microsoft.Web/certificates", + "location": "West US", + "properties": { + "friendlyName": "", + "subjectName": "ServerCert2", + "hostNames": [ + "ServerCert2" + ], + "issuer": "CACert", + "issueDate": "2015-12-12T23:40:25+00:00", + "expirationDate": "2040-12-31T23:59:59+00:00", + "thumbprint": "FE703D7411A44163B6D32B3AD9B0490D5886EBFE" + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListCertificatesByResourceGroup.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListCertificatesByResourceGroup.json new file mode 100644 index 000000000000..0154a2193d7d --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListCertificatesByResourceGroup.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/certificates/testc6282", + "name": "testc6282", + "type": "Microsoft.Web/certificates", + "location": "East US", + "properties": { + "friendlyName": "", + "subjectName": "ServerCert", + "hostNames": [ + "ServerCert" + ], + "issuer": "CACert", + "issueDate": "2015-11-12T23:40:25+00:00", + "expirationDate": "2039-12-31T23:59:59+00:00", + "thumbprint": "FE703D7411A44163B6D32B3AD9B03E175886EBFE" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/certificates/testc4912", + "name": "testc4912", + "type": "Microsoft.Web/certificates", + "location": "West US", + "properties": { + "friendlyName": "", + "subjectName": "ServerCert2", + "hostNames": [ + "ServerCert2" + ], + "issuer": "CACert", + "issueDate": "2015-12-12T23:40:25+00:00", + "expirationDate": "2040-12-31T23:59:59+00:00", + "thumbprint": "FE703D7411A44163B6D32B3AD9B0490D5886EBFE" + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListContainerAppSecrets.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListContainerAppSecrets.json new file mode 100644 index 000000000000..7a8b98c48d92 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListContainerAppSecrets.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testcontainerApp0", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "secret1", + "value": "value1" + }, + { + "name": "secret2", + "value": "value2" + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListContainerAppsByResourceGroup.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListContainerAppsByResourceGroup.json new file mode 100644 index 000000000000..64a9f3cfbed5 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListContainerAppsByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.Web/containerApps", + "kind": "containerApp", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "kubeEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/kubeEnvironments/demokube", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto" + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + }, + "dapr": { + "enabled": true, + "appPort": 3000 + } + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListContainerAppsBySubscription.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListContainerAppsBySubscription.json new file mode 100644 index 000000000000..7b6ff000052f --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListContainerAppsBySubscription.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.Web/containerApps", + "kind": "containerApp", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "kubeEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/kubeEnvironments/demokube", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto" + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + }, + "dapr": { + "enabled": true, + "appPort": 3000 + } + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListCustomHostNameSites.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListCustomHostNameSites.json new file mode 100644 index 000000000000..c66f653ac0bc --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListCustomHostNameSites.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Web/customhostnameSites/mywebapp.azurewebsites.net", + "name": "mywebapp.azurewebsites.net", + "type": "Microsoft.Web/customhostnameSites", + "properties": { + "customHostname": "mywebapp.azurewebsites.net", + "region": "West US", + "siteResourceIds": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westus-rg/providers/Microsoft.Web/sites/mywebapp" + } + ] + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Web/customhostnameSites/www.example.com", + "name": "www.example.com", + "type": "Microsoft.Web/customhostnameSites", + "properties": { + "customHostname": "www.example.com", + "region": "West US 2", + "siteResourceIds": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westus2-rg/providers/Microsoft.Web/sites/westus2app1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westus2-rg/providers/Microsoft.Web/sites/westus2app2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westus2-rg/providers/Microsoft.Web/sites/westus2app3" + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListCustomSpecificHostNameSites.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListCustomSpecificHostNameSites.json new file mode 100644 index 000000000000..520389723bda --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListCustomSpecificHostNameSites.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "hostname": "www.example.com", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Web/customhostnameSites/www.example.com", + "name": "www.example.com", + "type": "Microsoft.Web/customhostnameSites", + "properties": { + "customHostname": "www.example.com", + "region": "West US 2", + "siteResourceIds": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westus2-rg/providers/Microsoft.Web/sites/westus2app1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westus2-rg/providers/Microsoft.Web/sites/westus2app2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westus2-rg/providers/Microsoft.Web/sites/westus2app3" + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListDeletedWebAppsByLocation.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListDeletedWebAppsByLocation.json new file mode 100644 index 000000000000..3c9bf35b1fcf --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListDeletedWebAppsByLocation.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "location": "West US 2", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg1/providers/Microsoft.Web/locations/West US 2/deletedwebapps/wussite6", + "name": "wussite6", + "type": "Microsoft.Web/locations/deletedSites", + "properties": { + "deletedSiteId": 9, + "deletedTimestamp": "2019-05-09T22:29:05.1337007", + "subscription": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroup": "rg1", + "deletedSiteName": "wussite6", + "slot": "Production", + "kind": "app", + "geoRegionName": "West US 2" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListOperations.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListOperations.json new file mode 100644 index 000000000000..3501f2005ea6 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListOperations.json @@ -0,0 +1,5831 @@ +{ + "parameters": { + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "Microsoft.Web/sites/Read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App", + "operation": "Get Web App", + "description": "Get the properties of a Web App" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/Write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App", + "operation": "Create or Update Web App", + "description": "Create a new Web App or update an existing one" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/slots/Write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App Slot", + "operation": "Create or Update Web App Slot", + "description": "Create a new Web App Slot or update an existing one" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/Delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App", + "operation": "Delete Web App", + "description": "Delete an existing Web App" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/slots/Delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App Slot", + "operation": "Delete Web App Slot", + "description": "Delete an existing Web App Slot" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/slots/config/Read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App Slot", + "operation": "Get Web App Slot Configuration", + "description": "Get Web App Slot's configuration settings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/config/Read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App", + "operation": "Get Web App Configuration", + "description": "Get Web App configuration settings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/config/list/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App", + "operation": "List Web App Security Sensitive Settings", + "description": "List Web App's security sensitive settings, such as publishing credentials, app settings and connection strings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/slots/config/list/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App Slot", + "operation": "List Web App Slot Security Sensitive Settings", + "description": "List Web App Slot's security sensitive settings, such as publishing credentials, app settings and connection strings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/config/Write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App", + "operation": "Update Web App Configuration", + "description": "Update Web App's configuration settings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/slots/config/Write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App Slot", + "operation": "Update Web App Slot Configuration", + "description": "Update Web App Slot's configuration settings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/sourcecontrols/Read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App", + "operation": "Get Web App Source Control Configuration", + "description": "Get Web App's source control configuration settings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/slots/sourcecontrols/Read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App Slot", + "operation": "Get Web App Slot Source Control Configuration", + "description": "Get Web App Slot's source control configuration settings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/sourcecontrols/Write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App", + "operation": "Update Web App Source Control Configuration", + "description": "Update Web App's source control configuration settings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/slots/sourcecontrols/Write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App Slot", + "operation": "Update Web App Slot Source Control Configuration", + "description": "Update Web App Slot's source control configuration settings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/sourcecontrols/Delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App", + "operation": "Delete Web App Source Control Configuration", + "description": "Delete Web App's source control configuration settings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/slots/sourcecontrols/Delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App Slot", + "operation": "Delete Web App Slot Source Control Configuration", + "description": "Delete Web App Slot's source control configuration settings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/backup/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App", + "operation": "Create Web App Backup", + "description": "Create a new web app backup" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/slots/backup/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App Slot", + "operation": "Create Web App Slot Backup", + "description": "Create new Web App Slot backup." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/backups/Read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App", + "operation": "Get Web App Backup", + "description": "Get the properties of a web app's backup" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/slots/backups/Read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App Slot", + "operation": "List Web App Slot Backups", + "description": "Get the properties of a web app slots' backup" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/publishxml/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App", + "operation": "Get Web App Publishing Profile", + "description": "Get publishing profile xml for a Web App" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/slots/publishxml/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App Slot", + "operation": "Get Web App Slot Publishing Profile", + "description": "Get publishing profile xml for Web App Slot" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/publish/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App", + "operation": "Publish Web App", + "description": "Publish a Web App" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/slots/publish/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App Slot", + "operation": "Publish Web App Slot", + "description": "Publish a Web App Slot" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/restart/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App", + "operation": "Restart Web App", + "description": "Restart a Web App" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/slots/restart/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App Slot", + "operation": "Restart Web App Slot", + "description": "Restart a Web App Slot" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/start/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App", + "operation": "Start Web App", + "description": "Start a Web App" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/slots/start/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App Slot", + "operation": "Start Web App Slot", + "description": "Start a Web App Slot" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/stop/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App", + "operation": "Stop Web App", + "description": "Stop a Web App" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/slots/stop/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App Slot", + "operation": "Stop Web App Slot", + "description": "Stop a Web App Slot" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/slotsswap/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App", + "operation": "Swap Web App Slots", + "description": "Swap Web App deployment slots" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/slots/slotsswap/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App Slot", + "operation": "Swap Web App Slots", + "description": "Swap Web App deployment slots" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/slotsdiffs/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App", + "operation": "Get Web App Slots Differences", + "description": "Get differences in configuration between web app and slots" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/slots/slotsdiffs/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App Slot", + "operation": "Get Web App Slots Differences", + "description": "Get differences in configuration between web app and slots" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/applySlotConfig/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App", + "operation": "Apply Web App Configuration", + "description": "Apply web app slot configuration from target slot to the current web app" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/slots/applySlotConfig/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App Slot", + "operation": "Apply Web App Slot Configuration", + "description": "Apply web app slot configuration from target slot to the current slot." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/resetSlotConfig/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App", + "operation": "Reset Web App Configuration", + "description": "Reset web app configuration" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/slots/resetSlotConfig/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App Slot", + "operation": "Reset Web App Slot Configuration", + "description": "Reset web app slot configuration" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/slots/Read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App Slot", + "operation": "Get Web App Deployment Slot", + "description": "Get the properties of a Web App deployment slot" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/serverfarms/Read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plan", + "operation": "Get App Service Plan", + "description": "Get the properties on an App Service Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/serverfarms/Write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plan", + "operation": "Create or Update App Service Plan", + "description": "Create a new App Service Plan or update an existing one" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/serverfarms/Delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plan", + "operation": "Delete App Service Plan", + "description": "Delete an existing App Service Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/serverfarms/restartSites/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plan", + "operation": "Restart Web Apps", + "description": "Restart all Web Apps in an App Service Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/certificates/Read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Certificate", + "operation": "Get Certificates", + "description": "Get the list of certificates." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/certificates/Write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Certificate", + "operation": "Add or Update Certificate", + "description": "Add a new certificate or update an existing one." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/certificates/Delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Certificate", + "operation": "Delete Certificate", + "description": "Delete an existing certificate." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/aseRegions/Read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "ASE Region", + "operation": "Get ASE Regions", + "description": "Get the list of ASE regions." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/geoRegions/Read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Geo Region", + "operation": "Get Geo Regions", + "description": "Get the list of Geo regions." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/listSitesAssignedToHostName/Read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Site Name", + "operation": "Get sites assigned to hostname", + "description": "Get names of sites assigned to hostname." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/hostingEnvironments/Read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Environment", + "operation": "Get App Service Environment", + "description": "Get the properties of an App Service Environment" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/hostingEnvironments/Write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Environment", + "operation": "Create or Update App Service Environment", + "description": "Create a new App Service Environment or update existing one" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/hostingEnvironments/Delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Environment", + "operation": "Delete App Service Environment", + "description": "Delete an App Service Environment" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/hostingEnvironments/reboot/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Environment", + "operation": "Reboot an App Service Environment", + "description": "Reboot all machines in an App Service Environment" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/hostingEnvironments/multiRolePools/Read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Environment FrontEnd Pool", + "operation": "Get FrontEnd Pool", + "description": "Get the properties of a FrontEnd Pool in an App Service Environment" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/hostingEnvironments/multiRolePools/Write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Environment FrontEnd Pool", + "operation": "Create or Update FrontEnd Pool", + "description": "Create a new FrontEnd Pool in an App Service Environment or update an existing one" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/hostingEnvironments/workerPools/Read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Environment Worker Pool", + "operation": "Get Worker Pool", + "description": "Get the properties of a Worker Pool in an App Service Environment" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/hostingEnvironments/workerPools/Write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Environment Worker Pool", + "operation": "Create or Update Worker Pool", + "description": "Create a new Worker Pool in an App Service Environment or update an existing one" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/connections/Read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Connections", + "operation": "Get Connections", + "description": "Get the list of Connections." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/connections/Write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Connections", + "operation": "Add or Update Connection", + "description": "Creates or updates a Connection." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/connections/Delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Connections", + "operation": "Delete Connection", + "description": "Deletes a Connection." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/connections/Join/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Connections", + "operation": "Join Connection", + "description": "Joins a Connection." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/connectionGateways/Read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Connection Gateways", + "operation": "Get Connection Gateways", + "description": "Get the list of Connection Gateways." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/connectionGateways/Write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Connection Gateways", + "operation": "Add or Update Connection Gateways", + "description": "Creates or updates a Connection Gateway." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/connectionGateways/Delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Connection Gateways", + "operation": "Delete Connection Gateway", + "description": "Deletes a Connection Gateway." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/connectionGateways/Join/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Connection Gateways", + "operation": "Join Connection Gateway", + "description": "Joins a Connection Gateway." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/recommendations/Read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Recommendation", + "operation": "Get recommendations", + "description": "Get the list of recommendations for subscriptions." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/sites/recommendations/Read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Recommendation", + "operation": "Get recommendations for web app", + "description": "Get the list of recommendations for web app." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/availablestacks/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Available Stacks", + "operation": "Get Available Stacks", + "description": "Get Available Stacks." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/functionappstacks/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Function App Stacks", + "operation": "Get Function App Stacks", + "description": "Get Function App Stacks." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/webappstacks/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web App Stacks", + "operation": "Get Web App Stacks", + "description": "Get Web App Stacks." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/checknameavailability/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Check Name Availability", + "operation": "Get Check Name Availability", + "description": "Check if resource name is available." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/classicmobileservices/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Classic Mobile Services", + "operation": "Get Classic Mobile Services", + "description": "Get Classic Mobile Services." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/connections/confirmconsentcode/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Connections", + "operation": "Confirm Connections Consent Code", + "description": "Confirm Connections Consent Code." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/connections/listconsentlinks/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Connections", + "operation": "List Consent Links for Connections", + "description": "List Consent Links for Connections." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/deploymentlocations/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Deployment Locations", + "operation": "Get Deployment Locations", + "description": "Get Deployment Locations." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/hostingenvironments/capacities/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Hosting Environments Capacities", + "operation": "Get Hosting Environments Capacities", + "description": "Get Hosting Environments Capacities." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/hostingenvironments/diagnostics/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Hosting Environments Diagnostics", + "operation": "Get Hosting Environments Diagnostics", + "description": "Get Hosting Environments Diagnostics." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/hostingenvironments/metricdefinitions/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Hosting Environments Metric Definitions", + "operation": "Get Hosting Environments Metric Definitions", + "description": "Get Hosting Environments Metric Definitions." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/hostingenvironments/multirolepools/metricdefinitions/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Hosting Environments MultiRole Pools Metric Definitions", + "operation": "Get Hosting Environments MultiRole Pools Metric Definitions", + "description": "Get Hosting Environments MultiRole Pools Metric Definitions." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/hostingenvironments/multirolepools/metrics/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Hosting Environments MultiRole Pools Metrics", + "operation": "Get Hosting Environments MultiRole Pools Metrics", + "description": "Get Hosting Environments MultiRole Pools Metrics." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/hostingenvironments/multirolepools/skus/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Hosting Environments MultiRole Pools SKUs", + "operation": "Get Hosting Environments MultiRole Pools SKUs", + "description": "Get Hosting Environments MultiRole Pools SKUs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/hostingenvironments/multirolepools/usages/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Hosting Environments MultiRole Pools Usages", + "operation": "Get Hosting Environments MultiRole Pools Usages", + "description": "Get Hosting Environments MultiRole Pools Usages." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/hostingenvironments/operations/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Hosting Environments Operations", + "operation": "Get Hosting Environments Operations", + "description": "Get Hosting Environments Operations." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/hostingenvironments/resume/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Hosting Environments", + "operation": "Resume Hosting Environments", + "description": "Resume Hosting Environments." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/hostingenvironments/serverfarms/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Hosting Environments App Service Plans", + "operation": "Get Hosting Environments App Service Plans", + "description": "Get Hosting Environments App Service Plans." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/hostingenvironments/sites/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Hosting Environments Web Apps", + "operation": "Get Hosting Environments Web Apps", + "description": "Get Hosting Environments Web Apps." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/hostingenvironments/suspend/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Hosting Environments", + "operation": "Suspend Hosting Environments", + "description": "Suspend Hosting Environments." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/hostingenvironments/usages/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Hosting Environments Usages", + "operation": "Get Hosting Environments Usages", + "description": "Get Hosting Environments Usages." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/hostingenvironments/workerpools/metricdefinitions/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Hosting Environments Workerpools Metric Definitions", + "operation": "Get Hosting Environments Workerpools Metric Definitions", + "description": "Get Hosting Environments Workerpools Metric Definitions." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/hostingenvironments/workerpools/metrics/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Hosting Environments Workerpools Metrics", + "operation": "Get Hosting Environments Workerpools Metrics", + "description": "Get Hosting Environments Workerpools Metrics." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/hostingenvironments/workerpools/skus/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Hosting Environments Workerpools SKUs", + "operation": "Get Hosting Environments Workerpools SKUs", + "description": "Get Hosting Environments Workerpools SKUs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/hostingenvironments/workerpools/usages/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Hosting Environments Workerpools Usages", + "operation": "Get Hosting Environments Workerpools Usages", + "description": "Get Hosting Environments Workerpools Usages." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/ishostingenvironmentnameavailable/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Hosting Environment Name", + "operation": "Check if Hosting Environment Name is available", + "description": "Get if Hosting Environment Name is available." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/ishostnameavailable/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Hostname", + "operation": "Check if Hostname is Available", + "description": "Check if Hostname is Available." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/isusernameavailable/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Username", + "operation": "Check if Username is available", + "description": "Check if Username is available." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/locations/apioperations/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Locations API Operations", + "operation": "Get Locations API Operations", + "description": "Get Locations API Operations." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/locations/connectiongatewayinstallations/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Locations Connection Gateway Installations", + "operation": "Get Locations Connection Gateway Installations", + "description": "Get Locations Connection Gateway Installations." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/locations/functionappstacks/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Locations Function App Stacks", + "operation": "Get Locations Function App Stacks", + "description": "Get Locations Function App Stacks." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/locations/webappstacks/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Locations Web App Stacks", + "operation": "Get Locations Web App Stacks", + "description": "Get Locations Web App Stacks." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/locations/managedapis/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Locations Managed APIs", + "operation": "Get Locations Managed APIs", + "description": "Get Locations Managed APIs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/operations/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Operations", + "operation": "Get Operations", + "description": "Get Operations." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/publishingusers/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Publishing Users", + "operation": "Get Publishing Users", + "description": "Get Publishing Users." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/publishingusers/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Publishing Users", + "operation": "Update Publishing Users", + "description": "Update Publishing Users." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/serverfarms/capabilities/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plans Capabilities", + "operation": "Get App Service Plans Capabilities", + "description": "Get App Service Plans Capabilities." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/serverfarms/firstpartyapps/settings/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plans First Party Apps Settings", + "operation": "Delete App Service Plans First Party Apps Settings", + "description": "Delete App Service Plans First Party Apps Settings." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/serverfarms/firstpartyapps/settings/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plans First Party Apps Settings", + "operation": "Get App Service Plans First Party Apps Settings", + "description": "Get App Service Plans First Party Apps Settings." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/serverfarms/firstpartyapps/settings/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plans First Party Apps Settings", + "operation": "Update App Service Plans First Party Apps Settings", + "description": "Update App Service Plans First Party Apps Settings." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/serverfarms/hybridconnectionnamespaces/relays/sites/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plans Hybrid Connection Namespaces Relays Web Apps", + "operation": "Get App Service Plans Hybrid Connection Namespaces Relays Web Apps", + "description": "Get App Service Plans Hybrid Connection Namespaces Relays Web Apps." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/serverfarms/hybridconnectionplanlimits/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plans Hybrid Connection Plan Limits", + "operation": "Get App Service Plans Hybrid Connection Plan Limits", + "description": "Get App Service Plans Hybrid Connection Plan Limits." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/serverfarms/hybridconnectionrelays/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plans Hybrid Connection Relays", + "operation": "Get App Service Plans Hybrid Connection Relays", + "description": "Get App Service Plans Hybrid Connection Relays." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/serverfarms/metricdefinitions/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plans Metric Definitions", + "operation": "Get App Service Plans Metric Definitions", + "description": "Get App Service Plans Metric Definitions." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/serverfarms/metrics/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plans Metrics", + "operation": "Get App Service Plans Metrics", + "description": "Get App Service Plans Metrics." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/serverfarms/operationresults/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plans Operation Results", + "operation": "Get App Service Plans Operation Results", + "description": "Get App Service Plans Operation Results." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/serverfarms/sites/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plans Web Apps", + "operation": "Get App Service Plans Web Apps", + "description": "Get App Service Plans Web Apps." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/serverfarms/skus/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plans SKUs", + "operation": "Get App Service Plans SKUs", + "description": "Get App Service Plans SKUs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/serverfarms/usages/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plans Usages", + "operation": "Get App Service Plans Usages", + "description": "Get App Service Plans Usages." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/serverfarms/virtualnetworkconnections/gateways/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plans Virtual Network Connections Gateways", + "operation": "Update App Service Plans Virtual Network Connections Gateways", + "description": "Update App Service Plans Virtual Network Connections Gateways." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/serverfarms/virtualnetworkconnections/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plans Virtual Network Connections", + "operation": "Get App Service Plans Virtual Network Connections", + "description": "Get App Service Plans Virtual Network Connections." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/serverfarms/virtualnetworkconnections/routes/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plans Virtual Network Connections Routes", + "operation": "Delete App Service Plans Virtual Network Connections Routes", + "description": "Delete App Service Plans Virtual Network Connections Routes." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/serverfarms/virtualnetworkconnections/routes/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plans Virtual Network Connections Routes", + "operation": "Get App Service Plans Virtual Network Connections Routes", + "description": "Get App Service Plans Virtual Network Connections Routes." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/serverfarms/virtualnetworkconnections/routes/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plans Virtual Network Connections Routes", + "operation": "Update App Service Plans Virtual Network Connections Routes", + "description": "Update App Service Plans Virtual Network Connections Routes." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/serverfarms/workers/reboot/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plans Workers", + "operation": "Reboot App Service Plans Workers", + "description": "Reboot App Service Plans Workers." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/analyzecustomhostname/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Custom Hostname", + "operation": "Analyze Custom Hostname", + "description": "Analyze Custom Hostname." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/backup/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Backup", + "operation": "Get Web Apps Backup", + "description": "Get Web Apps Backup." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/backup/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Backup", + "operation": "Update Web Apps Backup", + "description": "Update Web Apps Backup." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/backups/list/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Backups", + "operation": "List Web Apps Backups", + "description": "List Web Apps Backups." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/backups/restore/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Backups", + "operation": "Restore Web Apps Backups", + "description": "Restore Web Apps Backups." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/config/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Config", + "operation": "Delete Web Apps Config", + "description": "Delete Web Apps Config." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/continuouswebjobs/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Continuous Web Jobs", + "operation": "Delete Web Apps Continuous Web Jobs", + "description": "Delete Web Apps Continuous Web Jobs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/continuouswebjobs/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Continuous Web Jobs", + "operation": "Get Web Apps Continuous Web Jobs", + "description": "Get Web Apps Continuous Web Jobs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/continuouswebjobs/start/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Continuous Web Jobs", + "operation": "Start Web Apps Continuous Web Jobs", + "description": "Start Web Apps Continuous Web Jobs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/continuouswebjobs/stop/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Continuous Web Jobs", + "operation": "Stop Web Apps Continuous Web Jobs", + "description": "Stop Web Apps Continuous Web Jobs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/deployments/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Deployments", + "operation": "Delete Web Apps Deployments", + "description": "Delete Web Apps Deployments." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/deployments/log/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Deployments Log", + "operation": "Get Web Apps Deployments Log", + "description": "Get Web Apps Deployments Log." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/deployments/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Deployments", + "operation": "Get Web Apps Deployments", + "description": "Get Web Apps Deployments." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/deployments/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Deployments", + "operation": "Update Web Apps Deployments", + "description": "Update Web Apps Deployments." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/diagnostics/frebanalysis/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Diagnostics FREB Analysis", + "operation": "Get Web Apps Diagnostics FREB Analysis", + "description": "Get Web Apps Diagnostics FREB Analysis." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/diagnostics/frebanalysis/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Diagnostics FREB Analysis", + "operation": "Get Web Apps Slots Diagnostics FREB Analysis", + "description": "Get Web Apps Slots Diagnostics FREB Analysis." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/diagnostics/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Diagnostics Category", + "operation": "Get Web Apps Diagnostics Category", + "description": "Get Web Apps Diagnostics Categories." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/diagnostics/runtimeavailability/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Diagnostics Runtime Availability", + "operation": "Get Web Apps Diagnostics Runtime Availability", + "description": "Get Web Apps Diagnostics Runtime Availability." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/diagnostics/servicehealth/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Diagnostics Service Health", + "operation": "Get Web Apps Diagnostics Service Health", + "description": "Get Web Apps Diagnostics Service Health." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/diagnostics/workeravailability/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Diagnostics Workeravailability", + "operation": "Get Web Apps Diagnostics Workeravailability", + "description": "Get Web Apps Diagnostics Workeravailability." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/diagnostics/workeravailability/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Diagnostics Workeravailability", + "operation": "Get Web Apps Slots Diagnostics Workeravailability", + "description": "Get Web Apps Slots Diagnostics Workeravailability." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/diagnostics/workerprocessrecycle/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Diagnostics Worker Process Recycle", + "operation": "Get Web Apps Diagnostics Worker Process Recycle", + "description": "Get Web Apps Diagnostics Worker Process Recycle." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/diagnostics/workerprocessrecycle/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Diagnostics Worker Process Recycle", + "operation": "Get Web Apps Slots Diagnostics Worker Process Recycle", + "description": "Get Web Apps Slots Diagnostics Worker Process Recycle." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/diagnostics/aspnetcore/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Diagnostics ASP.NET Core", + "operation": "Get Web Apps Diagnostics ASP.NET Core", + "description": "Get Web Apps Diagnostics for ASP.NET Core app." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/diagnostics/aspnetcore/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Diagnostics ASP.NET Core", + "operation": "Get Web Apps Slots Diagnostics ASP.NET Core", + "description": "Get Web Apps Slots Diagnostics for ASP.NET Core app." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/domainownershipidentifiers/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Domain Ownership Identifiers", + "operation": "Get Web Apps Domain Ownership Identifiers", + "description": "Get Web Apps Domain Ownership Identifiers." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/domainownershipidentifiers/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Domain Ownership Identifiers", + "operation": "Update Web Apps Domain Ownership Identifiers", + "description": "Update Web Apps Domain Ownership Identifiers." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/functions/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps", + "operation": "Functions Web Apps", + "description": "Functions Web Apps." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/functions/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Functions", + "operation": "Delete Web Apps Functions", + "description": "Delete Web Apps Functions." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/functions/listsecrets/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Functions", + "operation": "List Secrets Web Apps Functions", + "description": "List Secrets Web Apps Functions." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/functions/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Functions", + "operation": "Get Web Apps Functions", + "description": "Get Web Apps Functions." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/functions/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Functions", + "operation": "Update Web Apps Functions", + "description": "Update Web Apps Functions." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/hostnamebindings/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Hostname Bindings", + "operation": "Delete Web Apps Hostname Bindings", + "description": "Delete Web Apps Hostname Bindings." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/hostnamebindings/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Hostname Bindings", + "operation": "Get Web Apps Hostname Bindings", + "description": "Get Web Apps Hostname Bindings." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/hostnamebindings/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Hostname Bindings", + "operation": "Update Web Apps Hostname Bindings", + "description": "Update Web Apps Hostname Bindings." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/hybridconnection/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Hybrid Connection", + "operation": "Delete Web Apps Hybrid Connection", + "description": "Delete Web Apps Hybrid Connection." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/hybridconnection/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Hybrid Connection", + "operation": "Get Web Apps Hybrid Connection", + "description": "Get Web Apps Hybrid Connection." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/hybridconnection/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Hybrid Connection", + "operation": "Update Web Apps Hybrid Connection", + "description": "Update Web Apps Hybrid Connection." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/hybridconnectionrelays/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Hybrid Connection Relays", + "operation": "Get Web Apps Hybrid Connection Relays", + "description": "Get Web Apps Hybrid Connection Relays." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/instances/deployments/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Instances Deployments", + "operation": "Get Web Apps Instances Deployments", + "description": "Get Web Apps Instances Deployments." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/instances/processes/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Instances Processes", + "operation": "Delete Web Apps Instances Processes", + "description": "Delete Web Apps Instances Processes." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/instances/processes/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Instances Processes", + "operation": "Get Web Apps Instances Processes", + "description": "Get Web Apps Instances Processes." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/instances/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Instances", + "operation": "Get Web Apps Instances", + "description": "Get Web Apps Instances." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/listsyncfunctiontriggerstatus/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps", + "operation": "List Sync Function Trigger Status Web Apps", + "description": "List Sync Function Trigger Status Web Apps." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/metricdefinitions/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Metric Definitions", + "operation": "Get Web Apps Metric Definitions", + "description": "Get Web Apps Metric Definitions." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/metrics/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Metrics", + "operation": "Get Web Apps Metrics", + "description": "Get Web Apps Metrics." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/networktrace/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps", + "operation": "Network Trace Web Apps", + "description": "Network Trace Web Apps." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/newpassword/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps", + "operation": "Newpassword Web Apps", + "description": "Newpassword Web Apps." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/operationresults/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Operation Results", + "operation": "Get Web Apps Operation Results", + "description": "Get Web Apps Operation Results." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/perfcounters/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Performance Counters", + "operation": "Get Web Apps Performance Counters", + "description": "Get Web Apps Performance Counters." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/premieraddons/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Premier Addons", + "operation": "Delete Web Apps Premier Addons", + "description": "Delete Web Apps Premier Addons." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/premieraddons/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Premier Addons", + "operation": "Get Web Apps Premier Addons", + "description": "Get Web Apps Premier Addons." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/premieraddons/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Premier Addons", + "operation": "Update Web Apps Premier Addons", + "description": "Update Web Apps Premier Addons." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/publishxml/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Publishing XML", + "operation": "Get Web Apps Publishing XML", + "description": "Get Web Apps Publishing XML." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/recommendationhistory/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Recommendation History", + "operation": "Get Web Apps Recommendation History", + "description": "Get Web Apps Recommendation History." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/recommendations/disable/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Recommendations", + "operation": "Disable Web Apps Recommendations", + "description": "Disable Web Apps Recommendations." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/restore/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Restore", + "operation": "Get Web Apps Restore", + "description": "Get Web Apps Restore." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/analyzecustomhostname/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Analyze Custom Hostname", + "operation": "Get Web Apps Slots Analyze Custom Hostname", + "description": "Get Web Apps Slots Analyze Custom Hostname." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/backup/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Backup", + "operation": "Update Web Apps Slots Backup", + "description": "Update Web Apps Slots Backup." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/backups/list/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Backups", + "operation": "List Web Apps Slots Backups", + "description": "List Web Apps Slots Backups." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/backups/restore/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Backups", + "operation": "Restore Web Apps Slots Backups", + "description": "Restore Web Apps Slots Backups." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/config/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Config", + "operation": "Delete Web Apps Slots Config", + "description": "Delete Web Apps Slots Config." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/continuouswebjobs/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Continuous Web Jobs", + "operation": "Delete Web Apps Slots Continuous Web Jobs", + "description": "Delete Web Apps Slots Continuous Web Jobs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/continuouswebjobs/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Continuous Web Jobs", + "operation": "Get Web Apps Slots Continuous Web Jobs", + "description": "Get Web Apps Slots Continuous Web Jobs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/continuouswebjobs/start/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Continuous Web Jobs", + "operation": "Start Web Apps Slots Continuous Web Jobs", + "description": "Start Web Apps Slots Continuous Web Jobs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/continuouswebjobs/stop/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Continuous Web Jobs", + "operation": "Stop Web Apps Slots Continuous Web Jobs", + "description": "Stop Web Apps Slots Continuous Web Jobs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/deployments/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Deployments", + "operation": "Delete Web Apps Slots Deployments", + "description": "Delete Web Apps Slots Deployments." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/deployments/log/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Deployments Log", + "operation": "Get Web Apps Slots Deployments Log", + "description": "Get Web Apps Slots Deployments Log." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/deployments/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Deployments", + "operation": "Get Web Apps Slots Deployments", + "description": "Get Web Apps Slots Deployments." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/deployments/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Deployments", + "operation": "Update Web Apps Slots Deployments", + "description": "Update Web Apps Slots Deployments." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/hostnamebindings/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Hostname Bindings", + "operation": "Delete Web Apps Slots Hostname Bindings", + "description": "Delete Web Apps Slots Hostname Bindings." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/hostnamebindings/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Hostname Bindings", + "operation": "Get Web Apps Slots Hostname Bindings", + "description": "Get Web Apps Slots Hostname Bindings." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/hostnamebindings/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Hostname Bindings", + "operation": "Update Web Apps Slots Hostname Bindings", + "description": "Update Web Apps Slots Hostname Bindings." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/hybridconnection/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Hybrid Connection", + "operation": "Delete Web Apps Slots Hybrid Connection", + "description": "Delete Web Apps Slots Hybrid Connection." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/hybridconnection/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Hybrid Connection", + "operation": "Get Web Apps Slots Hybrid Connection", + "description": "Get Web Apps Slots Hybrid Connection." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/hybridconnection/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Hybrid Connection", + "operation": "Update Web Apps Slots Hybrid Connection", + "description": "Update Web Apps Slots Hybrid Connection." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/instances/deployments/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Instances Deployments", + "operation": "Get Web Apps Slots Instances Deployments", + "description": "Get Web Apps Slots Instances Deployments." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/instances/processes/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Instances Processes", + "operation": "Get Web Apps Slots Instances Processes", + "description": "Get Web Apps Slots Instances Processes." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/instances/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Instances", + "operation": "Get Web Apps Slots Instances", + "description": "Get Web Apps Slots Instances." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/metricdefinitions/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Metric Definitions", + "operation": "Get Web Apps Slots Metric Definitions", + "description": "Get Web Apps Slots Metric Definitions." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/metrics/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Metrics", + "operation": "Get Web Apps Slots Metrics", + "description": "Get Web Apps Slots Metrics." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/newpassword/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots", + "operation": "Newpassword Web Apps Slots", + "description": "Newpassword Web Apps Slots." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/operationresults/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Operation Results", + "operation": "Get Web Apps Slots Operation Results", + "description": "Get Web Apps Slots Operation Results." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/phplogging/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Phplogging", + "operation": "Get Web Apps Slots Phplogging", + "description": "Get Web Apps Slots Phplogging." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/premieraddons/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Premier Addons", + "operation": "Delete Web Apps Slots Premier Addons", + "description": "Delete Web Apps Slots Premier Addons." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/premieraddons/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Premier Addons", + "operation": "Get Web Apps Slots Premier Addons", + "description": "Get Web Apps Slots Premier Addons." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/premieraddons/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Premier Addons", + "operation": "Update Web Apps Slots Premier Addons", + "description": "Update Web Apps Slots Premier Addons." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/restore/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Restore", + "operation": "Get Web Apps Slots Restore", + "description": "Get Web Apps Slots Restore." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/sync/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots", + "operation": "Sync Web Apps Slots", + "description": "Sync Web Apps Slots." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/triggeredwebjobs/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Triggered WebJobs", + "operation": "Delete Web Apps Slots Triggered WebJobs", + "description": "Delete Web Apps Slots Triggered WebJobs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/triggeredwebjobs/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Triggered WebJobs", + "operation": "Get Web Apps Slots Triggered WebJobs", + "description": "Get Web Apps Slots Triggered WebJobs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/triggeredwebjobs/run/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Triggered WebJobs", + "operation": "Run Web Apps Slots Triggered WebJobs", + "description": "Run Web Apps Slots Triggered WebJobs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/usages/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Usages", + "operation": "Get Web Apps Slots Usages", + "description": "Get Web Apps Slots Usages." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/virtualnetworkconnections/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Virtual Network Connections", + "operation": "Delete Web Apps Slots Virtual Network Connections", + "description": "Delete Web Apps Slots Virtual Network Connections." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/virtualnetworkconnections/gateways/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Virtual Network Connections Gateways", + "operation": "Update Web Apps Slots Virtual Network Connections Gateways", + "description": "Update Web Apps Slots Virtual Network Connections Gateways." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/virtualnetworkconnections/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Virtual Network Connections", + "operation": "Get Web Apps Slots Virtual Network Connections", + "description": "Get Web Apps Slots Virtual Network Connections." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/virtualnetworkconnections/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Virtual Network Connections", + "operation": "Update Web Apps Slots Virtual Network Connections", + "description": "Update Web Apps Slots Virtual Network Connections." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/webjobs/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots WebJobs", + "operation": "Get Web Apps Slots WebJobs", + "description": "Get Web Apps Slots WebJobs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/snapshots/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Snapshots", + "operation": "Get Web Apps Snapshots", + "description": "Get Web Apps Snapshots." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/sync/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps", + "operation": "Sync Web Apps", + "description": "Sync Web Apps." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/triggeredwebjobs/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Triggered WebJobs", + "operation": "Delete Web Apps Triggered WebJobs", + "description": "Delete Web Apps Triggered WebJobs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/triggeredwebjobs/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Triggered WebJobs", + "operation": "Get Web Apps Triggered WebJobs", + "description": "Get Web Apps Triggered WebJobs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/triggeredwebjobs/run/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Triggered WebJobs", + "operation": "Run Web Apps Triggered WebJobs", + "description": "Run Web Apps Triggered WebJobs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/usages/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Usages", + "operation": "Get Web Apps Usages", + "description": "Get Web Apps Usages." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/virtualnetworkconnections/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Virtual Network Connections", + "operation": "Delete Web Apps Virtual Network Connections", + "description": "Delete Web Apps Virtual Network Connections." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/virtualnetworkconnections/gateways/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Virtual Network Connections Gateways", + "operation": "Get Web Apps Virtual Network Connections Gateways", + "description": "Get Web Apps Virtual Network Connections Gateways." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/virtualnetworkconnections/gateways/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Virtual Network Connections Gateways", + "operation": "Update Web Apps Virtual Network Connections Gateways", + "description": "Update Web Apps Virtual Network Connections Gateways." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/virtualnetworkconnections/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Virtual Network Connections", + "operation": "Get Web Apps Virtual Network Connections", + "description": "Get Web Apps Virtual Network Connections." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/virtualnetworkconnections/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Virtual Network Connections", + "operation": "Update Web Apps Virtual Network Connections", + "description": "Update Web Apps Virtual Network Connections." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/webjobs/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps WebJobs", + "operation": "Get Web Apps WebJobs", + "description": "Get Web Apps WebJobs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/skus/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "SKUs", + "operation": "Get SKUs", + "description": "Get SKUs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sourcecontrols/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Source Controls", + "operation": "Get Source Controls", + "description": "Get Source Controls." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sourcecontrols/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Source Controls", + "operation": "Update Source Controls", + "description": "Update Source Controls." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/unregister/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Microsoft.Web resource provider", + "operation": "Unregister Microsoft.Web resource provider", + "description": "Unregister Microsoft.Web resource provider for the subscription." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/validate/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "", + "operation": "Validate ", + "description": "Validate ." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/register/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Microsoft.Web resource provider", + "operation": "Register Microsoft.Web resource provider", + "description": "Register Microsoft.Web resource provider for the subscription." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/serverfarms/hybridconnectionnamespaces/relays/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plans Hybrid Connection Namespaces Relays", + "operation": "Get App Service Plans Hybrid Connection Namespaces Relays", + "description": "Get App Service Plans Hybrid Connection Namespaces Relays." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/backups/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Backups", + "operation": "Delete Web Apps Backups", + "description": "Delete Web Apps Backups." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/hybridconnectionnamespaces/relays/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Hybrid Connection Namespaces Relays", + "operation": "Delete Web Apps Hybrid Connection Namespaces Relays", + "description": "Delete Web Apps Hybrid Connection Namespaces Relays." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/hybridconnectionnamespaces/relays/listkeys/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Hybrid Connection Namespaces Relays", + "operation": "List Keys Web Apps Hybrid Connection Namespaces Relays", + "description": "List Keys Web Apps Hybrid Connection Namespaces Relays." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/hybridconnectionnamespaces/relays/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Hybrid Connection Namespaces Relays", + "operation": "Update Web Apps Hybrid Connection Namespaces Relays", + "description": "Update Web Apps Hybrid Connection Namespaces Relays." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/metricsdefinitions/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Metrics Definitions", + "operation": "Get Web Apps Metrics Definitions", + "description": "Get Web Apps Metrics Definitions." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/migratemysql/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps", + "operation": "Migrate MySql Web Apps", + "description": "Migrate MySql Web Apps." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/migratemysql/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Migrate MySql", + "operation": "Get Web Apps Migrate MySql", + "description": "Get Web Apps Migrate MySql." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/recover/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps", + "operation": "Recover Web Apps", + "description": "Recover Web Apps." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/siteextensions/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Site Extensions", + "operation": "Delete Web Apps Site Extensions", + "description": "Delete Web Apps Site Extensions." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/siteextensions/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Site Extensions", + "operation": "Get Web Apps Site Extensions", + "description": "Get Web Apps Site Extensions." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/siteextensions/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Site Extensions", + "operation": "Update Web Apps Site Extensions", + "description": "Update Web Apps Site Extensions." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/backup/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Backup", + "operation": "Get Web Apps Slots Backup", + "description": "Get Web Apps Slots Backup." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/hybridconnectionrelays/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Hybrid Connection Relays", + "operation": "Get Web Apps Slots Hybrid Connection Relays", + "description": "Get Web Apps Slots Hybrid Connection Relays." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/siteextensions/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Site Extensions", + "operation": "Delete Web Apps Slots Site Extensions", + "description": "Delete Web Apps Slots Site Extensions." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/siteextensions/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Site Extensions", + "operation": "Get Web Apps Slots Site Extensions", + "description": "Get Web Apps Slots Site Extensions." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/siteextensions/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Site Extensions", + "operation": "Update Web Apps Slots Site Extensions", + "description": "Update Web Apps Slots Site Extensions." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/snapshots/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Snapshots", + "operation": "Get Web Apps Slots Snapshots", + "description": "Get Web Apps Slots Snapshots." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/syncfunctiontriggers/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps", + "operation": "Sync Function Triggers for Web Apps", + "description": "Sync Function Triggers for Web Apps." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/triggeredwebjobs/history/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Triggered WebJobs History", + "operation": "Get Web Apps Triggered WebJobs History", + "description": "Get Web Apps Triggered WebJobs History." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/connectiongateways/liststatus/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Connection Gateways", + "operation": "List Status Connection Gateways", + "description": "List Status Connection Gateways." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/serverfarms/hybridconnectionnamespaces/relays/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "App Service Plans Hybrid Connection Namespaces Relays", + "operation": "Delete App Service Plans Hybrid Connection Namespaces Relays", + "description": "Delete App Service Plans Hybrid Connection Namespaces Relays." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/diagnostics/deployment/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Diagnostics Deployment", + "operation": "Get Web Apps Diagnostics Deployment", + "description": "Get Web Apps Diagnostics Deployment." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/diagnostics/sitecpuanalysis/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Diagnostics Site CPU Analysis", + "operation": "Get Web Apps Diagnostics Site CPU Analysis", + "description": "Get Web Apps Diagnostics Site CPU Analysis." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/diagnostics/sitelatency/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Diagnostics Site Latency", + "operation": "Get Web Apps Diagnostics Site Latency", + "description": "Get Web Apps Diagnostics Site Latency." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/diagnostics/sitememoryanalysis/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Diagnostics Site Memory Analysis", + "operation": "Get Web Apps Diagnostics Site Memory Analysis", + "description": "Get Web Apps Diagnostics Site Memory Analysis." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/diagnostics/threadcount/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Diagnostics Thread Count", + "operation": "Get Web Apps Diagnostics Thread Count", + "description": "Get Web Apps Diagnostics Thread Count." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/diagnostics/deployment/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Diagnostics Deployment", + "operation": "Get Web Apps Slots Diagnostics Deployment", + "description": "Get Web Apps Slots Diagnostics Deployment." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/diagnostics/sitecpuanalysis/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Diagnostics Site CPU Analysis", + "operation": "Get Web Apps Slots Diagnostics Site CPU Analysis", + "description": "Get Web Apps Slots Diagnostics Site CPU Analysis." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/diagnostics/sitelatency/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Diagnostics Site Latency", + "operation": "Get Web Apps Slots Diagnostics Site Latency", + "description": "Get Web Apps Slots Diagnostics Site Latency." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/diagnostics/sitememoryanalysis/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Diagnostics Site Memory Analysis", + "operation": "Get Web Apps Slots Diagnostics Site Memory Analysis", + "description": "Get Web Apps Slots Diagnostics Site Memory Analysis." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/diagnostics/threadcount/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Diagnostics Thread Count", + "operation": "Get Web Apps Slots Diagnostics Thread Count", + "description": "Get Web Apps Slots Diagnostics Thread Count." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/functions/masterkey/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Functions Masterkey", + "operation": "Get Web Apps Functions Masterkey", + "description": "Get Web Apps Functions Masterkey." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/hybridconnectionnamespaces/relays/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Hybrid Connection Namespaces Relays", + "operation": "Get Web Apps Hybrid Connection Namespaces Relays", + "description": "Get Web Apps Hybrid Connection Namespaces Relays." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/instances/extensions/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Instances Extensions", + "operation": "Get Web Apps Instances Extensions", + "description": "Get Web Apps Instances Extensions." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/operations/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Operations", + "operation": "Get Web Apps Operations", + "description": "Get Web Apps Operations." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/resourcehealthmetadata/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Resource Health Metadata", + "operation": "Get Web Apps Resource Health Metadata", + "description": "Get Web Apps Resource Health Metadata." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/backups/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Backups", + "operation": "Delete Web Apps Slots Backups", + "description": "Delete Web Apps Slots Backups." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/domainownershipidentifiers/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Domain Ownership Identifiers", + "operation": "Get Web Apps Slots Domain Ownership Identifiers", + "description": "Get Web Apps Slots Domain Ownership Identifiers." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/hybridconnectionnamespaces/relays/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Hybrid Connection Namespaces Relays", + "operation": "Delete Web Apps Slots Hybrid Connection Namespaces Relays", + "description": "Delete Web Apps Slots Hybrid Connection Namespaces Relays." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/hybridconnectionnamespaces/relays/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Hybrid Connection Namespaces Relays", + "operation": "Update Web Apps Slots Hybrid Connection Namespaces Relays", + "description": "Update Web Apps Slots Hybrid Connection Namespaces Relays." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/operations/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Operations", + "operation": "Get Web Apps Slots Operations", + "description": "Get Web Apps Slots Operations." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/perfcounters/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Performance Counters", + "operation": "Get Web Apps Slots Performance Counters", + "description": "Get Web Apps Slots Performance Counters." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/resourcehealthmetadata/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Resource Health Metadata", + "operation": "Get Web Apps Slots Resource Health Metadata", + "description": "Get Web Apps Slots Resource Health Metadata." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/apimanagementaccounts/apiacls/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Api Management Accounts Apiacls", + "operation": "Get Api Management Accounts Apiacls", + "description": "Get Api Management Accounts Apiacls." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/apimanagementaccounts/apis/connections/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Api Management Accounts APIs Connections", + "operation": "Get Api Management Accounts APIs Connections", + "description": "Get Api Management Accounts APIs Connections." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/apimanagementaccounts/apis/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Api Management Accounts APIs", + "operation": "Get Api Management Accounts APIs", + "description": "Get Api Management Accounts APIs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/apimanagementaccounts/connectionacls/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Api Management Accounts Connectionacls", + "operation": "Get Api Management Accounts Connectionacls", + "description": "Get Api Management Accounts Connectionacls." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/apimanagementaccounts/apis/apiacls/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Api Management Accounts APIs Apiacls", + "operation": "Delete Api Management Accounts APIs Apiacls", + "description": "Delete Api Management Accounts APIs Apiacls." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/apimanagementaccounts/apis/apiacls/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Api Management Accounts APIs Apiacls", + "operation": "Get Api Management Accounts APIs Apiacls", + "description": "Get Api Management Accounts APIs Apiacls." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/apimanagementaccounts/apis/apiacls/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Api Management Accounts APIs Apiacls", + "operation": "Update Api Management Accounts APIs Apiacls", + "description": "Update Api Management Accounts APIs Apiacls." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/apimanagementaccounts/apis/connectionacls/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Api Management Accounts APIs Connectionacls", + "operation": "Get Api Management Accounts APIs Connectionacls", + "description": "Get Api Management Accounts APIs Connectionacls." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/apimanagementaccounts/apis/connections/confirmconsentcode/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Api Management Accounts APIs Connections", + "operation": "Confirm Consent Code Api Management Accounts APIs Connections", + "description": "Confirm Consent Code Api Management Accounts APIs Connections." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/apimanagementaccounts/apis/connections/connectionacls/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Api Management Accounts APIs Connections Connectionacls", + "operation": "Delete Api Management Accounts APIs Connections Connectionacls", + "description": "Delete Api Management Accounts APIs Connections Connectionacls." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/apimanagementaccounts/apis/connections/connectionacls/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Api Management Accounts APIs Connections Connectionacls", + "operation": "Get Api Management Accounts APIs Connections Connectionacls", + "description": "Get Api Management Accounts APIs Connections Connectionacls." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/apimanagementaccounts/apis/connections/connectionacls/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Api Management Accounts APIs Connections Connectionacls", + "operation": "Update Api Management Accounts APIs Connections Connectionacls", + "description": "Update Api Management Accounts APIs Connections Connectionacls." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/apimanagementaccounts/apis/connections/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Api Management Accounts APIs Connections", + "operation": "Delete Api Management Accounts APIs Connections", + "description": "Delete Api Management Accounts APIs Connections." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/apimanagementaccounts/apis/connections/getconsentlinks/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Api Management Accounts APIs Connections", + "operation": "Get Consent Links for Api Management Accounts APIs Connections", + "description": "Get Consent Links for Api Management Accounts APIs Connections." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/apimanagementaccounts/apis/connections/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Api Management Accounts APIs Connections", + "operation": "Update Api Management Accounts APIs Connections", + "description": "Update Api Management Accounts APIs Connections." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/apimanagementaccounts/apis/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Api Management Accounts APIs", + "operation": "Delete Api Management Accounts APIs", + "description": "Delete Api Management Accounts APIs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/apimanagementaccounts/apis/localizeddefinitions/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Api Management Accounts APIs Localized Definitions", + "operation": "Delete Api Management Accounts APIs Localized Definitions", + "description": "Delete Api Management Accounts APIs Localized Definitions." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/apimanagementaccounts/apis/localizeddefinitions/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Api Management Accounts APIs Localized Definitions", + "operation": "Get Api Management Accounts APIs Localized Definitions", + "description": "Get Api Management Accounts APIs Localized Definitions." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/apimanagementaccounts/apis/localizeddefinitions/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Api Management Accounts APIs Localized Definitions", + "operation": "Update Api Management Accounts APIs Localized Definitions", + "description": "Update Api Management Accounts APIs Localized Definitions." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/apimanagementaccounts/apis/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Api Management Accounts APIs", + "operation": "Update Api Management Accounts APIs", + "description": "Update Api Management Accounts APIs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/apimanagementaccounts/apis/connections/listconnectionkeys/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Api Management Accounts APIs Connections", + "operation": "List Connection Keys Api Management Accounts APIs Connections", + "description": "List Connection Keys Api Management Accounts APIs Connections." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/apimanagementaccounts/apis/connections/listsecrets/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Api Management Accounts APIs Connections", + "operation": "List Secrets Api Management Accounts APIs Connections", + "description": "List Secrets Api Management Accounts APIs Connections." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/diagnostics/deployments/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Diagnostics Deployments", + "operation": "Get Web Apps Diagnostics Deployments", + "description": "Get Web Apps Diagnostics Deployments." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/diagnostics/deployments/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Diagnostics Deployments", + "operation": "Get Web Apps Slots Diagnostics Deployments", + "description": "Get Web Apps Slots Diagnostics Deployments." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/diagnostics/loganalyzer/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Diagnostics Log Analyzer", + "operation": "Get Web Apps Diagnostics Log Analyzer", + "description": "Get Web Apps Diagnostics Log Analyzer." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/diagnostics/loganalyzer/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Diagnostics Log Analyzer", + "operation": "Get Web Apps Slots Diagnostics Log Analyzer", + "description": "Get Web Apps Slots Diagnostics Log Analyzer." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/diagnostics/sitecrashes/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Diagnostics Site Crashes", + "operation": "Get Web Apps Diagnostics Site Crashes", + "description": "Get Web Apps Diagnostics Site Crashes." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/diagnostics/sitecrashes/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Diagnostics Site Crashes", + "operation": "Get Web Apps Slots Diagnostics Site Crashes", + "description": "Get Web Apps Slots Diagnostics Site Crashes." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/diagnostics/siterestartsettingupdate/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Diagnostics Site Restart Setting Update", + "operation": "Get Web Apps Diagnostics Site Restart Setting Update", + "description": "Get Web Apps Diagnostics Site Restart Setting Update." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/diagnostics/siterestartsettingupdate/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Diagnostics Site Restart Setting Update", + "operation": "Get Web Apps Slots Diagnostics Site Restart Setting Update", + "description": "Get Web Apps Slots Diagnostics Site Restart Setting Update." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/diagnostics/siterestartuserinitiated/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Diagnostics Site Restart User Initiated", + "operation": "Get Web Apps Diagnostics Site Restart User Initiated", + "description": "Get Web Apps Diagnostics Site Restart User Initiated." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/diagnostics/siterestartuserinitiated/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Diagnostics Site Restart User Initiated", + "operation": "Get Web Apps Slots Diagnostics Site Restart User Initiated", + "description": "Get Web Apps Slots Diagnostics Site Restart User Initiated." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/diagnostics/siteswap/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Diagnostics Site Swap", + "operation": "Get Web Apps Diagnostics Site Swap", + "description": "Get Web Apps Diagnostics Site Swap." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/diagnostics/siteswap/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Diagnostics Site Swap", + "operation": "Get Web Apps Slots Diagnostics Site Swap", + "description": "Get Web Apps Slots Diagnostics Site Swap." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/functions/token/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Functions Token", + "operation": "Get Web Apps Functions Token", + "description": "Get Web Apps Functions Token." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/instances/deployments/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Instances Deployments", + "operation": "Delete Web Apps Instances Deployments", + "description": "Delete Web Apps Instances Deployments." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/processes/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Processes", + "operation": "Get Web Apps Processes", + "description": "Get Web Apps Processes." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/publiccertificates/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Public Certificates", + "operation": "Delete Web Apps Public Certificates", + "description": "Delete Web Apps Public Certificates." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/publiccertificates/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Public Certificates", + "operation": "Get Web Apps Public Certificates", + "description": "Get Web Apps Public Certificates." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/publiccertificates/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Public Certificates", + "operation": "Update Web Apps Public Certificates", + "description": "Update Web Apps Public Certificates." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/networktrace/action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots", + "operation": "Network Trace Web Apps Slots", + "description": "Network Trace Web Apps Slots." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/diagnostics/autoheal/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Diagnostics Autoheal", + "operation": "Get Web Apps Diagnostics Autoheal", + "description": "Get Web Apps Diagnostics Autoheal." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/diagnostics/autoheal/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Diagnostics Autoheal", + "operation": "Get Web Apps Slots Diagnostics Autoheal", + "description": "Get Web Apps Slots Diagnostics Autoheal." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/diagnostics/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Diagnostics", + "operation": "Get Web Apps Slots Diagnostics", + "description": "Get Web Apps Slots Diagnostics." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/diagnostics/runtimeavailability/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Diagnostics Runtime Availability", + "operation": "Get Web Apps Slots Diagnostics Runtime Availability", + "description": "Get Web Apps Slots Diagnostics Runtime Availability." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/diagnostics/servicehealth/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Diagnostics Service Health", + "operation": "Get Web Apps Slots Diagnostics Service Health", + "description": "Get Web Apps Slots Diagnostics Service Health." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/diagnostics/sitelatency/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Diagnostics Site Latency", + "operation": "Get Web Apps Slots Diagnostics Site Latency", + "description": "Get Web Apps Slots Diagnostics Site Latency." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/migratemysql/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Migrate MySql", + "operation": "Get Web Apps Slots Migrate MySql", + "description": "Get Web Apps Slots Migrate MySql." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Diagnostic setting for Web App", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource" + }, + "origin": "system" + }, + { + "name": "microsoft.web/sites/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Diagnostic setting for Web App", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource" + }, + "origin": "system" + }, + { + "name": "microsoft.web/sites/slots/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Diagnostic setting for Web App slot", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource" + }, + "origin": "system" + }, + { + "name": "microsoft.web/sites/slots/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Diagnostic setting for Web App slot", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource" + }, + "origin": "system" + }, + { + "name": "microsoft.web/serverfarms/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Diagnostic setting for App Service plan", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource" + }, + "origin": "system" + }, + { + "name": "microsoft.web/serverfarms/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Diagnostic setting for App Service plan", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource" + }, + "origin": "system" + }, + { + "name": "microsoft.web/hostingenvironments/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Diagnostic setting for App Service Environment", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource" + }, + "origin": "system" + }, + { + "name": "microsoft.web/hostingenvironments/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Diagnostic setting for App Service Environment", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource" + }, + "origin": "system" + }, + { + "name": "microsoft.web/billingmeters/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Billing meters for Microsoft Web Apps", + "operation": "Read billing meters", + "description": "Get list of billing meters." + }, + "origin": "system" + }, + { + "name": "microsoft.web/sites/slots/instances/processes/delete", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Instances Processes", + "operation": "Delete Web Apps Slots Instances Processes", + "description": "Delete Web Apps Slots Instances Processes." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/restore/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps", + "operation": "Restore Web Apps", + "description": "Restore Web Apps." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/instances/extensions/log/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Instances Extensions Log", + "operation": "Get Web Apps Instances Extensions Log", + "description": "Get Web Apps Instances Extensions Log." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/customapis/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Custom APIs", + "operation": "Update Custom APIs", + "description": "Update Custom APIs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/customapis/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Custom APIs", + "operation": "Get Custom APIs", + "description": "Get Custom APIs." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/diagnostics/failedrequestsperuri/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Diagnostics Failed Requests Per Uri", + "operation": "Get Web Apps Diagnostics Failed Requests Per Uri", + "description": "Get Web Apps Diagnostics Failed Requests Per Uri." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/restore/write", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots", + "operation": "Restore Web Apps Slots", + "description": "Restore Web Apps Slots." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/diagnostics/detectors/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Diagnostics Detector", + "operation": "Get Web Apps Diagnostics Detector", + "description": "Get Web Apps Diagnostics Detector." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/diagnostics/analyses/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Diagnostics Analysis", + "operation": "Get Web Apps Diagnostics Analysis", + "description": "Get Web Apps Diagnostics Analysis." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/diagnostics/analyses/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Diagnostics Analysis", + "operation": "Get Web Apps Slots Diagnostics Analysis", + "description": "Get Web Apps Slots Diagnostics Analysis." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/diagnostics/detectors/read", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Diagnostics Detector", + "operation": "Get Web Apps Slots Diagnostics Detector", + "description": "Get Web Apps Slots Diagnostics Detector." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/diagnostics/analyses/execute/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Diagnostics Analysis", + "operation": "Run Web Apps Diagnostics Analysis", + "description": "Run Web Apps Diagnostics Analysis." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/diagnostics/detectors/execute/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Diagnostics Detector", + "operation": "Run Web Apps Diagnostics Detector", + "description": "Run Web Apps Diagnostics Detector." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/diagnostics/analyses/execute/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Diagnostics Analysis", + "operation": "Run Web Apps Slots Diagnostics Analysis", + "description": "Run Web Apps Slots Diagnostics Analysis." + }, + "origin": "user,system" + }, + { + "name": "microsoft.web/sites/slots/diagnostics/detectors/execute/Action", + "display": { + "provider": "Microsoft Web Apps", + "resource": "Web Apps Slots Diagnostics Detector", + "operation": "Run Web Apps Slots Diagnostics Detector", + "description": "Run Web Apps Slots Diagnostics Detector." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Web/serverfarms/providers/Microsoft.Insights/metricDefinitions/Read", + "display": { + "provider": "Microsoft.Web", + "resource": "The metric definition of App Service Plan", + "operation": "Read App Service Plan metric definitions", + "description": "Gets the available metrics for App Service Plan" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "CpuPercentage", + "displayName": "CPU Percentage", + "displayDescription": "CPU Percentage", + "unit": "Percent", + "aggregationType": "Average", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "MemoryPercentage", + "displayName": "Memory Percentage", + "displayDescription": "Memory Percentage", + "unit": "Percent", + "aggregationType": "Average", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "DiskQueueLength", + "displayName": "Disk Queue Length", + "displayDescription": "Disk Queue Length", + "unit": "Count", + "aggregationType": "Average", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "HttpQueueLength", + "displayName": "Http Queue Length", + "displayDescription": "Http Queue Length", + "unit": "Count", + "aggregationType": "Average", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "BytesReceived", + "displayName": "Data In", + "displayDescription": "Data In", + "unit": "Bytes", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "BytesSent", + "displayName": "Data Out", + "displayDescription": "Data Out", + "unit": "Bytes", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + } + ] + } + } + }, + { + "name": "Microsoft.Web/sites/providers/Microsoft.Insights/metricDefinitions/Read", + "display": { + "provider": "Microsoft.Web", + "resource": "The metric definition of Web App", + "operation": "Read Web App metric definitions", + "description": "Gets the available metrics for Web App" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "CpuTime", + "displayName": "CPU Time", + "displayDescription": "CPU Time", + "unit": "Seconds", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Requests", + "displayName": "Requests", + "displayDescription": "Requests", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "BytesReceived", + "displayName": "Data In", + "displayDescription": "Data In", + "unit": "Bytes", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "BytesSent", + "displayName": "Data Out", + "displayDescription": "Data Out", + "unit": "Bytes", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http101", + "displayName": "Http 101", + "displayDescription": "Http 101", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http2xx", + "displayName": "Http 2xx", + "displayDescription": "Http 2xx", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http3xx", + "displayName": "Http 3xx", + "displayDescription": "Http 3xx", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http401", + "displayName": "Http 401", + "displayDescription": "Http 401", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http403", + "displayName": "Http 403", + "displayDescription": "Http 403", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http404", + "displayName": "Http 404", + "displayDescription": "Http 404", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http406", + "displayName": "Http 406", + "displayDescription": "Http 406", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http4xx", + "displayName": "Http 4xx", + "displayDescription": "Http 4xx", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http5xx", + "displayName": "Http Server Errors", + "displayDescription": "Http Server Errors", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "MemoryWorkingSet", + "displayName": "Memory working set", + "displayDescription": "Memory working set", + "unit": "Bytes", + "aggregationType": "Average", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "AverageMemoryWorkingSet", + "displayName": "Average memory working set", + "displayDescription": "Average memory working set", + "unit": "Bytes", + "aggregationType": "Average", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "AverageResponseTime", + "displayName": "Average Response Time", + "displayDescription": "Average Response Time", + "unit": "Seconds", + "aggregationType": "Average", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "FunctionExecutionUnits", + "displayName": "Function Execution Units", + "displayDescription": "Function Execution Units", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "(?i:functionapp)", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "FunctionExecutionCount", + "displayName": "Function Execution Count", + "displayDescription": "Function Execution Count", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "(?i:functionapp)", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + } + ] + } + } + }, + { + "name": "Microsoft.Web/sites/slots/providers/Microsoft.Insights/metricDefinitions/Read", + "display": { + "provider": "Microsoft.Web", + "resource": "The metric definition of Web App Slot", + "operation": "Read Web App Slot metric definitions", + "description": "Gets the available metrics for Web App Slot" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "CpuTime", + "displayName": "CPU Time", + "displayDescription": "CPU Time", + "unit": "Seconds", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Requests", + "displayName": "Requests", + "displayDescription": "Requests", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "BytesReceived", + "displayName": "Data In", + "displayDescription": "Data In", + "unit": "Bytes", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "BytesSent", + "displayName": "Data Out", + "displayDescription": "Data Out", + "unit": "Bytes", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http101", + "displayName": "Http 101", + "displayDescription": "Http 101", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http2xx", + "displayName": "Http 2xx", + "displayDescription": "Http 2xx", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http3xx", + "displayName": "Http 3xx", + "displayDescription": "Http 3xx", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http401", + "displayName": "Http 401", + "displayDescription": "Http 401", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http403", + "displayName": "Http 403", + "displayDescription": "Http 403", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http404", + "displayName": "Http 404", + "displayDescription": "Http 404", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http406", + "displayName": "Http 406", + "displayDescription": "Http 406", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http4xx", + "displayName": "Http 4xx", + "displayDescription": "Http 4xx", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http5xx", + "displayName": "Http Server Errors", + "displayDescription": "Http Server Errors", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "MemoryWorkingSet", + "displayName": "Memory working set", + "displayDescription": "Memory working set", + "unit": "Bytes", + "aggregationType": "Average", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "AverageMemoryWorkingSet", + "displayName": "Average memory working set", + "displayDescription": "Average memory working set", + "unit": "Bytes", + "aggregationType": "Average", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "AverageResponseTime", + "displayName": "Average Response Time", + "displayDescription": "Average Response Time", + "unit": "Seconds", + "aggregationType": "Average", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^(?!functionapp).*$", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "FunctionExecutionUnits", + "displayName": "Function Execution Units", + "displayDescription": "Function Execution Units", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "(?i:functionapp)", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "FunctionExecutionCount", + "displayName": "Function Execution Count", + "displayDescription": "Function Execution Count", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "metricFilterPattern": "(?i:functionapp)", + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + } + ] + } + } + }, + { + "name": "Microsoft.Web/hostingEnvironments/multiRolePools/providers/Microsoft.Insights/metricDefinitions/Read", + "display": { + "provider": "Microsoft.Web", + "resource": "The metric definition of App Service Environment MultiRole", + "operation": "Read App Service Environment MultiRole metric definitions", + "description": "Gets the available metrics for App Service Environment MultiRole" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "Requests", + "displayName": "Requests", + "displayDescription": "Requests", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "BytesReceived", + "displayName": "Data In", + "displayDescription": "Data In", + "unit": "Bytes", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "BytesSent", + "displayName": "Data Out", + "displayDescription": "Data Out", + "unit": "Bytes", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http101", + "displayName": "Http 101", + "displayDescription": "Http 101", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http2xx", + "displayName": "Http 2xx", + "displayDescription": "Http 2xx", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http3xx", + "displayName": "Http 3xx", + "displayDescription": "Http 3xx", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http401", + "displayName": "Http 401", + "displayDescription": "Http 401", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http403", + "displayName": "Http 403", + "displayDescription": "Http 403", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http404", + "displayName": "Http 404", + "displayDescription": "Http 404", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http406", + "displayName": "Http 406", + "displayDescription": "Http 406", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http4xx", + "displayName": "Http 4xx", + "displayDescription": "Http 4xx", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "Http5xx", + "displayName": "Http Server Errors", + "displayDescription": "Http Server Errors", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "AverageResponseTime", + "displayName": "Average Response Time", + "displayDescription": "Average Response Time", + "unit": "Seconds", + "aggregationType": "Average", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "CpuPercentage", + "displayName": "CPU Percentage", + "displayDescription": "CPU Percentage", + "unit": "Percent", + "aggregationType": "Average", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "MemoryPercentage", + "displayName": "Memory Percentage", + "displayDescription": "Memory Percentage", + "unit": "Percent", + "aggregationType": "Average", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "DiskQueueLength", + "displayName": "Disk Queue Length", + "displayDescription": "Disk Queue Length", + "unit": "Count", + "aggregationType": "Average", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "HttpQueueLength", + "displayName": "Http Queue Length", + "displayDescription": "Http Queue Length", + "unit": "Count", + "aggregationType": "Average", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "ActiveRequests", + "displayName": "Active Requests", + "displayDescription": "Active Requests", + "unit": "Count", + "aggregationType": "Total", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "dimensions": [ + { + "name": "Instance", + "displayName": "Instance", + "internalName": "ServerName", + "toBeExportedForShoebox": true + } + ], + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "TotalFrontEnds", + "displayName": "Total Front Ends", + "displayDescription": "Total Front Ends", + "unit": "Count", + "aggregationType": "Average", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "SmallAppServicePlanInstances", + "displayName": "Small App Service Plan Workers", + "displayDescription": "Small App Service Plan Workers", + "unit": "Count", + "aggregationType": "Average", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "MediumAppServicePlanInstances", + "displayName": "Medium App Service Plan Workers", + "displayDescription": "Medium App Service Plan Workers", + "unit": "Count", + "aggregationType": "Average", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "LargeAppServicePlanInstances", + "displayName": "Large App Service Plan Workers", + "displayDescription": "Large App Service Plan Workers", + "unit": "Count", + "aggregationType": "Average", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + } + ] + } + } + }, + { + "name": "Microsoft.Web/hostingEnvironments/workerPools/providers/Microsoft.Insights/metricDefinitions/Read", + "display": { + "provider": "Microsoft.Web", + "resource": "The metric definition of App Service Environment WorkerPool", + "operation": "Read App Service Environment WorkerPool metric definitions", + "description": "Gets the available metrics for App Service Environment WorkerPool" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "WorkersTotal", + "displayName": "Total Workers", + "displayDescription": "Total Workers", + "unit": "Count", + "aggregationType": "Average", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "WorkersAvailable", + "displayName": "Available Workers", + "displayDescription": "Available Workers", + "unit": "Count", + "aggregationType": "Average", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + }, + { + "name": "WorkersUsed", + "displayName": "Used Workers", + "displayDescription": "Used Workers", + "unit": "Count", + "aggregationType": "Average", + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false, + "fillGapWithZero": true, + "isInternal": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P2D" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P30D" + }, + { + "timeGrain": "P1D", + "blobDuration": "P90D" + } + ] + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListPublishingCredentialsPolicies.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListPublishingCredentialsPolicies.json new file mode 100644 index 000000000000..8d55c529835d --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListPublishingCredentialsPolicies.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "3fb8d758-2e2c-42e9-a528-a8acdfe87237", + "resourceGroupName": "testrg123", + "name": "testsite", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/3fb8d758-2e2c-42e9-a528-a8acdfe87237/resourceGroups/testrg123/providers/Microsoft.Web/sites/testsite/basicPublishingCredentialsPolicies/ftp", + "name": "ftp", + "type": "Microsoft.Web/sites/basicPublishingCredentialsPolicies", + "properties": { + "allow": true + } + }, + { + "id": "/subscriptions/3fb8d758-2e2c-42e9-a528-a8acdfe87237/resourceGroups/testrg123/providers/Microsoft.Web/sites/testsite/basicPublishingCredentialsPolicies/scm", + "name": "scm", + "type": "Microsoft.Web/sites/basicPublishingCredentialsPolicies", + "properties": { + "allow": true + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListPublishingCredentialsPoliciesSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListPublishingCredentialsPoliciesSlot.json new file mode 100644 index 000000000000..3e383cf43fdf --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListPublishingCredentialsPoliciesSlot.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "3fb8d758-2e2c-42e9-a528-a8acdfe87237", + "resourceGroupName": "testrg123", + "name": "testsite", + "slot": "staging", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/3fb8d758-2e2c-42e9-a528-a8acdfe87237/resourceGroups/testrg123/providers/Microsoft.Web/sites/testsite/slots/staging/basicPublishingCredentialsPolicies/ftp", + "name": "ftp", + "type": "Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies", + "properties": { + "allow": true + } + }, + { + "id": "/subscriptions/3fb8d758-2e2c-42e9-a528-a8acdfe87237/resourceGroups/testrg123/providers/Microsoft.Web/sites/testsite/slots/staging/basicPublishingCredentialsPolicies/scm", + "name": "scm", + "type": "Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies", + "properties": { + "allow": true + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListResourceHealthMetadataByResourceGroup.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListResourceHealthMetadataByResourceGroup.json new file mode 100644 index 000000000000..cfd901dc1188 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListResourceHealthMetadataByResourceGroup.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceGroupName": "Default-Web-NorthCentralUS", + "subscriptionId": "4adb32ad-8327-4cbb-b775-b84b4465bb38" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "category": "Shared", + "signalAvailability": true + }, + "id": "/subscriptions/4adb32ad-8327-4cbb-b775-b84b4465bb38/resourceGroups/Default-Web-NorthCentralUS/providers/Microsoft.Web/sites/newsiteinnewASE-NCUS/resourceHealthMetadata/default", + "name": "default", + "type": "Microsoft.Web/sites/resourceHealthMetadata" + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListResourceHealthMetadataBySite.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListResourceHealthMetadataBySite.json new file mode 100644 index 000000000000..115694787513 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListResourceHealthMetadataBySite.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "name": "newsiteinnewASE-NCUS", + "slot": "Production", + "resourceGroupName": "Default-Web-NorthCentralUS", + "subscriptionId": "4adb32ad-8327-4cbb-b775-b84b4465bb38" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "category": "Shared", + "signalAvailability": true + }, + "id": "/subscriptions/4adb32ad-8327-4cbb-b775-b84b4465bb38/resourceGroups/Default-Web-NorthCentralUS/providers/Microsoft.Web/sites/newsiteinnewASE-NCUS/resourceHealthMetadata/default", + "name": "default", + "type": "Microsoft.Web/sites/resourceHealthMetadata" + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListResourceHealthMetadataBySubscription.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListResourceHealthMetadataBySubscription.json new file mode 100644 index 000000000000..0ae6ab3ab6ba --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListResourceHealthMetadataBySubscription.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "4adb32ad-8327-4cbb-b775-b84b4465bb38" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "category": "Shared", + "signalAvailability": true + }, + "id": "/subscriptions/4adb32ad-8327-4cbb-b775-b84b4465bb38/resourceGroups/Default-Web-NorthCentralUS/providers/Microsoft.Web/sites/newsiteinnewASE-NCUS/resourceHealthMetadata/default", + "name": "default", + "type": "Microsoft.Web/sites/resourceHealthMetadata" + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListRevisions.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListRevisions.json new file mode 100644 index 000000000000..1c789cf4237e --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListRevisions.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/containerApps/testcontainerApp0/revisions/testcontainerApp0-pjxhsye", + "name": "testcontainerApp0-pjxhsye", + "type": "Microsoft.Web/containerApps/revisions", + "location": "East US", + "properties": { + "createdTime": "2021-05-24T21:24:22+00:00", + "fqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerapps.k4apps.io", + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v2", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + }, + "dapr": { + "enabled": true, + "appPort": 3000 + } + }, + "active": true, + "replicas": 1 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListSiteDeploymentStatus.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListSiteDeploymentStatus.json new file mode 100644 index 000000000000..1a83f2fb928e --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListSiteDeploymentStatus.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testSite", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListSiteDeploymentStatusSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListSiteDeploymentStatusSlot.json new file mode 100644 index 000000000000..88751fbd2a54 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListSiteDeploymentStatusSlot.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testSite", + "slot": "stage", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListSlotBackups.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListSlotBackups.json new file mode 100644 index 000000000000..cc9458747b3a --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListSlotBackups.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "tests346", + "slot": "staging", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/tests346/slot/staging", + "name": "tests346/staging", + "type": "Microsoft.Web/sites/slots", + "properties": { + "storageAccountUrl": "https://blobstorage.windows.net", + "blobName": "blob1", + "status": "InProgress" + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteAppSettings.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteAppSettings.json new file mode 100644 index 000000000000..270d6e503531 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteAppSettings.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/appSettings", + "properties": { + "setting0": "someVal" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteBasicAuth.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteBasicAuth.json new file mode 100644 index 000000000000..89a7439f4a79 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteBasicAuth.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/basicAuth/default", + "name": "default", + "properties": { + "environments": null, + "secretUrl": null, + "applicableEnvironmentsMode": "AllEnvironments", + "secretState": "Password" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteBuildAppSettings.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteBuildAppSettings.json new file mode 100644 index 000000000000..fb0626d9a705 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteBuildAppSettings.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "environmentName": "12", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/12/config/appSettings", + "properties": { + "setting0": "someVal" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteBuildFunctionAppSettings.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteBuildFunctionAppSettings.json new file mode 100644 index 000000000000..fb0626d9a705 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteBuildFunctionAppSettings.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "environmentName": "12", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/12/config/appSettings", + "properties": { + "setting0": "someVal" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteBuildFunctions.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteBuildFunctions.json new file mode 100644 index 000000000000..a722ea5eeff7 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteBuildFunctions.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "environmentName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/functions/GetList", + "properties": { + "functionName": "GetList", + "triggerType": "HttpTrigger" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteConfiguredRoles.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteConfiguredRoles.json new file mode 100644 index 000000000000..43e86dea2157 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteConfiguredRoles.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": [ + "authenticated", + "anonymous", + "customRole1" + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteFunctionAppSettings.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteFunctionAppSettings.json new file mode 100644 index 000000000000..450fe56e4049 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteFunctionAppSettings.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/config/appsettings", + "properties": { + "setting0": "someVal" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteFunctions.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteFunctions.json new file mode 100644 index 000000000000..c629d2cead9b --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteFunctions.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/functions/GetList", + "properties": { + "functionName": "GetList", + "triggerType": "HttpTrigger" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteSecrets.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteSecrets.json new file mode 100644 index 000000000000..2eca11dd1f54 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteSecrets.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "dnsOwnershipKey": "ownershipKey123123" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteUsers.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteUsers.json new file mode 100644 index 000000000000..02ac287ef758 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListStaticSiteUsers.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "authprovider": "all", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/authproviders/all/users/1234", + "properties": { + "provider": "aad", + "userId": "1234", + "displayName": "username", + "roles": "admin,anonymous,authenticated" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebAppBackups.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebAppBackups.json new file mode 100644 index 000000000000..44e95c31be67 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebAppBackups.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/backups/12345", + "name": "sitef6141", + "type": "Microsoft.Web/sites", + "properties": { + "id": 12345, + "storageAccountUrl": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "blobName": "sitef6141_2024-04-01", + "name": "sitef6141_2024-04-01", + "status": "InProgress", + "sizeInBytes": 56091883, + "created": "2022-09-03T17:33:11.641Z", + "log": "Succeeded", + "databases": [ + { + "databaseType": "SqlAzure", + "name": "backenddb", + "connectionStringName": "backend", + "connectionString": "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;=]" + }, + { + "databaseType": "SqlAzure", + "name": "statsdb", + "connectionStringName": "stats", + "connectionString": "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;=]" + } + ], + "scheduled": true, + "lastRestoreTimeStamp": "2022-09-04T17:33:11.641Z", + "finishedTimeStamp": "2022-09-05T17:33:11.641Z", + "websiteSizeInBytes": 56091883 + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebAppConfigurations.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebAppConfigurations.json new file mode 100644 index 000000000000..f87b86b117b2 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebAppConfigurations.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/web", + "name": "web", + "type": "Microsoft.Web/sites/config", + "kind": "app", + "properties": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php", + "hostingstart.html" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebAppSlots.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebAppSlots.json new file mode 100644 index 000000000000..2c761c082df8 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebAppSlots.json @@ -0,0 +1,233 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/slots/staging", + "name": "sitef6141/staging", + "type": "Microsoft.Web/sites/slots", + "kind": "app", + "location": "East US", + "properties": { + "state": "Running", + "hostNames": [ + "sitef6141-staging.azurewebsites.net" + ], + "repositorySiteName": "sitef6141", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "sitef6141-staging.azurewebsites.net", + "sitef6141-staging.scm.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "sitef6141-staging.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "sitef6141-staging.scm.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp", + "reserved": false, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2020-03-04T17:33:11.641Z", + "vnetRouteAllEnabled": false, + "vnetImagePullEnabled": false, + "vnetContentShareEnabled": false, + "siteConfig": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php", + "hostingstart.html" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + }, + "scmSiteAlsoStopped": false, + "clientAffinityEnabled": true, + "clientCertEnabled": false, + "clientCertMode": "Required", + "hostNamesDisabled": false, + "customDomainVerificationId": "7F3BB652450EF7AD0B6AA33064586E4A9CE823A46DF0B2EC6443A68086E84153", + "outboundIpAddresses": "70.37.102.201,20.225.43.144", + "possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188", + "containerSize": 0, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "testrg123", + "defaultHostName": "sitef6141-staging.azurewebsites.net", + "httpsOnly": false, + "redundancyMode": "None", + "storageAccountRequired": false, + "keyVaultReferenceIdentity": "SystemAssigned" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/slots/qa", + "name": "sitef6141/qa", + "type": "Microsoft.Web/sites/slots", + "kind": "app", + "location": "East US", + "properties": { + "state": "Running", + "hostNames": [ + "sitef6141-qa.azurewebsites.net" + ], + "repositorySiteName": "sitef6141", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "sitef6141-staging.azurewebsites.net", + "sitef6141-staging.scm.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "sitef6141-qa.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "sitef6141-qa.scm.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp", + "reserved": false, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2020-03-04T17:33:11.641Z", + "vnetRouteAllEnabled": false, + "vnetImagePullEnabled": false, + "vnetContentShareEnabled": false, + "siteConfig": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php", + "hostingstart.html" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + }, + "scmSiteAlsoStopped": false, + "clientAffinityEnabled": true, + "clientCertEnabled": false, + "clientCertMode": "Required", + "hostNamesDisabled": false, + "customDomainVerificationId": "7F3BB652450EF7AD0B6AA33064586E4A9CE823A46DF0B2EC6443A68086E84153", + "outboundIpAddresses": "70.37.102.201,20.225.43.144", + "possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188", + "containerSize": 0, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "testrg123", + "defaultHostName": "sitef6141-qa.azurewebsites.net", + "httpsOnly": false, + "redundancyMode": "None", + "storageAccountRequired": false, + "keyVaultReferenceIdentity": "SystemAssigned" + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebApps.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebApps.json new file mode 100644 index 000000000000..2ec9b224d173 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebApps.json @@ -0,0 +1,241 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141", + "name": "sitef6141", + "type": "Microsoft.Web/sites", + "kind": "app", + "location": "East US", + "properties": { + "state": "Running", + "hostNames": [ + "sitef6141.azurewebsites.net" + ], + "repositorySiteName": "sitef6141", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "sitef6141.azurewebsites.net", + "sitef6141.scm.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "sitef6141.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "sitef6141.scm.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp", + "reserved": false, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2020-03-04T17:33:11.641Z", + "vnetRouteAllEnabled": false, + "vnetImagePullEnabled": false, + "vnetContentShareEnabled": false, + "siteConfig": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php", + "hostingstart.html" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + }, + "scmSiteAlsoStopped": false, + "clientAffinityEnabled": true, + "clientCertEnabled": false, + "clientCertMode": "Required", + "hostNamesDisabled": false, + "customDomainVerificationId": "7F3BB652450EF7AD0B6AA33064586E4A9CE823A46DF0B2EC6443A68086E84153", + "outboundIpAddresses": "70.37.102.201,20.225.43.144", + "possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188", + "containerSize": 0, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "testrg123", + "defaultHostName": "sitef6141.azurewebsites.net", + "httpsOnly": false, + "redundancyMode": "None", + "storageAccountRequired": false, + "keyVaultReferenceIdentity": "SystemAssigned", + "workloadProfileName": "myd4wp", + "resourceConfig": { + "cpu": 1.0, + "memory": "2.0Gi" + } + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef7252", + "name": "sitef7252", + "type": "Microsoft.Web/sites", + "kind": "app", + "location": "East US", + "properties": { + "state": "Running", + "hostNames": [ + "sitef7252.azurewebsites.net" + ], + "repositorySiteName": "sitef7252", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "sitef7252.azurewebsites.net", + "sitef7252.scm.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "sitef7252.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "sitef7252.scm.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp", + "reserved": false, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2020-03-04T17:33:11.641Z", + "vnetRouteAllEnabled": false, + "vnetImagePullEnabled": false, + "vnetContentShareEnabled": false, + "siteConfig": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php", + "hostingstart.html" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + }, + "scmSiteAlsoStopped": false, + "clientAffinityEnabled": true, + "clientCertEnabled": false, + "clientCertMode": "Required", + "hostNamesDisabled": false, + "customDomainVerificationId": "7F3BB652450EF7AD0B6AA33064586E4A9CE823A46DF0B2EC6443A68086E84153", + "outboundIpAddresses": "70.37.102.201,20.225.43.144", + "possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188", + "containerSize": 0, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "testrg123", + "defaultHostName": "sitef7252.azurewebsites.net", + "httpsOnly": false, + "redundancyMode": "None", + "storageAccountRequired": false, + "keyVaultReferenceIdentity": "SystemAssigned", + "workloadProfileName": "myd4wp", + "resourceConfig": { + "cpu": 1.0, + "memory": "2.0Gi" + } + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebAppsByResourceGroup.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebAppsByResourceGroup.json new file mode 100644 index 000000000000..a69e51c805da --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebAppsByResourceGroup.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141", + "name": "sitef6141", + "type": "Microsoft.Web/sites", + "kind": "app", + "location": "East US", + "properties": { + "state": "Running", + "hostNames": [ + "sitef6141.azurewebsites.net" + ], + "repositorySiteName": "sitef6141", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "sitef6141.azurewebsites.net", + "sitef6141.scm.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "sitef6141.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "sitef6141.scm.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp", + "reserved": false, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2020-03-04T17:33:11.641Z", + "vnetRouteAllEnabled": false, + "vnetImagePullEnabled": false, + "vnetContentShareEnabled": false, + "siteConfig": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php", + "hostingstart.html" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + }, + "scmSiteAlsoStopped": false, + "clientAffinityEnabled": true, + "clientCertEnabled": false, + "clientCertMode": "Required", + "hostNamesDisabled": false, + "customDomainVerificationId": "7F3BB652450EF7AD0B6AA33064586E4A9CE823A46DF0B2EC6443A68086E84153", + "outboundIpAddresses": "70.37.102.201,20.225.43.144", + "possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188", + "containerSize": 0, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "testrg123", + "defaultHostName": "sitef6141.azurewebsites.net", + "httpsOnly": false, + "redundancyMode": "None", + "storageAccountRequired": false, + "keyVaultReferenceIdentity": "SystemAssigned", + "workloadProfileName": "myd4wp", + "resourceConfig": { + "cpu": 1.0, + "memory": "2.0Gi" + } + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef7252", + "name": "sitef7252", + "type": "Microsoft.Web/sites", + "kind": "app", + "location": "East US", + "properties": { + "state": "Running", + "hostNames": [ + "sitef7252.azurewebsites.net" + ], + "repositorySiteName": "sitef7252", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "sitef7252.azurewebsites.net", + "sitef7252.scm.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "sitef7252.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "sitef7252.scm.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp", + "reserved": false, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2020-03-04T17:33:11.641Z", + "vnetRouteAllEnabled": false, + "vnetImagePullEnabled": false, + "vnetContentShareEnabled": false, + "siteConfig": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php", + "hostingstart.html" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + }, + "scmSiteAlsoStopped": false, + "clientAffinityEnabled": true, + "clientCertEnabled": false, + "clientCertMode": "Required", + "hostNamesDisabled": false, + "customDomainVerificationId": "7F3BB652450EF7AD0B6AA33064586E4A9CE823A46DF0B2EC6443A68086E84153", + "outboundIpAddresses": "70.37.102.201,20.225.43.144", + "possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188", + "containerSize": 0, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "testrg123", + "defaultHostName": "sitef7252.azurewebsites.net", + "httpsOnly": false, + "redundancyMode": "None", + "storageAccountRequired": false, + "keyVaultReferenceIdentity": "SystemAssigned", + "workloadProfileName": "myd4wp", + "resourceConfig": { + "cpu": 1.0, + "memory": "2.0Gi" + } + } + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWorkflows.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWorkflows.json new file mode 100644 index 000000000000..62fe465206ff --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWorkflows.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "testsite2", + "slot": "staging", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testsite2/workflows/a1", + "name": "testsite2/a1", + "type": "Microsoft.Web/sites/workflows", + "location": "USAAnywhere", + "kind": "Stateful", + "properties": { + "flowState": "Enabled", + "health": { + "state": "Healthy" + } + } + }, + { + "id": "/subscriptions/testsub/resourceGroups/testrg/providers/Microsoft.Web/sites/testsite2/workflows/stateful2", + "name": "testsite2/stateful2", + "type": "Microsoft.Web/sites/workflows", + "location": "USAAnywhere", + "kind": "Stateful", + "properties": { + "flowState": "Enabled", + "health": { + "state": "Unhealthy", + "error": { + "code": "InvalidWorkflowJson", + "message": "Invalid character after parsing property name. Expected ':' but got: \". Path '', line 2, position 2." + } + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWorkflowsConfigurationConnections.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWorkflowsConfigurationConnections.json new file mode 100644 index 000000000000..12daa7190a01 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWorkflowsConfigurationConnections.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "testsite2", + "slot": "staging", + "configurationName": "connections", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testsite2/workflowconfigurations/connections", + "name": "testsite2/connections", + "type": "Microsoft.Web/sites/workflowsconfiguration", + "location": "USAAnywhere", + "properties": { + "files": { + "connections.json": { + "managedApiConnections": { + "office365": { + "api": { + "id": "string" + }, + "connection": { + "id": "string" + }, + "connectionRuntimeUrl": "string", + "authentication": { + "type": "Raw", + "scheme": "Key", + "parameter": "@appsetting('office365-connectionKey')" + } + } + } + } + }, + "health": { + "state": "Healthy" + } + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PatchAppServicePlan.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PatchAppServicePlan.json new file mode 100644 index 000000000000..83637fde7016 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PatchAppServicePlan.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "testsf6141", + "api-version": "2024-04-01", + "appServicePlan": { + "kind": "app", + "properties": {} + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141", + "name": "testsf6141", + "type": "Microsoft.Web/serverfarms", + "kind": "app", + "location": "East US", + "properties": { + "status": "Ready", + "maximumNumberOfWorkers": 20, + "geoRegion": "East US", + "numberOfSites": 4, + "reserved": false, + "targetWorkerCount": 0, + "targetWorkerSizeId": 0, + "provisioningState": "Succeeded" + }, + "sku": { + "name": "P1", + "tier": "Premium", + "size": "P1", + "family": "P", + "capacity": 1 + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141/operationresults/F0C6B8EC-0D53-432C-913B-1CD9E8CDE3A0", + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141/operationresults/F0C6B8EC-0D53-432C-913B-1CD9E8CDE3A0" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141", + "name": "testsf6141", + "type": "Microsoft.Web/serverfarms", + "kind": "app", + "location": "East US", + "properties": { + "status": "Ready", + "maximumNumberOfWorkers": 20, + "geoRegion": "East US", + "numberOfSites": 4, + "isSpot": false, + "reserved": false, + "targetWorkerCount": 0, + "targetWorkerSizeId": 0, + "provisioningState": "Succeeded" + }, + "sku": { + "name": "P1", + "tier": "Premium", + "size": "P1", + "family": "P", + "capacity": 1 + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PatchCertificate.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PatchCertificate.json new file mode 100644 index 000000000000..6b8f722d7358 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PatchCertificate.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "testc6282", + "api-version": "2024-04-01", + "certificateEnvelope": { + "properties": { + "password": "" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/certificates/testc6282", + "name": "testc6282", + "type": "Microsoft.Web/certificates", + "location": "East US", + "properties": { + "friendlyName": "", + "subjectName": "ServerCert", + "hostNames": [ + "ServerCert" + ], + "issuer": "CACert", + "issueDate": "2015-11-12T23:40:25+00:00", + "expirationDate": "2039-12-31T23:59:59+00:00", + "thumbprint": "FE703D7411A44163B6D32B3AD9B03E175886EBFE" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PatchStaticSite.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PatchStaticSite.json new file mode 100644 index 000000000000..228efe08622e --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PatchStaticSite.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "api-version": "2024-04-01", + "staticSiteEnvelope": { + "properties": {} + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0", + "name": "testStaticSite0", + "type": "Microsoft.Web/staticSites", + "location": "West US 2", + "properties": { + "defaultHostname": "happy-sea-15afae3e.azurestaticwebsites.net", + "repositoryUrl": "https://github.com/username/RepoName", + "branch": "demo", + "customDomains": [], + "privateEndpointConnections": [], + "contentDistributionEndpoint": "", + "keyVaultReferenceIdentity": "SystemAssigned", + "userProvidedFunctionApps": [], + "stagingEnvironmentPolicy": "Enabled", + "allowConfigFileUpdates": true + }, + "sku": { + "name": "Basic", + "tier": "Basic" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus2/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2019-01-01" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0", + "name": "testStaticSite0", + "type": "Microsoft.Web/staticSites", + "location": "West US 2", + "properties": { + "defaultHostname": "happy-sea-15afae3e.azurestaticwebsites.net", + "repositoryUrl": "https://github.com/username/RepoName", + "branch": "demo", + "customDomains": [], + "privateEndpointConnections": [], + "contentDistributionEndpoint": "", + "keyVaultReferenceIdentity": "SystemAssigned", + "userProvidedFunctionApps": [], + "stagingEnvironmentPolicy": "Enabled", + "allowConfigFileUpdates": true + }, + "sku": { + "name": "Basic", + "tier": "Basic" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PatchStaticSiteBuildDatabaseConnection.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PatchStaticSiteBuildDatabaseConnection.json new file mode 100644 index 000000000000..ed3db9ccef69 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PatchStaticSiteBuildDatabaseConnection.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "environmentName": "default", + "databaseConnectionName": "default", + "api-version": "2024-04-01", + "databaseConnectionRequestEnvelope": { + "properties": {} + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/databaseConnections/default", + "name": "default", + "type": "Microsoft.Web/staticSites/builds/databaseConnections", + "properties": { + "resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName", + "connectionIdentity": "SystemAssigned", + "region": "West US 2" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PatchStaticSiteDatabaseConnection.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PatchStaticSiteDatabaseConnection.json new file mode 100644 index 000000000000..99c4199cdc8e --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PatchStaticSiteDatabaseConnection.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "databaseConnectionName": "default", + "api-version": "2024-04-01", + "databaseConnectionRequestEnvelope": { + "properties": {} + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/databaseConnections/default", + "name": "default", + "type": "Microsoft.Web/staticSites/databaseConnections", + "properties": { + "resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName", + "connectionIdentity": "SystemAssigned", + "region": "West US 2" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PostDeployWorkflowArtifacts.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PostDeployWorkflowArtifacts.json new file mode 100644 index 000000000000..d169a997a1f7 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PostDeployWorkflowArtifacts.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "testsite2", + "api-version": "2024-04-01", + "workflowArtifacts": { + "files": { + "test1/workflow.json": { + "definition": { + "$schema": "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#", + "actions": {}, + "contentVersion": "1.0.0.0", + "outputs": {}, + "triggers": { + "When_events_are_available_in_Event_hub": { + "inputs": { + "parameters": { + "eventHubName": "test123" + }, + "serviceProviderConfiguration": { + "connectionName": "eventHub", + "operationId": "receiveEvents", + "serviceProviderId": "/serviceProviders/eventHub" + } + }, + "splitOn": "@triggerOutputs()?['body']", + "type": "ServiceProvider" + } + } + }, + "kind": "Stateful" + }, + "connections.json": { + "serviceProviderConnections": { + "eventHub": { + "parameterValues": { + "connectionString": "@appsetting('eventHub_connectionString')" + }, + "serviceProvider": { + "id": "/serviceProviders/eventHub" + }, + "displayName": "example1" + } + }, + "managedApiConnections": {} + } + }, + "appSettings": { + "eventHub_connectionString": "Endpoint=sb://example.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=EXAMPLE1a2b3c4d5e6fEXAMPLE=" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PostDeployWorkflowArtifactsSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PostDeployWorkflowArtifactsSlot.json new file mode 100644 index 000000000000..65aef76cde35 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/PostDeployWorkflowArtifactsSlot.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "testsite2", + "slot": "testsSlot", + "api-version": "2024-04-01", + "workflowArtifacts": { + "files": { + "test1/workflow.json": { + "definition": { + "$schema": "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#", + "actions": {}, + "contentVersion": "1.0.0.0", + "outputs": {}, + "triggers": { + "When_events_are_available_in_Event_hub": { + "inputs": { + "parameters": { + "eventHubName": "test123" + }, + "serviceProviderConfiguration": { + "connectionName": "eventHub", + "operationId": "receiveEvents", + "serviceProviderId": "/serviceProviders/eventHub" + } + }, + "splitOn": "@triggerOutputs()?['body']", + "type": "ServiceProvider" + } + } + }, + "kind": "Stateful" + }, + "connections.json": { + "serviceProviderConnections": { + "eventHub": { + "parameterValues": { + "connectionString": "@appsetting('eventHub_connectionString')" + }, + "serviceProvider": { + "id": "/serviceProviders/eventHub" + }, + "displayName": "example1" + } + }, + "managedApiConnections": {} + } + }, + "appSettings": { + "eventHub_connectionString": "Endpoint=sb://example.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=EXAMPLE1a2b3c4d5e6fEXAMPLE=" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/RegisterUserProvidedFunctionAppWithStaticSite.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/RegisterUserProvidedFunctionAppWithStaticSite.json new file mode 100644 index 000000000000..64afe7fbafb9 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/RegisterUserProvidedFunctionAppWithStaticSite.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "functionAppName": "testFunctionApp", + "isForced": "true", + "api-version": "2024-04-01", + "staticSiteUserProvidedFunctionEnvelope": { + "properties": { + "functionAppResourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/functionRG/providers/Microsoft.Web/sites/testFunctionApp", + "functionAppRegion": "West US 2" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/userProvidedFunctionApps/testFunctionApp", + "name": "testFunctionApp", + "type": "Microsoft.Web/staticSites/builds/userProvidedFunctionApps", + "properties": { + "functionAppResourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/functionRG/providers/Microsoft.Web/sites/testFunctionApp", + "functionAppRegion": "West US 2", + "createdOn": "2020-03-04T17:33:11.641Z" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus2/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2019-01-01" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/userProvidedFunctionApps/testFunctionApp", + "name": "testFunctionApp", + "type": "Microsoft.Web/staticSites/builds/userProvidedFunctionApps", + "properties": { + "functionAppResourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/functionRG/providers/Microsoft.Web/sites/testFunctionApp", + "functionAppRegion": "West US 2", + "createdOn": "2020-03-04T17:33:11.641Z" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/RegisterUserProvidedFunctionAppWithStaticSiteBuild.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/RegisterUserProvidedFunctionAppWithStaticSiteBuild.json new file mode 100644 index 000000000000..218b125fb93b --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/RegisterUserProvidedFunctionAppWithStaticSiteBuild.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "environmentName": "default", + "functionAppName": "testFunctionApp", + "isForced": "true", + "api-version": "2024-04-01", + "staticSiteUserProvidedFunctionEnvelope": { + "properties": { + "functionAppResourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/functionRG/providers/Microsoft.Web/sites/testFunctionApp", + "functionAppRegion": "West US 2" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/userProvidedFunctionApps/testFunctionApp", + "name": "testFunctionApp", + "type": "Microsoft.Web/staticSites/builds/userProvidedFunctionApps", + "properties": { + "functionAppResourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/functionRG/providers/Microsoft.Web/sites/testFunctionApp", + "functionAppRegion": "West US 2", + "createdOn": "2020-03-04T17:33:11.641Z" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus2/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2019-01-01" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/userProvidedFunctionApps/testFunctionApp", + "name": "testFunctionApp", + "type": "Microsoft.Web/staticSites/builds/userProvidedFunctionApps", + "properties": { + "functionAppResourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/functionRG/providers/Microsoft.Web/sites/testFunctionApp", + "functionAppRegion": "West US 2", + "createdOn": "2020-03-04T17:33:11.641Z" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ResetStaticSiteApiKey.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ResetStaticSiteApiKey.json new file mode 100644 index 000000000000..ae72126f5422 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ResetStaticSiteApiKey.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "api-version": "2024-04-01", + "resetPropertiesEnvelope": { + "properties": { + "shouldUpdateRepository": true, + "repositoryToken": "repoToken123" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/RestartRevision.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/RestartRevision.json new file mode 100644 index 000000000000..053a9307993c --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/RestartRevision.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testStaticSite0", + "name": "testcontainerApp0-pjxhsye", + "api-version": "2024-04-01" + }, + "responses": { + "200": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/RestoreWebAppBackup.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/RestoreWebAppBackup.json new file mode 100644 index 000000000000..638a63ed6268 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/RestoreWebAppBackup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "backupId": "123244", + "api-version": "2024-04-01", + "request": { + "properties": { + "storageAccountUrl": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "overwrite": true, + "siteName": "sitef6141", + "databases": [ + { + "databaseType": "SqlAzure", + "name": "backenddb", + "connectionStringName": "backend", + "connectionString": "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;=]" + }, + { + "databaseType": "SqlAzure", + "name": "statsdb", + "connectionStringName": "stats", + "connectionString": "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;=]" + } + ] + } + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/sites/sitef6141/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-04-01" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/StartWebSiteNetworkTraceOperation.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/StartWebSiteNetworkTraceOperation.json new file mode 100644 index 000000000000..766b18904ffa --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/StartWebSiteNetworkTraceOperation.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "SampleApp", + "slot": "Production", + "durationInSeconds": 60, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip", + "status": "Succeeded", + "message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip" + } + ] + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d", + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d" + }, + "body": [ + { + "path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip", + "status": "Succeeded", + "message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip" + } + ] + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/StaticSiteBuildZipDeploy.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/StaticSiteBuildZipDeploy.json new file mode 100644 index 000000000000..b525ada8af51 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/StaticSiteBuildZipDeploy.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "environmentName": "12", + "api-version": "2024-04-01", + "staticSiteZipDeploymentEnvelope": { + "properties": { + "appZipUrl": "https://teststorageaccount.net/happy-sea-15afae3e-master-81828877/app-zipdeploy.zip", + "apiZipUrl": "https://teststorageaccount.net/happy-sea-15afae3e-master-81828877/api-zipdeploy.zip", + "deploymentTitle": "Update index.html", + "provider": "testProvider", + "functionLanguage": "testFunctionLanguage" + } + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus2/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2019-01-01" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/StaticSiteZipDeploy.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/StaticSiteZipDeploy.json new file mode 100644 index 000000000000..8958eede69e0 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/StaticSiteZipDeploy.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "api-version": "2024-04-01", + "staticSiteZipDeploymentEnvelope": { + "properties": { + "appZipUrl": "https://teststorageaccount.net/happy-sea-15afae3e-master-81828877/app-zipdeploy.zip", + "apiZipUrl": "https://teststorageaccount.net/happy-sea-15afae3e-master-81828877/api-zipdeploy.zip", + "deploymentTitle": "Update index.html", + "provider": "testProvider", + "functionLanguage": "testFunctionLanguage" + } + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus2/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2019-01-01" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/StopWebSiteNetworkTrace.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/StopWebSiteNetworkTrace.json new file mode 100644 index 000000000000..78b1f5117ef2 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/StopWebSiteNetworkTrace.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "SampleApp", + "slot": "Production", + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UnlinkBackendFromStaticSite.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UnlinkBackendFromStaticSite.json new file mode 100644 index 000000000000..ed5b2ee38dad --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UnlinkBackendFromStaticSite.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "linkedBackendName": "testBackend", + "cleanUpAuth": true, + "api-version": "2024-04-01" + }, + "responses": { + "204": {}, + "200": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UnlinkBackendFromStaticSiteBuild.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UnlinkBackendFromStaticSiteBuild.json new file mode 100644 index 000000000000..b2bfc6388cf6 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UnlinkBackendFromStaticSiteBuild.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "environmentName": "12", + "linkedBackendName": "testBackend", + "cleanUpAuth": true, + "api-version": "2024-04-01" + }, + "responses": { + "204": {}, + "200": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAppSettings.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAppSettings.json new file mode 100644 index 000000000000..8562c5372458 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAppSettings.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "api-version": "2024-04-01", + "appSettings": { + "properties": { + "Setting1": "Value1", + "Setting2": "Value2" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/appsettings", + "name": "appsettings", + "type": "Microsoft.Web/sites/config", + "kind": "app", + "properties": { + "Setting1": "Value1", + "Setting2": "Value2" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAseCustomDnsSuffixConfiguration.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAseCustomDnsSuffixConfiguration.json new file mode 100644 index 000000000000..efa8766f1860 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAseCustomDnsSuffixConfiguration.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-rg", + "name": "test-ase", + "api-version": "2024-04-01", + "customDnsSuffixConfiguration": { + "properties": { + "dnsSuffix": "contoso.com", + "certificateUrl": "https://test-kv.vault.azure.net/secrets/contosocert", + "keyVaultReferenceIdentity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/customdnssuffix", + "name": "customDnsSuffix", + "type": "Microsoft.Web/hostingEnvironments/configurations/customdnssuffix", + "properties": { + "provisioningState": "Succeeded", + "provisioningDetails": null, + "dnsSuffix": "contoso.com", + "certificateUrl": "https://test-kv.vault.azure.net/secrets/contosocert", + "keyVaultReferenceIdentity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAuthSettings.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAuthSettings.json new file mode 100644 index 000000000000..bc1737ee8930 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAuthSettings.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "api-version": "2024-04-01", + "siteAuthSettings": { + "properties": { + "enabled": true, + "runtimeVersion": "~1", + "unauthenticatedClientAction": "RedirectToLoginPage", + "tokenStoreEnabled": true, + "allowedExternalRedirectUrls": [ + "sitef6141.customdomain.net", + "sitef6141.customdomain.info" + ], + "defaultProvider": "Google", + "tokenRefreshExtensionHours": 120, + "clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettings", + "name": "authsettings", + "type": "Microsoft.Web/sites/authsettings", + "kind": "app", + "properties": { + "enabled": true, + "runtimeVersion": "~1", + "unauthenticatedClientAction": "RedirectToLoginPage", + "tokenStoreEnabled": true, + "allowedExternalRedirectUrls": [ + "sitef6141.customdomain.net", + "sitef6141.customdomain.info" + ], + "defaultProvider": "Google", + "tokenRefreshExtensionHours": 120, + "clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAuthSettingsV2.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAuthSettingsV2.json new file mode 100644 index 000000000000..2ddc120c35da --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAuthSettingsV2.json @@ -0,0 +1,155 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "api-version": "2024-04-01", + "siteAuthSettingsV2": { + "properties": { + "platform": { + "enabled": true, + "runtimeVersion": "~1", + "configFilePath": "/auth/config.json" + }, + "globalValidation": { + "requireAuthentication": true, + "unauthenticatedClientAction": "Return403", + "excludedPaths": [ + "/nosecrets/Path" + ] + }, + "identityProviders": { + "google": { + "enabled": true, + "registration": { + "clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com", + "clientSecretSettingName": "ClientSecret" + }, + "login": { + "scopes": [ + "admin" + ] + }, + "validation": { + "allowedAudiences": [ + "https://example.com" + ] + } + } + }, + "login": { + "routes": { + "logoutEndpoint": "https://app.com/logout" + }, + "tokenStore": { + "enabled": true, + "tokenRefreshExtensionHours": 96, + "fileSystem": { + "directory": "/wwwroot/sites/example" + } + }, + "preserveUrlFragmentsForLogins": true, + "allowedExternalRedirectUrls": [ + "https://someurl.com" + ], + "cookieExpiration": { + "convention": "IdentityProviderDerived", + "timeToExpiration": "2022:09-01T00:00Z" + }, + "nonce": { + "validateNonce": true + } + }, + "httpSettings": { + "requireHttps": true, + "routes": { + "apiPrefix": "/authv2/" + }, + "forwardProxy": { + "convention": "Standard", + "customHostHeaderName": "authHeader", + "customProtoHeaderName": "customProtoHeader" + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettingsv2", + "name": "authsettingsv2", + "type": "Microsoft.Web/sites/authsettingsv2", + "kind": "app", + "properties": { + "platform": { + "enabled": true, + "runtimeVersion": "~1", + "configFilePath": "/auth/config.json" + }, + "globalValidation": { + "requireAuthentication": true, + "unauthenticatedClientAction": "Return403", + "excludedPaths": [ + "/nosecrets/Path" + ] + }, + "identityProviders": { + "google": { + "enabled": true, + "registration": { + "clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com", + "clientSecretSettingName": "ClientSecret" + }, + "login": { + "scopes": [ + "admin" + ] + }, + "validation": { + "allowedAudiences": [ + "https://example.com" + ] + } + } + }, + "login": { + "routes": { + "logoutEndpoint": "https://app.com/logout" + }, + "tokenStore": { + "enabled": true, + "tokenRefreshExtensionHours": 96, + "fileSystem": { + "directory": "/wwwroot/sites/example" + } + }, + "preserveUrlFragmentsForLogins": true, + "allowedExternalRedirectUrls": [ + "https://someurl.com" + ], + "cookieExpiration": { + "convention": "IdentityProviderDerived", + "timeToExpiration": "2022:09-01T00:00Z" + }, + "nonce": { + "validateNonce": true + } + }, + "httpSettings": { + "requireHttps": true, + "routes": { + "apiPrefix": "/authv2/" + }, + "forwardProxy": { + "convention": "Standard", + "customHostHeaderName": "authHeader", + "customProtoHeaderName": "customProtoHeader" + } + } + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAzureStorageAccounts.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAzureStorageAccounts.json new file mode 100644 index 000000000000..d21e4594abd2 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAzureStorageAccounts.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "api-version": "2024-04-01", + "azureStorageAccounts": { + "properties": { + "account1": { + "type": "AzureFiles", + "accountName": "testsa", + "shareName": "web", + "accessKey": "26515^%@#*", + "mountPath": "/mounts/a/files" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/web", + "name": "web", + "type": "Microsoft.Web/sites/config", + "kind": "app", + "properties": { + "account1": { + "type": "AzureFiles", + "accountName": "testsa", + "shareName": "web", + "mountPath": "/mounts/a/files", + "state": "Ok" + } + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateMachineKey.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateMachineKey.json new file mode 100644 index 000000000000..0074f2e03250 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateMachineKey.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "contoso", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": {} + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdatePublishingCredentialsPolicy.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdatePublishingCredentialsPolicy.json new file mode 100644 index 000000000000..5d3a68fe5206 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdatePublishingCredentialsPolicy.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testSite", + "api-version": "2024-04-01", + "csmPublishingAccessPoliciesEntity": { + "properties": { + "allow": true + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/basicPublishingCredentialsPolicies/ftp", + "properties": { + "allow": true + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdatePublishingCredentialsPolicySlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdatePublishingCredentialsPolicySlot.json new file mode 100644 index 000000000000..24b965b7e11f --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdatePublishingCredentialsPolicySlot.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testSite", + "slot": "stage", + "api-version": "2024-04-01", + "csmPublishingAccessPoliciesEntity": { + "properties": { + "allow": true + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/slots/stage/basicPublishingCredentialsPolicies/ftp", + "properties": { + "allow": true + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateSiteConfig.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateSiteConfig.json new file mode 100644 index 000000000000..d3a6aabb4ba3 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateSiteConfig.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "api-version": "2024-04-01", + "siteConfig": { + "properties": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php", + "hostingstart.html" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/web", + "name": "web", + "type": "Microsoft.Web/sites/config", + "kind": "app", + "properties": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php", + "hostingstart.html" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateStaticSiteUser.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateStaticSiteUser.json new file mode 100644 index 000000000000..b3ddeb3acd2f --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateStaticSiteUser.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "authprovider": "aad", + "userid": "1234", + "api-version": "2024-04-01", + "staticSiteUserEnvelope": { + "properties": { + "roles": "contributor" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "provider": "aad", + "userId": "1234", + "displayName": "username", + "roles": "contributor,anonymous,authenticated" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateWebApp.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateWebApp.json new file mode 100644 index 000000000000..d1877adaf3b0 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateWebApp.json @@ -0,0 +1,249 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "api-version": "2024-04-01", + "siteEnvelope": { + "properties": { + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141", + "name": "sitef6141", + "type": "Microsoft.Web/sites", + "kind": "app", + "location": "East US", + "properties": { + "state": "Running", + "hostNames": [ + "sitef6141.azurewebsites.net" + ], + "repositorySiteName": "sitef6141", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "sitef6141.azurewebsites.net", + "sitef6141.scm.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "sitef6141.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "sitef6141.scm.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp", + "reserved": false, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2020-03-04T17:33:11.641Z", + "vnetRouteAllEnabled": false, + "vnetImagePullEnabled": false, + "vnetContentShareEnabled": false, + "siteConfig": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php", + "hostingstart.html" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + }, + "scmSiteAlsoStopped": false, + "clientAffinityEnabled": true, + "clientCertEnabled": false, + "clientCertMode": "Required", + "hostNamesDisabled": false, + "customDomainVerificationId": "7F3BB652450EF7AD0B6AA33064586E4A9CE823A46DF0B2EC6443A68086E84153", + "outboundIpAddresses": "70.37.102.201,20.225.43.144", + "possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188", + "containerSize": 0, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "testrg123", + "defaultHostName": "sitef6141.azurewebsites.net", + "httpsOnly": false, + "redundancyMode": "None", + "storageAccountRequired": false, + "keyVaultReferenceIdentity": "SystemAssigned", + "workloadProfileName": "myd4wp", + "resourceConfig": { + "cpu": 1.0, + "memory": "2.0Gi" + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/sites/sitef6141/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-04-01" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141", + "name": "sitef6141", + "type": "Microsoft.Web/sites", + "kind": "app", + "location": "East US", + "properties": { + "state": "Running", + "hostNames": [ + "sitef6141.azurewebsites.net" + ], + "repositorySiteName": "sitef6141", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "sitef6141.azurewebsites.net", + "sitef6141.scm.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "sitef6141.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "sitef6141.scm.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp", + "reserved": false, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2020-03-04T17:33:11.641Z", + "vnetRouteAllEnabled": false, + "vnetImagePullEnabled": false, + "vnetContentShareEnabled": false, + "siteConfig": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php", + "hostingstart.html" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + }, + "scmSiteAlsoStopped": false, + "clientAffinityEnabled": true, + "clientCertEnabled": false, + "clientCertMode": "Required", + "hostNamesDisabled": false, + "customDomainVerificationId": "7F3BB652450EF7AD0B6AA33064586E4A9CE823A46DF0B2EC6443A68086E84153", + "outboundIpAddresses": "70.37.102.201,20.225.43.144", + "possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188", + "containerSize": 0, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "testrg123", + "defaultHostName": "sitef6141.azurewebsites.net", + "httpsOnly": false, + "redundancyMode": "None", + "storageAccountRequired": false, + "keyVaultReferenceIdentity": "SystemAssigned", + "workloadProfileName": "myd4wp", + "resourceConfig": { + "cpu": 1.0, + "memory": "2.0Gi" + } + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateWebAppSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateWebAppSlot.json new file mode 100644 index 000000000000..15abb7f2e38f --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateWebAppSlot.json @@ -0,0 +1,240 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "sitef6141", + "slot": "staging", + "api-version": "2024-04-01", + "siteEnvelope": { + "properties": { + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/slots/staging", + "name": "sitef6141/staging", + "type": "Microsoft.Web/sites/slots", + "kind": "app", + "location": "East US", + "properties": { + "state": "Running", + "hostNames": [ + "sitef6141-staging.azurewebsites.net" + ], + "repositorySiteName": "sitef6141", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "sitef6141-staging.azurewebsites.net", + "sitef6141-staging.scm.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "sitef6141-staging.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "sitef6141-staging.scm.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp", + "reserved": false, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2020-03-04T17:33:11.641Z", + "vnetRouteAllEnabled": false, + "vnetImagePullEnabled": false, + "vnetContentShareEnabled": false, + "siteConfig": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php", + "hostingstart.html" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + }, + "scmSiteAlsoStopped": false, + "clientAffinityEnabled": true, + "clientCertEnabled": false, + "clientCertMode": "Required", + "hostNamesDisabled": false, + "customDomainVerificationId": "7F3BB652450EF7AD0B6AA33064586E4A9CE823A46DF0B2EC6443A68086E84153", + "outboundIpAddresses": "70.37.102.201,20.225.43.144", + "possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188", + "containerSize": 0, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "testrg123", + "defaultHostName": "sitef6141.azurewebsites.net", + "httpsOnly": false, + "redundancyMode": "None", + "storageAccountRequired": false, + "keyVaultReferenceIdentity": "SystemAssigned" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/sites/sitef6141/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-04-01" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/slots/staging", + "name": "sitef6141/staging", + "type": "Microsoft.Web/sites/slots", + "kind": "app", + "location": "East US", + "properties": { + "state": "Running", + "hostNames": [ + "sitef6141-staging.azurewebsites.net" + ], + "repositorySiteName": "sitef6141", + "usageState": "Normal", + "enabled": true, + "enabledHostNames": [ + "sitef6141-staging.azurewebsites.net", + "sitef6141-staging.scm.azurewebsites.net" + ], + "availabilityState": "Normal", + "hostNameSslStates": [ + { + "name": "sitef6141-staging.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Standard" + }, + { + "name": "sitef6141-staging.scm.azurewebsites.net", + "sslState": "Disabled", + "hostType": "Repository" + } + ], + "serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp", + "reserved": false, + "isXenon": false, + "hyperV": false, + "lastModifiedTimeUtc": "2020-03-04T17:33:11.641Z", + "vnetRouteAllEnabled": false, + "vnetImagePullEnabled": false, + "vnetContentShareEnabled": false, + "siteConfig": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php", + "hostingstart.html" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "powerShellVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "httpLoggingEnabled": false, + "acrUseManagedIdentityCreds": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false + } + ], + "loadBalancing": "LeastRequests", + "autoHealEnabled": false, + "vnetName": "", + "vnetRouteAllEnabled": false, + "vnetPrivatePortsCount": 0, + "http20Enabled": false, + "minTlsVersion": "1.2", + "scmMinTlsVersion": "1.2", + "ftpsState": "AllAllowed", + "functionAppScaleLimit": 0, + "functionsRuntimeScaleMonitoringEnabled": false, + "minimumElasticInstanceCount": 0, + "azureStorageAccounts": {} + }, + "scmSiteAlsoStopped": false, + "clientAffinityEnabled": true, + "clientCertEnabled": false, + "clientCertMode": "Required", + "hostNamesDisabled": false, + "customDomainVerificationId": "7F3BB652450EF7AD0B6AA33064586E4A9CE823A46DF0B2EC6443A68086E84153", + "outboundIpAddresses": "70.37.102.201,20.225.43.144", + "possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188", + "containerSize": 0, + "dailyMemoryTimeQuota": 0, + "resourceGroup": "testrg123", + "defaultHostName": "sitef6141-staging.azurewebsites.net", + "httpsOnly": false, + "redundancyMode": "None", + "storageAccountRequired": false, + "keyVaultReferenceIdentity": "SystemAssigned" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ValidateLinkedBackendForStaticSite.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ValidateLinkedBackendForStaticSite.json new file mode 100644 index 000000000000..fa8f832a9121 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ValidateLinkedBackendForStaticSite.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "linkedBackendName": "testBackend", + "api-version": "2024-04-01", + "staticSiteLinkedBackendEnvelope": { + "properties": { + "backendResourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/backendRg/providers/Microsoft.Web/sites/testBackend", + "region": "West US 2" + } + } + }, + "responses": { + "204": {}, + "200": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ValidateLinkedBackendForStaticSiteBuild.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ValidateLinkedBackendForStaticSiteBuild.json new file mode 100644 index 000000000000..b46138727e3c --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ValidateLinkedBackendForStaticSiteBuild.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "environmentName": "default", + "linkedBackendName": "testBackend", + "api-version": "2024-04-01", + "staticSiteLinkedBackendEnvelope": { + "properties": { + "backendResourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/backendRg/providers/Microsoft.Web/sites/testBackend", + "region": "West US 2" + } + } + }, + "responses": { + "204": {}, + "200": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ValidateStaticSiteCustomDomain.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ValidateStaticSiteCustomDomain.json new file mode 100644 index 000000000000..debcb5bfb95e --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ValidateStaticSiteCustomDomain.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testStaticSite0", + "domainName": "custom.domain.net", + "api-version": "2024-04-01", + "staticSiteCustomDomainRequestPropertiesEnvelope": { + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus2/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2019-01-01" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/VerifyHostingEnvironmentVnet.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/VerifyHostingEnvironmentVnet.json new file mode 100644 index 000000000000..6a5644d1a481 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/VerifyHostingEnvironmentVnet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2024-04-01", + "parameters": { + "properties": { + "vnetResourceGroup": "vNet123rg", + "vnetName": "vNet123", + "vnetSubnetName": "vNet123SubNet" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/verifyHostingEnvironmentVnet", + "properties": { + "failed": false, + "failedTests": [] + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitionsRequestHistories_Get.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitionsRequestHistories_Get.json new file mode 100644 index 000000000000..d67fe6bac52a --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitionsRequestHistories_Get.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceGroupName": "test-resource-group", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "name": "test-name", + "workflowName": "test-workflow", + "runName": "08586776228332053161046300351", + "actionName": "HTTP_Webhook", + "repetitionName": "000001", + "requestHistoryName": "08586611142732800686" + }, + "responses": { + "200": { + "body": { + "properties": { + "startTime": "2018-10-25T18:36:51.9206732Z", + "endTime": "2018-10-25T18:36:52.1863033Z", + "request": { + "headers": { + "Accept-Language": "en-US", + "User-Agent": "azure-logic-apps/1.0,(workflow 80244732be3648f59d2084fd979cdd56; version 08586611142904036539)", + "x-ms-execution-location": "brazilsouth", + "x-ms-workflow-id": "80244732be3648f59d2084fd979cdd56", + "x-ms-workflow-version": "08586611142904036539", + "x-ms-workflow-name": "test-workflow", + "x-ms-workflow-system-id": "/locations/brazilsouth/scaleunits/prod-17/workflows/80244732be3648f59d2084fd979cdd56", + "x-ms-workflow-run-id": "08586611142736787787412824395CU21", + "x-ms-workflow-run-tracking-id": "b4cd2e77-f949-4d8c-8753-791407aebde8", + "x-ms-workflow-operation-name": "HTTP_Webhook", + "x-ms-workflow-subscription-id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "x-ms-workflow-resourcegroup-name": "test-resource-group", + "x-ms-workflow-subscription-capacity": "Large", + "x-ms-tracking-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-correlation-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-client-request-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-client-tracking-id": "08586611142736787787412824395CU21", + "x-ms-action-tracking-id": "ad27f634-6523-492f-924e-9a75e28619c8" + }, + "uri": "http://tempuri.org", + "method": "GET" + }, + "response": { + "headers": { + "Cache-Control": "private", + "Date": "Thu, 25 Oct 2018 18:36:51 GMT", + "Location": "http://www.bing.com/", + "Server": "Microsoft-IIS/10.0", + "X-AspNet-Version": "4.0.30319", + "X-Powered-By": "ASP.NET" + }, + "statusCode": 302, + "bodyLink": { + "uri": "https://tempuri.org", + "contentVersion": "2LOOAR8Eh2pd7AvRHXUhRg==", + "contentSize": 137, + "contentHash": { + "algorithm": "md5", + "value": "2LOOAR8Eh2pd7AvRHXUhRg==" + } + } + } + }, + "id": "/workflows/test-workflow/runs/08586611142736787787412824395CU21/actions/HTTP_Webhook/requestHistories/08586611142732800686", + "name": "08586611142732800686", + "type": "/workflows/runs/actions/requestHistories" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitionsRequestHistories_List.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitionsRequestHistories_List.json new file mode 100644 index 000000000000..89073140db7a --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitionsRequestHistories_List.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceGroupName": "test-resource-group", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "name": "test-name", + "workflowName": "test-workflow", + "runName": "08586776228332053161046300351", + "actionName": "HTTP_Webhook", + "repetitionName": "000001" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "startTime": "2018-10-25T18:36:51.9206732Z", + "endTime": "2018-10-25T18:36:52.1863033Z", + "request": { + "headers": { + "Accept-Language": "en-US", + "User-Agent": "azure-logic-apps/1.0,(workflow 80244732be3648f59d2084fd979cdd56; version 08586611142904036539)", + "x-ms-execution-location": "brazilsouth", + "x-ms-workflow-id": "80244732be3648f59d2084fd979cdd56", + "x-ms-workflow-version": "08586611142904036539", + "x-ms-workflow-name": "test-workflow", + "x-ms-workflow-system-id": "/locations/brazilsouth/scaleunits/prod-17/workflows/80244732be3648f59d2084fd979cdd56", + "x-ms-workflow-run-id": "08586611142736787787412824395CU21", + "x-ms-workflow-run-tracking-id": "b4cd2e77-f949-4d8c-8753-791407aebde8", + "x-ms-workflow-operation-name": "HTTP_Webhook", + "x-ms-workflow-subscription-id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "x-ms-workflow-resourcegroup-name": "test-resource-group", + "x-ms-workflow-subscription-capacity": "Large", + "x-ms-tracking-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-correlation-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-client-request-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-client-tracking-id": "08586611142736787787412824395CU21", + "x-ms-action-tracking-id": "ad27f634-6523-492f-924e-9a75e28619c8" + }, + "uri": "http://tempuri.org", + "method": "GET" + }, + "response": { + "headers": { + "Cache-Control": "private", + "Date": "Thu, 25 Oct 2018 18:36:51 GMT", + "Location": "http://www.bing.com/", + "Server": "Microsoft-IIS/10.0", + "X-AspNet-Version": "4.0.30319", + "X-Powered-By": "ASP.NET" + }, + "statusCode": 302, + "bodyLink": { + "uri": "https://tempuri.org", + "contentVersion": "2LOOAR8Eh2pd7AvRHXUhRg==", + "contentSize": 137, + "contentHash": { + "algorithm": "md5", + "value": "2LOOAR8Eh2pd7AvRHXUhRg==" + } + } + } + }, + "id": "/workflows/test-workflow/runs/08586611142736787787412824395CU21/actions/HTTP_Webhook/requestHistories/08586611142732800686", + "name": "08586611142732800686", + "type": "/workflows/runs/actions/requestHistories" + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitions_Get.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitions_Get.json new file mode 100644 index 000000000000..f55ad368eb21 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitions_Get.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "name": "test-name", + "workflowName": "testFlow", + "runName": "08586776228332053161046300351", + "actionName": "testAction", + "repetitionName": "000001" + }, + "responses": { + "200": { + "body": { + "properties": { + "repetitionIndexes": [ + { + "scopeName": "For_each", + "itemIndex": 1 + } + ], + "trackingId": "f84f23eb-b331-4772-9f39-cc307fa83bc3", + "inputsLink": { + "uri": "https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/2dfde2fce2584c49bea17ef0b04c95f4/runs/08586776228332053161046300351/actions/testAction/repetitions/000001/contents/ActionInputs?api-version=2016-10-01&se=2018-04-18T21%3A00%3A00.0000000Z&sp=%2Fruns%2F08586776228332053161046300351%2Factions%2FtestAction%2Frepetitions%2F000001%2Fcontents%2FActionInputs%2Fread&sv=1.0&sig=dLmnt50joimEMK4k9rR6njHQh94iSFJ9rrDxFbkEg5M", + "contentVersion": "OA3i83YHGYVch+N8BQJIRQ==", + "contentSize": 6, + "contentHash": { + "algorithm": "md5", + "value": "OA3i83YHGYVch+N8BQJIRQ==" + } + }, + "outputsLink": { + "uri": "https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/2dfde2fce2584c49bea17ef0b04c95f4/runs/08586776228332053161046300351/actions/testAction/repetitions/000001/contents/ActionOutputs?api-version=2016-10-01&se=2018-04-18T21%3A00%3A00.0000000Z&sp=%2Fruns%2F08586776228332053161046300351%2Factions%2FtestAction%2Frepetitions%2F000001%2Fcontents%2FActionOutputs%2Fread&sv=1.0&sig=B3-X5sqIAv1Lb31GOD34ZgIRUXGuiM2QllWiNwXFYAw", + "contentVersion": "OA3i83YHGYVch+N8BQJIRQ==", + "contentSize": 6, + "contentHash": { + "algorithm": "md5", + "value": "OA3i83YHGYVch+N8BQJIRQ==" + } + }, + "startTime": "2018-04-18T17:05:57.0929911Z", + "endTime": "2018-04-18T17:05:57.1015421Z", + "correlation": { + "actionTrackingId": "f84f23eb-b331-4772-9f39-cc307fa83bc3", + "clientTrackingId": "08586775357427610445444523191" + }, + "status": "Succeeded", + "code": "OK" + }, + "id": "/workflows/testFlow/runs/08586776228332053161046300351/actions/testAction/repetitions/000001", + "name": "000001", + "type": "/workflows/runs/actions/repetitions" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitions_List.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitions_List.json new file mode 100644 index 000000000000..a1785eed1601 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitions_List.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "name": "test-name", + "workflowName": "testFlow", + "runName": "08586776228332053161046300351", + "actionName": "testAction" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "repetitionIndexes": [ + { + "scopeName": "For_each", + "itemIndex": 0 + } + ], + "trackingId": "0d8152bb-e198-44a9-bde8-5138eea16dd4", + "inputsLink": { + "uri": "https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/2dfde2fce2584c49bea17ef0b04c95f4/runs/08586776228332053161046300351/actions/testAction/repetitions/000000/contents/ActionInputs?api-version=2016-10-01&se=2018-04-18T21%3A00%3A00.0000000Z&sp=%2Fruns%2F08586776228332053161046300351%2Factions%2FtestAction%2Frepetitions%2F000000%2Fcontents%2FActionInputs%2Fread&sv=1.0&sig=vw4BDdYp4Ap5RXdM7tY_wl9C38DeAHfnixLBEOpideA", + "contentVersion": "8q1zMKS5ZyHBrPF+qF1xXw==", + "contentSize": 8, + "contentHash": { + "algorithm": "md5", + "value": "8q1zMKS5ZyHBrPF+qF1xXw==" + } + }, + "outputsLink": { + "uri": "https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/2dfde2fce2584c49bea17ef0b04c95f4/runs/08586776228332053161046300351/actions/testAction/repetitions/000000/contents/ActionOutputs?api-version=2016-10-01&se=2018-04-18T21%3A00%3A00.0000000Z&sp=%2Fruns%2F08586776228332053161046300351%2Factions%2FtestAction%2Frepetitions%2F000000%2Fcontents%2FActionOutputs%2Fread&sv=1.0&sig=y8Wq7jbu85tmlMo_1zpRyqNJuoCaQCFQtZ3bgSovLY0", + "contentVersion": "8q1zMKS5ZyHBrPF+qF1xXw==", + "contentSize": 8, + "contentHash": { + "algorithm": "md5", + "value": "8q1zMKS5ZyHBrPF+qF1xXw==" + } + }, + "startTime": "2018-04-18T17:05:57.217991Z", + "endTime": "2018-04-18T17:05:57.2264835Z", + "correlation": { + "actionTrackingId": "0d8152bb-e198-44a9-bde8-5138eea16dd4", + "clientTrackingId": "08586775357427610445444523191" + }, + "status": "Succeeded", + "code": "OK" + }, + "id": "/workflows/testFlow/runs/08586776228332053161046300351/actions/testAction/repetitions/000000", + "name": "000000", + "type": "/workflows/runs/actions/repetitions" + }, + { + "properties": { + "repetitionIndexes": [ + { + "scopeName": "For_each", + "itemIndex": 1 + } + ], + "trackingId": "f84f23eb-b331-4772-9f39-cc307fa83bc3", + "inputsLink": { + "uri": "https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/2dfde2fce2584c49bea17ef0b04c95f4/runs/08586776228332053161046300351/actions/testAction/repetitions/000001/contents/ActionInputs?api-version=2016-10-01&se=2018-04-18T21%3A00%3A00.0000000Z&sp=%2Fruns%2F08586776228332053161046300351%2Factions%2FtestAction%2Frepetitions%2F000001%2Fcontents%2FActionInputs%2Fread&sv=1.0&sig=dLmnt50joimEMK4k9rR6njHQh94iSFJ9rrDxFbkEg5M", + "contentVersion": "OA3i83YHGYVch+N8BQJIRQ==", + "contentSize": 6, + "contentHash": { + "algorithm": "md5", + "value": "OA3i83YHGYVch+N8BQJIRQ==" + } + }, + "outputsLink": { + "uri": "https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/2dfde2fce2584c49bea17ef0b04c95f4/runs/08586776228332053161046300351/actions/testAction/repetitions/000001/contents/ActionOutputs?api-version=2016-10-01&se=2018-04-18T21%3A00%3A00.0000000Z&sp=%2Fruns%2F08586776228332053161046300351%2Factions%2FtestAction%2Frepetitions%2F000001%2Fcontents%2FActionOutputs%2Fread&sv=1.0&sig=B3-X5sqIAv1Lb31GOD34ZgIRUXGuiM2QllWiNwXFYAw", + "contentVersion": "OA3i83YHGYVch+N8BQJIRQ==", + "contentSize": 6, + "contentHash": { + "algorithm": "md5", + "value": "OA3i83YHGYVch+N8BQJIRQ==" + } + }, + "startTime": "2018-04-18T17:05:57.0929911Z", + "endTime": "2018-04-18T17:05:57.1015421Z", + "correlation": { + "actionTrackingId": "f84f23eb-b331-4772-9f39-cc307fa83bc3", + "clientTrackingId": "08586775357427610445444523191" + }, + "status": "Succeeded", + "code": "OK" + }, + "id": "/workflows/testFlow/runs/08586776228332053161046300351/actions/testAction/repetitions/000001", + "name": "000001", + "type": "/workflows/runs/actions/repetitions" + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitions_ListExpressionTraces.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitions_ListExpressionTraces.json new file mode 100644 index 000000000000..cc2dca214b56 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitions_ListExpressionTraces.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "name": "test-name", + "workflowName": "testFlow", + "runName": "08586776228332053161046300351", + "actionName": "testAction", + "repetitionName": "000001" + }, + "responses": { + "200": { + "body": { + "inputs": [ + { + "path": "", + "text": "items('For_each')?['OccuringLocation']?['Environment']", + "value": "PROD" + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionScopeRepetitions_Get.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionScopeRepetitions_Get.json new file mode 100644 index 000000000000..7665bc9f70ad --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionScopeRepetitions_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "name": "test-name", + "workflowName": "testFlow", + "runName": "08586776228332053161046300351", + "actionName": "for_each", + "repetitionName": "000000" + }, + "responses": { + "200": { + "body": { + "properties": { + "repetitionIndexes": [ + { + "scopeName": "For_each", + "itemIndex": 0 + } + ], + "startTime": "2018-04-18T17:05:57.209588Z", + "endTime": "2018-04-18T17:05:57.6240967Z", + "correlation": { + "actionTrackingId": "5c0e7c24-4891-44e8-b631-8084c5531dd5", + "clientTrackingId": "08586775357427610445444523191" + }, + "status": "Succeeded", + "code": "NotSpecified" + }, + "id": "/workflows/testFlow/runs/08586776228332053161046300351/actions/for_each/scopeRepetitions/000000", + "name": "000000", + "type": "/workflows/runs/actions/scopeRepetitions" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionScopeRepetitions_List.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionScopeRepetitions_List.json new file mode 100644 index 000000000000..5c27443368da --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionScopeRepetitions_List.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "name": "test-name", + "workflowName": "testFlow", + "runName": "08586776228332053161046300351", + "actionName": "for_each" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "repetitionIndexes": [ + { + "scopeName": "For_each", + "itemIndex": 0 + } + ], + "startTime": "2018-04-18T17:05:57.209588Z", + "endTime": "2018-04-18T17:05:57.6240967Z", + "correlation": { + "actionTrackingId": "5c0e7c24-4891-44e8-b631-8084c5531dd5", + "clientTrackingId": "08586775357427610445444523191" + }, + "status": "Succeeded", + "code": "NotSpecified" + }, + "id": "/workflows/testFlow/runs/08586776228332053161046300351/actions/for_each/scopeRepetitions/000000", + "name": "000000", + "type": "/workflows/runs/actions/scopeRepetitions" + }, + { + "properties": { + "repetitionIndexes": [ + { + "scopeName": "For_each", + "itemIndex": 1 + } + ], + "startTime": "2018-04-18T17:05:57.0686808Z", + "endTime": "2018-04-18T17:05:57.2272796Z", + "correlation": { + "actionTrackingId": "1682d0bd-7189-4478-b333-fe364a80bd69", + "clientTrackingId": "08586775357427610445444523191" + }, + "status": "Succeeded", + "code": "NotSpecified" + }, + "id": "/workflows/testFlow/runs/08586776228332053161046300351/actions/for_each/scopeRepetitions/000001", + "name": "000001", + "type": "/workflows/runs/actions/scopeRepetitions" + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActions_Get.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActions_Get.json new file mode 100644 index 000000000000..875ab90d398b --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActions_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-resource-group", + "name": "test-name", + "workflowName": "test-workflow", + "runName": "08586676746934337772206998657CU22", + "actionName": "HTTP" + }, + "responses": { + "200": { + "body": { + "properties": { + "inputsLink": { + "uri": "https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/000012345678900000000056a41a/runs/00000aaaabbbbccccddddeeeeffff/actions/HTTP/contents/ActionInputs?api-version=2018-11-01&code=examplecode=2022-04-13T03%3A00%3A00.0000000Z&sp=%2Fruns%2F00000aaaabbbbccccddddeeeeffff%2Factions%2FHTTP%2Fcontents%2FActionInputs%2Fread&sv=1.0&sig=dJ6F00000aaaabbbbccccddddeeeeffff78co", + "contentSize": 138 + }, + "outputsLink": { + "uri": "https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/000012345678900000000056a41a/runs/00000aaaabbbbccccddddeeeeffff/actions/HTTP/contents/ActionOutputs?api-version=2018-11-01&code=examplecode=2022-04-13T03%3A00%3A00.0000000Z&sp=%2Fruns%2F00000aaaabbbbccccddddeeeeffff%2Factions%2FHTTP%2Fcontents%2FActionOutputs%2Fread&sv=1.0&sig=fIIgF00000aaaabbbbccccddddeeeeffffWRU0", + "contentSize": 15660 + }, + "startTime": "2018-08-10T20:16:32.305236Z", + "endTime": "2018-08-10T20:16:32.5450625Z", + "correlation": { + "actionTrackingId": "56063357-45dd-4278-9be5-8220ce0cc9ca", + "clientTrackingId": "08586676746934337772206998657CU22" + }, + "status": "Succeeded", + "code": "OK" + }, + "id": "/workflows/test-workflow/runs/08586676746934337772206998657CU22/actions/HTTP", + "name": "HTTP", + "type": "/workflows/runs/actions" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActions_List.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActions_List.json new file mode 100644 index 000000000000..261c5cf163b3 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActions_List.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-resource-group", + "name": "test-name", + "workflowName": "test-workflow", + "runName": "08586676746934337772206998657CU22" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inputsLink": { + "uri": "https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/000012345678900000000056a41a/runs/00000aaaabbbbccccddddeeeeffff/actions/HTTP/contents/ActionInputs?api-version=2018-11-01&code=examplecode=2022-04-13T03%3A00%3A00.0000000Z&sp=%2Fruns%2F00000aaaabbbbccccddddeeeeffff%2Factions%2FHTTP%2Fcontents%2FActionInputs%2Fread&sv=1.0&sig=dJ6F00000aaaabbbbccccddddeeeeffff78co", + "contentSize": 138 + }, + "outputsLink": { + "uri": "https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/000012345678900000000056a41a/runs/00000aaaabbbbccccddddeeeeffff/actions/HTTP/contents/ActionOutputs?api-version=2018-11-01&code=examplecode=2022-04-13T03%3A00%3A00.0000000Z&sp=%2Fruns%2F00000aaaabbbbccccddddeeeeffff%2Factions%2FHTTP%2Fcontents%2FActionOutputs%2Fread&sv=1.0&sig=fIIgF00000aaaabbbbccccddddeeeeffffWRU0", + "contentSize": 15660 + }, + "startTime": "2018-08-10T20:16:32.305236Z", + "endTime": "2018-08-10T20:16:32.5450625Z", + "correlation": { + "actionTrackingId": "56063357-45dd-4278-9be5-8220ce0cc9ca", + "clientTrackingId": "08586676746934337772206998657CU22" + }, + "status": "Succeeded", + "code": "OK" + }, + "id": "/workflows/test-workflow/runs/08586676746934337772206998657CU22/actions/HTTP", + "name": "HTTP", + "type": "/workflows/runs/actions" + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActions_ListExpressionTraces.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActions_ListExpressionTraces.json new file mode 100644 index 000000000000..54d86fb2a9ff --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActions_ListExpressionTraces.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "name": "test-name", + "workflowName": "testFlow", + "runName": "08586776228332053161046300351", + "actionName": "testAction", + "repetitionName": "000001" + }, + "responses": { + "200": { + "body": { + "inputs": [ + { + "path": "", + "text": "add(4, 4)", + "value": 8 + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRuns_Cancel.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRuns_Cancel.json new file mode 100644 index 000000000000..10424c69f76b --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRuns_Cancel.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-resource-group", + "name": "test-name", + "workflowName": "test-workflow", + "runName": "08586676746934337772206998657CU22" + }, + "responses": { + "200": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRuns_Get.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRuns_Get.json new file mode 100644 index 000000000000..8c1a67b1c1dc --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRuns_Get.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-resource-group", + "name": "test-name", + "workflowName": "test-workflow", + "runName": "08586676746934337772206998657CU22" + }, + "responses": { + "200": { + "body": { + "properties": { + "waitEndTime": "2018-08-10T20:16:32.044238Z", + "startTime": "2018-08-10T20:16:32.044238Z", + "endTime": "2018-08-10T20:16:32.5779999Z", + "status": "Succeeded", + "correlation": { + "clientTrackingId": "08586676746934337772206998657CU22" + }, + "workflow": { + "id": "/workflows/test-workflow/versions/08586676754160363885", + "name": "08586676754160363885", + "type": "workflows/versions" + }, + "trigger": { + "name": "Recurrence", + "startTime": "2018-08-10T20:16:32.0387927Z", + "endTime": "2018-08-10T20:16:32.0387927Z", + "scheduledTime": "2018-08-10T20:16:31.6344174Z", + "correlation": { + "clientTrackingId": "08586676746934337772206998657CU22" + }, + "code": "OK", + "status": "Succeeded" + }, + "outputs": {} + }, + "id": "/workflows/test-workflow/runs/08586676746934337772206998657CU22", + "name": "08586676746934337772206998657CU22", + "type": "workflows/runs" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRuns_List.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRuns_List.json new file mode 100644 index 000000000000..a886e70d7478 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRuns_List.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-resource-group", + "name": "test-name", + "workflowName": "test-workflow" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "waitEndTime": "2018-08-10T20:16:32.044238Z", + "startTime": "2018-08-10T20:16:32.044238Z", + "endTime": "2018-08-10T20:16:32.5779999Z", + "status": "Succeeded", + "correlation": { + "clientTrackingId": "08586676746934337772206998657CU22" + }, + "workflow": { + "id": "workflows/test-workflow/versions/08586676754160363885", + "name": "08586676754160363885", + "type": "workflows/versions" + }, + "trigger": { + "name": "Recurrence", + "startTime": "2018-08-10T20:16:32.0387927Z", + "endTime": "2018-08-10T20:16:32.0387927Z", + "scheduledTime": "2018-08-10T20:16:31.6344174Z", + "correlation": { + "clientTrackingId": "08586676746934337772206998657CU22" + }, + "code": "OK", + "status": "Succeeded" + }, + "outputs": {} + }, + "id": "workflows/test-workflow/runs/08586676746934337772206998657CU22", + "name": "08586676746934337772206998657CU22", + "type": "workflows/runs" + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggerHistories_Get.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggerHistories_Get.json new file mode 100644 index 000000000000..9a24fd33d7ed --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggerHistories_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "name": "test-name", + "workflowName": "testWorkflowName", + "triggerName": "testTriggerName", + "historyName": "08586676746934337772206998657CU22" + }, + "responses": { + "200": { + "body": { + "properties": { + "startTime": "2018-08-10T20:16:32.0387927Z", + "endTime": "2018-08-10T20:16:32.2987996Z", + "scheduledTime": "2018-08-10T20:16:31.6344174Z", + "status": "Succeeded", + "code": "OK", + "correlation": { + "clientTrackingId": "08586676746934337772206998657CU22" + }, + "fired": true, + "run": { + "name": "08586676746934337772206998657CU22", + "id": "/workflows/testWorkflowName/runs/08586676746934337772206998657CU22", + "type": "/workflows/runs" + } + }, + "id": "/workflows/testWorkflowName/triggers/testTriggerName/histories/08586676746934337772206998657CU22", + "name": "08586676746934337772206998657CU22", + "type": "/workflows/triggers/histories" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggerHistories_List.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggerHistories_List.json new file mode 100644 index 000000000000..cb243720a467 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggerHistories_List.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "name": "test-name", + "workflowName": "testWorkflowName", + "triggerName": "testTriggerName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "startTime": "2018-08-10T20:16:32.0387927Z", + "endTime": "2018-08-10T20:16:32.2987996Z", + "scheduledTime": "2018-08-10T20:16:31.6344174Z", + "status": "Succeeded", + "code": "OK", + "correlation": { + "clientTrackingId": "08586676746934337772206998657CU22" + }, + "fired": true, + "run": { + "name": "08586676746934337772206998657CU22", + "id": "/workflows/testWorkflowName/runs/08586676746934337772206998657CU22", + "type": "/workflows/runs" + } + }, + "id": "/workflows/testWorkflowName/triggers/testTriggerName/histories/08586676746934337772206998657CU22", + "name": "08586676746934337772206998657CU22", + "type": "/workflows/triggers/histories" + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggerHistories_Resubmit.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggerHistories_Resubmit.json new file mode 100644 index 000000000000..3c756892af23 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggerHistories_Resubmit.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "name": "test-name", + "workflowName": "testWorkflowName", + "triggerName": "testTriggerName", + "historyName": "testHistoryName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web//workflows/testWorkflowName/triggers/testTriggerName/histories/08586676746934337772206998657CU22?api-version=2024-04-01" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggers_Get.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggers_Get.json new file mode 100644 index 000000000000..78c7ad42debd --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggers_Get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-resource-group", + "name": "test-name", + "workflowName": "test-workflow", + "triggerName": "manual" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "createdTime": "2018-08-10T17:32:30.2496336Z", + "changedTime": "2018-08-10T18:47:49.5288666Z", + "state": "Enabled", + "workflow": { + "id": "/workflows/test-workflow/versions/08586676800160476478", + "name": "08586676800160476478", + "type": "/workflows/versions" + } + }, + "id": "/workflows/test-workflow/triggers/manual", + "name": "manual", + "type": "/workflows/triggers" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggers_GetSchemaJson.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggers_GetSchemaJson.json new file mode 100644 index 000000000000..a2767f82d61e --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggers_GetSchemaJson.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "name": "test-name", + "workflowName": "testWorkflow", + "triggerName": "testTrigger" + }, + "responses": { + "200": { + "body": { + "title": "JsonTitle", + "content": "JsonContent" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggers_List.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggers_List.json new file mode 100644 index 000000000000..bd8a0c46ce8d --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggers_List.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-resource-group", + "name": "test-name", + "workflowName": "test-workflow" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "createdTime": "2018-08-10T17:32:30.2496336Z", + "changedTime": "2018-08-10T18:47:49.5288666Z", + "state": "Enabled", + "workflow": { + "id": "/workflows/test-workflow/versions/08586676800160476478", + "name": "08586676800160476478", + "type": "/workflows/versions" + } + }, + "id": "/workflows/test-workflow/triggers/manual", + "name": "manual", + "type": "/workflows/triggers" + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggers_ListCallbackUrl.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggers_ListCallbackUrl.json new file mode 100644 index 000000000000..5feb01d1150d --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggers_ListCallbackUrl.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-resource-group", + "name": "test-name", + "workflowName": "test-workflow", + "triggerName": "manual" + }, + "responses": { + "200": { + "body": { + "value": "https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/fb9c8d79b15f41ce9b12861862f43546/versions/08587100027316071865/triggers/manualTrigger/paths/invoke?api-version=2015-08-01-preview&sp=%2Fversions%2F08587100027316071865%2Ftriggers%2FmanualTrigger%2Frun&sv=1.0&sig=IxEQ_ygZf6WNEQCbjV0Vs6p6Y4DyNEJVAa86U5B4xhk", + "method": "POST", + "basePath": "https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/fb9c8d79b15f41ce9b12861862f43546/versions/08587100027316071865/triggers/manualTrigger/paths/invoke", + "queries": { + "api-version": "2018-07-01-preview", + "sp": "/versions/08587100027316071865/triggers/manualTrigger/run", + "sv": "1.0", + "sig": "IxEQ_ygZf6WNEQCbjV0Vs6p6Y4DyNEJVAa86U5B4xhk" + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggers_Run.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggers_Run.json new file mode 100644 index 000000000000..c9d1f0e15fab --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggers_Run.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-resource-group", + "name": "test-name", + "workflowName": "test-workflow", + "triggerName": "recurrence" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web//workflows/testWorkflowName/triggers/testTriggerName/histories/08586676746934337772206998657CU22?api-version=2024-04-01" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowVersions_Get.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowVersions_Get.json new file mode 100644 index 000000000000..bfc87e1939ee --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowVersions_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-resource-group", + "name": "test-name", + "workflowName": "test-workflow", + "versionId": "08586676824806722526" + }, + "responses": { + "200": { + "body": { + "properties": { + "createdTime": "2018-04-25T01:39:21.4365247Z", + "changedTime": "2018-08-09T22:54:54.3533634Z", + "version": "08586677515911718341", + "definition": { + "$schema": "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#", + "contentVersion": "1.0.0.0", + "parameters": {}, + "triggers": {}, + "actions": {}, + "outputs": {} + }, + "parameters": {}, + "endpointsConfiguration": { + "workflow": { + "outgoingIpAddresses": [], + "accessEndpointIpAddresses": [] + }, + "connector": { + "outgoingIpAddresses": [] + } + } + }, + "id": "/workflows/test-workflow", + "name": "test-workflow", + "type": "/workflows/versions" + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowVersions_List.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowVersions_List.json new file mode 100644 index 000000000000..d4b38e2243df --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowVersions_List.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-resource-group", + "name": "test-name", + "workflowName": "test-workflow" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "createdTime": "2018-04-25T01:39:21.4365247Z", + "changedTime": "2018-08-09T22:54:54.3533634Z", + "version": "08586677515911718341", + "definition": { + "$schema": "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#", + "contentVersion": "1.0.0.0", + "parameters": {}, + "triggers": {}, + "actions": {}, + "outputs": {} + }, + "parameters": {}, + "endpointsConfiguration": { + "workflow": { + "outgoingIpAddresses": [], + "accessEndpointIpAddresses": [] + }, + "connector": { + "outgoingIpAddresses": [] + } + } + }, + "id": "/workflows/test-workflow", + "name": "test-workflow", + "type": "/workflows/versions" + } + ] + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Workflows_RegenerateAccessKey.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Workflows_RegenerateAccessKey.json new file mode 100644 index 000000000000..e91f9cf77b8a --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Workflows_RegenerateAccessKey.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "name": "test-name", + "workflowName": "testWorkflowName", + "keyType": { + "keyType": "Primary" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Workflows_Validate.json b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Workflows_Validate.json new file mode 100644 index 000000000000..4d37c46fcc61 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Workflows_Validate.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "test-resource-group", + "location": "brazilsouth", + "name": "test-name", + "workflowName": "test-workflow", + "validate": { + "properties": { + "definition": { + "$schema": "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#", + "contentVersion": "1.0.0.0", + "parameters": {}, + "triggers": {}, + "actions": {}, + "outputs": {} + }, + "kind": "Stateful" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/web/resource-manager/readme.cli.md b/specification/web/resource-manager/readme.cli.md index 9415e5a28bbe..a592cecf3917 100644 --- a/specification/web/resource-manager/readme.cli.md +++ b/specification/web/resource-manager/readme.cli.md @@ -2,7 +2,7 @@ These settings apply only when `--cli` is specified on the command line. -``` yaml $(cli) +```yaml $(cli) cli: cli-name: appservice package-name: azure-mgmt-web diff --git a/specification/web/resource-manager/readme.csharp.md b/specification/web/resource-manager/readme.csharp.md index 27232dee72b4..7eb9a8918530 100644 --- a/specification/web/resource-manager/readme.csharp.md +++ b/specification/web/resource-manager/readme.csharp.md @@ -5,30 +5,32 @@ This is the AutoRest configuration file for DNS. ## Common settings + These settings apply only when `--csharp` is specified on the command line. Please also specify `--csharp-sdks-folder=`. -``` yaml $(csharp) +```yaml $(csharp) csharp: azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION + license-header: MICROSOFT_MIT_NO_VERSION clear-output-folder: true ``` -``` yaml $(csharp) && !$(multiapi) && !$(csharp-profile) +```yaml $(csharp) && !$(multiapi) && !$(csharp-profile) namespace: Microsoft.Azure.Management.WebSites output-folder: $(csharp-sdks-folder)/websites/Microsoft.Azure.Management.WebSites/src/Generated ``` ## Batch settings + These settings are for batch mode only: (ie, add `--multiapi` to the command line ) -``` yaml $(multiapi) +```yaml $(multiapi) namespace: Microsoft.Azure.Management.WebSites.$(ApiVersionName) output-folder: $(csharp-sdks-folder)/$(ApiVersionName)/Generated batch: -#For WebSite 2016-08-01, you use the below tag + #For WebSite 2016-08-01, you use the below tag - tag: package-2016-09 ApiVersionName: Api2016_08_01 - tag: package-2019-08 @@ -50,7 +52,7 @@ batch: These settings apply only when `--csharp-profile=hybrid_2019_03_01` is specified on the command line. -``` yaml $(csharp-profile)=='hybrid_2019_03_01' +```yaml $(csharp-profile)=='hybrid_2019_03_01' namespace: Microsoft.Azure.Management.Profiles.$(csharp-profile).WebSites output-folder: $(csharp-sdks-folder)/$(csharp-profile)/Websites/Management.Websites/Generated batch: @@ -61,9 +63,9 @@ batch: These settings apply only when `--csharp-profile=hybrid_2020_09_01` is specified on the command line. -``` yaml $(csharp-profile)=='hybrid_2019_03_01' +```yaml $(csharp-profile)=='hybrid_2019_03_01' namespace: Microsoft.Azure.Management.Profiles.$(csharp-profile).WebSites output-folder: $(csharp-sdks-folder)/$(csharp-profile)/Websites/Management.Websites/Generated batch: - tag: profile-hybrid-2020-09-01 -``` \ No newline at end of file +``` diff --git a/specification/web/resource-manager/readme.go.md b/specification/web/resource-manager/readme.go.md index 8420a5441312..4508641a911a 100644 --- a/specification/web/resource-manager/readme.go.md +++ b/specification/web/resource-manager/readme.go.md @@ -2,7 +2,7 @@ These settings apply only when `--go` is specified on the command line. -``` yaml $(go) && !$(track2) +```yaml $(go) && !$(track2) go: license-header: MICROSOFT_MIT_NO_VERSION namespace: web @@ -15,21 +15,21 @@ module-name: sdk/resourcemanager/appservice/armappservice module: github.com/Azure/azure-sdk-for-go/$(module-name) output-folder: $(go-sdk-folder)/$(module-name) azure-arm: true -directive: -- rename-model: - from: 'Certificate' - to: 'AppCertificate' -- rename-model: - from: 'CertificateCollection' - to: 'AppCertificateCollection' -- rename-model: - from: 'CertificatePatchResource' - to: 'AppCertificatePatchResource' +directive: + - rename-model: + from: "Certificate" + to: "AppCertificate" + - rename-model: + from: "CertificateCollection" + to: "AppCertificateCollection" + - rename-model: + from: "CertificatePatchResource" + to: "AppCertificatePatchResource" ``` ### Go multi-api -``` yaml $(go) && $(multiapi) +```yaml $(go) && $(multiapi) batch: - tag: package-2021-03 - tag: package-2021-02 @@ -48,7 +48,7 @@ batch: These settings apply only when `--tag=package-2021-03 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -``` yaml $(tag) == 'package-2021-03' && $(go) +```yaml $(tag) == 'package-2021-03' && $(go) output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-03-01/$(namespace) ``` @@ -57,7 +57,7 @@ output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-03-01/$(namespac These settings apply only when `--tag=package-2021-02 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -``` yaml $(tag) == 'package-2021-02' && $(go) +```yaml $(tag) == 'package-2021-02' && $(go) output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-02-01/$(namespace) ``` @@ -66,7 +66,7 @@ output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-02-01/$(namespac These settings apply only when `--tag=package-2021-01-15 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -``` yaml $(tag) == 'package-2021-01-15' && $(go) +```yaml $(tag) == 'package-2021-01-15' && $(go) output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-01-15/$(namespace) ``` @@ -75,7 +75,7 @@ output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-01-15/$(namespac These settings apply only when `--tag=package-2020-12 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -``` yaml $(tag) == 'package-2020-12' && $(go) +```yaml $(tag) == 'package-2020-12' && $(go) output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-12-01/$(namespace) ``` @@ -84,7 +84,7 @@ output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-12-01/$(namespac These settings apply only when `--tag=package-2020-09 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -``` yaml $(tag) == 'package-2020-09' && $(go) +```yaml $(tag) == 'package-2020-09' && $(go) output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-09-01/$(namespace) ``` @@ -93,7 +93,7 @@ output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-09-01/$(namespac 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) +```yaml $(tag) == 'package-2020-06' && $(go) output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-06-01/$(namespace) ``` @@ -102,7 +102,7 @@ output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-06-01/$(namespac These settings apply only when `--tag=package-2019-08 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -``` yaml $(tag) == 'package-2019-08' && $(go) +```yaml $(tag) == 'package-2019-08' && $(go) output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2019-08-01/$(namespace) ``` @@ -111,7 +111,7 @@ output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2019-08-01/$(namespac These settings apply only when `--tag=package-2018-02 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -``` yaml $(tag) == 'package-2018-02' && $(go) +```yaml $(tag) == 'package-2018-02' && $(go) output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-02-01/$(namespace) ``` @@ -120,7 +120,7 @@ output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-02-01/$(namespac These settings apply only when `--tag=package-2016-09 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -``` yaml $(tag) == 'package-2016-09' && $(go) +```yaml $(tag) == 'package-2016-09' && $(go) output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2016-09-01/$(namespace) ``` @@ -129,6 +129,6 @@ output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2016-09-01/$(namespac These settings apply only when `--tag=package-2015-08-preview --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -``` yaml $(tag) == 'package-2015-08-preview' && $(go) +```yaml $(tag) == 'package-2015-08-preview' && $(go) output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2015-08-01-preview/$(namespace) ``` diff --git a/specification/web/resource-manager/readme.java.md b/specification/web/resource-manager/readme.java.md index 823e21a683e1..63c288692df6 100644 --- a/specification/web/resource-manager/readme.java.md +++ b/specification/web/resource-manager/readme.java.md @@ -2,7 +2,7 @@ These settings apply only when `--java` is specified on the command line. -``` yaml $(java) +```yaml $(java) azure-arm: true fluent: true namespace: com.microsoft.azure.management.appservice @@ -30,7 +30,7 @@ directive: "schema": { "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" } - }; + }; reason: Swagger bug. Function App on ACA is LRO. - from: WebApps.json where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web"].put @@ -45,7 +45,7 @@ directive: "schema": { "$ref": "#/definitions/SiteConfigResource" } - }; + }; reason: Swagger bug. Function App on ACA is LRO. - from: WebApps.json where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}"].patch @@ -59,24 +59,24 @@ directive: These settings apply only when `--tag=profile-hybrid-2020-09-01 --java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. -``` yaml $(tag) == 'profile-hybrid-2020-09-01' && $(java) +```yaml $(tag) == 'profile-hybrid-2020-09-01' && $(java) input-file: -- Microsoft.CertificateRegistration/stable/2018-02-01/AppServiceCertificateOrders.json -- Microsoft.CertificateRegistration/stable/2018-02-01/CertificateRegistrationProvider.json -- Microsoft.DomainRegistration/stable/2018-02-01/Domains.json -- Microsoft.DomainRegistration/stable/2018-02-01/TopLevelDomains.json -- Microsoft.DomainRegistration/stable/2018-02-01/DomainRegistrationProvider.json -- Microsoft.Web/stable/2018-02-01/Certificates.json -- Microsoft.Web/stable/2018-02-01/CommonDefinitions.json -- Microsoft.Web/stable/2018-02-01/DeletedWebApps.json -- Microsoft.Web/stable/2018-02-01/Diagnostics.json -- Microsoft.Web/stable/2018-02-01/Provider.json -- Microsoft.Web/stable/2018-02-01/Recommendations.json -- Microsoft.Web/stable/2018-02-01/ResourceProvider.json -- Microsoft.Web/stable/2018-02-01/WebApps.json -- Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json -- Microsoft.Web/stable/2018-02-01/AppServicePlans.json -- Microsoft.Web/stable/2018-02-01/ResourceHealthMetadata.json + - Microsoft.CertificateRegistration/stable/2018-02-01/AppServiceCertificateOrders.json + - Microsoft.CertificateRegistration/stable/2018-02-01/CertificateRegistrationProvider.json + - Microsoft.DomainRegistration/stable/2018-02-01/Domains.json + - Microsoft.DomainRegistration/stable/2018-02-01/TopLevelDomains.json + - Microsoft.DomainRegistration/stable/2018-02-01/DomainRegistrationProvider.json + - Microsoft.Web/stable/2018-02-01/Certificates.json + - Microsoft.Web/stable/2018-02-01/CommonDefinitions.json + - Microsoft.Web/stable/2018-02-01/DeletedWebApps.json + - Microsoft.Web/stable/2018-02-01/Diagnostics.json + - Microsoft.Web/stable/2018-02-01/Provider.json + - Microsoft.Web/stable/2018-02-01/Recommendations.json + - Microsoft.Web/stable/2018-02-01/ResourceProvider.json + - Microsoft.Web/stable/2018-02-01/WebApps.json + - Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json + - Microsoft.Web/stable/2018-02-01/AppServicePlans.json + - Microsoft.Web/stable/2018-02-01/ResourceHealthMetadata.json directive: - from: CommonDefinitions.json where: $.definitions.Identifier.properties.properties.properties.id diff --git a/specification/web/resource-manager/readme.md b/specification/web/resource-manager/readme.md index 80bc0272b75f..3439fcbf43ec 100644 --- a/specification/web/resource-manager/readme.md +++ b/specification/web/resource-manager/readme.md @@ -30,16 +30,16 @@ To see additional help and options, run: These are the global settings for the Web API. -``` yaml +```yaml title: WebSiteManagementClient description: WebSite Management Client openapi-type: arm -tag: package-2023-12 +tag: package-2024-04 ``` ### Suppression -``` yaml +```yaml directive: - suppress: XmsResourceInPutResponse from: WebApps.json @@ -63,7 +63,7 @@ directive: reason: Property name contains WWW which is an acronym, so camel case does not apply here. - suppress: OAV107 from: AppServiceCertificateOrders.json - reason: Will fix in next version. + reason: Will fix in next version. - suppress: XMS_EXAMPLE_NOTFOUND_ERROR from: ResourceProvider.json reason: Model type is not owned by cert and domain team @@ -90,6 +90,36 @@ directive: reason: Retroactive addition of missing examples out of scope at this time. ``` +### Tag: package-2024-04 + +These settings apply only when `--tag=package-2024-04` is specified on the command line. + +```yaml $(tag) == 'package-2024-04' +input-file: + - Microsoft.CertificateRegistration/stable/2024-04-01/AppServiceCertificateOrders.json + - Microsoft.CertificateRegistration/stable/2024-04-01/CertificateOrdersDiagnostics.json + - Microsoft.CertificateRegistration/stable/2024-04-01/CertificateRegistrationProvider.json + - Microsoft.DomainRegistration/stable/2024-04-01/DomainRegistrationProvider.json + - Microsoft.DomainRegistration/stable/2024-04-01/Domains.json + - Microsoft.DomainRegistration/stable/2024-04-01/TopLevelDomains.json + - Microsoft.Web/stable/2024-04-01/AppServiceEnvironments.json + - Microsoft.Web/stable/2024-04-01/AppServicePlans.json + - Microsoft.Web/stable/2024-04-01/Certificates.json + - Microsoft.Web/stable/2024-04-01/CommonDefinitions.json + - Microsoft.Web/stable/2024-04-01/ContainerApps.json + - Microsoft.Web/stable/2024-04-01/ContainerAppsRevisions.json + - Microsoft.Web/stable/2024-04-01/DeletedWebApps.json + - Microsoft.Web/stable/2024-04-01/Diagnostics.json + - Microsoft.Web/stable/2024-04-01/Global.json + - Microsoft.Web/stable/2024-04-01/KubeEnvironments.json + - Microsoft.Web/stable/2024-04-01/Provider.json + - Microsoft.Web/stable/2024-04-01/Recommendations.json + - Microsoft.Web/stable/2024-04-01/ResourceHealthMetadata.json + - Microsoft.Web/stable/2024-04-01/ResourceProvider.json + - Microsoft.Web/stable/2024-04-01/StaticSites.json + - Microsoft.Web/stable/2024-04-01/WebApps.json +``` + ### Tag: package-2023-12 These settings apply only when `--tag=package-2023-12` is specified on the command line. @@ -120,148 +150,148 @@ input-file: - Microsoft.Web/stable/2023-12-01/WebApps.json directive: # suppress each RPC 3016 error -- where: $.definitions.FunctionSecrets.properties.trigger_url - suppress: R3016 - reason: This requires a breaking change in functions runtime API. -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version -- where: $.definitions.VnetGateway - suppress: R4015 - reason: Does not have list operation -- where: $.definitions.VnetInfoResource - suppress: R4015 - reason: Does not have list operation -- suppress: R4009 - from: AppServiceCertificateOrders.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CertificateOrdersDiagnostics.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CertificateRegistrationProvider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Domains.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: TopLevelDomains.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: DomainRegistrationProvider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Certificates.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CommonDefinitions.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: DeletedWebApps.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Diagnostics.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Global.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Provider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Recommendations.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: WebApps.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: StaticSites.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: AppServiceEnvironments.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: AppServicePlans.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: ResourceHealthMetadata.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: KubeEnvironments.json - reason: SystemData will implement in next version. -- suppress: R4015 - from: WebApps.json - where: $.definitions.NetworkFeatures - reason: Will fix in next version -- suppress: R4019 - from: Recommendations.json - reason: Will fix in next version -- suppress: R4019 - from: WebApps.json - reason: Will fix in next version -- suppress: R3021 - from: WebApps.json - reason: Will fix in next version -- suppress: R4011 - from: WebApps.json - reason: Will fix in next version -- suppress: R4011 - from: AppServiceEnvironments.json - reason: Will fix in next version -- suppress: R4011 - from: StaticSites.json - reason: Will fix in next version -- suppress: R4011 - from: AppServicePlans.json - reason: Will fix in next version -- suppress: D5001 - reason: Will fix in next version -- suppress: R1003 - reason: Will fix in next version -- suppress: R2001 - reason: Will fix in next version -- suppress: R2029 - reason: Will fix in next version -- suppress: R2063 - reason: Will fix in next version -- suppress: R3010 - reason: Will fix in next version -- where: $.definitions.TriggeredJobRun.properties.trigger_url - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.web_job_name - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.start_time - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.end_time - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.output_url - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.error_url - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.job_name - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.web_job_id - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- suppress: R4009 - from: ContainerApps.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: ContainerAppsRevisions.json - reason: SystemData will implement in next version. -- suppress: R3026 - from: ContainerApps.json - reason: Patch operation will be implemented in later version. -- suppress: R3026 - from: ContainerAppsRevisions.json - reason: Patch operation will be implemented in later version. + - where: $.definitions.FunctionSecrets.properties.trigger_url + suppress: R3016 + reason: This requires a breaking change in functions runtime API. + - where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + - where: $.definitions.VnetGateway + suppress: R4015 + reason: Does not have list operation + - where: $.definitions.VnetInfoResource + suppress: R4015 + reason: Does not have list operation + - suppress: R4009 + from: AppServiceCertificateOrders.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CertificateOrdersDiagnostics.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CertificateRegistrationProvider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Domains.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: TopLevelDomains.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: DomainRegistrationProvider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Certificates.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CommonDefinitions.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: DeletedWebApps.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Diagnostics.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Global.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Provider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Recommendations.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: WebApps.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: StaticSites.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: AppServiceEnvironments.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: AppServicePlans.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: ResourceHealthMetadata.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: KubeEnvironments.json + reason: SystemData will implement in next version. + - suppress: R4015 + from: WebApps.json + where: $.definitions.NetworkFeatures + reason: Will fix in next version + - suppress: R4019 + from: Recommendations.json + reason: Will fix in next version + - suppress: R4019 + from: WebApps.json + reason: Will fix in next version + - suppress: R3021 + from: WebApps.json + reason: Will fix in next version + - suppress: R4011 + from: WebApps.json + reason: Will fix in next version + - suppress: R4011 + from: AppServiceEnvironments.json + reason: Will fix in next version + - suppress: R4011 + from: StaticSites.json + reason: Will fix in next version + - suppress: R4011 + from: AppServicePlans.json + reason: Will fix in next version + - suppress: D5001 + reason: Will fix in next version + - suppress: R1003 + reason: Will fix in next version + - suppress: R2001 + reason: Will fix in next version + - suppress: R2029 + reason: Will fix in next version + - suppress: R2063 + reason: Will fix in next version + - suppress: R3010 + reason: Will fix in next version + - where: $.definitions.TriggeredJobRun.properties.trigger_url + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.web_job_name + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.start_time + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.end_time + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.output_url + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.error_url + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.job_name + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.web_job_id + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - suppress: R4009 + from: ContainerApps.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: ContainerAppsRevisions.json + reason: SystemData will implement in next version. + - suppress: R3026 + from: ContainerApps.json + reason: Patch operation will be implemented in later version. + - suppress: R3026 + from: ContainerAppsRevisions.json + reason: Patch operation will be implemented in later version. ``` ### Tag: package-2023-01 @@ -294,148 +324,148 @@ input-file: - Microsoft.Web/stable/2023-01-01/WebApps.json directive: # suppress each RPC 3016 error -- where: $.definitions.FunctionSecrets.properties.trigger_url - suppress: R3016 - reason: This requires a breaking change in functions runtime API. -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version -- where: $.definitions.VnetGateway - suppress: R4015 - reason: Does not have list operation -- where: $.definitions.VnetInfoResource - suppress: R4015 - reason: Does not have list operation -- suppress: R4009 - from: AppServiceCertificateOrders.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CertificateOrdersDiagnostics.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CertificateRegistrationProvider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Domains.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: TopLevelDomains.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: DomainRegistrationProvider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Certificates.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CommonDefinitions.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: DeletedWebApps.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Diagnostics.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Global.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Provider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Recommendations.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: WebApps.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: StaticSites.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: AppServiceEnvironments.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: AppServicePlans.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: ResourceHealthMetadata.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: KubeEnvironments.json - reason: SystemData will implement in next version. -- suppress: R4015 - from: WebApps.json - where: $.definitions.NetworkFeatures - reason: Will fix in next version -- suppress: R4019 - from: Recommendations.json - reason: Will fix in next version -- suppress: R4019 - from: WebApps.json - reason: Will fix in next version -- suppress: R3021 - from: WebApps.json - reason: Will fix in next version -- suppress: R4011 - from: WebApps.json - reason: Will fix in next version -- suppress: R4011 - from: AppServiceEnvironments.json - reason: Will fix in next version -- suppress: R4011 - from: StaticSites.json - reason: Will fix in next version -- suppress: R4011 - from: AppServicePlans.json - reason: Will fix in next version -- suppress: D5001 - reason: Will fix in next version -- suppress: R1003 - reason: Will fix in next version -- suppress: R2001 - reason: Will fix in next version -- suppress: R2029 - reason: Will fix in next version -- suppress: R2063 - reason: Will fix in next version -- suppress: R3010 - reason: Will fix in next version -- where: $.definitions.TriggeredJobRun.properties.trigger_url - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.web_job_name - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.start_time - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.end_time - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.output_url - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.error_url - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.job_name - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.web_job_id - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- suppress: R4009 - from: ContainerApps.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: ContainerAppsRevisions.json - reason: SystemData will implement in next version. -- suppress: R3026 - from: ContainerApps.json - reason: Patch operation will be implemented in later version. -- suppress: R3026 - from: ContainerAppsRevisions.json - reason: Patch operation will be implemented in later version. + - where: $.definitions.FunctionSecrets.properties.trigger_url + suppress: R3016 + reason: This requires a breaking change in functions runtime API. + - where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + - where: $.definitions.VnetGateway + suppress: R4015 + reason: Does not have list operation + - where: $.definitions.VnetInfoResource + suppress: R4015 + reason: Does not have list operation + - suppress: R4009 + from: AppServiceCertificateOrders.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CertificateOrdersDiagnostics.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CertificateRegistrationProvider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Domains.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: TopLevelDomains.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: DomainRegistrationProvider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Certificates.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CommonDefinitions.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: DeletedWebApps.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Diagnostics.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Global.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Provider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Recommendations.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: WebApps.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: StaticSites.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: AppServiceEnvironments.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: AppServicePlans.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: ResourceHealthMetadata.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: KubeEnvironments.json + reason: SystemData will implement in next version. + - suppress: R4015 + from: WebApps.json + where: $.definitions.NetworkFeatures + reason: Will fix in next version + - suppress: R4019 + from: Recommendations.json + reason: Will fix in next version + - suppress: R4019 + from: WebApps.json + reason: Will fix in next version + - suppress: R3021 + from: WebApps.json + reason: Will fix in next version + - suppress: R4011 + from: WebApps.json + reason: Will fix in next version + - suppress: R4011 + from: AppServiceEnvironments.json + reason: Will fix in next version + - suppress: R4011 + from: StaticSites.json + reason: Will fix in next version + - suppress: R4011 + from: AppServicePlans.json + reason: Will fix in next version + - suppress: D5001 + reason: Will fix in next version + - suppress: R1003 + reason: Will fix in next version + - suppress: R2001 + reason: Will fix in next version + - suppress: R2029 + reason: Will fix in next version + - suppress: R2063 + reason: Will fix in next version + - suppress: R3010 + reason: Will fix in next version + - where: $.definitions.TriggeredJobRun.properties.trigger_url + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.web_job_name + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.start_time + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.end_time + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.output_url + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.error_url + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.job_name + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.web_job_id + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - suppress: R4009 + from: ContainerApps.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: ContainerAppsRevisions.json + reason: SystemData will implement in next version. + - suppress: R3026 + from: ContainerApps.json + reason: Patch operation will be implemented in later version. + - suppress: R3026 + from: ContainerAppsRevisions.json + reason: Patch operation will be implemented in later version. ``` ### Tag: package-2022-09 @@ -468,154 +498,155 @@ input-file: - Microsoft.Web/stable/2022-09-01/WebApps.json directive: # suppress each RPC 3016 error -- where: $.definitions.FunctionSecrets.properties.trigger_url - suppress: R3016 - reason: This requires a breaking change in functions runtime API. -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version -- where: $.definitions.VnetGateway - suppress: R4015 - reason: Does not have list operation -- where: $.definitions.VnetInfoResource - suppress: R4015 - reason: Does not have list operation -- suppress: R4009 - from: AppServiceCertificateOrders.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CertificateOrdersDiagnostics.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CertificateRegistrationProvider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Domains.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: TopLevelDomains.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: DomainRegistrationProvider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Certificates.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CommonDefinitions.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: DeletedWebApps.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Diagnostics.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Global.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Provider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Recommendations.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: WebApps.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: StaticSites.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: AppServiceEnvironments.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: AppServicePlans.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: ResourceHealthMetadata.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: KubeEnvironments.json - reason: SystemData will implement in next version. -- suppress: R4015 - from: WebApps.json - where: $.definitions.NetworkFeatures - reason: Will fix in next version -- suppress: R4019 - from: Recommendations.json - reason: Will fix in next version -- suppress: R4019 - from: WebApps.json - reason: Will fix in next version -- suppress: R3021 - from: WebApps.json - reason: Will fix in next version -- suppress: R4011 - from: WebApps.json - reason: Will fix in next version -- suppress: R4011 - from: AppServiceEnvironments.json - reason: Will fix in next version -- suppress: R4011 - from: StaticSites.json - reason: Will fix in next version -- suppress: R4011 - from: AppServicePlans.json - reason: Will fix in next version -- suppress: D5001 - reason: Will fix in next version -- suppress: R1003 - reason: Will fix in next version -- suppress: R2001 - reason: Will fix in next version -- suppress: R2029 - reason: Will fix in next version -- suppress: R2063 - reason: Will fix in next version -- suppress: R3010 - reason: Will fix in next version -- where: $.definitions.TriggeredJobRun.properties.trigger_url - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.web_job_name - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.start_time - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.end_time - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.output_url - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.error_url - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.job_name - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.web_job_id - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- suppress: R4009 - from: ContainerApps.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: ContainerAppsRevisions.json - reason: SystemData will implement in next version. -- suppress: R3026 - from: ContainerApps.json - reason: Patch operation will be implemented in later version. -- suppress: R3026 - from: ContainerAppsRevisions.json - reason: Patch operation will be implemented in later version. + - where: $.definitions.FunctionSecrets.properties.trigger_url + suppress: R3016 + reason: This requires a breaking change in functions runtime API. + - where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + - where: $.definitions.VnetGateway + suppress: R4015 + reason: Does not have list operation + - where: $.definitions.VnetInfoResource + suppress: R4015 + reason: Does not have list operation + - suppress: R4009 + from: AppServiceCertificateOrders.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CertificateOrdersDiagnostics.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CertificateRegistrationProvider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Domains.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: TopLevelDomains.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: DomainRegistrationProvider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Certificates.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CommonDefinitions.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: DeletedWebApps.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Diagnostics.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Global.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Provider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Recommendations.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: WebApps.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: StaticSites.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: AppServiceEnvironments.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: AppServicePlans.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: ResourceHealthMetadata.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: KubeEnvironments.json + reason: SystemData will implement in next version. + - suppress: R4015 + from: WebApps.json + where: $.definitions.NetworkFeatures + reason: Will fix in next version + - suppress: R4019 + from: Recommendations.json + reason: Will fix in next version + - suppress: R4019 + from: WebApps.json + reason: Will fix in next version + - suppress: R3021 + from: WebApps.json + reason: Will fix in next version + - suppress: R4011 + from: WebApps.json + reason: Will fix in next version + - suppress: R4011 + from: AppServiceEnvironments.json + reason: Will fix in next version + - suppress: R4011 + from: StaticSites.json + reason: Will fix in next version + - suppress: R4011 + from: AppServicePlans.json + reason: Will fix in next version + - suppress: D5001 + reason: Will fix in next version + - suppress: R1003 + reason: Will fix in next version + - suppress: R2001 + reason: Will fix in next version + - suppress: R2029 + reason: Will fix in next version + - suppress: R2063 + reason: Will fix in next version + - suppress: R3010 + reason: Will fix in next version + - where: $.definitions.TriggeredJobRun.properties.trigger_url + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.web_job_name + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.start_time + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.end_time + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.output_url + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.error_url + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.job_name + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.web_job_id + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - suppress: R4009 + from: ContainerApps.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: ContainerAppsRevisions.json + reason: SystemData will implement in next version. + - suppress: R3026 + from: ContainerApps.json + reason: Patch operation will be implemented in later version. + - suppress: R3026 + from: ContainerAppsRevisions.json + reason: Patch operation will be implemented in later version. ``` + ### Tag: package-2022-03 These settings apply only when `--tag=package-2022-03` is specified on the command line. -``` yaml $(tag) == 'package-2022-03' || $(tag) == 'package-2022-03-only' +```yaml $(tag) == 'package-2022-03' || $(tag) == 'package-2022-03-only' input-file: - Microsoft.CertificateRegistration/stable/2022-03-01/AppServiceCertificateOrders.json - Microsoft.CertificateRegistration/stable/2022-03-01/CertificateOrdersDiagnostics.json @@ -639,157 +670,157 @@ input-file: - Microsoft.Web/stable/2022-03-01/ResourceProvider.json - Microsoft.Web/stable/2022-03-01/StaticSites.json - Microsoft.Web/stable/2022-03-01/WebApps.json -directive: +directive: # suppress each RPC 3016 error -- where: $.definitions.FunctionSecrets.properties.trigger_url - suppress: R3016 - reason: This requires a breaking change in functions runtime API. -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version -- where: $.definitions.VnetGateway - suppress: R4015 - reason: Does not have list operation -- where: $.definitions.VnetInfoResource - suppress: R4015 - reason: Does not have list operation -- suppress: R4009 - from: AppServiceCertificateOrders.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CertificateOrdersDiagnostics.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CertificateRegistrationProvider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Domains.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: TopLevelDomains.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: DomainRegistrationProvider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Certificates.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CommonDefinitions.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: DeletedWebApps.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Diagnostics.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Global.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Provider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Recommendations.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: WebApps.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: StaticSites.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: AppServiceEnvironments.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: AppServicePlans.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: ResourceHealthMetadata.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: KubeEnvironments.json - reason: SystemData will implement in next version. -- suppress: R4015 - from: WebApps.json - where: $.definitions.NetworkFeatures - reason: Will fix in next version -- suppress: R4019 - from: Recommendations.json - reason: Will fix in next version -- suppress: R4019 - from: WebApps.json - reason: Will fix in next version -- suppress: R3021 - from: WebApps.json - reason: Will fix in next version -- suppress: R4011 - from: WebApps.json - reason: Will fix in next version -- suppress: R4011 - from: AppServiceEnvironments.json - reason: Will fix in next version -- suppress: R4011 - from: StaticSites.json - reason: Will fix in next version -- suppress: R4011 - from: AppServicePlans.json - reason: Will fix in next version -- suppress: D5001 - reason: Will fix in next version -- suppress: R1003 - reason: Will fix in next version -- suppress: R2001 - reason: Will fix in next version -- suppress: R2029 - reason: Will fix in next version -- suppress: R2063 - reason: Will fix in next version -- suppress: R3010 - reason: Will fix in next version -- where: $.definitions.TriggeredJobRun.properties.trigger_url - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.web_job_name - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.start_time - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.end_time - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.output_url - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.error_url - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.job_name - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.web_job_id - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- suppress: R4009 - from: ContainerApps.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: ContainerAppsRevisions.json - reason: SystemData will implement in next version. -- suppress: R3026 - from: ContainerApps.json - reason: Patch operation will be implemented in later version. -- suppress: R3026 - from: ContainerAppsRevisions.json - reason: Patch operation will be implemented in later version. + - where: $.definitions.FunctionSecrets.properties.trigger_url + suppress: R3016 + reason: This requires a breaking change in functions runtime API. + - where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + - where: $.definitions.VnetGateway + suppress: R4015 + reason: Does not have list operation + - where: $.definitions.VnetInfoResource + suppress: R4015 + reason: Does not have list operation + - suppress: R4009 + from: AppServiceCertificateOrders.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CertificateOrdersDiagnostics.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CertificateRegistrationProvider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Domains.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: TopLevelDomains.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: DomainRegistrationProvider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Certificates.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CommonDefinitions.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: DeletedWebApps.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Diagnostics.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Global.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Provider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Recommendations.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: WebApps.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: StaticSites.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: AppServiceEnvironments.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: AppServicePlans.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: ResourceHealthMetadata.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: KubeEnvironments.json + reason: SystemData will implement in next version. + - suppress: R4015 + from: WebApps.json + where: $.definitions.NetworkFeatures + reason: Will fix in next version + - suppress: R4019 + from: Recommendations.json + reason: Will fix in next version + - suppress: R4019 + from: WebApps.json + reason: Will fix in next version + - suppress: R3021 + from: WebApps.json + reason: Will fix in next version + - suppress: R4011 + from: WebApps.json + reason: Will fix in next version + - suppress: R4011 + from: AppServiceEnvironments.json + reason: Will fix in next version + - suppress: R4011 + from: StaticSites.json + reason: Will fix in next version + - suppress: R4011 + from: AppServicePlans.json + reason: Will fix in next version + - suppress: D5001 + reason: Will fix in next version + - suppress: R1003 + reason: Will fix in next version + - suppress: R2001 + reason: Will fix in next version + - suppress: R2029 + reason: Will fix in next version + - suppress: R2063 + reason: Will fix in next version + - suppress: R3010 + reason: Will fix in next version + - where: $.definitions.TriggeredJobRun.properties.trigger_url + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.web_job_name + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.start_time + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.end_time + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.output_url + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.error_url + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.job_name + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.web_job_id + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - suppress: R4009 + from: ContainerApps.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: ContainerAppsRevisions.json + reason: SystemData will implement in next version. + - suppress: R3026 + from: ContainerApps.json + reason: Patch operation will be implemented in later version. + - suppress: R3026 + from: ContainerAppsRevisions.json + reason: Patch operation will be implemented in later version. ``` ### Tag: package-2021-03 These settings apply only when `--tag=package-2021-03` is specified on the command line. -``` yaml $(tag) == 'package-2021-03' || $(tag) == 'package-2021-03-only' +```yaml $(tag) == 'package-2021-03' || $(tag) == 'package-2021-03-only' input-file: - Microsoft.CertificateRegistration/stable/2021-03-01/AppServiceCertificateOrders.json - Microsoft.CertificateRegistration/stable/2021-03-01/CertificateOrdersDiagnostics.json @@ -815,158 +846,158 @@ input-file: - Microsoft.Web/stable/2021-03-01/WebApps.json directive: # suppress each RPC 3016 error -- where: $.definitions.FunctionSecrets.properties.trigger_url - suppress: R3016 - reason: This requires a breaking change in functions runtime API. -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version -- where: $.definitions.VnetGateway - suppress: R4015 - reason: Does not have list operation -- where: $.definitions.VnetInfoResource - suppress: R4015 - reason: Does not have list operation -- suppress: R4009 - from: AppServiceCertificateOrders.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CertificateOrdersDiagnostics.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CertificateRegistrationProvider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Domains.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: TopLevelDomains.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: DomainRegistrationProvider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Certificates.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CommonDefinitions.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: DeletedWebApps.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Diagnostics.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Global.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Provider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Recommendations.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: WebApps.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: StaticSites.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: AppServiceEnvironments.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: AppServicePlans.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: ResourceHealthMetadata.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: KubeEnvironments.json - reason: SystemData will implement in next version. -- suppress: R4015 - from: WebApps.json - where: $.definitions.NetworkFeatures - reason: Will fix in next version -- suppress: R4019 - from: Recommendations.json - reason: Will fix in next version -- suppress: R4019 - from: WebApps.json - reason: Will fix in next version -- suppress: R3021 - from: WebApps.json - reason: Will fix in next version -- suppress: R4011 - from: WebApps.json - reason: Will fix in next version -- suppress: R4011 - from: AppServiceEnvironments.json - reason: Will fix in next version -- suppress: R4011 - from: StaticSites.json - reason: Will fix in next version -- suppress: R4011 - from: AppServicePlans.json - reason: Will fix in next version -- suppress: D5001 - reason: Will fix in next version -- suppress: R1003 - reason: Will fix in next version -- suppress: R2001 - reason: Will fix in next version -- suppress: R2029 - reason: Will fix in next version -- suppress: R2063 - reason: Will fix in next version -- suppress: R3010 - reason: Will fix in next version -- where: $.definitions.TriggeredJobRun.properties.trigger_url - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.web_job_name - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.start_time - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.end_time - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.output_url - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.error_url - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.job_name - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.web_job_id - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- suppress: R4009 - from: ContainerApps.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: ContainerAppsRevisions.json - reason: SystemData will implement in next version. -- suppress: R3026 - from: ContainerApps.json - reason: Patch operation will be implemented in later version. -- suppress: R3026 - from: ContainerAppsRevisions.json - reason: Patch operation will be implemented in later version. -- suppress: OAV107 - from: AppServiceCertificateOrders.json - reason: Will fix in next version. + - where: $.definitions.FunctionSecrets.properties.trigger_url + suppress: R3016 + reason: This requires a breaking change in functions runtime API. + - where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + - where: $.definitions.VnetGateway + suppress: R4015 + reason: Does not have list operation + - where: $.definitions.VnetInfoResource + suppress: R4015 + reason: Does not have list operation + - suppress: R4009 + from: AppServiceCertificateOrders.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CertificateOrdersDiagnostics.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CertificateRegistrationProvider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Domains.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: TopLevelDomains.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: DomainRegistrationProvider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Certificates.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CommonDefinitions.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: DeletedWebApps.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Diagnostics.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Global.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Provider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Recommendations.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: WebApps.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: StaticSites.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: AppServiceEnvironments.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: AppServicePlans.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: ResourceHealthMetadata.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: KubeEnvironments.json + reason: SystemData will implement in next version. + - suppress: R4015 + from: WebApps.json + where: $.definitions.NetworkFeatures + reason: Will fix in next version + - suppress: R4019 + from: Recommendations.json + reason: Will fix in next version + - suppress: R4019 + from: WebApps.json + reason: Will fix in next version + - suppress: R3021 + from: WebApps.json + reason: Will fix in next version + - suppress: R4011 + from: WebApps.json + reason: Will fix in next version + - suppress: R4011 + from: AppServiceEnvironments.json + reason: Will fix in next version + - suppress: R4011 + from: StaticSites.json + reason: Will fix in next version + - suppress: R4011 + from: AppServicePlans.json + reason: Will fix in next version + - suppress: D5001 + reason: Will fix in next version + - suppress: R1003 + reason: Will fix in next version + - suppress: R2001 + reason: Will fix in next version + - suppress: R2029 + reason: Will fix in next version + - suppress: R2063 + reason: Will fix in next version + - suppress: R3010 + reason: Will fix in next version + - where: $.definitions.TriggeredJobRun.properties.trigger_url + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.web_job_name + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.start_time + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.end_time + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.output_url + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.error_url + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.job_name + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.web_job_id + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - suppress: R4009 + from: ContainerApps.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: ContainerAppsRevisions.json + reason: SystemData will implement in next version. + - suppress: R3026 + from: ContainerApps.json + reason: Patch operation will be implemented in later version. + - suppress: R3026 + from: ContainerAppsRevisions.json + reason: Patch operation will be implemented in later version. + - suppress: OAV107 + from: AppServiceCertificateOrders.json + reason: Will fix in next version. ``` ### Tag: package-2021-02 These settings apply only when `--tag=package-2021-02` is specified on the command line. -``` yaml $(tag) == 'package-2021-02' || $(tag) == 'package-2021-02-only' +```yaml $(tag) == 'package-2021-02' || $(tag) == 'package-2021-02-only' input-file: - Microsoft.CertificateRegistration/stable/2021-02-01/AppServiceCertificateOrders.json - Microsoft.CertificateRegistration/stable/2021-02-01/CertificateOrdersDiagnostics.json @@ -990,146 +1021,146 @@ input-file: - Microsoft.Web/stable/2021-02-01/WebApps.json directive: # suppress each RPC 3016 error -- where: $.definitions.FunctionSecrets.properties.trigger_url - suppress: R3016 - reason: This requires a breaking change in functions runtime API. -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version -- where: $.definitions.VnetGateway - suppress: R4015 - reason: Does not have list operation -- where: $.definitions.VnetInfoResource - suppress: R4015 - reason: Does not have list operation -- suppress: R4009 - from: AppServiceCertificateOrders.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CertificateOrdersDiagnostics.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CertificateRegistrationProvider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Domains.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: TopLevelDomains.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: DomainRegistrationProvider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Certificates.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CommonDefinitions.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: DeletedWebApps.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Diagnostics.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Global.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Provider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Recommendations.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: WebApps.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: StaticSites.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: AppServiceEnvironments.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: AppServicePlans.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: ResourceHealthMetadata.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: KubeEnvironments.json - reason: SystemData will implement in next version. -- suppress: R4015 - from: WebApps.json - where: $.definitions.NetworkFeatures - reason: Will fix in next version -- suppress: R4019 - from: Recommendations.json - reason: Will fix in next version -- suppress: R4019 - from: WebApps.json - reason: Will fix in next version -- suppress: R3021 - from: WebApps.json - reason: Will fix in next version -- suppress: R4011 - from: WebApps.json - reason: Will fix in next version -- suppress: R4011 - from: AppServiceEnvironments.json - reason: Will fix in next version -- suppress: R4011 - from: StaticSites.json - reason: Will fix in next version -- suppress: R4011 - from: AppServicePlans.json - reason: Will fix in next version -- suppress: D5001 - reason: Will fix in next version -- suppress: R1003 - reason: Will fix in next version -- suppress: R2001 - reason: Will fix in next version -- suppress: R2029 - reason: Will fix in next version -- suppress: R2063 - reason: Will fix in next version -- suppress: R3010 - reason: Will fix in next version -- where: $.definitions.TriggeredJobRun.properties.trigger_url - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.web_job_name - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.start_time - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.end_time - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.output_url - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.error_url - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.job_name - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- where: $.definitions.TriggeredJobRun.properties.web_job_id - suppress: R3016 - reason: This requires a breaking change in kudu runtime API. -- suppress: OAV107 - from: AppServiceCertificateOrders.json - reason: Will fix in next version. + - where: $.definitions.FunctionSecrets.properties.trigger_url + suppress: R3016 + reason: This requires a breaking change in functions runtime API. + - where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + - where: $.definitions.VnetGateway + suppress: R4015 + reason: Does not have list operation + - where: $.definitions.VnetInfoResource + suppress: R4015 + reason: Does not have list operation + - suppress: R4009 + from: AppServiceCertificateOrders.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CertificateOrdersDiagnostics.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CertificateRegistrationProvider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Domains.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: TopLevelDomains.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: DomainRegistrationProvider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Certificates.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CommonDefinitions.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: DeletedWebApps.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Diagnostics.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Global.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Provider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Recommendations.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: WebApps.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: StaticSites.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: AppServiceEnvironments.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: AppServicePlans.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: ResourceHealthMetadata.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: KubeEnvironments.json + reason: SystemData will implement in next version. + - suppress: R4015 + from: WebApps.json + where: $.definitions.NetworkFeatures + reason: Will fix in next version + - suppress: R4019 + from: Recommendations.json + reason: Will fix in next version + - suppress: R4019 + from: WebApps.json + reason: Will fix in next version + - suppress: R3021 + from: WebApps.json + reason: Will fix in next version + - suppress: R4011 + from: WebApps.json + reason: Will fix in next version + - suppress: R4011 + from: AppServiceEnvironments.json + reason: Will fix in next version + - suppress: R4011 + from: StaticSites.json + reason: Will fix in next version + - suppress: R4011 + from: AppServicePlans.json + reason: Will fix in next version + - suppress: D5001 + reason: Will fix in next version + - suppress: R1003 + reason: Will fix in next version + - suppress: R2001 + reason: Will fix in next version + - suppress: R2029 + reason: Will fix in next version + - suppress: R2063 + reason: Will fix in next version + - suppress: R3010 + reason: Will fix in next version + - where: $.definitions.TriggeredJobRun.properties.trigger_url + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.web_job_name + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.start_time + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.end_time + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.output_url + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.error_url + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.job_name + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - where: $.definitions.TriggeredJobRun.properties.web_job_id + suppress: R3016 + reason: This requires a breaking change in kudu runtime API. + - suppress: OAV107 + from: AppServiceCertificateOrders.json + reason: Will fix in next version. ``` ### Tag: package-2021-01-15 These settings apply only when `--tag=package-2021-01-15` is specified on the command line. -``` yaml $(tag) == 'package-2021-01-15' || $(tag) == 'package-2021-01-15-only' +```yaml $(tag) == 'package-2021-01-15' || $(tag) == 'package-2021-01-15-only' input-file: - Microsoft.CertificateRegistration/stable/2021-01-15/AppServiceCertificateOrders.json - Microsoft.CertificateRegistration/stable/2021-01-15/CertificateOrdersDiagnostics.json @@ -1153,122 +1184,122 @@ input-file: - Microsoft.Web/stable/2021-01-15/WebApps.json directive: # suppress each RPC 3016 error -- where: $.definitions.FunctionSecrets.properties.trigger_url - suppress: R3016 - reason: This requires a breaking change in functions runtime API. -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version -- where: $.definitions.VnetGateway - suppress: R4015 - reason: Does not have list operation -- where: $.definitions.VnetInfo - suppress: R4015 - reason: Does not have list operation -- suppress: R4009 - from: AppServiceCertificateOrders.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CertificateOrdersDiagnostics.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CertificateRegistrationProvider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Domains.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: TopLevelDomains.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: DomainRegistrationProvider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Certificates.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CommonDefinitions.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: DeletedWebApps.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Diagnostics.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Global.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Provider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Recommendations.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: WebApps.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: StaticSites.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: AppServiceEnvironments.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: AppServicePlans.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: ResourceHealthMetadata.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: KubeEnvironments.json - reason: SystemData will implement in next version. -- suppress: R4015 - from: WebApps.json - where: $.definitions.NetworkFeatures - reason: Will fix in next version -- suppress: R4019 - from: Recommendations.json - reason: Will fix in next version -- suppress: R4019 - from: WebApps.json - reason: Will fix in next version -- suppress: R3021 - from: WebApps.json - reason: Will fix in next version -- suppress: R4011 - from: WebApps.json - reason: Will fix in next version -- suppress: R4011 - from: AppServiceEnvironments.json - reason: Will fix in next version -- suppress: R4011 - from: StaticSites.json - reason: Will fix in next version -- suppress: R4011 - from: AppServicePlans.json - reason: Will fix in next version -- suppress: D5001 - reason: Will fix in next version -- suppress: R1003 - reason: Will fix in next version -- suppress: R2001 - reason: Will fix in next version -- suppress: R2029 - reason: Will fix in next version -- suppress: R2063 - reason: Will fix in next version -- suppress: R3010 - reason: Will fix in next version -- suppress: OAV107 - from: AppServiceCertificateOrders.json - reason: Will fix in next version. + - where: $.definitions.FunctionSecrets.properties.trigger_url + suppress: R3016 + reason: This requires a breaking change in functions runtime API. + - where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + - where: $.definitions.VnetGateway + suppress: R4015 + reason: Does not have list operation + - where: $.definitions.VnetInfo + suppress: R4015 + reason: Does not have list operation + - suppress: R4009 + from: AppServiceCertificateOrders.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CertificateOrdersDiagnostics.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CertificateRegistrationProvider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Domains.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: TopLevelDomains.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: DomainRegistrationProvider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Certificates.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CommonDefinitions.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: DeletedWebApps.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Diagnostics.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Global.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Provider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Recommendations.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: WebApps.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: StaticSites.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: AppServiceEnvironments.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: AppServicePlans.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: ResourceHealthMetadata.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: KubeEnvironments.json + reason: SystemData will implement in next version. + - suppress: R4015 + from: WebApps.json + where: $.definitions.NetworkFeatures + reason: Will fix in next version + - suppress: R4019 + from: Recommendations.json + reason: Will fix in next version + - suppress: R4019 + from: WebApps.json + reason: Will fix in next version + - suppress: R3021 + from: WebApps.json + reason: Will fix in next version + - suppress: R4011 + from: WebApps.json + reason: Will fix in next version + - suppress: R4011 + from: AppServiceEnvironments.json + reason: Will fix in next version + - suppress: R4011 + from: StaticSites.json + reason: Will fix in next version + - suppress: R4011 + from: AppServicePlans.json + reason: Will fix in next version + - suppress: D5001 + reason: Will fix in next version + - suppress: R1003 + reason: Will fix in next version + - suppress: R2001 + reason: Will fix in next version + - suppress: R2029 + reason: Will fix in next version + - suppress: R2063 + reason: Will fix in next version + - suppress: R3010 + reason: Will fix in next version + - suppress: OAV107 + from: AppServiceCertificateOrders.json + reason: Will fix in next version. ``` ### Tag: package-2021-01 These settings apply only when `--tag=package-2021-01` is specified on the command line. -``` yaml $(tag) == 'package-2021-01' || $(tag) == 'package-2021-01-only' +```yaml $(tag) == 'package-2021-01' || $(tag) == 'package-2021-01-only' input-file: - Microsoft.CertificateRegistration/stable/2021-01-01/AppServiceCertificateOrders.json - Microsoft.CertificateRegistration/stable/2021-01-01/CertificateOrdersDiagnostics.json @@ -1292,78 +1323,78 @@ input-file: - Microsoft.Web/stable/2021-01-01/KubeEnvironments.json directive: # suppress each RPC 3016 error -- where: $.definitions.FunctionSecrets.properties.trigger_url - suppress: R3016 - reason: This requires a breaking change in functions runtime API. -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version -- where: $.definitions.VnetGateway - suppress: R4015 - reason: Does not have list operation -- where: $.definitions.VnetInfo - suppress: R4015 - reason: Does not have list operation -- suppress: R4009 - from: AppServiceCertificateOrders.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CertificateOrdersDiagnostics.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CertificateRegistrationProvider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Domains.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: TopLevelDomains.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: DomainRegistrationProvider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Certificates.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CommonDefinitions.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: DeletedWebApps.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Diagnostics.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Global.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Provider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Recommendations.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: WebApps.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: StaticSites.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: AppServiceEnvironments.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: AppServicePlans.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: ResourceHealthMetadata.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: KubeEnvironments.json - reason: SystemData will implement in next version. -- suppress: OAV107 - from: AppServiceCertificateOrders.json - reason: Will fix in next version. + - where: $.definitions.FunctionSecrets.properties.trigger_url + suppress: R3016 + reason: This requires a breaking change in functions runtime API. + - where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + - where: $.definitions.VnetGateway + suppress: R4015 + reason: Does not have list operation + - where: $.definitions.VnetInfo + suppress: R4015 + reason: Does not have list operation + - suppress: R4009 + from: AppServiceCertificateOrders.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CertificateOrdersDiagnostics.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CertificateRegistrationProvider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Domains.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: TopLevelDomains.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: DomainRegistrationProvider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Certificates.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CommonDefinitions.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: DeletedWebApps.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Diagnostics.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Global.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Provider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Recommendations.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: WebApps.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: StaticSites.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: AppServiceEnvironments.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: AppServicePlans.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: ResourceHealthMetadata.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: KubeEnvironments.json + reason: SystemData will implement in next version. + - suppress: OAV107 + from: AppServiceCertificateOrders.json + reason: Will fix in next version. ``` ### Tag: package-2020-12 @@ -1371,98 +1402,98 @@ directive: These settings apply only when `--tag=package-2020-12` or `--tag=package-2020-12-only` is specified on the command line. NOTE: Currently these tags are the same, but it will need to be split if any files from folders other than 2020-06-01 are included. -``` yaml $(tag) == 'package-2020-12' || $(tag) == 'package-2020-12-only' +```yaml $(tag) == 'package-2020-12' || $(tag) == 'package-2020-12-only' input-file: -- Microsoft.CertificateRegistration/stable/2020-12-01/AppServiceCertificateOrders.json -- Microsoft.CertificateRegistration/stable/2020-12-01/CertificateOrdersDiagnostics.json -- Microsoft.CertificateRegistration/stable/2020-12-01/CertificateRegistrationProvider.json -- Microsoft.DomainRegistration/stable/2020-12-01/Domains.json -- Microsoft.DomainRegistration/stable/2020-12-01/TopLevelDomains.json -- Microsoft.DomainRegistration/stable/2020-12-01/DomainRegistrationProvider.json -- Microsoft.Web/stable/2020-12-01/Certificates.json -- Microsoft.Web/stable/2020-12-01/CommonDefinitions.json -- Microsoft.Web/stable/2020-12-01/DeletedWebApps.json -- Microsoft.Web/stable/2020-12-01/Diagnostics.json -- Microsoft.Web/stable/2020-12-01/Global.json -- Microsoft.Web/stable/2020-12-01/Provider.json -- Microsoft.Web/stable/2020-12-01/Recommendations.json -- Microsoft.Web/stable/2020-12-01/ResourceProvider.json -- Microsoft.Web/stable/2020-12-01/WebApps.json -- Microsoft.Web/stable/2020-12-01/StaticSites.json -- Microsoft.Web/stable/2020-12-01/AppServiceEnvironments.json -- Microsoft.Web/stable/2020-12-01/AppServicePlans.json -- Microsoft.Web/stable/2020-12-01/ResourceHealthMetadata.json + - Microsoft.CertificateRegistration/stable/2020-12-01/AppServiceCertificateOrders.json + - Microsoft.CertificateRegistration/stable/2020-12-01/CertificateOrdersDiagnostics.json + - Microsoft.CertificateRegistration/stable/2020-12-01/CertificateRegistrationProvider.json + - Microsoft.DomainRegistration/stable/2020-12-01/Domains.json + - Microsoft.DomainRegistration/stable/2020-12-01/TopLevelDomains.json + - Microsoft.DomainRegistration/stable/2020-12-01/DomainRegistrationProvider.json + - Microsoft.Web/stable/2020-12-01/Certificates.json + - Microsoft.Web/stable/2020-12-01/CommonDefinitions.json + - Microsoft.Web/stable/2020-12-01/DeletedWebApps.json + - Microsoft.Web/stable/2020-12-01/Diagnostics.json + - Microsoft.Web/stable/2020-12-01/Global.json + - Microsoft.Web/stable/2020-12-01/Provider.json + - Microsoft.Web/stable/2020-12-01/Recommendations.json + - Microsoft.Web/stable/2020-12-01/ResourceProvider.json + - Microsoft.Web/stable/2020-12-01/WebApps.json + - Microsoft.Web/stable/2020-12-01/StaticSites.json + - Microsoft.Web/stable/2020-12-01/AppServiceEnvironments.json + - Microsoft.Web/stable/2020-12-01/AppServicePlans.json + - Microsoft.Web/stable/2020-12-01/ResourceHealthMetadata.json directive: # suppress each RPC 3016 error -- where: $.definitions.FunctionSecrets.properties.trigger_url - suppress: R3016 - reason: This requires a breaking change in functions runtime API. -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version -- where: $.definitions.VnetGateway - suppress: R4015 - reason: Does not have list operation -- where: $.definitions.VnetInfo - suppress: R4015 - reason: Does not have list operation -- suppress: R4009 - from: AppServiceCertificateOrders.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CertificateOrdersDiagnostics.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CertificateRegistrationProvider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Domains.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: TopLevelDomains.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: DomainRegistrationProvider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Certificates.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: CommonDefinitions.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: DeletedWebApps.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Diagnostics.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Global.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Provider.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: Recommendations.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: WebApps.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: StaticSites.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: AppServiceEnvironments.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: AppServicePlans.json - reason: SystemData will implement in next version. -- suppress: R4009 - from: ResourceHealthMetadata.json - reason: SystemData will implement in next version. -- suppress: OAV107 - from: AppServiceCertificateOrders.json - reason: Will fix in next version. + - where: $.definitions.FunctionSecrets.properties.trigger_url + suppress: R3016 + reason: This requires a breaking change in functions runtime API. + - where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + - where: $.definitions.VnetGateway + suppress: R4015 + reason: Does not have list operation + - where: $.definitions.VnetInfo + suppress: R4015 + reason: Does not have list operation + - suppress: R4009 + from: AppServiceCertificateOrders.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CertificateOrdersDiagnostics.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CertificateRegistrationProvider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Domains.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: TopLevelDomains.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: DomainRegistrationProvider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Certificates.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: CommonDefinitions.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: DeletedWebApps.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Diagnostics.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Global.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Provider.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: Recommendations.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: WebApps.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: StaticSites.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: AppServiceEnvironments.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: AppServicePlans.json + reason: SystemData will implement in next version. + - suppress: R4009 + from: ResourceHealthMetadata.json + reason: SystemData will implement in next version. + - suppress: OAV107 + from: AppServiceCertificateOrders.json + reason: Will fix in next version. ``` ### Tag: package-2020-10 @@ -1470,42 +1501,42 @@ directive: These settings apply only when `--tag=package-2020-10` or `--tag=package-2020-10-only` is specified on the command line. NOTE: Currently these tags are the same, but it will need to be split if any files from folders other than 2020-06-01 are included. -``` yaml $(tag) == 'package-2020-10' || $(tag) == 'package-2020-10-only' +```yaml $(tag) == 'package-2020-10' || $(tag) == 'package-2020-10-only' input-file: -- Microsoft.CertificateRegistration/stable/2020-10-01/AppServiceCertificateOrders.json -- Microsoft.CertificateRegistration/stable/2020-10-01/CertificateRegistrationProvider.json -- Microsoft.DomainRegistration/stable/2020-10-01/Domains.json -- Microsoft.DomainRegistration/stable/2020-10-01/TopLevelDomains.json -- Microsoft.DomainRegistration/stable/2020-10-01/DomainRegistrationProvider.json -- Microsoft.Web/stable/2020-10-01/Certificates.json -- Microsoft.Web/stable/2020-10-01/CommonDefinitions.json -- Microsoft.Web/stable/2020-10-01/DeletedWebApps.json -- Microsoft.Web/stable/2020-10-01/Diagnostics.json -- Microsoft.Web/stable/2020-10-01/Provider.json -- Microsoft.Web/stable/2020-10-01/Recommendations.json -- Microsoft.Web/stable/2020-10-01/ResourceProvider.json -- Microsoft.Web/stable/2020-10-01/WebApps.json -- Microsoft.Web/stable/2020-10-01/StaticSites.json -- Microsoft.Web/stable/2020-10-01/AppServiceEnvironments.json -- Microsoft.Web/stable/2020-10-01/AppServicePlans.json -- Microsoft.Web/stable/2020-10-01/ResourceHealthMetadata.json + - Microsoft.CertificateRegistration/stable/2020-10-01/AppServiceCertificateOrders.json + - Microsoft.CertificateRegistration/stable/2020-10-01/CertificateRegistrationProvider.json + - Microsoft.DomainRegistration/stable/2020-10-01/Domains.json + - Microsoft.DomainRegistration/stable/2020-10-01/TopLevelDomains.json + - Microsoft.DomainRegistration/stable/2020-10-01/DomainRegistrationProvider.json + - Microsoft.Web/stable/2020-10-01/Certificates.json + - Microsoft.Web/stable/2020-10-01/CommonDefinitions.json + - Microsoft.Web/stable/2020-10-01/DeletedWebApps.json + - Microsoft.Web/stable/2020-10-01/Diagnostics.json + - Microsoft.Web/stable/2020-10-01/Provider.json + - Microsoft.Web/stable/2020-10-01/Recommendations.json + - Microsoft.Web/stable/2020-10-01/ResourceProvider.json + - Microsoft.Web/stable/2020-10-01/WebApps.json + - Microsoft.Web/stable/2020-10-01/StaticSites.json + - Microsoft.Web/stable/2020-10-01/AppServiceEnvironments.json + - Microsoft.Web/stable/2020-10-01/AppServicePlans.json + - Microsoft.Web/stable/2020-10-01/ResourceHealthMetadata.json directive: # suppress each RPC 3016 error -- where: $.definitions.FunctionSecrets.properties.trigger_url - suppress: R3016 - reason: This requires a breaking change in functions runtime API. -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version -- where: $.definitions.VnetGateway - suppress: R4015 - reason: Does not have list operation -- where: $.definitions.VnetInfo - suppress: R4015 - reason: Does not have list operation -- suppress: OAV107 - from: AppServiceCertificateOrders.json - reason: Will fix in next version. + - where: $.definitions.FunctionSecrets.properties.trigger_url + suppress: R3016 + reason: This requires a breaking change in functions runtime API. + - where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + - where: $.definitions.VnetGateway + suppress: R4015 + reason: Does not have list operation + - where: $.definitions.VnetInfo + suppress: R4015 + reason: Does not have list operation + - suppress: OAV107 + from: AppServiceCertificateOrders.json + reason: Will fix in next version. ``` ### Tag: package-2020-09 @@ -1513,46 +1544,46 @@ directive: These settings apply only when `--tag=package-2020-09` or `--tag=package-2020-09-only` is specified on the command line. NOTE: Currently these tags are the same, but it will need to be split if any files from folders other than 2020-06-01 are included. -``` yaml $(tag) == 'package-2020-09' || $(tag) == 'package-2020-09-only' +```yaml $(tag) == 'package-2020-09' || $(tag) == 'package-2020-09-only' input-file: -- Microsoft.CertificateRegistration/stable/2020-09-01/AppServiceCertificateOrders.json -- Microsoft.CertificateRegistration/stable/2020-09-01/CertificateRegistrationProvider.json -- Microsoft.DomainRegistration/stable/2020-09-01/Domains.json -- Microsoft.DomainRegistration/stable/2020-09-01/TopLevelDomains.json -- Microsoft.DomainRegistration/stable/2020-09-01/DomainRegistrationProvider.json -- Microsoft.Web/stable/2020-09-01/Certificates.json -- Microsoft.Web/stable/2020-09-01/CommonDefinitions.json -- Microsoft.Web/stable/2020-09-01/DeletedWebApps.json -- Microsoft.Web/stable/2020-09-01/Diagnostics.json -- Microsoft.Web/stable/2020-09-01/Provider.json -- Microsoft.Web/stable/2020-09-01/Recommendations.json -- Microsoft.Web/stable/2020-09-01/ResourceProvider.json -- Microsoft.Web/stable/2020-09-01/WebApps.json -- Microsoft.Web/stable/2020-09-01/StaticSites.json -- Microsoft.Web/stable/2020-09-01/AppServiceEnvironments.json -- Microsoft.Web/stable/2020-09-01/AppServicePlans.json -- Microsoft.Web/stable/2020-09-01/ResourceHealthMetadata.json + - Microsoft.CertificateRegistration/stable/2020-09-01/AppServiceCertificateOrders.json + - Microsoft.CertificateRegistration/stable/2020-09-01/CertificateRegistrationProvider.json + - Microsoft.DomainRegistration/stable/2020-09-01/Domains.json + - Microsoft.DomainRegistration/stable/2020-09-01/TopLevelDomains.json + - Microsoft.DomainRegistration/stable/2020-09-01/DomainRegistrationProvider.json + - Microsoft.Web/stable/2020-09-01/Certificates.json + - Microsoft.Web/stable/2020-09-01/CommonDefinitions.json + - Microsoft.Web/stable/2020-09-01/DeletedWebApps.json + - Microsoft.Web/stable/2020-09-01/Diagnostics.json + - Microsoft.Web/stable/2020-09-01/Provider.json + - Microsoft.Web/stable/2020-09-01/Recommendations.json + - Microsoft.Web/stable/2020-09-01/ResourceProvider.json + - Microsoft.Web/stable/2020-09-01/WebApps.json + - Microsoft.Web/stable/2020-09-01/StaticSites.json + - Microsoft.Web/stable/2020-09-01/AppServiceEnvironments.json + - Microsoft.Web/stable/2020-09-01/AppServicePlans.json + - Microsoft.Web/stable/2020-09-01/ResourceHealthMetadata.json directive: # suppress each RPC 3016 error -- where: $.definitions.FunctionSecrets.properties.trigger_url - suppress: R3016 - reason: This requires a breaking change in functions runtime API. - approved-by: "@weidongxu-microsoft" -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.VnetGateway - suppress: R4015 - reason: Does not have list operation - approved-by: "@mark.cowlishaw" -- where: $.definitions.VnetInfo - suppress: R4015 - reason: Does not have list operation - approved-by: "@mark.cowlishaw" -- suppress: OAV107 - from: AppServiceCertificateOrders.json - reason: Will fix in next version. + - where: $.definitions.FunctionSecrets.properties.trigger_url + suppress: R3016 + reason: This requires a breaking change in functions runtime API. + approved-by: "@weidongxu-microsoft" + - where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.VnetGateway + suppress: R4015 + reason: Does not have list operation + approved-by: "@mark.cowlishaw" + - where: $.definitions.VnetInfo + suppress: R4015 + reason: Does not have list operation + approved-by: "@mark.cowlishaw" + - suppress: OAV107 + from: AppServiceCertificateOrders.json + reason: Will fix in next version. ``` ### Tag: package-2020-06 @@ -1560,34 +1591,34 @@ directive: These settings apply only when `--tag=package-2020-06` or `--tag=package-2020-06-only` is specified on the command line. NOTE: Currently these tags are the same, but it will need to be split if any files from folders other than 2019-08-01 are included. -``` yaml $(tag) == 'package-2020-06' || $(tag) == 'package-2020-06-only' +```yaml $(tag) == 'package-2020-06' || $(tag) == 'package-2020-06-only' input-file: -- Microsoft.CertificateRegistration/stable/2020-06-01/AppServiceCertificateOrders.json -- Microsoft.CertificateRegistration/stable/2020-06-01/CertificateRegistrationProvider.json -- Microsoft.DomainRegistration/stable/2020-06-01/Domains.json -- Microsoft.DomainRegistration/stable/2020-06-01/TopLevelDomains.json -- Microsoft.DomainRegistration/stable/2020-06-01/DomainRegistrationProvider.json -- Microsoft.Web/stable/2020-06-01/Certificates.json -- Microsoft.Web/stable/2020-06-01/CommonDefinitions.json -- Microsoft.Web/stable/2020-06-01/DeletedWebApps.json -- Microsoft.Web/stable/2020-06-01/Diagnostics.json -- Microsoft.Web/stable/2020-06-01/Provider.json -- Microsoft.Web/stable/2020-06-01/Recommendations.json -- Microsoft.Web/stable/2020-06-01/ResourceProvider.json -- Microsoft.Web/stable/2020-06-01/WebApps.json -- Microsoft.Web/stable/2020-06-01/StaticSites.json -- Microsoft.Web/stable/2020-06-01/AppServiceEnvironments.json -- Microsoft.Web/stable/2020-06-01/AppServicePlans.json -- Microsoft.Web/stable/2020-06-01/ResourceHealthMetadata.json + - Microsoft.CertificateRegistration/stable/2020-06-01/AppServiceCertificateOrders.json + - Microsoft.CertificateRegistration/stable/2020-06-01/CertificateRegistrationProvider.json + - Microsoft.DomainRegistration/stable/2020-06-01/Domains.json + - Microsoft.DomainRegistration/stable/2020-06-01/TopLevelDomains.json + - Microsoft.DomainRegistration/stable/2020-06-01/DomainRegistrationProvider.json + - Microsoft.Web/stable/2020-06-01/Certificates.json + - Microsoft.Web/stable/2020-06-01/CommonDefinitions.json + - Microsoft.Web/stable/2020-06-01/DeletedWebApps.json + - Microsoft.Web/stable/2020-06-01/Diagnostics.json + - Microsoft.Web/stable/2020-06-01/Provider.json + - Microsoft.Web/stable/2020-06-01/Recommendations.json + - Microsoft.Web/stable/2020-06-01/ResourceProvider.json + - Microsoft.Web/stable/2020-06-01/WebApps.json + - Microsoft.Web/stable/2020-06-01/StaticSites.json + - Microsoft.Web/stable/2020-06-01/AppServiceEnvironments.json + - Microsoft.Web/stable/2020-06-01/AppServicePlans.json + - Microsoft.Web/stable/2020-06-01/ResourceHealthMetadata.json directive: # suppress each RPC 3016 error -- where: $.definitions.FunctionSecrets.properties.trigger_url - suppress: R3016 - reason: This requires a breaking change in functions runtime API. - approved-by: "@weidongxu-microsoft" -- suppress: OAV107 - from: AppServiceCertificateOrders.json - reason: Will fix in next version. + - where: $.definitions.FunctionSecrets.properties.trigger_url + suppress: R3016 + reason: This requires a breaking change in functions runtime API. + approved-by: "@weidongxu-microsoft" + - suppress: OAV107 + from: AppServiceCertificateOrders.json + reason: Will fix in next version. ``` ### Tag: package-2019-08 @@ -1595,1011 +1626,1010 @@ directive: These settings apply only when `--tag=package-2019-08` or `--tag=package-2019-08-only` is specified on the command line. NOTE: Currently these tags are the same, but it will need to be split if any files from folders other than 2019-08-01 are included. -``` yaml $(tag) == 'package-2019-08' || $(tag) == 'package-2019-08-only' - +```yaml $(tag) == 'package-2019-08' || $(tag) == 'package-2019-08-only' input-file: -- Microsoft.CertificateRegistration/stable/2019-08-01/AppServiceCertificateOrders.json -- Microsoft.CertificateRegistration/stable/2019-08-01/CertificateRegistrationProvider.json -- Microsoft.DomainRegistration/stable/2019-08-01/Domains.json -- Microsoft.DomainRegistration/stable/2019-08-01/TopLevelDomains.json -- Microsoft.DomainRegistration/stable/2019-08-01/DomainRegistrationProvider.json -- Microsoft.Web/stable/2019-08-01/Certificates.json -- Microsoft.Web/stable/2019-08-01/CommonDefinitions.json -- Microsoft.Web/stable/2019-08-01/DeletedWebApps.json -- Microsoft.Web/stable/2019-08-01/Diagnostics.json -- Microsoft.Web/stable/2019-08-01/Provider.json -- Microsoft.Web/stable/2019-08-01/Recommendations.json -- Microsoft.Web/stable/2019-08-01/ResourceProvider.json -- Microsoft.Web/stable/2019-08-01/WebApps.json -- Microsoft.Web/stable/2019-08-01/StaticSites.json -- Microsoft.Web/stable/2019-08-01/AppServiceEnvironments.json -- Microsoft.Web/stable/2019-08-01/AppServicePlans.json -- Microsoft.Web/stable/2019-08-01/ResourceHealthMetadata.json + - Microsoft.CertificateRegistration/stable/2019-08-01/AppServiceCertificateOrders.json + - Microsoft.CertificateRegistration/stable/2019-08-01/CertificateRegistrationProvider.json + - Microsoft.DomainRegistration/stable/2019-08-01/Domains.json + - Microsoft.DomainRegistration/stable/2019-08-01/TopLevelDomains.json + - Microsoft.DomainRegistration/stable/2019-08-01/DomainRegistrationProvider.json + - Microsoft.Web/stable/2019-08-01/Certificates.json + - Microsoft.Web/stable/2019-08-01/CommonDefinitions.json + - Microsoft.Web/stable/2019-08-01/DeletedWebApps.json + - Microsoft.Web/stable/2019-08-01/Diagnostics.json + - Microsoft.Web/stable/2019-08-01/Provider.json + - Microsoft.Web/stable/2019-08-01/Recommendations.json + - Microsoft.Web/stable/2019-08-01/ResourceProvider.json + - Microsoft.Web/stable/2019-08-01/WebApps.json + - Microsoft.Web/stable/2019-08-01/StaticSites.json + - Microsoft.Web/stable/2019-08-01/AppServiceEnvironments.json + - Microsoft.Web/stable/2019-08-01/AppServicePlans.json + - Microsoft.Web/stable/2019-08-01/ResourceHealthMetadata.json directive: -- suppress: OAV107 - from: AppServiceCertificateOrders.json - reason: Will fix in next version. + - suppress: OAV107 + from: AppServiceCertificateOrders.json + reason: Will fix in next version. ``` ### Tag: package-2018-12 These settings apply only when `--tag=package-2018-12` is specified on the command line. -``` yaml $(tag) == 'package-2018-12' +```yaml $(tag) == 'package-2018-12' input-file: -- Microsoft.CertificateRegistration/stable/2018-02-01/AppServiceCertificateOrders.json -- Microsoft.CertificateRegistration/stable/2018-02-01/CertificateRegistrationProvider.json -- Microsoft.DomainRegistration/stable/2018-02-01/Domains.json -- Microsoft.DomainRegistration/stable/2018-02-01/TopLevelDomains.json -- Microsoft.DomainRegistration/stable/2018-02-01/DomainRegistrationProvider.json -- Microsoft.Web/stable/2018-11-01/Certificates.json -- Microsoft.Web/stable/2018-02-01/CommonDefinitions.json -- Microsoft.Web/stable/2018-02-01/DeletedWebApps.json -- Microsoft.Web/stable/2018-02-01/Diagnostics.json -- Microsoft.Web/stable/2018-02-01/Provider.json -- Microsoft.Web/stable/2018-02-01/Recommendations.json -- Microsoft.Web/stable/2018-02-01/ResourceProvider.json -- Microsoft.Web/stable/2018-11-01/WebApps.json -- Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json -- Microsoft.Web/stable/2018-02-01/AppServicePlans.json -- Microsoft.Web/stable/2018-02-01/ResourceHealthMetadata.json + - Microsoft.CertificateRegistration/stable/2018-02-01/AppServiceCertificateOrders.json + - Microsoft.CertificateRegistration/stable/2018-02-01/CertificateRegistrationProvider.json + - Microsoft.DomainRegistration/stable/2018-02-01/Domains.json + - Microsoft.DomainRegistration/stable/2018-02-01/TopLevelDomains.json + - Microsoft.DomainRegistration/stable/2018-02-01/DomainRegistrationProvider.json + - Microsoft.Web/stable/2018-11-01/Certificates.json + - Microsoft.Web/stable/2018-02-01/CommonDefinitions.json + - Microsoft.Web/stable/2018-02-01/DeletedWebApps.json + - Microsoft.Web/stable/2018-02-01/Diagnostics.json + - Microsoft.Web/stable/2018-02-01/Provider.json + - Microsoft.Web/stable/2018-02-01/Recommendations.json + - Microsoft.Web/stable/2018-02-01/ResourceProvider.json + - Microsoft.Web/stable/2018-11-01/WebApps.json + - Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json + - Microsoft.Web/stable/2018-02-01/AppServicePlans.json + - Microsoft.Web/stable/2018-02-01/ResourceHealthMetadata.json directive: # suppress each RPC 3019 error -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- suppress: OAV107 - from: AppServiceCertificateOrders.json - reason: Will fix in next version. + - where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - suppress: OAV107 + from: AppServiceCertificateOrders.json + reason: Will fix in next version. ``` ### Tag: package-2018-11 These settings apply only when `--tag=package-2018-11` is specified on the command line. -``` yaml $(tag) == 'package-2018-11' +```yaml $(tag) == 'package-2018-11' input-file: -- Microsoft.CertificateRegistration/stable/2018-02-01/AppServiceCertificateOrders.json -- Microsoft.CertificateRegistration/stable/2018-02-01/CertificateRegistrationProvider.json -- Microsoft.DomainRegistration/stable/2018-02-01/Domains.json -- Microsoft.DomainRegistration/stable/2018-02-01/TopLevelDomains.json -- Microsoft.DomainRegistration/stable/2018-02-01/DomainRegistrationProvider.json -- Microsoft.Web/stable/2018-11-01/Certificates.json -- Microsoft.Web/stable/2018-02-01/CommonDefinitions.json -- Microsoft.Web/stable/2018-02-01/DeletedWebApps.json -- Microsoft.Web/stable/2018-02-01/Diagnostics.json -- Microsoft.Web/stable/2018-02-01/Provider.json -- Microsoft.Web/stable/2018-02-01/Recommendations.json -- Microsoft.Web/stable/2018-02-01/ResourceProvider.json -- Microsoft.Web/stable/2018-02-01/WebApps.json -- Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json -- Microsoft.Web/stable/2018-02-01/AppServicePlans.json -- Microsoft.Web/stable/2018-02-01/ResourceHealthMetadata.json + - Microsoft.CertificateRegistration/stable/2018-02-01/AppServiceCertificateOrders.json + - Microsoft.CertificateRegistration/stable/2018-02-01/CertificateRegistrationProvider.json + - Microsoft.DomainRegistration/stable/2018-02-01/Domains.json + - Microsoft.DomainRegistration/stable/2018-02-01/TopLevelDomains.json + - Microsoft.DomainRegistration/stable/2018-02-01/DomainRegistrationProvider.json + - Microsoft.Web/stable/2018-11-01/Certificates.json + - Microsoft.Web/stable/2018-02-01/CommonDefinitions.json + - Microsoft.Web/stable/2018-02-01/DeletedWebApps.json + - Microsoft.Web/stable/2018-02-01/Diagnostics.json + - Microsoft.Web/stable/2018-02-01/Provider.json + - Microsoft.Web/stable/2018-02-01/Recommendations.json + - Microsoft.Web/stable/2018-02-01/ResourceProvider.json + - Microsoft.Web/stable/2018-02-01/WebApps.json + - Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json + - Microsoft.Web/stable/2018-02-01/AppServicePlans.json + - Microsoft.Web/stable/2018-02-01/ResourceHealthMetadata.json directive: # suppress each RPC 3019 error -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- suppress: OAV107 - from: AppServiceCertificateOrders.json - reason: Will fix in next version. + - where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - suppress: OAV107 + from: AppServiceCertificateOrders.json + reason: Will fix in next version. ``` ### Tag: package-2018-11-only These settings apply only when `--tag=package-2018-11-only` is specified on the command line. -``` yaml $(tag) == 'package-2018-11-only' +```yaml $(tag) == 'package-2018-11-only' input-file: -- Microsoft.Web/stable/2018-11-01/Certificates.json + - Microsoft.Web/stable/2018-11-01/Certificates.json directive: # suppress each RPC 3019 error -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- suppress: OAV107 - from: AppServiceCertificateOrders.json - reason: Will fix in next version. + - where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - suppress: OAV107 + from: AppServiceCertificateOrders.json + reason: Will fix in next version. ``` ### Tag: package-2018-02 These settings apply only when `--tag=package-2018-02` is specified on the command line. -``` yaml $(tag) == 'package-2018-02' +```yaml $(tag) == 'package-2018-02' input-file: -- Microsoft.CertificateRegistration/stable/2018-02-01/AppServiceCertificateOrders.json -- Microsoft.CertificateRegistration/stable/2018-02-01/CertificateRegistrationProvider.json -- Microsoft.DomainRegistration/stable/2018-02-01/Domains.json -- Microsoft.DomainRegistration/stable/2018-02-01/TopLevelDomains.json -- Microsoft.DomainRegistration/stable/2018-02-01/DomainRegistrationProvider.json -- Microsoft.Web/stable/2018-02-01/Certificates.json -- Microsoft.Web/stable/2018-02-01/CommonDefinitions.json -- Microsoft.Web/stable/2018-02-01/DeletedWebApps.json -- Microsoft.Web/stable/2018-02-01/Diagnostics.json -- Microsoft.Web/stable/2018-02-01/Provider.json -- Microsoft.Web/stable/2018-02-01/Recommendations.json -- Microsoft.Web/stable/2018-02-01/ResourceProvider.json -- Microsoft.Web/stable/2018-02-01/WebApps.json -- Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json -- Microsoft.Web/stable/2018-02-01/AppServicePlans.json -- Microsoft.Web/stable/2018-02-01/ResourceHealthMetadata.json + - Microsoft.CertificateRegistration/stable/2018-02-01/AppServiceCertificateOrders.json + - Microsoft.CertificateRegistration/stable/2018-02-01/CertificateRegistrationProvider.json + - Microsoft.DomainRegistration/stable/2018-02-01/Domains.json + - Microsoft.DomainRegistration/stable/2018-02-01/TopLevelDomains.json + - Microsoft.DomainRegistration/stable/2018-02-01/DomainRegistrationProvider.json + - Microsoft.Web/stable/2018-02-01/Certificates.json + - Microsoft.Web/stable/2018-02-01/CommonDefinitions.json + - Microsoft.Web/stable/2018-02-01/DeletedWebApps.json + - Microsoft.Web/stable/2018-02-01/Diagnostics.json + - Microsoft.Web/stable/2018-02-01/Provider.json + - Microsoft.Web/stable/2018-02-01/Recommendations.json + - Microsoft.Web/stable/2018-02-01/ResourceProvider.json + - Microsoft.Web/stable/2018-02-01/WebApps.json + - Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json + - Microsoft.Web/stable/2018-02-01/AppServicePlans.json + - Microsoft.Web/stable/2018-02-01/ResourceHealthMetadata.json directive: # suppress each RPC 3019 error -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- suppress: OAV107 - from: AppServiceCertificateOrders.json - reason: Will fix in next version. + - where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - suppress: OAV107 + from: AppServiceCertificateOrders.json + reason: Will fix in next version. ``` ### Tag: package-2018-02-only These settings apply only when `--tag=package-2018-02` is specified on the command line. -``` yaml $(tag) == 'package-2018-02-only' +```yaml $(tag) == 'package-2018-02-only' input-file: -- Microsoft.CertificateRegistration/stable/2018-02-01/AppServiceCertificateOrders.json -- Microsoft.CertificateRegistration/stable/2018-02-01/CertificateRegistrationProvider.json -- Microsoft.DomainRegistration/stable/2018-02-01/Domains.json -- Microsoft.DomainRegistration/stable/2018-02-01/TopLevelDomains.json -- Microsoft.DomainRegistration/stable/2018-02-01/DomainRegistrationProvider.json -- Microsoft.Web/stable/2018-02-01/Certificates.json -- Microsoft.Web/stable/2018-02-01/CommonDefinitions.json -- Microsoft.Web/stable/2018-02-01/DeletedWebApps.json -- Microsoft.Web/stable/2018-02-01/Diagnostics.json -- Microsoft.Web/stable/2018-02-01/Provider.json -- Microsoft.Web/stable/2018-02-01/Recommendations.json -- Microsoft.Web/stable/2018-02-01/ResourceProvider.json -- Microsoft.Web/stable/2018-02-01/WebApps.json -- Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json -- Microsoft.Web/stable/2018-02-01/AppServicePlans.json -- Microsoft.Web/stable/2018-02-01/ResourceHealthMetadata.json + - Microsoft.CertificateRegistration/stable/2018-02-01/AppServiceCertificateOrders.json + - Microsoft.CertificateRegistration/stable/2018-02-01/CertificateRegistrationProvider.json + - Microsoft.DomainRegistration/stable/2018-02-01/Domains.json + - Microsoft.DomainRegistration/stable/2018-02-01/TopLevelDomains.json + - Microsoft.DomainRegistration/stable/2018-02-01/DomainRegistrationProvider.json + - Microsoft.Web/stable/2018-02-01/Certificates.json + - Microsoft.Web/stable/2018-02-01/CommonDefinitions.json + - Microsoft.Web/stable/2018-02-01/DeletedWebApps.json + - Microsoft.Web/stable/2018-02-01/Diagnostics.json + - Microsoft.Web/stable/2018-02-01/Provider.json + - Microsoft.Web/stable/2018-02-01/Recommendations.json + - Microsoft.Web/stable/2018-02-01/ResourceProvider.json + - Microsoft.Web/stable/2018-02-01/WebApps.json + - Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json + - Microsoft.Web/stable/2018-02-01/AppServicePlans.json + - Microsoft.Web/stable/2018-02-01/ResourceHealthMetadata.json directive: # suppress each RPC 3019 error -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- suppress: OAV107 - from: AppServiceCertificateOrders.json - reason: Will fix in next version. + - where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - suppress: OAV107 + from: AppServiceCertificateOrders.json + reason: Will fix in next version. ``` ### Tag: package-2016-09 These settings apply only when `--tag=package-2016-09` is specified on the command line. -``` yaml $(tag) == 'package-2016-09' +```yaml $(tag) == 'package-2016-09' input-file: -- Microsoft.CertificateRegistration/stable/2015-08-01/AppServiceCertificateOrders.json -- Microsoft.CertificateRegistration/stable/2015-08-01/CertificateRegistrationProvider.json -- Microsoft.DomainRegistration/stable/2015-04-01/Domains.json -- Microsoft.DomainRegistration/stable/2015-04-01/TopLevelDomains.json -- Microsoft.DomainRegistration/stable/2015-04-01/DomainRegistrationProvider.json -- Microsoft.Web/stable/2016-03-01/Certificates.json -- Microsoft.Web/stable/2016-03-01/CommonDefinitions.json -- Microsoft.Web/stable/2016-03-01/DeletedWebApps.json -- Microsoft.Web/stable/2016-03-01/Diagnostics.json -- Microsoft.Web/stable/2016-03-01/Provider.json -- Microsoft.Web/stable/2016-03-01/Recommendations.json -- Microsoft.Web/stable/2016-03-01/ResourceHealthMetadata.json -- Microsoft.Web/stable/2016-03-01/ResourceProvider.json -- Microsoft.Web/stable/2016-08-01/WebApps.json -- Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json -- Microsoft.Web/stable/2016-09-01/AppServicePlans.json + - Microsoft.CertificateRegistration/stable/2015-08-01/AppServiceCertificateOrders.json + - Microsoft.CertificateRegistration/stable/2015-08-01/CertificateRegistrationProvider.json + - Microsoft.DomainRegistration/stable/2015-04-01/Domains.json + - Microsoft.DomainRegistration/stable/2015-04-01/TopLevelDomains.json + - Microsoft.DomainRegistration/stable/2015-04-01/DomainRegistrationProvider.json + - Microsoft.Web/stable/2016-03-01/Certificates.json + - Microsoft.Web/stable/2016-03-01/CommonDefinitions.json + - Microsoft.Web/stable/2016-03-01/DeletedWebApps.json + - Microsoft.Web/stable/2016-03-01/Diagnostics.json + - Microsoft.Web/stable/2016-03-01/Provider.json + - Microsoft.Web/stable/2016-03-01/Recommendations.json + - Microsoft.Web/stable/2016-03-01/ResourceHealthMetadata.json + - Microsoft.Web/stable/2016-03-01/ResourceProvider.json + - Microsoft.Web/stable/2016-08-01/WebApps.json + - Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json + - Microsoft.Web/stable/2016-09-01/AppServicePlans.json directive: # suppress each RPC 3019 error -- where: $.definitions.User.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SourceControl.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.BackupRequest.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.Deployment.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.PremierAddOn.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SiteExtensionInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.AppServicePlan.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.VnetRoute.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.FunctionEnvelope.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.CertificateOrderAction.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ResourceMetricDefinition.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.TopLevelDomain.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.GeoRegion.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.PremierAddOnOffer.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ContinuousWebJob.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ProcessInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ProcessThreadInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SiteConfigurationSnapshotInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SiteInstance.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SlotDifference.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.TriggeredJobRun.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.TriggeredWebJob.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.WebJob.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.MetricDefinition.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.Usage.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.AppServicePlanPatchResource.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- suppress: OAV107 - from: AppServiceCertificateOrders.json - reason: Will fix in next version. + - where: $.definitions.User.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SourceControl.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.BackupRequest.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.Deployment.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.PremierAddOn.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SiteExtensionInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.AppServicePlan.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.VnetRoute.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.FunctionEnvelope.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.CertificateOrderAction.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.ResourceMetricDefinition.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.TopLevelDomain.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.GeoRegion.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.PremierAddOnOffer.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.ContinuousWebJob.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.ProcessInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.ProcessThreadInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SiteConfigurationSnapshotInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SiteInstance.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SlotDifference.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.TriggeredJobRun.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.TriggeredWebJob.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.WebJob.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.MetricDefinition.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.Usage.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.AppServicePlanPatchResource.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - suppress: OAV107 + from: AppServiceCertificateOrders.json + reason: Will fix in next version. ``` ### Tag: package-2016-09-only These settings apply only when `--tag=package-2016-09-only` is specified on the command line. -``` yaml $(tag) == 'package-2016-09-only' +```yaml $(tag) == 'package-2016-09-only' input-file: -- Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json -- Microsoft.Web/stable/2016-09-01/AppServicePlans.json + - Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json + - Microsoft.Web/stable/2016-09-01/AppServicePlans.json directive: # suppress each RPC 3019 error -- where: $.definitions.User.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SourceControl.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.BackupRequest.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.Deployment.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.PremierAddOn.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SiteExtensionInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.AppServicePlan.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.VnetRoute.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.FunctionEnvelope.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.CertificateOrderAction.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ResourceMetricDefinition.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.TopLevelDomain.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.GeoRegion.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.PremierAddOnOffer.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ContinuousWebJob.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ProcessInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ProcessThreadInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SiteConfigurationSnapshotInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SiteInstance.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SlotDifference.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.TriggeredJobRun.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.TriggeredWebJob.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.WebJob.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.MetricDefinition.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.Usage.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.AppServicePlanPatchResource.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- suppress: OAV107 - from: AppServiceCertificateOrders.json - reason: Will fix in next version. + - where: $.definitions.User.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SourceControl.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.BackupRequest.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.Deployment.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.PremierAddOn.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SiteExtensionInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.AppServicePlan.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.VnetRoute.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.FunctionEnvelope.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.CertificateOrderAction.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.ResourceMetricDefinition.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.TopLevelDomain.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.GeoRegion.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.PremierAddOnOffer.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.ContinuousWebJob.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.ProcessInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.ProcessThreadInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SiteConfigurationSnapshotInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SiteInstance.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SlotDifference.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.TriggeredJobRun.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.TriggeredWebJob.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.WebJob.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.MetricDefinition.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.Usage.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.AppServicePlanPatchResource.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - suppress: OAV107 + from: AppServiceCertificateOrders.json + reason: Will fix in next version. ``` ### Tag: package-2016-08-only These settings apply only when `--tag=package-2016-08-only` is specified on the command line. -``` yaml $(tag) == 'package-2016-08-only' +```yaml $(tag) == 'package-2016-08-only' input-file: -- Microsoft.Web/stable/2016-08-01/WebApps.json + - Microsoft.Web/stable/2016-08-01/WebApps.json directive: # suppress each RPC 3019 error -- where: $.definitions.User.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SourceControl.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.BackupRequest.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.Deployment.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.PremierAddOn.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SiteExtensionInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.AppServicePlan.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.VnetRoute.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.FunctionEnvelope.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.CertificateOrderAction.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ResourceMetricDefinition.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.TopLevelDomain.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.GeoRegion.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.PremierAddOnOffer.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ContinuousWebJob.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ProcessInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ProcessThreadInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SiteConfigurationSnapshotInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SiteInstance.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SlotDifference.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.TriggeredJobRun.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.TriggeredWebJob.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.WebJob.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.MetricDefinition.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.Usage.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.AppServicePlanPatchResource.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- suppress: OAV107 - from: AppServiceCertificateOrders.json - reason: Will fix in next version. + - where: $.definitions.User.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SourceControl.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.BackupRequest.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.Deployment.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.PremierAddOn.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SiteExtensionInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.AppServicePlan.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.VnetRoute.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.FunctionEnvelope.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.CertificateOrderAction.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.ResourceMetricDefinition.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.TopLevelDomain.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.GeoRegion.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.PremierAddOnOffer.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.ContinuousWebJob.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.ProcessInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.ProcessThreadInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SiteConfigurationSnapshotInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SiteInstance.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SlotDifference.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.TriggeredJobRun.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.TriggeredWebJob.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.WebJob.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.MetricDefinition.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.Usage.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.AppServicePlanPatchResource.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - suppress: OAV107 + from: AppServiceCertificateOrders.json + reason: Will fix in next version. ``` ### Tag: package-2016-03-only These settings apply only when `--tag=package-2016-03-only` is specified on the command line. -``` yaml $(tag) == 'package-2016-03-only' +```yaml $(tag) == 'package-2016-03-only' input-file: -- Microsoft.Web/stable/2016-03-01/Certificates.json -- Microsoft.Web/stable/2016-03-01/CommonDefinitions.json -- Microsoft.Web/stable/2016-03-01/DeletedWebApps.json -- Microsoft.Web/stable/2016-03-01/Diagnostics.json -- Microsoft.Web/stable/2016-03-01/Provider.json -- Microsoft.Web/stable/2016-03-01/Recommendations.json -- Microsoft.Web/stable/2016-03-01/ResourceHealthMetadata.json -- Microsoft.Web/stable/2016-03-01/ResourceProvider.json + - Microsoft.Web/stable/2016-03-01/Certificates.json + - Microsoft.Web/stable/2016-03-01/CommonDefinitions.json + - Microsoft.Web/stable/2016-03-01/DeletedWebApps.json + - Microsoft.Web/stable/2016-03-01/Diagnostics.json + - Microsoft.Web/stable/2016-03-01/Provider.json + - Microsoft.Web/stable/2016-03-01/Recommendations.json + - Microsoft.Web/stable/2016-03-01/ResourceHealthMetadata.json + - Microsoft.Web/stable/2016-03-01/ResourceProvider.json directive: # suppress each RPC 3019 error -- where: $.definitions.User.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SourceControl.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.BackupRequest.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.Deployment.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.PremierAddOn.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SiteExtensionInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.AppServicePlan.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.VnetRoute.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.FunctionEnvelope.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.CertificateOrderAction.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ResourceMetricDefinition.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.TopLevelDomain.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.GeoRegion.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.PremierAddOnOffer.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ContinuousWebJob.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ProcessInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ProcessThreadInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SiteConfigurationSnapshotInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SiteInstance.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SlotDifference.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.TriggeredJobRun.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.TriggeredWebJob.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.WebJob.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.MetricDefinition.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.Usage.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.AppServicePlanPatchResource.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" + - where: $.definitions.User.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SourceControl.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.BackupRequest.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.Deployment.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.PremierAddOn.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SiteExtensionInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.AppServicePlan.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.VnetRoute.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.FunctionEnvelope.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.CertificateOrderAction.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.ResourceMetricDefinition.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.TopLevelDomain.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.GeoRegion.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.PremierAddOnOffer.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.ContinuousWebJob.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.ProcessInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.ProcessThreadInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SiteConfigurationSnapshotInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SiteInstance.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SlotDifference.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.TriggeredJobRun.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.TriggeredWebJob.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.WebJob.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.MetricDefinition.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.Usage.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.AppServicePlanPatchResource.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" ``` ### Tag: package-2015-08-only These settings apply only when `--tag=package-2015-08-only` is specified on the command line. -``` yaml $(tag) == 'package-2015-08-only' +```yaml $(tag) == 'package-2015-08-only' input-file: -- Microsoft.CertificateRegistration/stable/2015-08-01/AppServiceCertificateOrders.json -- Microsoft.CertificateRegistration/stable/2015-08-01/CertificateRegistrationProvider.json + - Microsoft.CertificateRegistration/stable/2015-08-01/AppServiceCertificateOrders.json + - Microsoft.CertificateRegistration/stable/2015-08-01/CertificateRegistrationProvider.json directive: # suppress each RPC 3019 error -- where: $.definitions.User.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SourceControl.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.BackupRequest.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.Deployment.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.PremierAddOn.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SiteExtensionInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.AppServicePlan.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.VnetRoute.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.FunctionEnvelope.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.CertificateOrderAction.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ResourceMetricDefinition.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.TopLevelDomain.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.GeoRegion.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.PremierAddOnOffer.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ContinuousWebJob.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ProcessInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ProcessThreadInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SiteConfigurationSnapshotInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SiteInstance.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SlotDifference.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.TriggeredJobRun.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.TriggeredWebJob.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.WebJob.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.MetricDefinition.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.Usage.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.AppServicePlanPatchResource.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- suppress: OAV107 - from: AppServiceCertificateOrders.json - reason: Will fix in next version. + - where: $.definitions.User.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SourceControl.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.BackupRequest.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.Deployment.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.PremierAddOn.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SiteExtensionInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.AppServicePlan.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.VnetRoute.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.FunctionEnvelope.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.CertificateOrderAction.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.ResourceMetricDefinition.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.TopLevelDomain.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.GeoRegion.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.PremierAddOnOffer.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.ContinuousWebJob.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.ProcessInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.ProcessThreadInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SiteConfigurationSnapshotInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SiteInstance.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SlotDifference.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.TriggeredJobRun.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.TriggeredWebJob.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.WebJob.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.MetricDefinition.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.Usage.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.AppServicePlanPatchResource.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - suppress: OAV107 + from: AppServiceCertificateOrders.json + reason: Will fix in next version. ``` ### Tag: package-2015-04-only These settings apply only when `--tag=package-2015-04-only` is specified on the command line. -``` yaml $(tag) == 'package-2015-04-only' +```yaml $(tag) == 'package-2015-04-only' input-file: -- Microsoft.DomainRegistration/stable/2015-04-01/Domains.json -- Microsoft.DomainRegistration/stable/2015-04-01/TopLevelDomains.json -- Microsoft.DomainRegistration/stable/2015-04-01/DomainRegistrationProvider.json + - Microsoft.DomainRegistration/stable/2015-04-01/Domains.json + - Microsoft.DomainRegistration/stable/2015-04-01/TopLevelDomains.json + - Microsoft.DomainRegistration/stable/2015-04-01/DomainRegistrationProvider.json directive: # suppress each RPC 3019 error -- where: $.definitions.User.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SourceControl.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.BackupRequest.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.Deployment.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.PremierAddOn.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SiteExtensionInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.AppServicePlan.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.VnetRoute.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.FunctionEnvelope.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.CertificateOrderAction.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ResourceMetricDefinition.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.TopLevelDomain.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.GeoRegion.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.PremierAddOnOffer.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ContinuousWebJob.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ProcessInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ProcessThreadInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SiteConfigurationSnapshotInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SiteInstance.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SlotDifference.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.TriggeredJobRun.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.TriggeredWebJob.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.WebJob.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.MetricDefinition.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.Usage.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.AppServicePlanPatchResource.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" + - where: $.definitions.User.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SourceControl.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.BackupRequest.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.Deployment.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.PremierAddOn.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SiteExtensionInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.AppServicePlan.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.VnetRoute.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.FunctionEnvelope.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.CertificateOrderAction.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.ResourceMetricDefinition.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.TopLevelDomain.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.GeoRegion.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.PremierAddOnOffer.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.ContinuousWebJob.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.ProcessInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.ProcessThreadInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SiteConfigurationSnapshotInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SiteInstance.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.SlotDifference.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.TriggeredJobRun.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.TriggeredWebJob.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.WebJob.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.MetricDefinition.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.Usage.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" + - where: $.definitions.AppServicePlanPatchResource.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" ``` ### Tag: package-2016-06-01 These settings apply only when `--tag=package-2016-06-01` is specified on the command line. -``` yaml $(tag) == 'package-2016-06-01' +```yaml $(tag) == 'package-2016-06-01' input-file: -- Microsoft.Web/stable/2016-06-01/logicAppsManagementClient.json + - Microsoft.Web/stable/2016-06-01/logicAppsManagementClient.json ``` ### Tag: package-2015-08-preview These settings apply only when `--tag=package-2015-08-preview` is specified on the command line. -``` yaml $(tag) == 'package-2015-08-preview' +```yaml $(tag) == 'package-2015-08-preview' input-file: -- Microsoft.Web/stable/2015-08-01/service.json -- Microsoft.Web/preview/2015-08-01-preview/logicAppsManagementClient.json + - Microsoft.Web/stable/2015-08-01/service.json + - Microsoft.Web/preview/2015-08-01-preview/logicAppsManagementClient.json ``` ### Tag: package-2015-08-certificate-registration These settings apply only when `--tag=package-2015-08-certificate-registration` is specified on the command line. -``` yaml $(tag) == 'package-2015-08-certificate-registration' +```yaml $(tag) == 'package-2015-08-certificate-registration' input-file: -- Microsoft.CertificateRegistration/stable/2015-08-01/AppServiceCertificateOrders.json -- Microsoft.CertificateRegistration/stable/2015-08-01/CertificateRegistrationProvider.json + - Microsoft.CertificateRegistration/stable/2015-08-01/AppServiceCertificateOrders.json + - Microsoft.CertificateRegistration/stable/2015-08-01/CertificateRegistrationProvider.json directive: -- suppress: OAV107 - from: AppServiceCertificateOrders.json - reason: Will fix in next version. + - suppress: OAV107 + from: AppServiceCertificateOrders.json + reason: Will fix in next version. ``` ### Tag: package-2015-04-domain-registration These settings apply only when `--tag=package-2015-04-domain-registration` is specified on the command line. -``` yaml $(tag) == 'package-2015-04-domain-registration' +```yaml $(tag) == 'package-2015-04-domain-registration' input-file: -- Microsoft.DomainRegistration/stable/2015-04-01/Domains.json -- Microsoft.DomainRegistration/stable/2015-04-01/TopLevelDomains.json -- Microsoft.DomainRegistration/stable/2015-04-01/DomainRegistrationProvider.json + - Microsoft.DomainRegistration/stable/2015-04-01/Domains.json + - Microsoft.DomainRegistration/stable/2015-04-01/TopLevelDomains.json + - Microsoft.DomainRegistration/stable/2015-04-01/DomainRegistrationProvider.json ``` ### Tag: package-2016-09-01-web These settings apply only when `--tag=package-2016-09-01-web` is specified on the command line. -``` yaml $(tag) == 'package-2016-09-01-web' +```yaml $(tag) == 'package-2016-09-01-web' input-file: -- Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json -- Microsoft.Web/stable/2016-09-01/AppServicePlans.json + - Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json + - Microsoft.Web/stable/2016-09-01/AppServicePlans.json ``` ### Tag: package-2016-08-01-web These settings apply only when `--tag=package-2016-08-01-web` is specified on the command line. -``` yaml $(tag) == 'package-2016-08-01-web' +```yaml $(tag) == 'package-2016-08-01-web' input-file: -- Microsoft.Web/stable/2016-08-01/WebApps.json + - Microsoft.Web/stable/2016-08-01/WebApps.json ``` ### Tag: package-2016-03-01-web These settings apply only when `--tag=package-2016-03-01-web` is specified on the command line. -``` yaml $(tag) == 'package-2016-03-01-web' +```yaml $(tag) == 'package-2016-03-01-web' input-file: -- Microsoft.Web/stable/2016-03-01/Certificates.json -- Microsoft.Web/stable/2016-03-01/CommonDefinitions.json -- Microsoft.Web/stable/2016-03-01/DeletedWebApps.json -- Microsoft.Web/stable/2016-03-01/Diagnostics.json -- Microsoft.Web/stable/2016-03-01/Provider.json -- Microsoft.Web/stable/2016-03-01/Recommendations.json -- Microsoft.Web/stable/2016-03-01/ResourceHealthMetadata.json -- Microsoft.Web/stable/2016-03-01/ResourceProvider.json + - Microsoft.Web/stable/2016-03-01/Certificates.json + - Microsoft.Web/stable/2016-03-01/CommonDefinitions.json + - Microsoft.Web/stable/2016-03-01/DeletedWebApps.json + - Microsoft.Web/stable/2016-03-01/Diagnostics.json + - Microsoft.Web/stable/2016-03-01/Provider.json + - Microsoft.Web/stable/2016-03-01/Recommendations.json + - Microsoft.Web/stable/2016-03-01/ResourceHealthMetadata.json + - Microsoft.Web/stable/2016-03-01/ResourceProvider.json ``` --- @@ -2611,7 +2641,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-track2 - repo: azure-sdk-for-python @@ -2643,16 +2673,16 @@ See configuration in [readme.java.md](./readme.java.md) These settings apply only when `--tag=package-2018-03-01-hybrid` is specified on the command line. Creating this tag to pick proper resources from the hybrid profile for csharp code generation. -``` yaml $(tag) == 'package-2018-03-01-hybrid' +```yaml $(tag) == 'package-2018-03-01-hybrid' input-file: -- Microsoft.Web/stable/2016-03-01/Certificates.json -- Microsoft.Web/stable/2016-03-01/CommonDefinitions.json -- Microsoft.Web/stable/2016-08-01/WebApps.json -- Microsoft.Web/stable/2016-03-01/ResourceProvider.json -- Microsoft.Web/stable/2016-03-01/Provider.json -- Microsoft.Web/stable/2016-03-01/Recommendations.json -- Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json -- Microsoft.Web/stable/2016-09-01/AppServicePlans.json + - Microsoft.Web/stable/2016-03-01/Certificates.json + - Microsoft.Web/stable/2016-03-01/CommonDefinitions.json + - Microsoft.Web/stable/2016-08-01/WebApps.json + - Microsoft.Web/stable/2016-03-01/ResourceProvider.json + - Microsoft.Web/stable/2016-03-01/Provider.json + - Microsoft.Web/stable/2016-03-01/Recommendations.json + - Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json + - Microsoft.Web/stable/2016-09-01/AppServicePlans.json ``` ### Tag: profile-hybrid-2019-03-01 @@ -2660,16 +2690,16 @@ input-file: These settings apply only when `--tag=profile-hybrid-2019-03-01` is specified on the command line. Creating this tag to pick proper resources from the hybrid profile. -``` yaml $(tag) == 'profile-hybrid-2019-03-01' +```yaml $(tag) == 'profile-hybrid-2019-03-01' input-file: -- Microsoft.Web/stable/2018-02-01/Certificates.json -- Microsoft.Web/stable/2018-02-01/CommonDefinitions.json -- Microsoft.Web/stable/2018-02-01/WebApps.json -- Microsoft.Web/stable/2018-02-01/ResourceProvider.json -- Microsoft.Web/stable/2018-02-01/AppServicePlans.json -- Microsoft.Web/stable/2018-02-01/Provider.json -- Microsoft.Web/stable/2018-02-01/ResourceProvider.json -- Microsoft.Web/stable/2018-02-01/Recommendations.json + - Microsoft.Web/stable/2018-02-01/Certificates.json + - Microsoft.Web/stable/2018-02-01/CommonDefinitions.json + - Microsoft.Web/stable/2018-02-01/WebApps.json + - Microsoft.Web/stable/2018-02-01/ResourceProvider.json + - Microsoft.Web/stable/2018-02-01/AppServicePlans.json + - Microsoft.Web/stable/2018-02-01/Provider.json + - Microsoft.Web/stable/2018-02-01/ResourceProvider.json + - Microsoft.Web/stable/2018-02-01/Recommendations.json ``` ### Tag: profile-hybrid-2020-09-01 @@ -2677,13 +2707,13 @@ input-file: These settings apply only when `--tag=profile-hybrid-2020-09-01` is specified on the command line. Creating this tag to pick proper resources from the hybrid profile. -``` yaml $(tag) == 'profile-hybrid-2020-09-01' +```yaml $(tag) == 'profile-hybrid-2020-09-01' input-file: -- Microsoft.Web/stable/2018-02-01/Certificates.json -- Microsoft.Web/stable/2018-02-01/WebApps.json -- Microsoft.Web/stable/2018-02-01/ResourceProvider.json -- Microsoft.Web/stable/2018-02-01/AppServicePlans.json -- Microsoft.Web/stable/2018-02-01/Provider.json -- Microsoft.Web/stable/2018-02-01/ResourceProvider.json -- Microsoft.Web/stable/2018-02-01/Recommendations.json + - Microsoft.Web/stable/2018-02-01/Certificates.json + - Microsoft.Web/stable/2018-02-01/WebApps.json + - Microsoft.Web/stable/2018-02-01/ResourceProvider.json + - Microsoft.Web/stable/2018-02-01/AppServicePlans.json + - Microsoft.Web/stable/2018-02-01/Provider.json + - Microsoft.Web/stable/2018-02-01/ResourceProvider.json + - Microsoft.Web/stable/2018-02-01/Recommendations.json ``` diff --git a/specification/web/resource-manager/readme.nodejs.md b/specification/web/resource-manager/readme.nodejs.md index dccfcc4f360c..69bc21d7bf95 100644 --- a/specification/web/resource-manager/readme.nodejs.md +++ b/specification/web/resource-manager/readme.nodejs.md @@ -3,7 +3,7 @@ These settings apply only when `--nodejs` is specified on the command line. Please also specify `--node-sdks-folder=`. -``` yaml $(nodejs) +```yaml $(nodejs) nodejs: azure-arm: true package-name: azure-arm-website diff --git a/specification/web/resource-manager/readme.python.md b/specification/web/resource-manager/readme.python.md index 1688e6600f53..44ea36ea3738 100644 --- a/specification/web/resource-manager/readme.python.md +++ b/specification/web/resource-manager/readme.python.md @@ -4,8 +4,7 @@ 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) +```yaml $(python) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-web @@ -17,7 +16,6 @@ no-namespace-folders: true Generate all API versions currently shipped for this package - ```yaml $(python) multiapi: true default-api-version: "2023-12-01" @@ -43,7 +41,7 @@ batch: - multiapiscript: true ``` -``` yaml $(multiapiscript) +```yaml $(multiapiscript) output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/ perform-load: false clear-output-folder: false @@ -64,7 +62,7 @@ output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2 These settings apply only when `--tag=package-2023-01 --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2023-01' && $(python) +```yaml $(tag) == 'package-2023-01' && $(python) namespace: azure.mgmt.web.v2023_01_01 output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2023_01_01 ``` @@ -74,7 +72,7 @@ output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2 These settings apply only when `--tag=package-2022-09 --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2022-09' && $(python) +```yaml $(tag) == 'package-2022-09' && $(python) namespace: azure.mgmt.web.v2022_09_01 output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2022_09_01 ``` @@ -84,7 +82,7 @@ output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2 These settings apply only when `--tag=package-2021-03-only --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2021-03-only' && $(python) +```yaml $(tag) == 'package-2021-03-only' && $(python) namespace: azure.mgmt.web.v2021_03_01 output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2021_03_01 ``` @@ -94,7 +92,7 @@ output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2 These settings apply only when `--tag=package-2021-01-15-only --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2021-01-15-only' && $(python) +```yaml $(tag) == 'package-2021-01-15-only' && $(python) namespace: azure.mgmt.web.v2021_01_15 output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2021_01_15 ``` @@ -104,7 +102,7 @@ output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2 These settings apply only when `--tag=package-2021-01-only --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2021-01-only' && $(python) +```yaml $(tag) == 'package-2021-01-only' && $(python) namespace: azure.mgmt.web.v2021_01_01 output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2021_01_01 ``` @@ -114,7 +112,7 @@ output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2 These settings apply only when `--tag=package-2020-12-only --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2020-12-only' && $(python) +```yaml $(tag) == 'package-2020-12-only' && $(python) namespace: azure.mgmt.web.v2020_12_01 output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2020_12_01 ``` @@ -124,7 +122,7 @@ output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2 These settings apply only when `--tag=package-2020-09-only --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2020-09-only' && $(python) +```yaml $(tag) == 'package-2020-09-only' && $(python) namespace: azure.mgmt.web.v2020_09_01 output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2020_09_01 ``` @@ -134,7 +132,7 @@ output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2 These settings apply only when `--tag=package-2020-06-only --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2020-06-only' && $(python) +```yaml $(tag) == 'package-2020-06-only' && $(python) namespace: azure.mgmt.web.v2020_06_01 output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2020_06_01 ``` @@ -144,7 +142,7 @@ output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2 These settings apply only when `--tag=package-2019-08-only --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2019-08-only' && $(python) +```yaml $(tag) == 'package-2019-08-only' && $(python) namespace: azure.mgmt.web.v2019_08_01 output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2019_08_01 ``` @@ -154,7 +152,7 @@ output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2 These settings apply only when `--tag=package-2018-11-only --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2018-11-only' && $(python) +```yaml $(tag) == 'package-2018-11-only' && $(python) namespace: azure.mgmt.web.v2018_11_01 output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2018_11_01 ``` @@ -164,7 +162,7 @@ output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2 These settings apply only when `--tag=package-2018-02-only --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2018-02-only' && $(python) +```yaml $(tag) == 'package-2018-02-only' && $(python) namespace: azure.mgmt.web.v2018_02_01 output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2018_02_01 ``` @@ -174,7 +172,7 @@ output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2 These settings apply only when `--tag=package-2016-09-only --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2016-09-only' && $(python) +```yaml $(tag) == 'package-2016-09-only' && $(python) namespace: azure.mgmt.web.v2016_09_01 output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2016_09_01 ``` @@ -184,7 +182,7 @@ output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2 These settings apply only when `--tag=package-2016-08-only --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2016-08-only' && $(python) +```yaml $(tag) == 'package-2016-08-only' && $(python) namespace: azure.mgmt.web.v2016_08_01 output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2016_08_01 ``` @@ -194,7 +192,7 @@ output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2 These settings apply only when `--tag=package-2016-03-only --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2016-03-only' && $(python) +```yaml $(tag) == 'package-2016-03-only' && $(python) namespace: azure.mgmt.web.v2016_03_01 output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2016_03_01 ``` @@ -204,7 +202,7 @@ output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2 These settings apply only when `--tag=package-2019-04-only --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2015-08-only' && $(python) +```yaml $(tag) == 'package-2015-08-only' && $(python) namespace: azure.mgmt.web.v2015_08_01 output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2015_08_01 ``` @@ -214,7 +212,7 @@ output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2 These settings apply only when `--tag=package-2019-04-only --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2015-04-only' && $(python) +```yaml $(tag) == 'package-2015-04-only' && $(python) namespace: azure.mgmt.web.v2015_04_01 output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2015_04_01 ``` diff --git a/specification/web/resource-manager/readme.ruby.md b/specification/web/resource-manager/readme.ruby.md index 8c6f3baa8717..08a3e7fa6075 100644 --- a/specification/web/resource-manager/readme.ruby.md +++ b/specification/web/resource-manager/readme.ruby.md @@ -2,7 +2,7 @@ These settings apply only when `--ruby` is specified on the command line. -``` yaml +```yaml package-name: azure_mgmt_web package-version: "0.16.0" azure-arm: true @@ -10,7 +10,7 @@ azure-arm: true ### Ruby multi-api -``` yaml $(ruby) && $(multiapi) +```yaml $(ruby) && $(multiapi) batch: - tag: package-2015-08-certificate-registration - tag: package-2015-04-domain-registration @@ -25,7 +25,7 @@ batch: These settings apply only when `--tag=package-2015-08-certificate-registration --ruby` is specified on the command line. Please also specify `--ruby-sdks-folder=`. -``` yaml $(tag) == 'package-2015-08-certificate-registration' && $(ruby) +```yaml $(tag) == 'package-2015-08-certificate-registration' && $(ruby) namespace: "Azure::Web::Mgmt::V2015_08_01" output-folder: $(ruby-sdks-folder)/management/azure_mgmt_web/lib title: "WebSiteManagementClient" @@ -36,7 +36,7 @@ title: "WebSiteManagementClient" These settings apply only when `--tag=package-2015-04-domain-registration --ruby` is specified on the command line. Please also specify `--ruby-sdks-folder=`. -``` yaml $(tag) == 'package-2015-04-domain-registration' && $(ruby) +```yaml $(tag) == 'package-2015-04-domain-registration' && $(ruby) namespace: "Azure::Web::Mgmt::V2015_04_01" output-folder: $(ruby-sdks-folder)/management/azure_mgmt_web/lib title: "WebSiteManagementClient" @@ -47,7 +47,7 @@ title: "WebSiteManagementClient" These settings apply only when `--tag=package-2016-09-01-web --ruby` is specified on the command line. Please also specify `--ruby-sdks-folder=`. -``` yaml $(tag) == 'package-2016-09-01-web' && $(ruby) +```yaml $(tag) == 'package-2016-09-01-web' && $(ruby) namespace: "Azure::Web::Mgmt::V2016_09_01" output-folder: $(ruby-sdks-folder)/management/azure_mgmt_web/lib title: "WebSiteManagementClient" @@ -58,7 +58,7 @@ title: "WebSiteManagementClient" These settings apply only when `--tag=package-2016-08-01-web --ruby` is specified on the command line. Please also specify `--ruby-sdks-folder=`. -``` yaml $(tag) == 'package-2016-08-01-web' && $(ruby) +```yaml $(tag) == 'package-2016-08-01-web' && $(ruby) namespace: "Azure::Web::Mgmt::V2016_08_01" output-folder: $(ruby-sdks-folder)/management/azure_mgmt_web/lib title: "WebSiteManagementClient" @@ -69,7 +69,7 @@ title: "WebSiteManagementClient" These settings apply only when `--tag=package-2016-03-01-web --ruby` is specified on the command line. Please also specify `--ruby-sdks-folder=`. -``` yaml $(tag) == 'package-2016-03-01-web' && $(ruby) +```yaml $(tag) == 'package-2016-03-01-web' && $(ruby) namespace: "Azure::Web::Mgmt::V2016_03_01" output-folder: $(ruby-sdks-folder)/management/azure_mgmt_web/lib title: "WebSiteManagementClient" @@ -80,7 +80,7 @@ title: "WebSiteManagementClient" These settings apply only when `--tag=package-2019-08-01-web --ruby` is specified on the command line. Please also specify `--ruby-sdks-folder=`. -``` yaml $(tag) == 'package-2019-08-01-web' && $(ruby) +```yaml $(tag) == 'package-2019-08-01-web' && $(ruby) namespace: "Azure::Web::Mgmt::V2019_08_01" output-folder: $(ruby-sdks-folder)/management/azure_mgmt_web/lib title: "WebSiteManagementClient" diff --git a/specification/web/resource-manager/readme.typescript.md b/specification/web/resource-manager/readme.typescript.md index f0731218bd02..c596ca0895b9 100644 --- a/specification/web/resource-manager/readme.typescript.md +++ b/specification/web/resource-manager/readme.typescript.md @@ -5,14 +5,14 @@ Please also specify `--typescript-sdks-folder= Date: Thu, 26 Sep 2024 17:32:07 +0800 Subject: [PATCH 23/48] update tspconfigs (#30745) --- .../iotoperations/IoTOperations.Management/client.tsp | 6 ++++++ .../IoTOperations.Management/tspconfig.yaml | 10 ++++++++++ 2 files changed, 16 insertions(+) create mode 100644 specification/iotoperations/IoTOperations.Management/client.tsp diff --git a/specification/iotoperations/IoTOperations.Management/client.tsp b/specification/iotoperations/IoTOperations.Management/client.tsp new file mode 100644 index 000000000000..e7db2f8919a4 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/client.tsp @@ -0,0 +1,6 @@ +import "./main.tsp"; +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; + +@@clientName(Microsoft.IoTOperations, "IoTOperationsMgmt", "python"); diff --git a/specification/iotoperations/IoTOperations.Management/tspconfig.yaml b/specification/iotoperations/IoTOperations.Management/tspconfig.yaml index e6f26465450b..708bdfee191a 100644 --- a/specification/iotoperations/IoTOperations.Management/tspconfig.yaml +++ b/specification/iotoperations/IoTOperations.Management/tspconfig.yaml @@ -1,3 +1,6 @@ +parameters: + "service-dir": + default: "sdk/iotoperations" emit: - "@azure-tools/typespec-autorest" options: @@ -6,6 +9,13 @@ options: azure-resource-provider-folder: "resource-manager" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/iotoperations.json" use-read-only-status-schema: true + "@azure-tools/typespec-python": + package-dir: "azure-mgmt-iotoperations" + package-name: "{package-dir}" + flavor: "azure" + generate-test: true + generate-sample: true + examples-dir: "{project-root}/examples" linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" From ff7d667287a71f1ca45924712cd55975524eccba Mon Sep 17 00:00:00 2001 From: Drishti Peshwani <148189108+drishtipeshwani09@users.noreply.github.com> Date: Thu, 26 Sep 2024 16:10:10 +0530 Subject: [PATCH 24/48] Microsoft.ContainerInstance : Updated API version 2024-05-01-preview for ContainerGroupProfile feature (#30694) * Added the container group profile model , api paths related to the cg profile and the corresponding examples * Modifed cg profile properties struction, added pattern for cg profile name and removed LRO tag * Modified files names for better context and removed deregister path for cg profile revisions * Updated container group profiles patch path and added pattern for container group profile name * Updated the file name * Replaced all the standard parameter references in order to use them directly from the common-types * Corrected the relative path * Updated the sub id parameter to a uuid format --- .../2024-05-01-preview/containerInstance.json | 669 ++++++++++++++++-- .../examples/CachedImagesList.json | 2 +- .../examples/CapabilitiesList.json | 2 +- .../examples/ContainerAttach.json | 2 +- .../examples/ContainerExec.json | 2 +- .../ContainerGroupCreateConfidential.json | 2 +- ...ntainerGroupCreateOrUpdateStandbyPool.json | 2 +- .../ContainerGroupEncryptionProperties.json | 2 +- .../examples/ContainerGroupExtensions.json | 2 +- ...fileCreateOrUpdate_CreateConfidential.json | 180 +++++ ...leCreateOrUpdate_EncryptionProperties.json | 164 +++++ ...GroupProfileCreateOrUpdate_Extensions.json | 191 +++++ ...tainerGroupProfileGetByRevisionNumber.json | 81 +++ ...ContainerGroupProfileListAllRevisions.json | 84 +++ .../ContainerGroupProfilesCreateOrUpdate.json | 293 ++++++++ .../ContainerGroupProfilesDelete.json | 12 + .../examples/ContainerGroupProfilesGet.json | 80 +++ .../ContainerGroupProfilesGetPriority.json | 81 +++ .../examples/ContainerGroupProfilesList.json | 82 +++ ...ainerGroupProfilesListByResourceGroup.json | 83 +++ .../examples/ContainerGroupProfilesPatch.json | 99 +++ .../examples/ContainerGroupUsage.json | 2 +- .../ContainerGroupsCreateOrUpdate.json | 2 +- .../ContainerGroupsCreatePriority.json | 2 +- .../examples/ContainerGroupsDelete.json | 2 +- .../examples/ContainerGroupsGetPriority.json | 2 +- .../examples/ContainerGroupsGet_Failed.json | 2 +- .../ContainerGroupsGet_Succeeded.json | 2 +- .../examples/ContainerGroupsList.json | 2 +- .../ContainerGroupsListByResourceGroup.json | 2 +- ...sProfileCreateOrUpdate_CreatePriority.json | 112 +++ .../examples/ContainerGroupsRestart.json | 2 +- .../examples/ContainerGroupsStart.json | 2 +- .../examples/ContainerGroupsStop.json | 2 +- .../examples/ContainerGroupsUpdate.json | 2 +- .../examples/ContainerListLogs.json | 2 +- .../SubnetServiceAssociationLinkDelete.json | 2 +- 37 files changed, 2158 insertions(+), 99 deletions(-) create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfileCreateOrUpdate_CreateConfidential.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfileCreateOrUpdate_EncryptionProperties.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfileCreateOrUpdate_Extensions.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfileGetByRevisionNumber.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfileListAllRevisions.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesCreateOrUpdate.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesDelete.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesGet.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesGetPriority.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesListByResourceGroup.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesPatch.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsProfileCreateOrUpdate_CreatePriority.json diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json index 1375a0e2998e..f9ef1d01ad25 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json @@ -45,10 +45,10 @@ "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": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -82,13 +82,13 @@ "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": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { @@ -128,13 +128,13 @@ "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": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ContainerGroupNameParameter" @@ -181,13 +181,13 @@ "description": "Create or update container groups with specified configurations.", "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ContainerGroupNameParameter" @@ -235,13 +235,13 @@ "description": "Updates container group tags with specified values.", "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ContainerGroupNameParameter" @@ -282,13 +282,13 @@ "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": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ContainerGroupNameParameter" @@ -329,13 +329,13 @@ "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": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ContainerGroupNameParameter" @@ -367,13 +367,13 @@ "description": "Stops all containers in a container group. Compute resources will be deallocated and billing will stop.", "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ContainerGroupNameParameter" @@ -404,13 +404,13 @@ "description": "Starts all containers in a container group. Compute resources will be allocated and billing will start.", "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ContainerGroupNameParameter" @@ -447,7 +447,7 @@ "description": "List the operations for Azure Container Instance service.", "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -480,13 +480,13 @@ "description": "Get the usage for a subscription", "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/LocationParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/LocationParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -520,13 +520,13 @@ "description": "Get the logs for a specified container instance in a specified resource group and container group.", "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ContainerGroupNameParameter" @@ -580,13 +580,13 @@ "description": "Executes a command for a specific container instance in a specified resource group and container group.", "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ContainerGroupNameParameter" @@ -636,13 +636,13 @@ "description": "Attach to the output stream of a specific container instance in a specified resource group and container group.", "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ContainerGroupNameParameter" @@ -683,13 +683,13 @@ "description": "Get the list of cached images on specific OS type for a subscription in a region.", "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/LocationParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/LocationParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -723,13 +723,13 @@ "description": "Get the list of CPU/memory/GPU capabilities of a region.", "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/LocationParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/LocationParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -759,13 +759,13 @@ "description": "Gets all the network dependencies for this container group to allow complete control of network setting and configuration. For container groups, this will always be an empty list.", "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ContainerGroupNameParameter" @@ -799,13 +799,13 @@ "description": "Delete container group virtual network association links. The operation does not delete other resources provided by the user.", "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/VirtualNetworkNameParameter" @@ -833,6 +833,362 @@ }, "x-ms-long-running-operation": true } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/containerGroupProfiles": { + "get": { + "operationId": "ContainerGroupProfiles_List", + "x-ms-examples": { + "ContainerGroupProfilesList": { + "$ref": "./examples/ContainerGroupProfilesList.json" + } + }, + "summary": "Get a list of container group profiles in the specified subscription.", + "description": "Get a list of container group profiles in the specified subscription. This operation returns properties of each container group profile including containers, image registry credentials, restart policy, IP address type, OS type,volumes,current revision number, etc.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroupProfileListResult" + } + }, + "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/containerGroupProfiles": { + "get": { + "operationId": "ContainerGroupProfiles_ListByResourceGroup", + "x-ms-examples": { + "ContainerGroupProfilesListByResourceGroup": { + "$ref": "./examples/ContainerGroupProfilesListByResourceGroup.json" + } + }, + "summary": "Get a list of container group profiles in the specified subscription and resource group.", + "description": "Get a list of container group profiles in a specified subscription and resource group. This operation returns properties of each container group profile including containers, image registry credentials, restart policy, IP address type, OS type volumes, current revision number, etc.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroupProfileListResult" + } + }, + "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/containerGroupProfiles/{containerGroupProfileName}": { + "get": { + "operationId": "ContainerGroupProfiles_Get", + "x-ms-examples": { + "ContainerGroupProfilesGet_Succeeded": { + "$ref": "./examples/ContainerGroupProfilesGet.json" + }, + "ContainerGroupProfilesGetWithPriority": { + "$ref": "./examples/ContainerGroupProfilesGetPriority.json" + } + }, + "summary": "Get the properties of the specified container group profile.", + "description": "Gets the properties of the specified container group profile in the specified subscription and resource group. The operation returns the properties of container group profile including containers, image registry credentials, restart policy, IP address type, OS type, volumes, current revision number, etc.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupProfileNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroupProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "ContainerGroupProfiles_CreateOrUpdate", + "x-ms-examples": { + "ContainerGroupProfilesCreateOrUpdate": { + "$ref": "./examples/ContainerGroupProfilesCreateOrUpdate.json" + }, + "ContainerGroupProfileCreateWithExtensions": { + "$ref": "./examples/ContainerGroupProfileCreateOrUpdate_Extensions.json" + }, + "ContainerGroupProfileWithEncryptionProperties": { + "$ref": "./examples/ContainerGroupProfileCreateOrUpdate_EncryptionProperties.json" + }, + "ConfidentialContainerGroupProfile": { + "$ref": "./examples/ContainerGroupProfileCreateOrUpdate_CreateConfidential.json" + }, + "ContainerGroupsCreateWithPriority": { + "$ref": "./examples/ContainerGroupsProfileCreateOrUpdate_CreatePriority.json" + } + }, + "summary": "Create or update container group profiles.", + "description": "Create or update container group profiles with specified configurations.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupProfileNameParameter" + }, + { + "name": "containerGroupProfile", + "description": "The properties of the container group profile to be created or updated.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/ContainerGroupProfile" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroupProfile" + } + }, + "201": { + "description": "Created - the container group profile is created.", + "schema": { + "$ref": "#/definitions/ContainerGroupProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "operationId": "ContainerGroupProfiles_Patch", + "x-ms-examples": { + "ContainerGroupProfilesPatch": { + "$ref": "./examples/ContainerGroupProfilesPatch.json" + } + }, + "summary": "Patch container group profiles.", + "description": "Patches container group profile with specified properties.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupProfileNameParameter" + }, + { + "name": "properties", + "description": "The container group profile properties that need to be updated.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/ContainerGroupProfilePatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroupProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "ContainerGroupProfiles_Delete", + "x-ms-examples": { + "ContainerGroupProfilesDelete": { + "$ref": "./examples/ContainerGroupProfilesDelete.json" + } + }, + "summary": "Delete the specified container group profile.", + "description": "Delete the specified container group profile in the specified subscription and resource group. The operation does not delete other resources provided by the user, such as volumes.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupProfileNameParameter" + } + ], + "responses": { + "200": { + "description": "OK - Delete started" + }, + "204": { + "description": "No Content - the specified container group profile was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles/{containerGroupProfileName}/revisions": { + "get": { + "operationId": "ContainerGroupProfile_ListAllRevisions", + "x-ms-examples": { + "ContainerGroupProfileListAllRevisions": { + "$ref": "./examples/ContainerGroupProfileListAllRevisions.json" + } + }, + "summary": "Get a list of all the revisions of the specified container group profile in the given subscription and resource group.", + "description": "Get a list of all the revisions of the specified container group profile in the given subscription and resource group. This operation returns properties of each revision of the specified container group profile including containers, image registry credentials, restart policy, IP address type, OS type volumes, revision number, etc.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupProfileNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroupProfileListResult" + } + }, + "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/containerGroupProfiles/{containerGroupProfileName}/revisions/{revisionNumber}": { + "get": { + "operationId": "ContainerGroupProfile_GetByRevisionNumber", + "x-ms-examples": { + "ContainerGroupProfileGetByRevisionNumber": { + "$ref": "./examples/ContainerGroupProfileGetByRevisionNumber.json" + } + }, + "summary": "Get the properties of the specified revision of the container group profile.", + "description": "Gets the properties of the specified revision of the container group profile in the given subscription and resource group. The operation returns the properties of container group profile including containers, image registry credentials, restart policy, IP address type, OS type, volumes, current revision number, etc.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupProfileNameParameter" + }, + { + "$ref": "#/parameters/RevisionNumberParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroupProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } } }, "definitions": { @@ -1399,6 +1755,17 @@ } ] }, + "ContainerGroupProfile": { + "description": "A container group profile.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "$ref": "#/definitions/ContainerGroupProfileProperties" + } + ] + }, "ContainerGroupProperties": { "description": "The container group properties", "type": "object", @@ -1582,6 +1949,139 @@ } } }, + "ContainerGroupProfileProperties": { + "description": "The container group profile properties", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "type": "object", + "description": "The container group profile properties", + "properties": { + "containers": { + "type": "array", + "description": "The containers within the container group.", + "items": { + "$ref": "#/definitions/Container" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "imageRegistryCredentials": { + "type": "array", + "description": "The image registry credentials by which the container group is created from.", + "items": { + "$ref": "#/definitions/ImageRegistryCredential" + }, + "x-ms-identifiers": [ + "username" + ] + }, + "restartPolicy": { + "type": "string", + "description": "Restart policy for all containers within the container group. \n- `Always` Always restart\n- `OnFailure` Restart on failure\n- `Never` Never restart\n", + "enum": [ + "Always", + "OnFailure", + "Never" + ], + "x-ms-enum": { + "name": "ContainerGroupRestartPolicy", + "modelAsString": true + } + }, + "ipAddress": { + "description": "The IP address type of the container group.", + "$ref": "#/definitions/IpAddress" + }, + "osType": { + "type": "string", + "description": "The operating system type required by the containers in the container group.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": true + } + }, + "volumes": { + "type": "array", + "description": "The list of volumes that can be mounted by containers in this container group.", + "items": { + "$ref": "#/definitions/Volume" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "diagnostics": { + "description": "The diagnostic information for a container group.", + "$ref": "#/definitions/ContainerGroupDiagnostics" + }, + "sku": { + "description": "The SKU for a container group.", + "$ref": "#/definitions/ContainerGroupSku" + }, + "encryptionProperties": { + "description": "The encryption properties for a container group.", + "$ref": "#/definitions/EncryptionProperties" + }, + "initContainers": { + "type": "array", + "description": "The init containers for a container group.", + "items": { + "$ref": "#/definitions/InitContainerDefinition" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "extensions": { + "type": "array", + "description": "extensions used by virtual kubelet", + "items": { + "$ref": "#/definitions/DeploymentExtensionSpec" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "confidentialComputeProperties": { + "description": "The properties for confidential container group", + "$ref": "#/definitions/ConfidentialComputeProperties" + }, + "priority": { + "type": "string", + "description": "The priority of the container group.", + "enum": [ + "Regular", + "Spot" + ], + "x-ms-enum": { + "name": "ContainerGroupPriority", + "modelAsString": true + } + }, + "revision": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The container group profile current revision number. This only appears in the response." + } + }, + "required": [ + "containers", + "osType" + ] + } + } + }, "ContainerGroupProfileReferenceDefinition": { "description": "The container group profile reference.", "type": "object", @@ -2093,6 +2593,36 @@ } } }, + "ContainerGroupProfileListResult": { + "description": "The container group profile list response that contains the container group profile properties.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerGroupProfile" + }, + "description": "The list of container group profiles." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of container group profiles." + } + } + }, + "ContainerGroupProfilePatch": { + "type": "object", + "description": "Properties of container group profile that need to be patched", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, "Logs": { "description": "The logs.", "type": "object", @@ -2541,44 +3071,31 @@ } }, "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", + "ContainerGroupNameParameter": { + "name": "containerGroupName", "in": "path", "required": true, "type": "string", - "description": "The identifier for the physical azure location.", + "description": "The name of the container group.", "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", + "ContainerGroupProfileNameParameter": { + "name": "containerGroupProfileName", "in": "path", "required": true, + "pattern": "^(?!.*--)[a-z0-9]([-a-z0-9]*[a-z0-9])?$", + "minLength": 1, + "maxLength": 63, "type": "string", - "description": "The name of the resource group.", + "description": "The name of the container group profile.", "x-ms-parameter-location": "method" }, - "ContainerGroupNameParameter": { - "name": "containerGroupName", + "RevisionNumberParameter": { + "name": "revisionNumber", "in": "path", "required": true, "type": "string", - "description": "The name of the container group.", + "description": "The revision number of the container group profile.", "x-ms-parameter-location": "method" }, "VirtualNetworkNameParameter": { diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/CachedImagesList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/CachedImagesList.json index ddc3207b60f4..9507aef6add9 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/CachedImagesList.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/CachedImagesList.json @@ -1,6 +1,6 @@ { "parameters": { - "subscriptionId": "subid", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "location": "westcentralus", "api-version": "2024-05-01-preview" }, diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/CapabilitiesList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/CapabilitiesList.json index 9bbdbe7194fe..2182a08505a9 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/CapabilitiesList.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/CapabilitiesList.json @@ -1,6 +1,6 @@ { "parameters": { - "subscriptionId": "subid", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "location": "westus", "api-version": "2024-05-01-preview" }, diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerAttach.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerAttach.json index f3c9cb70238f..d94233a3d313 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerAttach.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerAttach.json @@ -1,6 +1,6 @@ { "parameters": { - "subscriptionId": "subid", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "api-version": "2024-05-01-preview", "resourceGroupName": "demo", "containerGroupName": "demo1", diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerExec.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerExec.json index ec34b861e41c..795c78187dfa 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerExec.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerExec.json @@ -1,6 +1,6 @@ { "parameters": { - "subscriptionId": "subid", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "api-version": "2024-05-01-preview", "resourceGroupName": "demo", "containerGroupName": "demo1", diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupCreateConfidential.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupCreateConfidential.json index 20e44336b9dc..a07bfa0d008e 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupCreateConfidential.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupCreateConfidential.json @@ -1,6 +1,6 @@ { "parameters": { - "subscriptionId": "subid", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "api-version": "2024-05-01-preview", "resourceGroupName": "demo", "containerGroupName": "demo1", diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupCreateOrUpdateStandbyPool.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupCreateOrUpdateStandbyPool.json index 085e2cea968f..0a794230f048 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupCreateOrUpdateStandbyPool.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupCreateOrUpdateStandbyPool.json @@ -1,6 +1,6 @@ { "parameters": { - "subscriptionId": "subid", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "api-version": "2024-05-01-preview", "resourceGroupName": "demo", "containerGroupName": "demo1", diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupEncryptionProperties.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupEncryptionProperties.json index 8467e64e2862..a9e67ec90f2a 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupEncryptionProperties.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupEncryptionProperties.json @@ -1,6 +1,6 @@ { "parameters": { - "subscriptionId": "subid", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "api-version": "2024-05-01-preview", "resourceGroupName": "demo", "containerGroupName": "demo1", diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupExtensions.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupExtensions.json index 9a0c24e8b93d..d7e096d65150 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupExtensions.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupExtensions.json @@ -1,6 +1,6 @@ { "parameters": { - "subscriptionId": "subid", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "api-version": "2024-05-01-preview", "resourceGroupName": "demo", "containerGroupName": "demo1", diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfileCreateOrUpdate_CreateConfidential.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfileCreateOrUpdate_CreateConfidential.json new file mode 100644 index 000000000000..c6152dca956d --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfileCreateOrUpdate_CreateConfidential.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-05-01-preview", + "resourceGroupName": "demo", + "containerGroupProfileName": "demo1", + "containerGroupProfile": { + "location": "westeurope", + "zones": [ + "1" + ], + "properties": { + "containers": [ + { + "name": "accdemo", + "properties": { + "command": [], + "environmentVariables": [], + "image": "confiimage", + "ports": [ + { + "port": 8000 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "securityContext": { + "privileged": false, + "capabilities": { + "add": [ + "CAP_NET_ADMIN" + ] + } + } + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 8000 + } + ], + "type": "Public" + }, + "osType": "Linux", + "sku": "Confidential", + "confidentialComputeProperties": { + "ccePolicy": "eyJhbGxvd19hbGwiOiB0cnVlLCAiY29udGFpbmVycyI6IHsibGVuZ3RoIjogMCwgImVsZW1lbnRzIjogbnVsbH19" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Confidential", + "containers": [ + { + "name": "accdemo", + "properties": { + "image": "confiimage", + "command": [], + "ports": [ + { + "port": 8000 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + }, + "securityContext": { + "privileged": false, + "capabilities": { + "add": [ + "CAP_NET_ADMIN" + ] + } + } + } + } + ], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 8000 + } + ], + "type": "Public" + }, + "initContainers": [], + "imageRegistryCredentials": [], + "osType": "Linux", + "confidentialComputeProperties": { + "ccePolicy": "eyJhbGxvd19hbGwiOiB0cnVlLCAiY29udGFpbmVycyI6IHsibGVuZ3RoIjogMCwgImVsZW1lbnRzIjogbnVsbH19" + }, + "revision": 0 + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroupProfiles/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroupProfiles", + "location": "westeurope", + "zones": [ + "1" + ] + } + }, + "201": { + "body": { + "properties": { + "sku": "Confidential", + "containers": [ + { + "name": "accdemo", + "properties": { + "image": "confiimage", + "command": [], + "ports": [ + { + "port": 8000 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + }, + "securityContext": { + "privileged": false, + "capabilities": { + "add": [ + "CAP_NET_ADMIN" + ] + } + } + } + } + ], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 8000 + } + ], + "type": "Public" + }, + "initContainers": [], + "imageRegistryCredentials": [], + "osType": "Linux", + "confidentialComputeProperties": { + "ccePolicy": "eyJhbGxvd19hbGwiOiB0cnVlLCAiY29udGFpbmVycyI6IHsibGVuZ3RoIjogMCwgImVsZW1lbnRzIjogbnVsbH19" + }, + "revision": 1 + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroupProfiles/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroupProfiles", + "location": "westeurope", + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfileCreateOrUpdate_EncryptionProperties.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfileCreateOrUpdate_EncryptionProperties.json new file mode 100644 index 000000000000..b02df971c286 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfileCreateOrUpdate_EncryptionProperties.json @@ -0,0 +1,164 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-05-01-preview", + "resourceGroupName": "demo", + "containerGroupProfileName": "demo1", + "containerGroupProfile": { + "location": "eastus2", + "zones": [ + "1" + ], + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + } + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public" + }, + "osType": "Linux", + "encryptionProperties": { + "vaultBaseUrl": "https://testkeyvault.vault.azure.net", + "keyName": "test-key", + "keyVersion": "", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "encryptionProperties": { + "vaultBaseUrl": "https://testkeyvault.vault.azure.net/", + "keyName": "test-key", + "keyVersion": "", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity" + }, + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public" + }, + "osType": "Linux", + "revision": 0 + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ContainerInstance/containerGroupProfiles/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroupProfiles", + "location": "eastus2", + "zones": [ + "1" + ] + } + }, + "201": { + "body": { + "properties": { + "sku": "Standard", + "encryptionProperties": { + "vaultBaseUrl": "https://testkeyvault.vault.azure.net/", + "keyName": "test-key", + "keyVersion": "key version", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity" + }, + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public" + }, + "osType": "Linux", + "revision": 1 + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ContainerInstance/containerGroupProfiles/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroupProfiles", + "location": "eastus2", + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfileCreateOrUpdate_Extensions.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfileCreateOrUpdate_Extensions.json new file mode 100644 index 000000000000..8330874990bc --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfileCreateOrUpdate_Extensions.json @@ -0,0 +1,191 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-05-01-preview", + "resourceGroupName": "demo", + "containerGroupProfileName": "demo1", + "containerGroupProfile": { + "location": "eastus2", + "zones": [ + "1" + ], + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + } + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Private" + }, + "osType": "Linux", + "extensions": [ + { + "name": "kube-proxy", + "properties": { + "extensionType": "kube-proxy", + "version": "1.0", + "settings": { + "clusterCidr": "10.240.0.0/16", + "kubeVersion": "v1.9.10" + }, + "protectedSettings": { + "kubeConfig": "" + } + } + }, + { + "name": "vk-realtime-metrics", + "properties": { + "extensionType": "realtime-metrics", + "version": "1.0" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "extensions": [ + { + "name": "kube-proxy", + "properties": { + "extensionType": "kube-proxy", + "version": "1.0", + "settings": { + "clusterCidr": "10.240.0.0/16", + "kubeVersion": "v1.9.10" + } + } + }, + { + "name": "vk-realtime-metrics", + "properties": { + "extensionType": "realtime-metrics", + "version": "1.0" + } + } + ], + "imageRegistryCredentials": [], + "osType": "Linux", + "revision": 0 + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroupProfiles/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroupProfiles", + "location": "eastus2", + "zones": [ + "1" + ] + } + }, + "201": { + "body": { + "properties": { + "sku": "Standard", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "extensions": [ + { + "name": "kube-proxy", + "properties": { + "extensionType": "kube-proxy", + "version": "1.0", + "settings": { + "clusterCidr": "10.240.0.0/16", + "kubeVersion": "v1.9.10" + } + } + }, + { + "name": "vk-realtime-metrics", + "properties": { + "extensionType": "realtime-metrics", + "version": "1.0" + } + } + ], + "imageRegistryCredentials": [], + "osType": "Linux", + "revision": 1 + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroupProfiles/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroupProfiles", + "location": "eastus2", + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfileGetByRevisionNumber.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfileGetByRevisionNumber.json new file mode 100644 index 000000000000..08954b595f28 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfileGetByRevisionNumber.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "demo", + "containerGroupProfileName": "demo1", + "revisionNumber": "1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroupProfiles/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "sku": "Standard", + "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", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ], + "revision": 1 + }, + "type": "Microsoft.ContainerInstance/containerGroupProfiles" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfileListAllRevisions.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfileListAllRevisions.json new file mode 100644 index 000000000000..5006d0bce8e2 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfileListAllRevisions.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "demo", + "containerGroupProfileName": "demo1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroupProfiles/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "sku": "Standard", + "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", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ], + "revision": 1 + }, + "type": "Microsoft.ContainerInstance/containerGroupProfiles" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesCreateOrUpdate.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesCreateOrUpdate.json new file mode 100644 index 000000000000..4d61d0b4ca58 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesCreateOrUpdate.json @@ -0,0 +1,293 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-05-01-preview", + "resourceGroupName": "demo", + "containerGroupProfileName": "demo1", + "containerGroupProfile": { + "location": "west us", + "zones": [ + "1" + ], + "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": { + "pod-uuid": "test-metadata-value" + }, + "workspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/microsoft.operationalinsights/workspaces/workspace" + } + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public" + }, + "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/containerGroupProfiles/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "sku": "Standard", + "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", + "logType": "ContainerInsights", + "metadata": { + "pod-uuid": "test-metadata-value" + } + } + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ], + "revision": 0 + }, + "type": "Microsoft.ContainerInstance/containerGroupProfiles" + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroupProfiles/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "sku": "Standard", + "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 + } + ] + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "diagnostics": { + "logAnalytics": { + "workspaceId": "workspaceid", + "logType": "ContainerInsights", + "metadata": { + "pod-uuid": "test-metadata-value" + } + } + }, + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ], + "revision": 1 + }, + "type": "Microsoft.ContainerInstance/containerGroupProfiles" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesDelete.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesDelete.json new file mode 100644 index 000000000000..d7ce02cd3832 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-05-01-preview", + "resourceGroupName": "demo", + "containerGroupProfileName": "demo1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesGet.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesGet.json new file mode 100644 index 000000000000..747a82c66978 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesGet.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "demo", + "containerGroupProfileName": "demo1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroupProfiles/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "sku": "Standard", + "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", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ], + "revision": 1 + }, + "type": "Microsoft.ContainerInstance/containerGroupProfiles" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesGetPriority.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesGetPriority.json new file mode 100644 index 000000000000..1498eb75f3fc --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesGetPriority.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "demo", + "containerGroupProfileName": "demo1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroupProfiles/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "sku": "Standard", + "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", + "priority": "Spot", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ], + "revision": 1 + }, + "type": "Microsoft.ContainerInstance/containerGroupProfiles" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesList.json new file mode 100644 index 000000000000..cf759ee364ed --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesList.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroupProfiles/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "sku": "Standard", + "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", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ], + "revision": 1 + }, + "type": "Microsoft.ContainerInstance/containerGroupProfiles" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesListByResourceGroup.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesListByResourceGroup.json new file mode 100644 index 000000000000..2b9b3284eabe --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesListByResourceGroup.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "demo", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroupProfiles/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "sku": "Standard", + "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", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ], + "revision": 1 + }, + "type": "Microsoft.ContainerInstance/containerGroupProfiles" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesPatch.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesPatch.json new file mode 100644 index 000000000000..9090b51765a6 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupProfilesPatch.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-05-01-preview", + "resourceGroupName": "demoResource", + "containerGroupProfileName": "demo1", + "properties": { + "tags": { + "tag1key": "tag1Value", + "tag2key": "tag2Value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demoResource/providers/Microsoft.ContainerInstance/containerGroupProfiles/demo1", + "location": "WestUs", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroupProfiles", + "tags": { + "tag1key": "tag1Value", + "tag2key": "tag2Value" + }, + "properties": { + "sku": "Standard", + "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" + }, + "osType": "Linux", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ], + "revision": 2 + } + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupUsage.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupUsage.json index a03657bca6d5..8d99aaae4fde 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupUsage.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupUsage.json @@ -1,6 +1,6 @@ { "parameters": { - "subscriptionId": "subid", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "location": "westcentralus", "api-version": "2024-05-01-preview" }, diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsCreateOrUpdate.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsCreateOrUpdate.json index 27afd2512667..502db3a94728 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsCreateOrUpdate.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsCreateOrUpdate.json @@ -1,6 +1,6 @@ { "parameters": { - "subscriptionId": "subid", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "api-version": "2024-05-01-preview", "resourceGroupName": "demo", "containerGroupName": "demo1", diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsCreatePriority.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsCreatePriority.json index c6f3d9569a5d..5ad3dc8bae54 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsCreatePriority.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsCreatePriority.json @@ -1,6 +1,6 @@ { "parameters": { - "subscriptionId": "subid", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "api-version": "2024-05-01-preview", "resourceGroupName": "demo", "containerGroupName": "demo1", diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsDelete.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsDelete.json index 0eb2d6b600c5..59b2063da04d 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsDelete.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsDelete.json @@ -1,6 +1,6 @@ { "parameters": { - "subscriptionId": "subid", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "api-version": "2024-05-01-preview", "resourceGroupName": "demo", "containerGroupName": "demo1" diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsGetPriority.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsGetPriority.json index f73660bdea3c..e7f3d7285b92 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsGetPriority.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsGetPriority.json @@ -1,6 +1,6 @@ { "parameters": { - "subscriptionId": "subid", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "demo", "containerGroupName": "demo1", "api-version": "2024-05-01-preview" diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsGet_Failed.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsGet_Failed.json index 5ff099014ec8..d56bf0358ea1 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsGet_Failed.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsGet_Failed.json @@ -1,6 +1,6 @@ { "parameters": { - "subscriptionId": "subid", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "demo", "containerGroupName": "demo1", "api-version": "2024-05-01-preview" diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsGet_Succeeded.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsGet_Succeeded.json index f2d852a5abf9..89cb49142e35 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsGet_Succeeded.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsGet_Succeeded.json @@ -1,6 +1,6 @@ { "parameters": { - "subscriptionId": "subid", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "demo", "containerGroupName": "demo1", "api-version": "2024-05-01-preview" diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsList.json index ce9a903fbd5d..dbec3b2dadc0 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsList.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsList.json @@ -1,6 +1,6 @@ { "parameters": { - "subscriptionId": "subid", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "api-version": "2024-05-01-preview" }, "responses": { diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsListByResourceGroup.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsListByResourceGroup.json index ef1d03323719..4c04bd835737 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsListByResourceGroup.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsListByResourceGroup.json @@ -1,6 +1,6 @@ { "parameters": { - "subscriptionId": "subid", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "demo", "api-version": "2024-05-01-preview" }, diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsProfileCreateOrUpdate_CreatePriority.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsProfileCreateOrUpdate_CreatePriority.json new file mode 100644 index 000000000000..6b77d55112ac --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsProfileCreateOrUpdate_CreatePriority.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-05-01-preview", + "resourceGroupName": "demo", + "containerGroupProfileName": "demo1", + "containerGroupProfile": { + "properties": { + "sku": "Standard", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "restartPolicy": "Never", + "osType": "Linux", + "priority": "Spot" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "ports": [], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "initContainers": [], + "restartPolicy": "Never", + "osType": "Linux", + "priority": "Spot", + "revision": 0 + }, + "id": "/subscriptions/subId/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroupProfiles/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroupProfiles", + "location": "eastus" + } + }, + "201": { + "body": { + "properties": { + "sku": "Standard", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "ports": [], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "initContainers": [], + "restartPolicy": "Never", + "osType": "Linux", + "priority": "Spot", + "revision": 1 + }, + "id": "/subscriptions/subId/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroupProfiles/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroupProfiles", + "location": "eastus" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsRestart.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsRestart.json index 54427e59496a..457575177a10 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsRestart.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsRestart.json @@ -1,6 +1,6 @@ { "parameters": { - "subscriptionId": "subid", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "api-version": "2024-05-01-preview", "resourceGroupName": "demo", "containerGroupName": "demo1" diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsStart.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsStart.json index 21c6cba5a581..2c1b60091ff5 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsStart.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsStart.json @@ -1,6 +1,6 @@ { "parameters": { - "subscriptionId": "subid", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "api-version": "2024-05-01-preview", "resourceGroupName": "demo", "containerGroupName": "demo1" diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsStop.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsStop.json index 54427e59496a..457575177a10 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsStop.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsStop.json @@ -1,6 +1,6 @@ { "parameters": { - "subscriptionId": "subid", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "api-version": "2024-05-01-preview", "resourceGroupName": "demo", "containerGroupName": "demo1" diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsUpdate.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsUpdate.json index 7cc8f8cd6da0..47f4125b5f10 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsUpdate.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsUpdate.json @@ -1,6 +1,6 @@ { "parameters": { - "subscriptionId": "subid", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "api-version": "2024-05-01-preview", "resourceGroupName": "demoResource", "containerGroupName": "demo1", diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerListLogs.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerListLogs.json index 893324e87a3d..150d25441a93 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerListLogs.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerListLogs.json @@ -1,6 +1,6 @@ { "parameters": { - "subscriptionId": "subid", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "api-version": "2024-05-01-preview", "resourceGroupName": "demo", "containerGroupName": "demo1", diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/SubnetServiceAssociationLinkDelete.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/SubnetServiceAssociationLinkDelete.json index dd958037e751..6c65c53fe8bd 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/SubnetServiceAssociationLinkDelete.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/SubnetServiceAssociationLinkDelete.json @@ -1,6 +1,6 @@ { "parameters": { - "subscriptionId": "subid", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "api-version": "2024-05-01-preview", "resourceGroupName": "demo", "virtualNetworkName": "demo2", From 3ca7edabc2edf1117b7d912ba34f2694721e3ff3 Mon Sep 17 00:00:00 2001 From: kanil4664 <103174100+kanil4664@users.noreply.github.com> Date: Thu, 26 Sep 2024 05:48:59 -0700 Subject: [PATCH 25/48] Kanil4664 elasticsan microsoft.elastic san 2024 06 01 preview (#30019) * copying latest stable version to preview * changin API version to 2024-06-01-preview * changes to elasticsan.json file and examples * changes to readme.md file * fixing typo --- .../2024-06-01-preview/elasticsan.json | 2809 +++++++++++++++++ .../ElasticSans_Create_MaximumSet_Gen.json | 189 ++ .../ElasticSans_Create_MinimumSet_Gen.json | 53 + .../ElasticSans_Delete_MaximumSet_Gen.json | 19 + .../ElasticSans_Delete_MinimumSet_Gen.json | 19 + .../ElasticSans_Get_MaximumSet_Gen.json | 86 + .../ElasticSans_Get_MinimumSet_Gen.json | 26 + ...ns_ListByResourceGroup_MaximumSet_Gen.json | 90 + ...ns_ListByResourceGroup_MinimumSet_Gen.json | 14 + ...ans_ListBySubscription_MaximumSet_Gen.json | 89 + ...ans_ListBySubscription_MinimumSet_Gen.json | 13 + .../ElasticSans_Update_MaximumSet_Gen.json | 109 + .../ElasticSans_Update_MinimumSet_Gen.json | 30 + .../Operations_List_MaximumSet_Gen.json | 28 + .../Operations_List_MinimumSet_Gen.json | 12 + ...ointConnections_Create_MaximumSet_Gen.json | 87 + ...ointConnections_Create_MinimumSet_Gen.json | 79 + ...ointConnections_Delete_MaximumSet_Gen.json | 20 + ...ointConnections_Delete_MinimumSet_Gen.json | 20 + ...ndpointConnections_Get_MaximumSet_Gen.json | 42 + ...ndpointConnections_Get_MinimumSet_Gen.json | 42 + ...dpointConnections_List_MaximumSet_Gen.json | 46 + ...dpointConnections_List_MinimumSet_Gen.json | 15 + ...urces_ListByElasticSan_MaximumSet_Gen.json | 41 + ...urces_ListByElasticSan_MinimumSet_Gen.json | 15 + .../examples/Skus_List_MaximumSet_Gen.json | 40 + .../examples/Skus_List_MinimumSet_Gen.json | 13 + .../VolumeGroups_Create_MaximumSet_Gen.json | 211 ++ .../VolumeGroups_Create_MinimumSet_Gen.json | 23 + .../VolumeGroups_Delete_MaximumSet_Gen.json | 20 + .../VolumeGroups_Delete_MinimumSet_Gen.json | 20 + .../VolumeGroups_Get_MaximumSet_Gen.json | 95 + .../VolumeGroups_Get_MinimumSet_Gen.json | 16 + ...roups_ListByElasticSan_MaximumSet_Gen.json | 99 + ...roups_ListByElasticSan_MinimumSet_Gen.json | 15 + .../VolumeGroups_Update_MaximumSet_Gen.json | 131 + .../VolumeGroups_Update_MinimumSet_Gen.json | 22 + ...VolumeSnapshots_Create_MaximumSet_Gen.json | 70 + ...VolumeSnapshots_Create_MinimumSet_Gen.json | 70 + ...VolumeSnapshots_Delete_MaximumSet_Gen.json | 21 + ...VolumeSnapshots_Delete_MinimumSet_Gen.json | 21 + .../VolumeSnapshots_Get_MaximumSet_Gen.json | 37 + .../VolumeSnapshots_Get_MinimumSet_Gen.json | 37 + ...hots_ListByVolumeGroup_MaximumSet_Gen.json | 42 + ...hots_ListByVolumeGroup_MinimumSet_Gen.json | 16 + .../Volumes_Create_MaximumSet_Gen.json | 97 + .../Volumes_Create_MinimumSet_Gen.json | 90 + .../Volumes_Delete_MaximumSet_Gen.json | 23 + .../Volumes_Delete_MinimumSet_Gen.json | 21 + .../examples/Volumes_Get_MaximumSet_Gen.json | 48 + .../examples/Volumes_Get_MinimumSet_Gen.json | 48 + ...umes_ListByVolumeGroup_MaximumSet_Gen.json | 52 + ...umes_ListByVolumeGroup_MinimumSet_Gen.json | 16 + .../Volumes_Update_MaximumSet_Gen.json | 58 + .../Volumes_Update_MinimumSet_Gen.json | 54 + .../elasticsan/resource-manager/readme.md | 12 +- 56 files changed, 5529 insertions(+), 2 deletions(-) create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/elasticsan.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Create_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Create_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Delete_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Delete_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Get_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Get_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_ListByResourceGroup_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_ListBySubscription_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Update_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Update_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Operations_List_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Operations_List_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_Create_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_Delete_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_Get_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_List_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_List_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateLinkResources_ListByElasticSan_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateLinkResources_ListByElasticSan_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Skus_List_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Skus_List_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Create_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Create_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Delete_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Delete_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Get_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Get_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_ListByElasticSan_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_ListByElasticSan_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Update_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Update_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_Create_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_Create_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_Delete_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_Delete_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_Get_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_Get_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_ListByVolumeGroup_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_ListByVolumeGroup_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Create_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Create_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Delete_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Delete_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Get_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Get_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_ListByVolumeGroup_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_ListByVolumeGroup_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Update_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Update_MinimumSet_Gen.json diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/elasticsan.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/elasticsan.json new file mode 100644 index 000000000000..924dc21f6f63 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/elasticsan.json @@ -0,0 +1,2809 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-06-01-preview", + "title": "ElasticSanManagement" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "ElasticSans", + "description": "APIs for ElasticSan operations." + }, + { + "name": "ElasticSanOperations", + "description": "APIs for ElasticSan operations," + }, + { + "name": "VolumeGroups", + "description": "APIs for Volume Group operations." + }, + { + "name": "Volumes", + "description": "APIs for Volume operations." + } + ], + "paths": { + "/providers/Microsoft.ElasticSan/operations": { + "get": { + "tags": [ + "Elastic San Operations" + ], + "operationId": "Operations_List", + "description": "Gets a list of ElasticSan operations.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Operations_List_MaximumSet_Gen": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + }, + "Operations_List_MinimumSet_Gen": { + "$ref": "./examples/Operations_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ElasticSan/skus": { + "get": { + "tags": [ + "Elastic San Skus" + ], + "summary": "List all the available Skus in the region and information related to them", + "operationId": "Skus_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Specify $filter='location eq ' to filter on location.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Lists the available SKUs supported by Microsoft.ElasticSan for given subscription.", + "schema": { + "$ref": "#/definitions/SkuInformationList" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Skus_List_MaximumSet_Gen": { + "$ref": "./examples/Skus_List_MaximumSet_Gen.json" + }, + "Skus_List_MinimumSet_Gen": { + "$ref": "./examples/Skus_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ElasticSan/elasticSans": { + "get": { + "tags": [ + "ElasticSans" + ], + "operationId": "ElasticSans_ListBySubscription", + "description": "Gets a list of ElasticSans in a subscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Operation completed successfully; retrieved Elastic San by subscription", + "schema": { + "$ref": "#/definitions/ElasticSanList" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ElasticSans_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/ElasticSans_ListBySubscription_MaximumSet_Gen.json" + }, + "ElasticSans_ListBySubscription_MinimumSet_Gen": { + "$ref": "./examples/ElasticSans_ListBySubscription_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans": { + "get": { + "tags": [ + "ElasticSan" + ], + "operationId": "ElasticSans_ListByResourceGroup", + "description": "Gets a list of ElasticSan in a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Operation completed successfully; retrieved elasticSans by resource group", + "schema": { + "$ref": "#/definitions/ElasticSanList" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ElasticSans_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/ElasticSans_ListByResourceGroup_MaximumSet_Gen.json" + }, + "ElasticSans_ListByResourceGroup_MinimumSet_Gen": { + "$ref": "./examples/ElasticSans_ListByResourceGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}": { + "put": { + "tags": [ + "ElasticSans" + ], + "operationId": "ElasticSans_Create", + "description": "Create ElasticSan.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ElasticSan" + }, + "description": "Elastic San object." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Resource Create or Update operation is successfully completed.", + "schema": { + "$ref": "#/definitions/ElasticSan" + } + }, + "201": { + "description": "Created -- Resource Create; operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ElasticSan" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ElasticSans_Create_MaximumSet_Gen": { + "$ref": "./examples/ElasticSans_Create_MaximumSet_Gen.json" + }, + "ElasticSans_Create_MinimumSet_Gen": { + "$ref": "./examples/ElasticSans_Create_MinimumSet_Gen.json" + } + } + }, + "patch": { + "tags": [ + "ElasticSans" + ], + "operationId": "ElasticSans_Update", + "description": "Update a Elastic San.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ElasticSanUpdate" + }, + "description": "Elastic San object." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- ElasticSAN properties updated successfully.", + "schema": { + "$ref": "#/definitions/ElasticSan" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ElasticSans_Update_MaximumSet_Gen": { + "$ref": "./examples/ElasticSans_Update_MaximumSet_Gen.json" + }, + "ElasticSans_Update_MinimumSet_Gen": { + "$ref": "./examples/ElasticSans_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "ElasticSans" + ], + "operationId": "ElasticSans_Delete", + "description": "Delete a Elastic San.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete operation completed successfully." + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent --ElasticSAN does not exist in the subscription." + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ElasticSans_Delete_MaximumSet_Gen": { + "$ref": "./examples/ElasticSans_Delete_MaximumSet_Gen.json" + }, + "ElasticSans_Delete_MinimumSet_Gen": { + "$ref": "./examples/ElasticSans_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "ElasticSans" + ], + "operationId": "ElasticSans_Get", + "description": "Get a ElasticSan.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Operation completed successfully; retrieved ElasticSan.", + "schema": { + "$ref": "#/definitions/ElasticSan" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticSans_Get_MaximumSet_Gen": { + "$ref": "./examples/ElasticSans_Get_MaximumSet_Gen.json" + }, + "ElasticSans_Get_MinimumSet_Gen": { + "$ref": "./examples/ElasticSans_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumeGroups": { + "get": { + "tags": [ + "VolumeGroups" + ], + "description": "List VolumeGroups.", + "operationId": "VolumeGroups_ListByElasticSan", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Operation completed successfully; retrieved Volume Group List.", + "schema": { + "$ref": "#/definitions/VolumeGroupList" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VolumeGroups_ListByElasticSan_MaximumSet_Gen": { + "$ref": "./examples/VolumeGroups_ListByElasticSan_MaximumSet_Gen.json" + }, + "VolumeGroups_ListByElasticSan_MinimumSet_Gen": { + "$ref": "./examples/VolumeGroups_ListByElasticSan_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}": { + "put": { + "tags": [ + "VolumeGroups" + ], + "description": "Create a Volume Group.", + "operationId": "VolumeGroups_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VolumeGroup" + }, + "description": "Volume Group object." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Resource Create or Update operation is successfully completed.", + "schema": { + "$ref": "#/definitions/VolumeGroup" + } + }, + "201": { + "description": "Created -- Resource Create; operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/VolumeGroup" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeGroups_Create_MaximumSet_Gen": { + "$ref": "./examples/VolumeGroups_Create_MaximumSet_Gen.json" + }, + "VolumeGroups_Create_MinimumSet_Gen": { + "$ref": "./examples/VolumeGroups_Create_MinimumSet_Gen.json" + } + } + }, + "patch": { + "tags": [ + "VolumeGroups" + ], + "description": "Update an VolumeGroup.", + "operationId": "VolumeGroups_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VolumeGroupUpdate" + }, + "description": "Volume Group object." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Returned when the update operation is successfully completed.", + "schema": { + "$ref": "#/definitions/VolumeGroup" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeGroups_Update_MaximumSet_Gen": { + "$ref": "./examples/VolumeGroups_Update_MaximumSet_Gen.json" + }, + "VolumeGroups_Update_MinimumSet_Gen": { + "$ref": "./examples/VolumeGroups_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "VolumeGroups" + ], + "description": "Delete an VolumeGroup.", + "operationId": "VolumeGroups_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete operation completed successfully." + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent -- Resource does not exist in the subscription." + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeGroups_Delete_MaximumSet_Gen": { + "$ref": "./examples/VolumeGroups_Delete_MaximumSet_Gen.json" + }, + "VolumeGroups_Delete_MinimumSet_Gen": { + "$ref": "./examples/VolumeGroups_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "VolumeGroups" + ], + "description": "Get an VolumeGroups.", + "operationId": "VolumeGroups_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully; retrieved iSCSI Target.", + "schema": { + "$ref": "#/definitions/VolumeGroup" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeGroups_Get_MaximumSet_Gen": { + "$ref": "./examples/VolumeGroups_Get_MaximumSet_Gen.json" + }, + "VolumeGroups_Get_MinimumSet_Gen": { + "$ref": "./examples/VolumeGroups_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}": { + "put": { + "tags": [ + "Volumes" + ], + "description": "Create a Volume.", + "operationId": "Volumes_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "#/parameters/VolumeNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Volume" + }, + "description": "Volume object." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Resource Create or Update operation is successfully completed.", + "schema": { + "$ref": "#/definitions/Volume" + } + }, + "201": { + "description": "Created -- Resource Create; operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Volume" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Create_MaximumSet_Gen": { + "$ref": "./examples/Volumes_Create_MaximumSet_Gen.json" + }, + "Volumes_Create_MinimumSet_Gen": { + "$ref": "./examples/Volumes_Create_MinimumSet_Gen.json" + } + } + }, + "patch": { + "tags": [ + "Volumes" + ], + "description": "Update an Volume.", + "operationId": "Volumes_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "#/parameters/VolumeNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VolumeUpdate" + }, + "description": "Volume object." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Returned when the update operation is successfully completed.", + "schema": { + "$ref": "#/definitions/Volume" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Update_MaximumSet_Gen": { + "$ref": "./examples/Volumes_Update_MaximumSet_Gen.json" + }, + "Volumes_Update_MinimumSet_Gen": { + "$ref": "./examples/Volumes_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "Volumes" + ], + "description": "Delete an Volume.", + "operationId": "Volumes_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "#/parameters/VolumeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "x-ms-delete-snapshots", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "x-ms-delete-snapshots", + "modelAsString": true + }, + "description": "Optional, used to delete snapshots under volume. Allowed value are only true or false. Default value is false." + }, + { + "name": "x-ms-force-delete", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "x-ms-force-delete", + "modelAsString": true + }, + "description": "Optional, used to delete volume if active sessions present. Allowed value are only true or false. Default value is false." + } + ], + "responses": { + "200": { + "description": "Delete operation completed successfully." + }, + "202": { + "description": "Delete request accepted; operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist in the subscription." + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Delete_MaximumSet_Gen": { + "$ref": "./examples/Volumes_Delete_MaximumSet_Gen.json" + }, + "Volumes_Delete_MinimumSet_Gen": { + "$ref": "./examples/Volumes_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "Volumes" + ], + "description": "Get an Volume.", + "operationId": "Volumes_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "#/parameters/VolumeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully; retrieved Volume.", + "schema": { + "$ref": "#/definitions/Volume" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_Get_MaximumSet_Gen": { + "$ref": "./examples/Volumes_Get_MaximumSet_Gen.json" + }, + "Volumes_Get_MinimumSet_Gen": { + "$ref": "./examples/Volumes_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes": { + "get": { + "tags": [ + "Volumes" + ], + "description": "List Volumes in a VolumeGroup.", + "operationId": "Volumes_ListByVolumeGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully; retrieved volumes in a volume group.", + "schema": { + "$ref": "#/definitions/VolumeList" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Volumes_ListByVolumeGroup_MaximumSet_Gen": { + "$ref": "./examples/Volumes_ListByVolumeGroup_MaximumSet_Gen.json" + }, + "Volumes_ListByVolumeGroup_MinimumSet_Gen": { + "$ref": "./examples/Volumes_ListByVolumeGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Update the state of specified private endpoint connection associated with the Elastic San", + "operationId": "PrivateEndpointConnections_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "Private Endpoint Connection Approval object." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Resource Create or Update operation is successfully completed.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Created -- Resource Create; operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error from Elastic SAN resource provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "PrivateEndpointConnections_Create_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json" + }, + "PrivateEndpointConnections_Create_MinimumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnections_Create_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets the specified private endpoint connection associated with the Elastic San", + "operationId": "PrivateEndpointConnections_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the private endpoint connection properties successfully", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error from Elastic SAN resource provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Get_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json" + }, + "PrivateEndpointConnections_Get_MinimumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnections_Get_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Deletes the specified private endpoint connection associated with the Elastic San", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the private endpoint connection properties successfully" + }, + "202": { + "description": "Delete request accepted; operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content -- The Private Endpoint Connection does not exist." + }, + "default": { + "description": "Error from Elastic SAN resource provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "PrivateEndpointConnections_Delete_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json" + }, + "PrivateEndpointConnections_Delete_MinimumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnections_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "List all Private Endpoint Connections associated with the Elastic San.", + "operationId": "PrivateEndpointConnections_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Successfully retrieved private endpoint connections", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "PrivateEndpointConnections_List_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnections_List_MaximumSet_Gen.json" + }, + "PrivateEndpointConnections_List_MinimumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnections_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_ListByElasticSan", + "description": "Gets the private link resources that need to be created for a elastic San.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Successfully retrieved private endpoint connections", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkResources_ListByElasticSan_MaximumSet_Gen": { + "$ref": "./examples/PrivateLinkResources_ListByElasticSan_MaximumSet_Gen.json" + }, + "PrivateLinkResources_ListByElasticSan_MinimumSet_Gen": { + "$ref": "./examples/PrivateLinkResources_ListByElasticSan_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "description": "List Snapshots in a VolumeGroup or List Snapshots by Volume (name) in a VolumeGroup using filter", + "operationId": "VolumeSnapshots_ListByVolumeGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Specify $filter='volumeName eq ' to filter on volume.", + "required": false, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully; retrieved snapshots in a volume group.", + "schema": { + "$ref": "#/definitions/SnapshotList" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VolumeSnapshots_ListByVolumeGroup_MaximumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_ListByVolumeGroup_MaximumSet_Gen.json" + }, + "VolumeSnapshots_ListByVolumeGroup_MinimumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_ListByVolumeGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots/{snapshotName}": { + "put": { + "tags": [ + "Snapshots" + ], + "description": "Create a Volume Snapshot.", + "operationId": "VolumeSnapshots_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Snapshot" + }, + "description": "Snapshot object." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Returned when the create operation is successfully completed.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "201": { + "description": "Created -- Resource Created; operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeSnapshots_Create_MaximumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_Create_MaximumSet_Gen.json" + }, + "VolumeSnapshots_Create_MinimumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_Create_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "Snapshots" + ], + "description": "Delete a Volume Snapshot.", + "operationId": "VolumeSnapshots_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete operation completed successfully." + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent -- Resource does not exist in the subscription." + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeSnapshots_Delete_MaximumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_Delete_MaximumSet_Gen.json" + }, + "VolumeSnapshots_Delete_MinimumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "Snapshots" + ], + "description": "Get a Volume Snapshot.", + "operationId": "VolumeSnapshots_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully; retrieved Volume Snapshot.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeSnapshots_Get_MaximumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_Get_MaximumSet_Gen.json" + }, + "VolumeSnapshots_Get_MinimumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_Get_MinimumSet_Gen.json" + } + } + } + } + }, + "parameters": { + "ElasticSanNameParameter": { + "name": "elasticSanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ElasticSan.", + "pattern": "^[A-Za-z0-9]+((-|_)[a-z0-9A-Z]+)*$", + "minLength": 3, + "maxLength": 24, + "x-ms-parameter-location": "method" + }, + "VolumeGroupNameParameter": { + "name": "volumeGroupName", + "type": "string", + "required": true, + "in": "path", + "description": "The name of the VolumeGroup.", + "pattern": "^[A-Za-z0-9]+((-|_)[a-z0-9A-Z]+)*$", + "minLength": 3, + "maxLength": 63, + "x-ms-parameter-location": "method" + }, + "VolumeNameParameter": { + "name": "volumeName", + "type": "string", + "required": true, + "in": "path", + "description": "The name of the Volume.", + "pattern": "^[a-z0-9]+(-[a-z0-9A-Z]+)*$", + "minLength": 3, + "maxLength": 63, + "x-ms-parameter-location": "method" + }, + "PrivateEndpointConnectionNameParameter": { + "name": "privateEndpointConnectionName", + "type": "string", + "required": true, + "in": "path", + "description": "The name of the Private Endpoint connection.", + "x-ms-parameter-location": "method" + }, + "SnapshotNameParameter": { + "name": "snapshotName", + "type": "string", + "required": true, + "in": "path", + "description": "The name of the volume snapshot within the given volume group.", + "pattern": "^[a-z0-9]+(?:[._-][a-z0-9]+)*$", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "ElasticSanList": { + "type": "object", + "description": "List of Elastic Sans", + "additionalProperties": false, + "properties": { + "value": { + "description": "An array of Elastic San objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ElasticSan" + } + }, + "nextLink": { + "description": "URI to fetch the next section of the paginated response.", + "type": "string", + "readOnly": true + } + } + }, + "ElasticSan": { + "type": "object", + "description": "Response for ElasticSan request.", + "required": [ + "properties", + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of ElasticSan.", + "$ref": "#/definitions/ElasticSanProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "ElasticSanProperties": { + "type": "object", + "description": "Elastic San response properties.", + "required": [ + "baseSizeTiB", + "extendedCapacitySizeTiB", + "sku" + ], + "properties": { + "sku": { + "description": "resource sku", + "$ref": "#/definitions/Sku" + }, + "availabilityZones": { + "type": "array", + "description": "Logical zone for Elastic San resource; example: [\"1\"].", + "items": { + "$ref": "#/definitions/AvailabilityZone" + } + }, + "provisioningState": { + "description": "State of the operation on the resource.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + }, + "baseSizeTiB": { + "description": "Base size of the Elastic San appliance in TiB.", + "type": "integer", + "format": "int64", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "extendedCapacitySizeTiB": { + "description": "Extended size of the Elastic San appliance in TiB.", + "type": "integer", + "format": "int64", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "totalVolumeSizeGiB": { + "description": "Total size of the provisioned Volumes in GiB.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "volumeGroupCount": { + "description": "Total number of volume groups in this Elastic San appliance.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "totalIops": { + "description": "Total Provisioned IOPS of the Elastic San appliance.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "totalMBps": { + "description": "Total Provisioned MBps Elastic San appliance.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "totalSizeTiB": { + "description": "Total size of the Elastic San appliance in TB.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The list of Private Endpoint Connections." + }, + "publicNetworkAccess": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + }, + "description": "Allow or disallow public network access to ElasticSan. Value is optional but if passed in, must be 'Enabled' or 'Disabled'." + }, + "autoScaleProperties": { + "description": "Auto Scale Properties for Elastic San Appliance.", + "$ref": "#/definitions/AutoScaleProperties" + } + } + }, + "ElasticSanUpdate": { + "type": "object", + "description": "Response for ElasticSan update request.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of ElasticSan.", + "$ref": "#/definitions/ElasticSanUpdateProperties" + }, + "tags": { + "type": "object", + "description": "Update tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ElasticSanUpdateProperties": { + "type": "object", + "description": "Elastic San update properties.", + "properties": { + "baseSizeTiB": { + "description": "Base size of the Elastic San appliance in TiB.", + "type": "integer", + "format": "int64", + "x-ms-mutability": [ + "update" + ] + }, + "extendedCapacitySizeTiB": { + "description": "Extended size of the Elastic San appliance in TiB.", + "type": "integer", + "format": "int64", + "x-ms-mutability": [ + "update" + ] + }, + "publicNetworkAccess": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + }, + "description": "Allow or disallow public network access to ElasticSan Account. Value is optional but if passed in, must be 'Enabled' or 'Disabled'." + }, + "autoScaleProperties": { + "description": "Auto Scale Properties for Elastic San Appliance.", + "$ref": "#/definitions/AutoScaleProperties" + } + } + }, + "AvailabilityZone": { + "type": "string", + "description": "Availability zone." + }, + "SkuInformationList": { + "description": "List of SKU Information objects", + "type": "object", + "properties": { + "value": { + "description": "List of ResourceType Sku", + "type": "array", + "items": { + "$ref": "#/definitions/SkuInformation" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "nextLink": { + "description": "URI to fetch the next section of the paginated response.", + "type": "string", + "readOnly": true + } + } + }, + "SkuInformation": { + "description": "ElasticSAN SKU and its properties", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "Sku Name", + "$ref": "#/definitions/SkuName" + }, + "tier": { + "type": "string", + "description": "Sku Tier", + "$ref": "#/definitions/SkuTier" + }, + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of the resource." + }, + "locations": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.)." + }, + "locationInfo": { + "description": "Availability of the SKU for the location/zone", + "type": "array", + "items": { + "$ref": "#/definitions/SkuLocationInfo" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "capabilities": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SKUCapability" + }, + "x-ms-identifiers": [], + "description": "The capability information in the specified SKU." + } + } + }, + "SKUCapability": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The name of capability." + }, + "value": { + "readOnly": true, + "type": "string", + "description": "A string value to indicate states of given capability." + } + }, + "description": "The capability information in the specified SKU.", + "type": "object" + }, + "SkuLocationInfo": { + "description": "The location info.", + "type": "object", + "properties": { + "location": { + "description": "The location.", + "type": "string", + "readOnly": true + }, + "zones": { + "description": "The zones.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "Sku": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "$ref": "#/definitions/SkuName" + }, + "tier": { + "$ref": "#/definitions/SkuTier" + } + }, + "description": "The SKU name. Required for account creation; optional for update." + }, + "SkuName": { + "type": "string", + "enum": [ + "Premium_LRS", + "Premium_ZRS" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true, + "values": [ + { + "value": "Premium_LRS", + "description": "Premium locally redundant storage" + }, + { + "value": "Premium_ZRS", + "description": "Premium zone redundant storage" + } + ] + }, + "description": "The sku name." + }, + "SkuTier": { + "type": "string", + "enum": [ + "Premium" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true, + "values": [ + { + "value": "Premium", + "description": "Premium Tier" + } + ] + }, + "description": "The sku tier." + }, + "IscsiTargetInfo": { + "type": "object", + "description": "Iscsi target information", + "readOnly": true, + "properties": { + "targetIqn": { + "type": "string", + "description": "iSCSI Target IQN (iSCSI Qualified Name); example: \"iqn.2005-03.org.iscsi:server\".", + "readOnly": true + }, + "targetPortalHostname": { + "type": "string", + "description": "iSCSI Target Portal Host Name", + "readOnly": true + }, + "targetPortalPort": { + "type": "integer", + "format": "int32", + "description": "iSCSI Target Portal Port", + "readOnly": true + }, + "provisioningState": { + "description": "State of the operation on the resource.", + "$ref": "#/definitions/ProvisioningState" + }, + "status": { + "$ref": "#/definitions/OperationalStatus", + "description": "Operational status of the iSCSI Target." + } + } + }, + "VolumeGroup": { + "type": "object", + "description": "Response for Volume Group request.", + "properties": { + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of VolumeGroup.", + "$ref": "#/definitions/VolumeGroupProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "Identity": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of resource identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of resource." + }, + "type": { + "type": "string", + "description": "The identity type.", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": true + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + }, + "description": "Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this volume group. The key is the ARM resource identifier of the identity." + } + }, + "required": [ + "type" + ], + "description": "Identity for the resource." + }, + "VolumeGroupList": { + "type": "object", + "description": "List of Volume Groups", + "additionalProperties": false, + "properties": { + "value": { + "description": "An array of Volume Groups objects.", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeGroup" + } + }, + "nextLink": { + "description": "URI to fetch the next section of the paginated response.", + "type": "string", + "readOnly": true + } + } + }, + "VolumeGroupProperties": { + "type": "object", + "description": "VolumeGroup response properties.", + "properties": { + "provisioningState": { + "description": "State of the operation on the resource.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + }, + "protocolType": { + "description": "Type of storage target", + "$ref": "#/definitions/StorageTargetType" + }, + "encryption": { + "description": "Type of encryption", + "$ref": "#/definitions/EncryptionType" + }, + "encryptionProperties": { + "description": "Encryption Properties describing Key Vault and Identity information", + "$ref": "#/definitions/EncryptionProperties" + }, + "networkAcls": { + "$ref": "#/definitions/NetworkRuleSet", + "description": "A collection of rules governing the accessibility from specific network locations.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The list of Private Endpoint Connections." + }, + "enforceDataIntegrityCheckForIscsi": { + "type": "boolean", + "description": "A boolean indicating whether or not Data Integrity Check is enabled" + } + } + }, + "EncryptionProperties": { + "type": "object", + "properties": { + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "x-ms-client-name": "KeyVaultProperties", + "description": "Properties provided by key vault." + }, + "identity": { + "$ref": "#/definitions/EncryptionIdentity", + "x-ms-client-name": "EncryptionIdentity", + "description": "The identity to be used with service-side encryption at rest." + } + }, + "description": "The encryption settings on the volume group." + }, + "EncryptionIdentity": { + "type": "object", + "properties": { + "userAssignedIdentity": { + "type": "string", + "description": "Resource identifier of the UserAssigned identity to be associated with server-side encryption on the volume group.", + "x-ms-client-name": "EncryptionUserAssignedIdentity" + } + }, + "description": "Encryption identity for the volume group." + }, + "KeyVaultProperties": { + "type": "object", + "description": "Properties of key vault.", + "properties": { + "keyName": { + "type": "string", + "description": "The name of KeyVault key.", + "x-ms-client-name": "KeyName" + }, + "keyVersion": { + "type": "string", + "description": "The version of KeyVault key.", + "x-ms-client-name": "KeyVersion" + }, + "keyVaultUri": { + "type": "string", + "description": "The Uri of KeyVault.", + "x-ms-client-name": "KeyVaultUri", + "format": "uri" + }, + "currentVersionedKeyIdentifier": { + "type": "string", + "readOnly": true, + "description": "The object identifier of the current versioned Key Vault Key in use.", + "x-ms-client-name": "CurrentVersionedKeyIdentifier" + }, + "lastKeyRotationTimestamp": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "Timestamp of last rotation of the Key Vault Key.", + "x-ms-client-name": "LastKeyRotationTimestamp" + }, + "currentVersionedKeyExpirationTimestamp": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption.", + "x-ms-client-name": "CurrentVersionedKeyExpirationTimestamp" + } + } + }, + "UserAssignedIdentity": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of the identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client ID of the identity." + } + }, + "description": "UserAssignedIdentity for the resource." + }, + "VolumeGroupUpdate": { + "type": "object", + "description": "Volume Group request.", + "properties": { + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of VolumeGroup.", + "$ref": "#/definitions/VolumeGroupUpdateProperties" + } + } + }, + "VolumeGroupUpdateProperties": { + "type": "object", + "description": "VolumeGroup response properties.", + "properties": { + "protocolType": { + "description": "Type of storage target", + "$ref": "#/definitions/StorageTargetType" + }, + "encryption": { + "description": "Type of encryption", + "$ref": "#/definitions/EncryptionType" + }, + "encryptionProperties": { + "description": "Encryption Properties describing Key Vault and Identity information", + "$ref": "#/definitions/EncryptionProperties" + }, + "networkAcls": { + "$ref": "#/definitions/NetworkRuleSet", + "description": "A collection of rules governing the accessibility from specific network locations.", + "x-ms-mutability": [ + "update" + ] + }, + "enforceDataIntegrityCheckForIscsi": { + "type": "boolean", + "description": "A boolean indicating whether or not Data Integrity Check is enabled" + } + } + }, + "Volume": { + "type": "object", + "description": "Response for Volume request.", + "required": [ + "properties" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of Volume.", + "$ref": "#/definitions/VolumeProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "VolumeList": { + "type": "object", + "description": "List of Volumes", + "additionalProperties": false, + "properties": { + "value": { + "description": "An array of Volume objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Volume" + } + }, + "nextLink": { + "description": "URI to fetch the next section of the paginated response.", + "type": "string", + "readOnly": true + } + } + }, + "VolumeProperties": { + "type": "object", + "required": [ + "sizeGiB" + ], + "description": "Volume response properties.", + "properties": { + "volumeId": { + "description": "Unique Id of the volume in GUID format", + "type": "string", + "readOnly": true + }, + "creationData": { + "description": "State of the operation on the resource.", + "$ref": "#/definitions/SourceCreationData" + }, + "sizeGiB": { + "description": "Volume size.", + "type": "integer", + "format": "int64" + }, + "storageTarget": { + "description": "Storage target information", + "$ref": "#/definitions/IscsiTargetInfo" + }, + "managedBy": { + "description": "Parent resource information.", + "$ref": "#/definitions/ManagedByInfo" + }, + "provisioningState": { + "description": "State of the operation on the resource.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "ManagedByInfo": { + "type": "object", + "description": "Parent resource information.", + "properties": { + "resourceId": { + "type": "string", + "x-ms-client-name": "ResourceId", + "description": "Resource ID of the resource managing the volume, this is a restricted field and can only be set for internal use." + } + } + }, + "VolumeUpdate": { + "type": "object", + "description": "Response for Volume request.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of Volume.", + "$ref": "#/definitions/VolumeUpdateProperties" + } + } + }, + "VolumeUpdateProperties": { + "type": "object", + "description": "Volume response properties.", + "properties": { + "sizeGiB": { + "description": "Volume size.", + "type": "integer", + "format": "int64" + }, + "managedBy": { + "description": "Parent resource information.", + "$ref": "#/definitions/ManagedByInfo" + } + } + }, + "SourceCreationData": { + "type": "object", + "description": "Data source used when creating the volume.", + "properties": { + "createSource": { + "type": "string", + "enum": [ + "None", + "VolumeSnapshot", + "DiskSnapshot", + "Disk", + "DiskRestorePoint" + ], + "x-ms-enum": { + "name": "VolumeCreateOption", + "modelAsString": true + }, + "description": "This enumerates the possible sources of a volume creation." + }, + "sourceId": { + "type": "string", + "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\"" + } + } + }, + "ProvisioningState": { + "type": "string", + "enum": [ + "Invalid", + "Succeeded", + "Failed", + "Canceled", + "Pending", + "Creating", + "Updating", + "Deleting" + ], + "x-ms-enum": { + "name": "ProvisioningStates", + "modelAsString": true + }, + "description": "Provisioning state of the iSCSI Target.", + "readOnly": true + }, + "OperationalStatus": { + "type": "string", + "enum": [ + "Invalid", + "Unknown", + "Healthy", + "Unhealthy", + "Updating", + "Running", + "Stopped", + "Stopped (deallocated)" + ], + "x-ms-enum": { + "name": "OperationalStatus", + "modelAsString": true + }, + "description": "Operational status of the resource." + }, + "StorageTargetType": { + "type": "string", + "enum": [ + "Iscsi", + "None" + ], + "x-ms-enum": { + "name": "StorageTargetType", + "modelAsString": true + }, + "description": "Storage Target type." + }, + "EncryptionType": { + "type": "string", + "description": "The type of key used to encrypt the data of the disk.", + "enum": [ + "EncryptionAtRestWithPlatformKey", + "EncryptionAtRestWithCustomerManagedKey" + ], + "x-ms-enum": { + "name": "EncryptionType", + "modelAsString": true, + "values": [ + { + "value": "EncryptionAtRestWithPlatformKey", + "description": "Volume is encrypted at rest with Platform managed key. It is the default encryption type." + }, + { + "value": "EncryptionAtRestWithCustomerManagedKey", + "description": "Volume is encrypted at rest with Customer managed key that can be changed and revoked by a customer." + } + ] + } + }, + "NetworkRuleSet": { + "type": "object", + "properties": { + "virtualNetworkRules": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + }, + "description": "The list of virtual network rules." + } + }, + "description": "A set of rules governing the network accessibility." + }, + "VirtualNetworkRule": { + "type": "object", + "properties": { + "id": { + "type": "string", + "x-ms-client-name": "VirtualNetworkResourceId", + "description": "Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}." + }, + "action": { + "type": "string", + "enum": [ + "Allow" + ], + "x-ms-enum": { + "name": "Action", + "modelAsString": true + }, + "default": "Allow", + "description": "The action of virtual network rule." + } + }, + "required": [ + "id" + ], + "description": "Virtual Network rule." + }, + "PrivateEndpointConnection": { + "type": "object", + "description": " Response for PrivateEndpoint Connection object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Private Endpoint Connection Properties.", + "$ref": "#/definitions/PrivateEndpointConnectionProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ] + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": " Response for PrivateEndpoint connection properties", + "properties": { + "provisioningState": { + "description": "Provisioning State of Private Endpoint connection resource", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + }, + "privateEndpoint": { + "description": "Private Endpoint resource", + "$ref": "#/definitions/PrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "description": "Private Link Service Connection State.", + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + }, + "groupIds": { + "description": " List of resources private endpoint is mapped", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "type": "object", + "description": "Response for PrivateEndpoint", + "properties": { + "id": { + "type": "string", + "description": "The ARM identifier for Private Endpoint", + "readOnly": true + } + } + }, + "PrivateLinkServiceConnectionState": { + "type": "object", + "description": "Response for Private Link Service Connection state", + "properties": { + "status": { + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.", + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" + }, + "description": { + "type": "string", + "description": "The reason for approval/rejection of the connection." + }, + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer." + } + } + }, + "PrivateEndpointServiceConnectionStatus": { + "type": "string", + "description": "The private endpoint connection status.", + "enum": [ + "Pending", + "Approved", + "Failed", + "Rejected" + ], + "x-ms-enum": { + "name": "PrivateEndpointServiceConnectionStatus", + "modelAsString": true + } + }, + "PrivateLinkResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "description": "URI to fetch the next section of the paginated response.", + "type": "string", + "readOnly": true + } + }, + "description": "A list of private link resources" + }, + "PrivateLinkResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "description": "A private link resource" + }, + "PrivateLinkResourceProperties": { + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource Private link DNS zone name." + } + }, + "description": "Properties of a private link resource." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "description": "URI to fetch the next section of the paginated response.", + "type": "string", + "readOnly": true + } + }, + "description": "List of private endpoint connections associated with SAN" + }, + "Snapshot": { + "type": "object", + "required": [ + "properties" + ], + "description": "Response for Volume Snapshot request.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of Volume Snapshot.", + "$ref": "#/definitions/SnapshotProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "SnapshotList": { + "type": "object", + "description": "List of Snapshots", + "additionalProperties": false, + "properties": { + "value": { + "description": "An array of Snapshot objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Snapshot" + } + }, + "nextLink": { + "description": "URI to fetch the next section of the paginated response.", + "type": "string", + "readOnly": true + } + } + }, + "SnapshotProperties": { + "type": "object", + "required": [ + "creationData" + ], + "description": "Properties for Snapshot.", + "properties": { + "creationData": { + "description": "Data used when creating a volume snapshot.", + "$ref": "#/definitions/SnapshotCreationData" + }, + "provisioningState": { + "description": "State of the operation on the resource.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + }, + "sourceVolumeSizeGiB": { + "description": "Size of Source Volume", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "volumeName": { + "description": "Source Volume Name of a snapshot", + "type": "string", + "readOnly": true + } + } + }, + "SnapshotCreationData": { + "type": "object", + "required": [ + "sourceId" + ], + "description": "Data used when creating a volume snapshot.", + "properties": { + "sourceId": { + "type": "string", + "description": "Fully qualified resource ID of the volume. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}\"" + } + } + }, + "AutoScaleProperties": { + "type": "object", + "properties": { + "scaleUpProperties": { + "$ref": "#/definitions/ScaleUpProperties", + "x-ms-client-name": "ScaleUpProperties", + "description": "Scale up settings on Elastic San Appliance." + } + }, + "description": "The auto scale settings on Elastic San Appliance." + }, + "ScaleUpProperties": { + "type": "object", + "properties": { + "unusedSizeTiB": { + "description": "Unused size on Elastic San appliance in TiB.", + "type": "integer", + "format": "int64" + }, + "increaseCapacityUnitByTiB": { + "description": "Unit to increase Capacity Unit on Elastic San appliance in TiB.", + "type": "integer", + "format": "int64" + }, + "capacityUnitScaleUpLimitTiB": { + "description": "Maximum scale up size on Elastic San appliance in TiB.", + "type": "integer", + "format": "int64" + }, + "autoScalePolicyEnforcement": { + "type": "string", + "enum": [ + "None", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "autoScalePolicyEnforcement", + "modelAsString": true + }, + "description": "Enable or Disable scale up setting on Elastic San Appliance." + } + }, + "description": "Scale up properties on Elastic San Appliance." + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Create_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..1e6cff3c725d --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Create_MaximumSet_Gen.json @@ -0,0 +1,189 @@ +{ + "title": "ElasticSans_Create", + "operationId": "ElasticSans_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "parameters": { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "xoz" + ], + "baseSizeTiB": 1, + "extendedCapacitySizeTiB": 3, + "publicNetworkAccess": "Enabled", + "autoScaleProperties": { + "scaleUpProperties": { + "unusedSizeTiB": 24, + "increaseCapacityUnitByTiB": 4, + "capacityUnitScaleUpLimitTiB": 17, + "autoScalePolicyEnforcement": "None" + } + } + }, + "tags": { + "key9706": "haitqqakcntcpalkzqmjmcnifnhd" + }, + "location": "France Central" + }, + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "xoz" + ], + "provisioningState": "Invalid", + "baseSizeTiB": 1, + "extendedCapacitySizeTiB": 3, + "totalVolumeSizeGiB": 12, + "volumeGroupCount": 25, + "totalIops": 29, + "totalMBps": 6, + "totalSizeTiB": 5, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "wnlsfvatungpitrlcbhgdtlpl" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "mrcibusihsmwcbmsrukbmrrjdiy", + "actionsRequired": "eyhujyohsisgywrozmunjmrtao" + }, + "groupIds": [ + "seuxenjsfpavichmai" + ] + }, + "id": "xnaxhlih", + "name": "jgjelkmzzuu", + "type": "emgnetaviizobnwm", + "systemData": { + "createdBy": "bcgpoousvimjrhlgweigyeazr", + "createdByType": "User", + "createdAt": "2024-07-24T09:15:59.688Z", + "lastModifiedBy": "jflskmaiembmcpdrurolsi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-24T09:15:59.688Z" + } + } + ], + "publicNetworkAccess": "Enabled", + "autoScaleProperties": { + "scaleUpProperties": { + "unusedSizeTiB": 24, + "increaseCapacityUnitByTiB": 4, + "capacityUnitScaleUpLimitTiB": 17, + "autoScalePolicyEnforcement": "None" + } + } + }, + "tags": { + "key9706": "haitqqakcntcpalkzqmjmcnifnhd" + }, + "location": "eupkimcjwiphitotibv", + "id": "wthgilvis", + "name": "dnwirxrikyzsoqmf", + "type": "uocreclqzfafzwwbzozgryxurwhf", + "systemData": { + "createdBy": "bcgpoousvimjrhlgweigyeazr", + "createdByType": "User", + "createdAt": "2024-07-24T09:15:59.688Z", + "lastModifiedBy": "jflskmaiembmcpdrurolsi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-24T09:15:59.688Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "xoz" + ], + "provisioningState": "Invalid", + "baseSizeTiB": 1, + "extendedCapacitySizeTiB": 3, + "totalVolumeSizeGiB": 12, + "volumeGroupCount": 25, + "totalIops": 29, + "totalMBps": 6, + "totalSizeTiB": 5, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "wnlsfvatungpitrlcbhgdtlpl" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "mrcibusihsmwcbmsrukbmrrjdiy", + "actionsRequired": "eyhujyohsisgywrozmunjmrtao" + }, + "groupIds": [ + "seuxenjsfpavichmai" + ] + }, + "id": "xnaxhlih", + "name": "jgjelkmzzuu", + "type": "emgnetaviizobnwm", + "systemData": { + "createdBy": "bcgpoousvimjrhlgweigyeazr", + "createdByType": "User", + "createdAt": "2024-07-24T09:15:59.688Z", + "lastModifiedBy": "jflskmaiembmcpdrurolsi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-24T09:15:59.688Z" + } + } + ], + "publicNetworkAccess": "Enabled", + "autoScaleProperties": { + "scaleUpProperties": { + "unusedSizeTiB": 24, + "increaseCapacityUnitByTiB": 4, + "capacityUnitScaleUpLimitTiB": 17, + "autoScalePolicyEnforcement": "None" + } + } + }, + "tags": { + "key9706": "haitqqakcntcpalkzqmjmcnifnhd" + }, + "location": "eupkimcjwiphitotibv", + "id": "wthgilvis", + "name": "dnwirxrikyzsoqmf", + "type": "uocreclqzfafzwwbzozgryxurwhf", + "systemData": { + "createdBy": "bcgpoousvimjrhlgweigyeazr", + "createdByType": "User", + "createdAt": "2024-07-24T09:15:59.688Z", + "lastModifiedBy": "jflskmaiembmcpdrurolsi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-24T09:15:59.688Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Create_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..fda192a7787f --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Create_MinimumSet_Gen.json @@ -0,0 +1,53 @@ +{ + "title": "ElasticSans_Create", + "operationId": "ElasticSans_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "parameters": { + "properties": { + "sku": { + "name": "Premium_LRS" + }, + "baseSizeTiB": 1, + "extendedCapacitySizeTiB": 3 + }, + "location": "France Central" + }, + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": { + "name": "Premium_LRS" + }, + "baseSizeTiB": 1, + "extendedCapacitySizeTiB": 3, + "provisioningState": "Succeeded" + }, + "location": "eupkimcjwiphitotibv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}" + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "sku": { + "name": "Premium_LRS" + }, + "baseSizeTiB": 1, + "extendedCapacitySizeTiB": 3, + "provisioningState": "Creating" + }, + "location": "eupkimcjwiphitotibv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Delete_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..2a2ae608ab24 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "ElasticSans_Delete", + "operationId": "ElasticSans_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Delete_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..2a2ae608ab24 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Delete_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "ElasticSans_Delete", + "operationId": "ElasticSans_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Get_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..46229aafe0c7 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Get_MaximumSet_Gen.json @@ -0,0 +1,86 @@ +{ + "title": "ElasticSans_Get", + "operationId": "ElasticSans_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "xoz" + ], + "provisioningState": "Invalid", + "baseSizeTiB": 1, + "extendedCapacitySizeTiB": 3, + "totalVolumeSizeGiB": 12, + "volumeGroupCount": 25, + "totalIops": 29, + "totalMBps": 6, + "totalSizeTiB": 5, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "wnlsfvatungpitrlcbhgdtlpl" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "mrcibusihsmwcbmsrukbmrrjdiy", + "actionsRequired": "eyhujyohsisgywrozmunjmrtao" + }, + "groupIds": [ + "seuxenjsfpavichmai" + ] + }, + "id": "xnaxhlih", + "name": "jgjelkmzzuu", + "type": "emgnetaviizobnwm", + "systemData": { + "createdBy": "bcgpoousvimjrhlgweigyeazr", + "createdByType": "User", + "createdAt": "2024-07-24T09:15:59.688Z", + "lastModifiedBy": "jflskmaiembmcpdrurolsi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-24T09:15:59.688Z" + } + } + ], + "publicNetworkAccess": "Enabled", + "autoScaleProperties": { + "scaleUpProperties": { + "unusedSizeTiB": 24, + "increaseCapacityUnitByTiB": 4, + "capacityUnitScaleUpLimitTiB": 17, + "autoScalePolicyEnforcement": "None" + } + } + }, + "tags": { + "key9706": "haitqqakcntcpalkzqmjmcnifnhd" + }, + "location": "eupkimcjwiphitotibv", + "id": "wthgilvis", + "name": "dnwirxrikyzsoqmf", + "type": "uocreclqzfafzwwbzozgryxurwhf", + "systemData": { + "createdBy": "bcgpoousvimjrhlgweigyeazr", + "createdByType": "User", + "createdAt": "2024-07-24T09:15:59.688Z", + "lastModifiedBy": "jflskmaiembmcpdrurolsi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-24T09:15:59.688Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Get_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..d7f72993a2dc --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Get_MinimumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "ElasticSans_Get", + "operationId": "ElasticSans_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": { + "name": "Premium_LRS" + }, + "baseSizeTiB": 1, + "extendedCapacitySizeTiB": 3, + "provisioningState": "Succeeded" + }, + "location": "eupkimcjwiphitotibv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_ListByResourceGroup_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..67eacdbce3cb --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,90 @@ +{ + "title": "ElasticSans_ListByResourceGroup", + "operationId": "ElasticSans_ListByResourceGroup", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "xoz" + ], + "provisioningState": "Invalid", + "baseSizeTiB": 1, + "extendedCapacitySizeTiB": 3, + "totalVolumeSizeGiB": 12, + "volumeGroupCount": 25, + "totalIops": 29, + "totalMBps": 6, + "totalSizeTiB": 5, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "wnlsfvatungpitrlcbhgdtlpl" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "mrcibusihsmwcbmsrukbmrrjdiy", + "actionsRequired": "eyhujyohsisgywrozmunjmrtao" + }, + "groupIds": [ + "seuxenjsfpavichmai" + ] + }, + "id": "xnaxhlih", + "name": "jgjelkmzzuu", + "type": "emgnetaviizobnwm", + "systemData": { + "createdBy": "bcgpoousvimjrhlgweigyeazr", + "createdByType": "User", + "createdAt": "2024-07-24T09:15:59.688Z", + "lastModifiedBy": "jflskmaiembmcpdrurolsi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-24T09:15:59.688Z" + } + } + ], + "publicNetworkAccess": "Enabled", + "autoScaleProperties": { + "scaleUpProperties": { + "unusedSizeTiB": 24, + "increaseCapacityUnitByTiB": 4, + "capacityUnitScaleUpLimitTiB": 17, + "autoScalePolicyEnforcement": "None" + } + } + }, + "tags": { + "key9706": "haitqqakcntcpalkzqmjmcnifnhd" + }, + "location": "eupkimcjwiphitotibv", + "id": "wthgilvis", + "name": "dnwirxrikyzsoqmf", + "type": "uocreclqzfafzwwbzozgryxurwhf", + "systemData": { + "createdBy": "bcgpoousvimjrhlgweigyeazr", + "createdByType": "User", + "createdAt": "2024-07-24T09:15:59.688Z", + "lastModifiedBy": "jflskmaiembmcpdrurolsi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-24T09:15:59.688Z" + } + } + ], + "nextLink": "ounphaqkdcuefi" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_ListByResourceGroup_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..c36545bc566b --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "title": "ElasticSans_ListByResourceGroup", + "operationId": "ElasticSans_ListByResourceGroup", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_ListBySubscription_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..8d16b31b3196 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,89 @@ +{ + "title": "ElasticSans_ListBySubscription", + "operationId": "ElasticSans_ListBySubscription", + "parameters": { + "subscriptionId": "subscriptionid", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "xoz" + ], + "provisioningState": "Invalid", + "baseSizeTiB": 1, + "extendedCapacitySizeTiB": 3, + "totalVolumeSizeGiB": 12, + "volumeGroupCount": 25, + "totalIops": 29, + "totalMBps": 6, + "totalSizeTiB": 5, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "wnlsfvatungpitrlcbhgdtlpl" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "mrcibusihsmwcbmsrukbmrrjdiy", + "actionsRequired": "eyhujyohsisgywrozmunjmrtao" + }, + "groupIds": [ + "seuxenjsfpavichmai" + ] + }, + "id": "xnaxhlih", + "name": "jgjelkmzzuu", + "type": "emgnetaviizobnwm", + "systemData": { + "createdBy": "bcgpoousvimjrhlgweigyeazr", + "createdByType": "User", + "createdAt": "2024-07-24T09:15:59.688Z", + "lastModifiedBy": "jflskmaiembmcpdrurolsi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-24T09:15:59.688Z" + } + } + ], + "publicNetworkAccess": "Enabled", + "autoScaleProperties": { + "scaleUpProperties": { + "unusedSizeTiB": 24, + "increaseCapacityUnitByTiB": 4, + "capacityUnitScaleUpLimitTiB": 17, + "autoScalePolicyEnforcement": "None" + } + } + }, + "tags": { + "key9706": "haitqqakcntcpalkzqmjmcnifnhd" + }, + "location": "eupkimcjwiphitotibv", + "id": "wthgilvis", + "name": "dnwirxrikyzsoqmf", + "type": "uocreclqzfafzwwbzozgryxurwhf", + "systemData": { + "createdBy": "bcgpoousvimjrhlgweigyeazr", + "createdByType": "User", + "createdAt": "2024-07-24T09:15:59.688Z", + "lastModifiedBy": "jflskmaiembmcpdrurolsi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-24T09:15:59.688Z" + } + } + ], + "nextLink": "ounphaqkdcuefi" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_ListBySubscription_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..1f74b3b6e669 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "title": "ElasticSans_ListBySubscription", + "operationId": "ElasticSans_ListBySubscription", + "parameters": { + "subscriptionId": "subscriptionid", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Update_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..9f658f3c43e3 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Update_MaximumSet_Gen.json @@ -0,0 +1,109 @@ +{ + "title": "ElasticSans_Update", + "operationId": "ElasticSans_Update", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "parameters": { + "properties": { + "baseSizeTiB": 21, + "extendedCapacitySizeTiB": 10, + "publicNetworkAccess": "Enabled", + "autoScaleProperties": { + "scaleUpProperties": { + "unusedSizeTiB": 24, + "increaseCapacityUnitByTiB": 4, + "capacityUnitScaleUpLimitTiB": 17, + "autoScalePolicyEnforcement": "None" + } + } + }, + "tags": { + "key5945": "eufqmxresekerilkgvfzddolxzas" + } + }, + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "xoz" + ], + "provisioningState": "Invalid", + "baseSizeTiB": 1, + "extendedCapacitySizeTiB": 3, + "totalVolumeSizeGiB": 12, + "volumeGroupCount": 25, + "totalIops": 29, + "totalMBps": 6, + "totalSizeTiB": 5, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "wnlsfvatungpitrlcbhgdtlpl" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "mrcibusihsmwcbmsrukbmrrjdiy", + "actionsRequired": "eyhujyohsisgywrozmunjmrtao" + }, + "groupIds": [ + "seuxenjsfpavichmai" + ] + }, + "id": "xnaxhlih", + "name": "jgjelkmzzuu", + "type": "emgnetaviizobnwm", + "systemData": { + "createdBy": "bcgpoousvimjrhlgweigyeazr", + "createdByType": "User", + "createdAt": "2024-07-24T09:15:59.688Z", + "lastModifiedBy": "jflskmaiembmcpdrurolsi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-24T09:15:59.688Z" + } + } + ], + "publicNetworkAccess": "Enabled", + "autoScaleProperties": { + "scaleUpProperties": { + "unusedSizeTiB": 24, + "increaseCapacityUnitByTiB": 4, + "capacityUnitScaleUpLimitTiB": 17, + "autoScalePolicyEnforcement": "None" + } + } + }, + "tags": { + "key9706": "haitqqakcntcpalkzqmjmcnifnhd" + }, + "location": "eupkimcjwiphitotibv", + "id": "wthgilvis", + "name": "dnwirxrikyzsoqmf", + "type": "uocreclqzfafzwwbzozgryxurwhf", + "systemData": { + "createdBy": "bcgpoousvimjrhlgweigyeazr", + "createdByType": "User", + "createdAt": "2024-07-24T09:15:59.688Z", + "lastModifiedBy": "jflskmaiembmcpdrurolsi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-24T09:15:59.688Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Update_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..a72d47df68fc --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/ElasticSans_Update_MinimumSet_Gen.json @@ -0,0 +1,30 @@ +{ + "title": "ElasticSans_Update", + "operationId": "ElasticSans_Update", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "parameters": {}, + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": { + "name": "Premium_LRS" + }, + "baseSizeTiB": 1, + "extendedCapacitySizeTiB": 3 + }, + "location": "eupkimcjwiphitotibv" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Operations_List_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..b6b6d1ec390b --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "zgtqmglizaqlsx", + "isDataAction": true, + "display": { + "provider": "apbqaoiegbmipkbqdczsuvlak", + "resource": "hjyuuxkj", + "operation": "yumtqbnawcvunwda", + "description": "pmkjqzjverubmslnrcadqur" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "ljqzljjgtxaytxufbermmlkrmpy" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Operations_List_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..c7b3dba8975a --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..d2c0ca798cd1 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json @@ -0,0 +1,87 @@ +{ + "title": "PrivateEndpointConnections_Create", + "operationId": "PrivateEndpointConnections_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "privateEndpointConnectionName": "privateendpointconnectionname", + "parameters": { + "properties": { + "privateEndpoint": {}, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "dxl", + "actionsRequired": "jhjdpwvyzipggtn" + }, + "groupIds": [ + "jdwrzpemdjrpiwzvy" + ] + } + }, + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "bgurjvijz", + "createdByType": "User", + "createdAt": "2023-08-25T17:40:52.453Z", + "lastModifiedBy": "uvexylihjrtinzkeluohusnaxatfqh", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-25T17:40:52.453Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "bgurjvijz", + "createdByType": "User", + "createdAt": "2023-08-25T17:40:52.453Z", + "lastModifiedBy": "uvexylihjrtinzkeluohusnaxatfqh", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-25T17:40:52.453Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_Create_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..9fc84b7ed686 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_Create_MinimumSet_Gen.json @@ -0,0 +1,79 @@ +{ + "title": "PrivateEndpointConnections_Create", + "operationId": "PrivateEndpointConnections_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "privateEndpointConnectionName": "privateendpointconnectionname", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": {} + } + }, + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "bgurjvijz", + "createdByType": "User", + "createdAt": "2023-08-25T17:40:52.453Z", + "lastModifiedBy": "uvexylihjrtinzkeluohusnaxatfqh", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-25T17:40:52.453Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "bgurjvijz", + "createdByType": "User", + "createdAt": "2023-08-25T17:40:52.453Z", + "lastModifiedBy": "uvexylihjrtinzkeluohusnaxatfqh", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-25T17:40:52.453Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..1fdb9d3d338d --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "PrivateEndpointConnections_Delete", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "privateEndpointConnectionName": "privateendpointconnectionname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_Delete_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..1fdb9d3d338d --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_Delete_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "PrivateEndpointConnections_Delete", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "privateEndpointConnectionName": "privateendpointconnectionname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..04fd819d12f0 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "PrivateEndpointConnections_Get", + "operationId": "PrivateEndpointConnections_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "privateEndpointConnectionName": "privateendpointconnectionname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "bgurjvijz", + "createdByType": "User", + "createdAt": "2023-08-25T17:40:52.453Z", + "lastModifiedBy": "uvexylihjrtinzkeluohusnaxatfqh", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-25T17:40:52.453Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_Get_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..04fd819d12f0 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_Get_MinimumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "PrivateEndpointConnections_Get", + "operationId": "PrivateEndpointConnections_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "privateEndpointConnectionName": "privateendpointconnectionname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "bgurjvijz", + "createdByType": "User", + "createdAt": "2023-08-25T17:40:52.453Z", + "lastModifiedBy": "uvexylihjrtinzkeluohusnaxatfqh", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-25T17:40:52.453Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_List_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..00f16c9bcd2e --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_List_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "PrivateEndpointConnections_List", + "operationId": "PrivateEndpointConnections_List", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "gktekmqchmjqxhfvywq" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "dxl", + "actionsRequired": "jhjdpwvyzipggtn" + }, + "groupIds": [ + "jdwrzpemdjrpiwzvy" + ] + }, + "id": "ynin", + "name": "vyzqckpcwufpvalbspekxikt", + "type": "ldolsnjwzutewucdfessitnxqb", + "systemData": { + "createdBy": "bgurjvijz", + "createdByType": "User", + "createdAt": "2023-08-25T17:40:52.453Z", + "lastModifiedBy": "uvexylihjrtinzkeluohusnaxatfqh", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-25T17:40:52.453Z" + } + } + ], + "nextLink": "ifbpdcl" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_List_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..1fc5f08ca561 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateEndpointConnections_List_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "PrivateEndpointConnections_List", + "operationId": "PrivateEndpointConnections_List", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateLinkResources_ListByElasticSan_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateLinkResources_ListByElasticSan_MaximumSet_Gen.json new file mode 100644 index 000000000000..b35e35a98f3e --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateLinkResources_ListByElasticSan_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "PrivateLinkResources_ListByElasticSan", + "operationId": "PrivateLinkResources_ListByElasticSan", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "mbouakfumvbeqnevmgxpk", + "requiredMembers": [ + "wujfilzifgumbvxbdhazmzf" + ], + "requiredZoneNames": [ + "hzxhgoqxxiaf" + ] + }, + "id": "iidc", + "name": "ggbyptukibs", + "type": "qrfsowhtanlj", + "systemData": { + "createdBy": "bgurjvijz", + "createdByType": "User", + "createdAt": "2023-08-25T17:40:52.453Z", + "lastModifiedBy": "uvexylihjrtinzkeluohusnaxatfqh", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-25T17:40:52.453Z" + } + } + ], + "nextLink": "bvbshxnaxznetoylfjjbyf" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateLinkResources_ListByElasticSan_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateLinkResources_ListByElasticSan_MinimumSet_Gen.json new file mode 100644 index 000000000000..381c308f0837 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/PrivateLinkResources_ListByElasticSan_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "PrivateLinkResources_ListByElasticSan", + "operationId": "PrivateLinkResources_ListByElasticSan", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Skus_List_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Skus_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..f892638ab4c7 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Skus_List_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "List all the available Skus in the region and information related to them", + "operationId": "Skus_List", + "parameters": { + "subscriptionId": "subscriptionid", + "api-version": "2024-06-01-preview", + "$filter": "obwwdrkq" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Premium_LRS", + "tier": "Premium", + "resourceType": "tlqickysdtjahoanstgancifxfu", + "locations": [ + "ceszpxwqyifrxobqykplm" + ], + "locationInfo": [ + { + "location": "ngycrsoihxdfctigejlf", + "zones": [ + "1" + ] + } + ], + "capabilities": [ + { + "name": "qkht", + "value": "eoayvlyzyjjziecxymlpk" + } + ] + } + ], + "nextLink": "venbbrnqqxaqemezvv" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Skus_List_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Skus_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..e16cb0e80dbc --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Skus_List_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "title": "List all the available Skus in the region and information related to them", + "operationId": "Skus_List", + "parameters": { + "subscriptionId": "subscriptionid", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Create_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..f78e61832fe2 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Create_MaximumSet_Gen.json @@ -0,0 +1,211 @@ +{ + "title": "VolumeGroups_Create", + "operationId": "VolumeGroups_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "parameters": { + "identity": { + "type": "None", + "userAssignedIdentities": { + "key1006": {} + } + }, + "properties": { + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "encryptionProperties": { + "keyVaultProperties": { + "keyName": "lunpapamzeimppgobraxjt", + "keyVersion": "oemygbnfmqhijmonkqfqmy", + "keyVaultUri": "https://microsoft.com/a" + }, + "identity": { + "userAssignedIdentity": "gfhkfbozahmmwluqndfgxunssafa" + } + }, + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "bkhwaiqvvaguymsmnzzbzz", + "action": "Allow" + } + ] + }, + "enforceDataIntegrityCheckForIscsi": true + } + }, + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "identity": { + "principalId": "uqclmeopt", + "tenantId": "qvhlvbvgodtycsfjhamstlrusktly", + "type": "None", + "userAssignedIdentities": { + "key1006": { + "principalId": "pcbbifvgblsrhzmpdt", + "clientId": "hsfmzocbkqpxspqwamdqjknd" + } + } + }, + "properties": { + "provisioningState": "Invalid", + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "encryptionProperties": { + "keyVaultProperties": { + "keyName": "lunpapamzeimppgobraxjt", + "keyVersion": "oemygbnfmqhijmonkqfqmy", + "keyVaultUri": "https://microsoft.com/a", + "currentVersionedKeyIdentifier": "giyyriknaomjipru", + "lastKeyRotationTimestamp": "2024-07-09T08:26:49.141Z", + "currentVersionedKeyExpirationTimestamp": "2024-07-09T08:26:49.141Z" + }, + "identity": { + "userAssignedIdentity": "gfhkfbozahmmwluqndfgxunssafa" + } + }, + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "bkhwaiqvvaguymsmnzzbzz", + "action": "Allow" + } + ] + }, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "kdvywmjnrvqksyvxgosjorlzjk" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "hqsksvdlhacbmawvhlhhfmcyv", + "actionsRequired": "xvnopczgivazrjlzirhtww" + }, + "groupIds": [ + "ftdxwynrey" + ] + }, + "id": "utnp", + "name": "duzwhl", + "type": "mzwnrqbkzgk", + "systemData": { + "createdBy": "iskcypymrroqhmdwccwqzdclpyutpb", + "createdByType": "User", + "createdAt": "2024-07-09T08:26:45.352Z", + "lastModifiedBy": "ujpptnmvqtzudoiaihbgrvnagxh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-09T08:26:45.352Z" + } + } + ], + "enforceDataIntegrityCheckForIscsi": true + }, + "id": "cgwmakehxvhv", + "name": "qymuqyvdlpshrna", + "type": "wwkffcgidqktzuzo", + "systemData": { + "createdBy": "iskcypymrroqhmdwccwqzdclpyutpb", + "createdByType": "User", + "createdAt": "2024-07-09T08:26:45.352Z", + "lastModifiedBy": "ujpptnmvqtzudoiaihbgrvnagxh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-09T08:26:45.352Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "identity": { + "principalId": "uqclmeopt", + "tenantId": "qvhlvbvgodtycsfjhamstlrusktly", + "type": "None", + "userAssignedIdentities": { + "key1006": { + "principalId": "pcbbifvgblsrhzmpdt", + "clientId": "hsfmzocbkqpxspqwamdqjknd" + } + } + }, + "properties": { + "provisioningState": "Invalid", + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "encryptionProperties": { + "keyVaultProperties": { + "keyName": "lunpapamzeimppgobraxjt", + "keyVersion": "oemygbnfmqhijmonkqfqmy", + "keyVaultUri": "https://microsoft.com/a", + "currentVersionedKeyIdentifier": "giyyriknaomjipru", + "lastKeyRotationTimestamp": "2024-07-09T08:26:49.141Z", + "currentVersionedKeyExpirationTimestamp": "2024-07-09T08:26:49.141Z" + }, + "identity": { + "userAssignedIdentity": "gfhkfbozahmmwluqndfgxunssafa" + } + }, + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "bkhwaiqvvaguymsmnzzbzz", + "action": "Allow" + } + ] + }, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "kdvywmjnrvqksyvxgosjorlzjk" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "hqsksvdlhacbmawvhlhhfmcyv", + "actionsRequired": "xvnopczgivazrjlzirhtww" + }, + "groupIds": [ + "ftdxwynrey" + ] + }, + "id": "utnp", + "name": "duzwhl", + "type": "mzwnrqbkzgk", + "systemData": { + "createdBy": "iskcypymrroqhmdwccwqzdclpyutpb", + "createdByType": "User", + "createdAt": "2024-07-09T08:26:45.352Z", + "lastModifiedBy": "ujpptnmvqtzudoiaihbgrvnagxh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-09T08:26:45.352Z" + } + } + ], + "enforceDataIntegrityCheckForIscsi": true + }, + "id": "cgwmakehxvhv", + "name": "qymuqyvdlpshrna", + "type": "wwkffcgidqktzuzo", + "systemData": { + "createdBy": "iskcypymrroqhmdwccwqzdclpyutpb", + "createdByType": "User", + "createdAt": "2024-07-09T08:26:45.352Z", + "lastModifiedBy": "ujpptnmvqtzudoiaihbgrvnagxh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-09T08:26:45.352Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Create_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..d67292533f5b --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Create_MinimumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "title": "VolumeGroups_Create", + "operationId": "VolumeGroups_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "parameters": {}, + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": {} + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": {} + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Delete_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..a5df490acd63 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "VolumeGroups_Delete", + "operationId": "VolumeGroups_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Delete_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..a5df490acd63 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Delete_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "VolumeGroups_Delete", + "operationId": "VolumeGroups_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Get_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..1d994d06b702 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Get_MaximumSet_Gen.json @@ -0,0 +1,95 @@ +{ + "title": "VolumeGroups_Get", + "operationId": "VolumeGroups_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "identity": { + "principalId": "uqclmeopt", + "tenantId": "qvhlvbvgodtycsfjhamstlrusktly", + "type": "None", + "userAssignedIdentities": { + "key1006": { + "principalId": "pcbbifvgblsrhzmpdt", + "clientId": "hsfmzocbkqpxspqwamdqjknd" + } + } + }, + "properties": { + "provisioningState": "Invalid", + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "encryptionProperties": { + "keyVaultProperties": { + "keyName": "lunpapamzeimppgobraxjt", + "keyVersion": "oemygbnfmqhijmonkqfqmy", + "keyVaultUri": "https://microsoft.com/a", + "currentVersionedKeyIdentifier": "giyyriknaomjipru", + "lastKeyRotationTimestamp": "2024-07-09T08:26:49.141Z", + "currentVersionedKeyExpirationTimestamp": "2024-07-09T08:26:49.141Z" + }, + "identity": { + "userAssignedIdentity": "gfhkfbozahmmwluqndfgxunssafa" + } + }, + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "bkhwaiqvvaguymsmnzzbzz", + "action": "Allow" + } + ] + }, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "kdvywmjnrvqksyvxgosjorlzjk" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "hqsksvdlhacbmawvhlhhfmcyv", + "actionsRequired": "xvnopczgivazrjlzirhtww" + }, + "groupIds": [ + "ftdxwynrey" + ] + }, + "id": "utnp", + "name": "duzwhl", + "type": "mzwnrqbkzgk", + "systemData": { + "createdBy": "iskcypymrroqhmdwccwqzdclpyutpb", + "createdByType": "User", + "createdAt": "2024-07-09T08:26:45.352Z", + "lastModifiedBy": "ujpptnmvqtzudoiaihbgrvnagxh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-09T08:26:45.352Z" + } + } + ], + "enforceDataIntegrityCheckForIscsi": true + }, + "id": "cgwmakehxvhv", + "name": "qymuqyvdlpshrna", + "type": "wwkffcgidqktzuzo", + "systemData": { + "createdBy": "iskcypymrroqhmdwccwqzdclpyutpb", + "createdByType": "User", + "createdAt": "2024-07-09T08:26:45.352Z", + "lastModifiedBy": "ujpptnmvqtzudoiaihbgrvnagxh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-09T08:26:45.352Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Get_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..34fac143d980 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Get_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VolumeGroups_Get", + "operationId": "VolumeGroups_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_ListByElasticSan_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_ListByElasticSan_MaximumSet_Gen.json new file mode 100644 index 000000000000..c627162257be --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_ListByElasticSan_MaximumSet_Gen.json @@ -0,0 +1,99 @@ +{ + "title": "VolumeGroups_ListByElasticSan", + "operationId": "VolumeGroups_ListByElasticSan", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "principalId": "uqclmeopt", + "tenantId": "qvhlvbvgodtycsfjhamstlrusktly", + "type": "None", + "userAssignedIdentities": { + "key1006": { + "principalId": "pcbbifvgblsrhzmpdt", + "clientId": "hsfmzocbkqpxspqwamdqjknd" + } + } + }, + "properties": { + "provisioningState": "Invalid", + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "encryptionProperties": { + "keyVaultProperties": { + "keyName": "lunpapamzeimppgobraxjt", + "keyVersion": "oemygbnfmqhijmonkqfqmy", + "keyVaultUri": "https://microsoft.com/a", + "currentVersionedKeyIdentifier": "giyyriknaomjipru", + "lastKeyRotationTimestamp": "2024-07-09T08:26:49.141Z", + "currentVersionedKeyExpirationTimestamp": "2024-07-09T08:26:49.141Z" + }, + "identity": { + "userAssignedIdentity": "gfhkfbozahmmwluqndfgxunssafa" + } + }, + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "bkhwaiqvvaguymsmnzzbzz", + "action": "Allow" + } + ] + }, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "kdvywmjnrvqksyvxgosjorlzjk" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "hqsksvdlhacbmawvhlhhfmcyv", + "actionsRequired": "xvnopczgivazrjlzirhtww" + }, + "groupIds": [ + "ftdxwynrey" + ] + }, + "id": "utnp", + "name": "duzwhl", + "type": "mzwnrqbkzgk", + "systemData": { + "createdBy": "iskcypymrroqhmdwccwqzdclpyutpb", + "createdByType": "User", + "createdAt": "2024-07-09T08:26:45.352Z", + "lastModifiedBy": "ujpptnmvqtzudoiaihbgrvnagxh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-09T08:26:45.352Z" + } + } + ], + "enforceDataIntegrityCheckForIscsi": true + }, + "id": "cgwmakehxvhv", + "name": "qymuqyvdlpshrna", + "type": "wwkffcgidqktzuzo", + "systemData": { + "createdBy": "iskcypymrroqhmdwccwqzdclpyutpb", + "createdByType": "User", + "createdAt": "2024-07-09T08:26:45.352Z", + "lastModifiedBy": "ujpptnmvqtzudoiaihbgrvnagxh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-09T08:26:45.352Z" + } + } + ], + "nextLink": "xhokenxyibcglczppcoqlnvwblwx" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_ListByElasticSan_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_ListByElasticSan_MinimumSet_Gen.json new file mode 100644 index 000000000000..c30b5ece6645 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_ListByElasticSan_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "VolumeGroups_ListByElasticSan", + "operationId": "VolumeGroups_ListByElasticSan", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Update_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..3f21707789e3 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Update_MaximumSet_Gen.json @@ -0,0 +1,131 @@ +{ + "title": "VolumeGroups_Update", + "operationId": "VolumeGroups_Update", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "parameters": { + "identity": { + "type": "None", + "userAssignedIdentities": { + "key1006": {} + } + }, + "properties": { + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "encryptionProperties": { + "keyVaultProperties": { + "keyName": "lunpapamzeimppgobraxjt", + "keyVersion": "oemygbnfmqhijmonkqfqmy", + "keyVaultUri": "https://microsoft.com/a" + }, + "identity": { + "userAssignedIdentity": "gfhkfbozahmmwluqndfgxunssafa" + } + }, + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "bkhwaiqvvaguymsmnzzbzz", + "action": "Allow" + } + ] + }, + "enforceDataIntegrityCheckForIscsi": true + } + }, + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "identity": { + "principalId": "uqclmeopt", + "tenantId": "qvhlvbvgodtycsfjhamstlrusktly", + "type": "None", + "userAssignedIdentities": { + "key1006": { + "principalId": "pcbbifvgblsrhzmpdt", + "clientId": "hsfmzocbkqpxspqwamdqjknd" + } + } + }, + "properties": { + "provisioningState": "Invalid", + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "encryptionProperties": { + "keyVaultProperties": { + "keyName": "lunpapamzeimppgobraxjt", + "keyVersion": "oemygbnfmqhijmonkqfqmy", + "keyVaultUri": "https://microsoft.com/a", + "currentVersionedKeyIdentifier": "giyyriknaomjipru", + "lastKeyRotationTimestamp": "2024-07-09T08:26:49.141Z", + "currentVersionedKeyExpirationTimestamp": "2024-07-09T08:26:49.141Z" + }, + "identity": { + "userAssignedIdentity": "gfhkfbozahmmwluqndfgxunssafa" + } + }, + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "bkhwaiqvvaguymsmnzzbzz", + "action": "Allow" + } + ] + }, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "kdvywmjnrvqksyvxgosjorlzjk" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "hqsksvdlhacbmawvhlhhfmcyv", + "actionsRequired": "xvnopczgivazrjlzirhtww" + }, + "groupIds": [ + "ftdxwynrey" + ] + }, + "id": "utnp", + "name": "duzwhl", + "type": "mzwnrqbkzgk", + "systemData": { + "createdBy": "iskcypymrroqhmdwccwqzdclpyutpb", + "createdByType": "User", + "createdAt": "2024-07-09T08:26:45.352Z", + "lastModifiedBy": "ujpptnmvqtzudoiaihbgrvnagxh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-09T08:26:45.352Z" + } + } + ], + "enforceDataIntegrityCheckForIscsi": true + }, + "id": "cgwmakehxvhv", + "name": "qymuqyvdlpshrna", + "type": "wwkffcgidqktzuzo", + "systemData": { + "createdBy": "iskcypymrroqhmdwccwqzdclpyutpb", + "createdByType": "User", + "createdAt": "2024-07-09T08:26:45.352Z", + "lastModifiedBy": "ujpptnmvqtzudoiaihbgrvnagxh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-09T08:26:45.352Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Update_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..96cbb14c9442 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeGroups_Update_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "VolumeGroups_Update", + "operationId": "VolumeGroups_Update", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "parameters": {}, + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_Create_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..eec936af3f69 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_Create_MaximumSet_Gen.json @@ -0,0 +1,70 @@ +{ + "title": "VolumeSnapshots_Create", + "operationId": "VolumeSnapshots_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "snapshotName": "snapshotname", + "parameters": { + "properties": { + "creationData": { + "sourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}" + } + } + }, + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "creationData": { + "sourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}" + }, + "provisioningState": "Succeeded", + "sourceVolumeSizeGiB": 28, + "volumeName": "volumename" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots/{snapshotName}", + "name": "qukfugetqthsufp", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/snapshots", + "systemData": { + "createdBy": "f", + "createdByType": "User", + "createdAt": "2023-09-06T06:58:45.864Z", + "lastModifiedBy": "wifrlzeszzcckvdzdwxhvservlvarp", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-06T06:58:45.864Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "creationData": { + "sourceId": "vfirlleqvpepxnptyyrz" + }, + "provisioningState": "Invalid", + "sourceVolumeSizeGiB": 28, + "volumeName": "o" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots/{snapshotName}", + "name": "qukfugetqthsufp", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/snapshots", + "systemData": { + "createdBy": "f", + "createdByType": "User", + "createdAt": "2023-09-06T06:58:45.864Z", + "lastModifiedBy": "wifrlzeszzcckvdzdwxhvservlvarp", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-06T06:58:45.864Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_Create_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..eec936af3f69 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_Create_MinimumSet_Gen.json @@ -0,0 +1,70 @@ +{ + "title": "VolumeSnapshots_Create", + "operationId": "VolumeSnapshots_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "snapshotName": "snapshotname", + "parameters": { + "properties": { + "creationData": { + "sourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}" + } + } + }, + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "creationData": { + "sourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}" + }, + "provisioningState": "Succeeded", + "sourceVolumeSizeGiB": 28, + "volumeName": "volumename" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots/{snapshotName}", + "name": "qukfugetqthsufp", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/snapshots", + "systemData": { + "createdBy": "f", + "createdByType": "User", + "createdAt": "2023-09-06T06:58:45.864Z", + "lastModifiedBy": "wifrlzeszzcckvdzdwxhvservlvarp", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-06T06:58:45.864Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "creationData": { + "sourceId": "vfirlleqvpepxnptyyrz" + }, + "provisioningState": "Invalid", + "sourceVolumeSizeGiB": 28, + "volumeName": "o" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots/{snapshotName}", + "name": "qukfugetqthsufp", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/snapshots", + "systemData": { + "createdBy": "f", + "createdByType": "User", + "createdAt": "2023-09-06T06:58:45.864Z", + "lastModifiedBy": "wifrlzeszzcckvdzdwxhvservlvarp", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-06T06:58:45.864Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_Delete_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..eedb5471b3ae --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_Delete_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "VolumeSnapshots_Delete", + "operationId": "VolumeSnapshots_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "snapshotName": "snapshotname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_Delete_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..eedb5471b3ae --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_Delete_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "VolumeSnapshots_Delete", + "operationId": "VolumeSnapshots_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "snapshotName": "snapshotname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_Get_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..6da1d5a377f7 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_Get_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "VolumeSnapshots_Get", + "operationId": "VolumeSnapshots_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "snapshotName": "snapshotname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "creationData": { + "sourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}" + }, + "provisioningState": "Succeeded", + "sourceVolumeSizeGiB": 28, + "volumeName": "volumename" + }, + "id": "bbqqgzxagggqgkdgjqq", + "name": "qukfugetqthsufp", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/snapshots", + "systemData": { + "createdBy": "f", + "createdByType": "User", + "createdAt": "2023-09-06T06:58:45.864Z", + "lastModifiedBy": "wifrlzeszzcckvdzdwxhvservlvarp", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-06T06:58:45.864Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_Get_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..6da1d5a377f7 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_Get_MinimumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "VolumeSnapshots_Get", + "operationId": "VolumeSnapshots_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "snapshotName": "snapshotname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "creationData": { + "sourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}" + }, + "provisioningState": "Succeeded", + "sourceVolumeSizeGiB": 28, + "volumeName": "volumename" + }, + "id": "bbqqgzxagggqgkdgjqq", + "name": "qukfugetqthsufp", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/snapshots", + "systemData": { + "createdBy": "f", + "createdByType": "User", + "createdAt": "2023-09-06T06:58:45.864Z", + "lastModifiedBy": "wifrlzeszzcckvdzdwxhvservlvarp", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-06T06:58:45.864Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_ListByVolumeGroup_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_ListByVolumeGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..a592a80a3552 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_ListByVolumeGroup_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "VolumeSnapshots_ListByVolumeGroup", + "operationId": "VolumeSnapshots_ListByVolumeGroup", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "$filter": "volumeName eq ", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "creationData": { + "sourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}" + }, + "provisioningState": "Succeeded", + "sourceVolumeSizeGiB": 28, + "volumeName": "volumename" + }, + "id": "bbqqgzxagggqgkdgjqq", + "name": "qukfugetqthsufp", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/snapshots", + "systemData": { + "createdBy": "f", + "createdByType": "User", + "createdAt": "2023-09-06T06:58:45.864Z", + "lastModifiedBy": "wifrlzeszzcckvdzdwxhvservlvarp", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-06T06:58:45.864Z" + } + } + ], + "nextLink": "dhkjkw" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_ListByVolumeGroup_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_ListByVolumeGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..717fa96dacc8 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/VolumeSnapshots_ListByVolumeGroup_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VolumeSnapshots_ListByVolumeGroup", + "operationId": "VolumeSnapshots_ListByVolumeGroup", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Create_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..76540a522112 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Create_MaximumSet_Gen.json @@ -0,0 +1,97 @@ +{ + "title": "Volumes_Create", + "operationId": "Volumes_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "volumeName": "volumename", + "parameters": { + "properties": { + "creationData": { + "createSource": "None", + "sourceId": "ARM Id of Resource" + }, + "sizeGiB": 9, + "managedBy": { + "resourceId": "mtkeip" + } + } + }, + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "volumeId": "umwjlxntntjejiyrywrytkzbfbluhk", + "creationData": { + "createSource": "None", + "sourceId": "ARM Id of Resource" + }, + "sizeGiB": 9, + "storageTarget": { + "targetIqn": "izdwogzjedsfug", + "targetPortalHostname": "wyfbjobugmad", + "targetPortalPort": 21, + "provisioningState": "Succeeded", + "status": "Invalid" + }, + "managedBy": { + "resourceId": "mtkeip" + }, + "provisioningState": "Invalid" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", + "name": "o", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/volumes", + "systemData": { + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", + "createdByType": "User", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-23T12:16:10.057Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "volumeId": "umwjlxntntjejiyrywrytkzbfbluhk", + "creationData": { + "createSource": "None", + "sourceId": "ARM Id of Resource" + }, + "sizeGiB": 9, + "storageTarget": { + "targetIqn": "izdwogzjedsfug", + "targetPortalHostname": "wyfbjobugmad", + "targetPortalPort": 21, + "provisioningState": "Succeeded", + "status": "Invalid" + }, + "managedBy": { + "resourceId": "mtkeip" + }, + "provisioningState": "Invalid" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", + "name": "o", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/volumes", + "systemData": { + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", + "createdByType": "User", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-23T12:16:10.057Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Create_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..8a481b80b125 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Create_MinimumSet_Gen.json @@ -0,0 +1,90 @@ +{ + "title": "Volumes_Create", + "operationId": "Volumes_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "volumeName": "volumename", + "parameters": { + "properties": { + "sizeGiB": 9 + } + }, + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "volumeId": "umwjlxntntjejiyrywrytkzbfbluhk", + "creationData": { + "createSource": "None", + "sourceId": "ARM Id of Resource" + }, + "sizeGiB": 9, + "storageTarget": { + "targetIqn": "izdwogzjedsfug", + "targetPortalHostname": "wyfbjobugmad", + "targetPortalPort": 21, + "provisioningState": "Succeeded", + "status": "Invalid" + }, + "managedBy": { + "resourceId": "mtkeip" + }, + "provisioningState": "Invalid" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", + "name": "o", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/volumes", + "systemData": { + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", + "createdByType": "User", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-23T12:16:10.057Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "volumeId": "umwjlxntntjejiyrywrytkzbfbluhk", + "creationData": { + "createSource": "None", + "sourceId": "ARM Id of Resource" + }, + "sizeGiB": 9, + "storageTarget": { + "targetIqn": "izdwogzjedsfug", + "targetPortalHostname": "wyfbjobugmad", + "targetPortalPort": 21, + "provisioningState": "Succeeded", + "status": "Invalid" + }, + "managedBy": { + "resourceId": "mtkeip" + }, + "provisioningState": "Invalid" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", + "name": "o", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/volumes", + "systemData": { + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", + "createdByType": "User", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-23T12:16:10.057Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Delete_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..f79639f2c7bb --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Delete_MaximumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "title": "Volumes_Delete", + "operationId": "Volumes_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "volumeName": "volumename", + "api-version": "2024-06-01-preview", + "x-ms-delete-snapshots": "true", + "x-ms-force-delete": "true" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Delete_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..12a97c67bff2 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Delete_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Volumes_Delete", + "operationId": "Volumes_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "volumeName": "volumename", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Get_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..210d64789e7a --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Get_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "Volumes_Get", + "operationId": "Volumes_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "volumeName": "volumename", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "volumeId": "umwjlxntntjejiyrywrytkzbfbluhk", + "creationData": { + "createSource": "None", + "sourceId": "ARM Id of Resource" + }, + "sizeGiB": 9, + "storageTarget": { + "targetIqn": "izdwogzjedsfug", + "targetPortalHostname": "wyfbjobugmad", + "targetPortalPort": 21, + "provisioningState": "Succeeded", + "status": "Invalid" + }, + "managedBy": { + "resourceId": "mtkeip" + }, + "provisioningState": "Invalid" + }, + "id": "swkcmwglncgtsnejzvldnbpsifxez", + "name": "o", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/volumes", + "systemData": { + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", + "createdByType": "User", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-23T12:16:10.057Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Get_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..210d64789e7a --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Get_MinimumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "Volumes_Get", + "operationId": "Volumes_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "volumeName": "volumename", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "volumeId": "umwjlxntntjejiyrywrytkzbfbluhk", + "creationData": { + "createSource": "None", + "sourceId": "ARM Id of Resource" + }, + "sizeGiB": 9, + "storageTarget": { + "targetIqn": "izdwogzjedsfug", + "targetPortalHostname": "wyfbjobugmad", + "targetPortalPort": 21, + "provisioningState": "Succeeded", + "status": "Invalid" + }, + "managedBy": { + "resourceId": "mtkeip" + }, + "provisioningState": "Invalid" + }, + "id": "swkcmwglncgtsnejzvldnbpsifxez", + "name": "o", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/volumes", + "systemData": { + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", + "createdByType": "User", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-23T12:16:10.057Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_ListByVolumeGroup_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_ListByVolumeGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..f248d5aba72e --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_ListByVolumeGroup_MaximumSet_Gen.json @@ -0,0 +1,52 @@ +{ + "title": "Volumes_ListByVolumeGroup", + "operationId": "Volumes_ListByVolumeGroup", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "volumeId": "umwjlxntntjejiyrywrytkzbfbluhk", + "creationData": { + "createSource": "None", + "sourceId": "ARM Id of Resource" + }, + "sizeGiB": 9, + "storageTarget": { + "targetIqn": "izdwogzjedsfug", + "targetPortalHostname": "wyfbjobugmad", + "targetPortalPort": 21, + "provisioningState": "Succeeded", + "status": "Invalid" + }, + "managedBy": { + "resourceId": "mtkeip" + }, + "provisioningState": "Invalid" + }, + "id": "swkcmwglncgtsnejzvldnbpsifxez", + "name": "o", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/volumes", + "systemData": { + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", + "createdByType": "User", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-23T12:16:10.057Z" + } + } + ], + "nextLink": "gguhcswqbqzoxqirej" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_ListByVolumeGroup_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_ListByVolumeGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..0aa3862dbeef --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_ListByVolumeGroup_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "Volumes_ListByVolumeGroup", + "operationId": "Volumes_ListByVolumeGroup", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Update_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..0ed2eb6c16d6 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Update_MaximumSet_Gen.json @@ -0,0 +1,58 @@ +{ + "title": "Volumes_Update", + "operationId": "Volumes_Update", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "volumeName": "volumename", + "parameters": { + "properties": { + "sizeGiB": 11 + } + }, + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "volumeId": "umwjlxntntjejiyrywrytkzbfbluhk", + "creationData": { + "createSource": "None", + "sourceId": "ARM Id of Resource" + }, + "sizeGiB": 9, + "storageTarget": { + "targetIqn": "izdwogzjedsfug", + "targetPortalHostname": "wyfbjobugmad", + "targetPortalPort": 21, + "provisioningState": "Succeeded", + "status": "Invalid" + }, + "managedBy": { + "resourceId": "mtkeip" + }, + "provisioningState": "Invalid" + }, + "id": "swkcmwglncgtsnejzvldnbpsifxez", + "name": "o", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/volumes", + "systemData": { + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", + "createdByType": "User", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-23T12:16:10.057Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Update_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..b83e4bfe8329 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2024-06-01-preview/examples/Volumes_Update_MinimumSet_Gen.json @@ -0,0 +1,54 @@ +{ + "title": "Volumes_Update", + "operationId": "Volumes_Update", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "volumeName": "volumename", + "parameters": {}, + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "volumeId": "umwjlxntntjejiyrywrytkzbfbluhk", + "creationData": { + "createSource": "None", + "sourceId": "ARM Id of Resource" + }, + "sizeGiB": 9, + "storageTarget": { + "targetIqn": "izdwogzjedsfug", + "targetPortalHostname": "wyfbjobugmad", + "targetPortalPort": 21, + "provisioningState": "Succeeded", + "status": "Invalid" + }, + "managedBy": { + "resourceId": "mtkeip" + }, + "provisioningState": "Invalid" + }, + "id": "swkcmwglncgtsnejzvldnbpsifxez", + "name": "o", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/volumes", + "systemData": { + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", + "createdByType": "User", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-23T12:16:10.057Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/readme.md b/specification/elasticsan/resource-manager/readme.md index 3be0f264aabc..9d32d96e4c4f 100644 --- a/specification/elasticsan/resource-manager/readme.md +++ b/specification/elasticsan/resource-manager/readme.md @@ -26,9 +26,17 @@ These are the global settings for the storagepool. ``` yaml openapi-type: arm -tag: package-2024-05 +tag: package-preview-2024-06 ``` +### Tag: package-preview-2024-06 + +These settings apply only when `--tag=package-preview-2024-06` is specified on the command line. + +``` yaml $(tag) == 'package-preview-2024-06' +input-file: + - Microsoft.ElasticSan/preview/2024-06-01-preview/elasticsan.json +``` ### Tag: package-2024-05 @@ -99,4 +107,4 @@ See configuration in [readme.typescript.md](./readme.typescript.md) ## CSharp -See configuration in [readme.csharp.md](./readme.csharp.md) +See configuration in [readme.csharp.md](./readme.csharp.md) \ No newline at end of file From 0f8b47b1c07039272118cc7e576a548408ba6273 Mon Sep 17 00:00:00 2001 From: Arthur Ma Date: Thu, 26 Sep 2024 23:34:09 +0800 Subject: [PATCH 26/48] Update client.tsp for ComputeSchedule (#30746) --- .../ComputeSchedule.Management/client.tsp | 12 ++++++++++++ .../ComputeSchedule.Management/models.tsp | 16 ++++++++-------- .../2024-08-15-preview/computeschedule.json | 16 ++++++++-------- 3 files changed, 28 insertions(+), 16 deletions(-) diff --git a/specification/computeschedule/ComputeSchedule.Management/client.tsp b/specification/computeschedule/ComputeSchedule.Management/client.tsp index d8a451726e84..60ef54dbebce 100644 --- a/specification/computeschedule/ComputeSchedule.Management/client.tsp +++ b/specification/computeschedule/ComputeSchedule.Management/client.tsp @@ -79,3 +79,15 @@ using Microsoft.ComputeSchedule; "csharp" ); @@clientName(StartResourceOperationResponse.type, "ResourceType", "csharp"); + +@@clientName(SubmitDeallocateRequest.correlationid, "correlationId", "csharp"); +@@clientName(SubmitStartRequest.correlationid, "correlationId", "csharp"); +@@clientName(SubmitHibernateRequest.correlationid, "correlationId", "csharp"); +@@clientName(ExecuteDeallocateRequest.correlationid, "correlationId", "csharp"); +@@clientName(ExecuteHibernateRequest.correlationid, "correlationId", "csharp"); +@@clientName(ExecuteStartRequest.correlationid, "correlationId", "csharp"); +@@clientName(GetOperationStatusRequest.correlationid, + "correlationId", + "csharp" +); +@@clientName(CancelOperationsRequest.correlationid, "correlationId", "csharp"); diff --git a/specification/computeschedule/ComputeSchedule.Management/models.tsp b/specification/computeschedule/ComputeSchedule.Management/models.tsp index a2b0ab895408..72e955278c57 100644 --- a/specification/computeschedule/ComputeSchedule.Management/models.tsp +++ b/specification/computeschedule/ComputeSchedule.Management/models.tsp @@ -257,7 +257,7 @@ model SubmitDeallocateRequest { @doc("The resources for the request") resources: Resources; - @doc("Correlationid item") + @doc("CorrelationId item") correlationid: string; } @@ -290,7 +290,7 @@ model SubmitStartRequest { @doc("The resources for the request") resources: Resources; - @doc("Correlationid item") + @doc("CorrelationId item") correlationid: string; } @@ -323,7 +323,7 @@ model SubmitHibernateRequest { @doc("The resources for the request") resources: Resources; - @doc("Correlationid item") + @doc("CorrelationId item") correlationid: string; } @@ -353,7 +353,7 @@ model ExecuteDeallocateRequest { @doc("The resources for the request") resources: Resources; - @doc("Correlationid item") + @doc("CorrelationId item") correlationid: string; } @@ -365,7 +365,7 @@ model ExecuteHibernateRequest { @doc("The resources for the request") resources: Resources; - @doc("Correlationid item") + @doc("CorrelationId item") correlationid: string; } @@ -377,7 +377,7 @@ model ExecuteStartRequest { @doc("The resources for the request") resources: Resources; - @doc("Correlationid item") + @doc("CorrelationId item") correlationid: string; } @@ -387,7 +387,7 @@ model GetOperationStatusRequest { @doc("The list of operation ids to get the status of") operationIds: Array; - @doc("Correlationid item") + @doc("CorrelationId item") correlationid: string; } @@ -404,7 +404,7 @@ model CancelOperationsRequest { @doc("The list of operation ids to cancel operations on") operationIds: Array; - @doc("Correlationid item") + @doc("CorrelationId item") correlationid: string; } diff --git a/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-08-15-preview/computeschedule.json b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-08-15-preview/computeschedule.json index b55ad7f312ce..17ddedcb8278 100644 --- a/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-08-15-preview/computeschedule.json +++ b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-08-15-preview/computeschedule.json @@ -579,7 +579,7 @@ }, "correlationid": { "type": "string", - "description": "Correlationid item" + "description": "CorrelationId item" } }, "required": [ @@ -687,7 +687,7 @@ }, "correlationid": { "type": "string", - "description": "Correlationid item" + "description": "CorrelationId item" } }, "required": [ @@ -710,7 +710,7 @@ }, "correlationid": { "type": "string", - "description": "Correlationid item" + "description": "CorrelationId item" } }, "required": [ @@ -733,7 +733,7 @@ }, "correlationid": { "type": "string", - "description": "Correlationid item" + "description": "CorrelationId item" } }, "required": [ @@ -804,7 +804,7 @@ }, "correlationid": { "type": "string", - "description": "Correlationid item" + "description": "CorrelationId item" } }, "required": [ @@ -1437,7 +1437,7 @@ }, "correlationid": { "type": "string", - "description": "Correlationid item" + "description": "CorrelationId item" } }, "required": [ @@ -1465,7 +1465,7 @@ }, "correlationid": { "type": "string", - "description": "Correlationid item" + "description": "CorrelationId item" } }, "required": [ @@ -1493,7 +1493,7 @@ }, "correlationid": { "type": "string", - "description": "Correlationid item" + "description": "CorrelationId item" } }, "required": [ From c8f9de769c368555b68162ea7d4f9360c2ecae75 Mon Sep 17 00:00:00 2001 From: James Suplizio Date: Thu, 26 Sep 2024 12:45:40 -0700 Subject: [PATCH 27/48] Update CodeownersLinter to 1.0.0-dev.20240926.2 (#30753) --- eng/pipelines/codeowners-linter.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/eng/pipelines/codeowners-linter.yml b/eng/pipelines/codeowners-linter.yml index 087270ab372b..287b027ee016 100644 --- a/eng/pipelines/codeowners-linter.yml +++ b/eng/pipelines/codeowners-linter.yml @@ -31,7 +31,7 @@ stages: vmImage: ubuntu-22.04 variables: - CodeownersLinterVersion: '1.0.0-dev.20240917.2' + CodeownersLinterVersion: '1.0.0-dev.20240926.2' DotNetDevOpsFeed: "https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-net/nuget/v3/index.json" RepoLabelUri: "https://azuresdkartifacts.blob.core.windows.net/azure-sdk-write-teams/repository-labels-blob" TeamUserUri: "https://azuresdkartifacts.blob.core.windows.net/azure-sdk-write-teams/azure-sdk-write-teams-blob" From 851123422e57b3d9549306b3ac6277ee1a85b876 Mon Sep 17 00:00:00 2001 From: Eugene Tolmachev Date: Thu, 26 Sep 2024 16:03:49 -0400 Subject: [PATCH 28/48] Microsoft.AVS grid events review (#30735) * AVS grid events * generated files --- .../Microsoft.AVS/AVS.tsp | 8 ++++---- .../stable/2018-01-01/GeneratedSystemEvents.json | 16 +++++++++++++--- .../stable/2024-01-01/GeneratedSystemEvents.json | 16 +++++++++++++--- 3 files changed, 30 insertions(+), 10 deletions(-) diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.AVS/AVS.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.AVS/AVS.tsp index deae256ada7b..b927d21690ed 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.AVS/AVS.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.AVS/AVS.tsp @@ -65,13 +65,13 @@ model AvsScriptExecutionFailedEventData extends AvsScriptExecutionEventData { /** Schema of the Data property of an EventGridEvent for Microsoft.AVS/privateClouds events. */ model AvsPrivateCloudEventData { /** Id of the operation that caused this event. */ - operationId?: string; + operationId: string; } /** Schema of the Data property of an EventGridEvent for Microsoft.AVS/clusters events. */ model AvsClusterEventData { /** Id of the operation that caused this event. */ - operationId?: string; + operationId: string; /** Hosts added to the cluster in this event, if any. */ addedHostNames?: string[]; @@ -86,10 +86,10 @@ model AvsClusterEventData { /** Schema of the Data property of an EventGridEvent for Microsoft.AVS/scriptExecutions events. */ model AvsScriptExecutionEventData { /** Id of the operation that caused this event. */ - operationId?: string; + operationId: string; /** Cmdlet referenced in the execution that caused this event. */ - cmdletId?: string; + cmdletId: string; /** Stdout outputs from the execution, if any. */ output?: string[]; diff --git a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/GeneratedSystemEvents.json b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/GeneratedSystemEvents.json index 0cdd6a187ca5..48945635b761 100644 --- a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/GeneratedSystemEvents.json +++ b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/GeneratedSystemEvents.json @@ -3037,7 +3037,10 @@ "type": "string" } } - } + }, + "required": [ + "operationId" + ] }, "AvsClusterFailedEventData": { "type": "object", @@ -3080,7 +3083,10 @@ "type": "string", "description": "Id of the operation that caused this event." } - } + }, + "required": [ + "operationId" + ] }, "AvsPrivateCloudFailedEventData": { "type": "object", @@ -3143,7 +3149,11 @@ "type": "string" } } - } + }, + "required": [ + "operationId", + "cmdletId" + ] }, "AvsScriptExecutionFailedEventData": { "type": "object", diff --git a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/GeneratedSystemEvents.json b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/GeneratedSystemEvents.json index 6d1979e0180c..36bd7e604627 100644 --- a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/GeneratedSystemEvents.json +++ b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/GeneratedSystemEvents.json @@ -3101,7 +3101,10 @@ "type": "string" } } - } + }, + "required": [ + "operationId" + ] }, "AvsClusterFailedEventData": { "type": "object", @@ -3144,7 +3147,10 @@ "type": "string", "description": "Id of the operation that caused this event." } - } + }, + "required": [ + "operationId" + ] }, "AvsPrivateCloudFailedEventData": { "type": "object", @@ -3207,7 +3213,11 @@ "type": "string" } } - } + }, + "required": [ + "operationId", + "cmdletId" + ] }, "AvsScriptExecutionFailedEventData": { "type": "object", From 2a3294803a8df71659e27711e5fbfe4e97826828 Mon Sep 17 00:00:00 2001 From: Gerry Tan Date: Fri, 27 Sep 2024 12:04:52 +1000 Subject: [PATCH 29/48] Add typespec-csharp config for .NET SDK code generation (#30736) * typespec-csharp config for AzureTerraform * Rename AzureTerraform to Terraform --- .../Microsoft.AzureTerraform.Management/tspconfig.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/specification/terraform/Microsoft.AzureTerraform.Management/tspconfig.yaml b/specification/terraform/Microsoft.AzureTerraform.Management/tspconfig.yaml index 2b37c676ebf5..b0969fdd42f9 100644 --- a/specification/terraform/Microsoft.AzureTerraform.Management/tspconfig.yaml +++ b/specification/terraform/Microsoft.AzureTerraform.Management/tspconfig.yaml @@ -7,6 +7,12 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/export.json" + "@azure-tools/typespec-csharp": + flavor: azure + package-dir: "Azure.ResourceManager.Terraform" + clear-output-folder: true + model-namespace: false + namespace: "{package-dir}" linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" From 139840784c38414085b3d799cee5545f9b6e8dec Mon Sep 17 00:00:00 2001 From: Weidong Xu Date: Fri, 27 Sep 2024 11:03:41 +0800 Subject: [PATCH 30/48] mgmt, codesigning, update tspconfig (#30744) * mgmt, codesigning, update tspconfig * Update python config * Update tspconfig.yaml * update client name for python * Update client.tsp * Update tspconfig.yaml * Update tspconfig.yaml for go --------- Co-authored-by: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> Co-authored-by: ChenxiJiang333 Co-authored-by: Chenjie Shi --- .../CodeSigning.Management/client.tsp | 7 ++++ .../CodeSigning.Management/tspconfig.yaml | 36 +++++++++++++++++++ 2 files changed, 43 insertions(+) create mode 100644 specification/codesigning/CodeSigning.Management/client.tsp diff --git a/specification/codesigning/CodeSigning.Management/client.tsp b/specification/codesigning/CodeSigning.Management/client.tsp new file mode 100644 index 000000000000..740e592dc8e0 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/client.tsp @@ -0,0 +1,7 @@ +import "./main.tsp"; +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; + +@@clientName(Microsoft.CodeSigning, "TrustedSigningMgmt", "python"); +@@clientName(Microsoft.CodeSigning, "TrustedSigningManagementClient", "java"); diff --git a/specification/codesigning/CodeSigning.Management/tspconfig.yaml b/specification/codesigning/CodeSigning.Management/tspconfig.yaml index 78c952a12b48..a500693e0357 100644 --- a/specification/codesigning/CodeSigning.Management/tspconfig.yaml +++ b/specification/codesigning/CodeSigning.Management/tspconfig.yaml @@ -1,3 +1,6 @@ +parameters: + "service-dir": + default: "sdk/trustedsigning" emit: - "@azure-tools/typespec-autorest" options: @@ -9,6 +12,39 @@ options: # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/codeSigningAccount.json" + "@azure-tools/typespec-java": + package-dir: "azure-resourcemanager-trustedsigning" + flavor: "azure" + namespace: "com.azure.resourcemanager.trustedsigning" + service-name: "Trusted Signing" + "@azure-tools/typespec-python": + package-dir: "azure-mgmt-trustedsigning" + package-name: "{package-dir}" + flavor: "azure" + generate-test: true + generate-sample: true + "@azure-tools/typespec-ts": + azureSdkForJs: true + isModularLibrary: true + generateMetadata: true + hierarchyClient: false + experimentalExtensibleEnums: true + enableOperationGroup: true + package-dir: "arm-trustedsigning" + flavor: "azure" + packageDetails: + name: "@azure/arm-trustedsigning" + "@azure-tools/typespec-go": + service-dir: "sdk/resourcemanager/trustedsigning" + package-dir: "armtrustedsigning" + module: "github.com/Azure/azure-sdk-for-go/{service-dir}/{package-dir}" + fix-const-stuttering: true + flavor: "azure" + generate-examples: true + generate-fakes: true + head-as-boolean: true + inject-spans: true + remove-unreferenced-types: true linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" From 10b3107f2eafcd428a208ec5858f3ca9261b1123 Mon Sep 17 00:00:00 2001 From: Jian Chen Date: Fri, 27 Sep 2024 13:19:07 +0800 Subject: [PATCH 31/48] [Service Linker] add 24-07-01-preview api version (#30743) * add 24-07-01-preview --------- Co-authored-by: Bryce Chen --- .../examples/ConfigurationNamesList.json | 52 + .../examples/ConnectorDryrunCreate.json | 116 + .../examples/ConnectorDryrunDelete.json | 13 + .../examples/ConnectorDryrunGet.json | 33 + .../examples/ConnectorDryrunList.json | 36 + .../examples/ConnectorDryrunUpdate.json | 78 + .../examples/ConnectorList.json | 34 + .../examples/Connectors.json | 43 + .../examples/DeleteConnector.json | 18 + .../examples/DeleteDryrun.json | 11 + .../examples/DeleteLinker.json | 16 + .../examples/GenerateConfigurations.json | 26 + .../examples/GetConfigurations.json | 41 + .../examples/GetDaprConfigurations.json | 33 + .../examples/GetDryrun.json | 32 + .../2024-07-01-preview/examples/Linker.json | 47 + .../LinkerGenerateConfigurations.json | 24 + .../examples/LinkerList.json | 32 + .../examples/ListDryrun.json | 35 + .../examples/OperationsList.json | 184 ++ .../examples/PatchConnector.json | 64 + .../examples/PatchDryrun.json | 77 + .../examples/PatchLinker.json | 59 + .../examples/PutConnector.json | 63 + .../examples/PutDryrun.json | 116 + .../examples/PutLinker.json | 68 + .../examples/ValidateConnectorSuccess.json | 38 + .../examples/ValidateLinkerSuccess.json | 38 + .../2024-07-01-preview/servicelinker.json | 2937 +++++++++++++++++ .../servicelinker/resource-manager/readme.md | 11 +- 30 files changed, 4374 insertions(+), 1 deletion(-) create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConfigurationNamesList.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunCreate.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunDelete.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunGet.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunList.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunUpdate.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorList.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/Connectors.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteConnector.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteDryrun.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteLinker.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GenerateConfigurations.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetConfigurations.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetDaprConfigurations.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetDryrun.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/Linker.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/LinkerGenerateConfigurations.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/LinkerList.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ListDryrun.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/OperationsList.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchConnector.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchDryrun.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchLinker.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutConnector.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutDryrun.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutLinker.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ValidateConnectorSuccess.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ValidateLinkerSuccess.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/servicelinker.json diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConfigurationNamesList.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConfigurationNamesList.json new file mode 100644 index 000000000000..57c406a4b875 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConfigurationNamesList.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "targetService": "MICROSOFT.APPCONFIGURATION/CONFIGURATIONSTORES", + "clientType": "none", + "authType": "systemAssignedIdentity", + "names": [ + { + "value": "AZURE_APPCONFIGURATION_ENDPOINT", + "description": "App configuration endpoint" + }, + { + "value": "AZURE_APPCONFIGURATION_SCOPE", + "description": "The scopes required for the token." + } + ] + } + }, + { + "properties": { + "targetService": "MICROSOFT.APPCONFIGURATION/CONFIGURATIONSTORES", + "clientType": "none", + "authType": "userAssignedIdentity", + "names": [ + { + "value": "AZURE_APPCONFIGURATION_ENDPOINT", + "description": "App configuration endpoint" + }, + { + "value": "AZURE_APPCONFIGURATION_CLIENTID", + "description": "The client(application) ID of the user identity." + }, + { + "value": "AZURE_APPCONFIGURATION_SCOPE", + "description": "The scopes required for getting token." + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunCreate.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunCreate.json new file mode 100644 index 000000000000..d4103f9d88e4 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunCreate.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "dryrunName": "dryrunName", + "parameters": { + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name", + "secretInfo": { + "secretType": "rawValue", + "value": "secret" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "dryrunName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/locations/westus/dryruns/dryrunName", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name" + } + }, + "prerequisiteResults": [ + { + "type": "basicError", + "code": "ResourceNotFound", + "message": "Target resource is not found" + }, + { + "type": "permissionsMissing", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc", + "permissions": [ + "Microsoft.DocumentDb/databaseAccounts/write" + ] + } + ], + "operationPreviews": [ + { + "name": "configFirewallRule", + "operationType": "configNetwork", + "description": "Config firewall rule for target service to allow source service access", + "action": "Microsoft.DocumentDb/databaseAccounts/write", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc" + } + ], + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "dryrunName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/locations/westus/dryruns/dryrunName", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name" + } + }, + "prerequisiteResults": [ + { + "type": "basicError", + "code": "ResourceNotFound", + "message": "Target resource is not found" + }, + { + "type": "permissionsMissing", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc", + "permissions": [ + "Microsoft.DocumentDb/databaseAccounts/write" + ] + } + ], + "operationPreviews": [ + { + "name": "configFirewallRule", + "operationType": "configNetwork", + "description": "Config firewall rule for target service to allow source service access", + "action": "Microsoft.DocumentDb/databaseAccounts/write", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc" + } + ], + "provisioningState": "Accepted" + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunDelete.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunDelete.json new file mode 100644 index 000000000000..d1cd053dfdf2 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "dryrunName": "dryrunName" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunGet.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunGet.json new file mode 100644 index 000000000000..e9fab0f0d0fb --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "dryrunName": "dryrunName" + }, + "responses": { + "200": { + "body": { + "name": "dryrunName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/locations/westus/dryruns/dryrunName", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "authInfo": { + "authType": "secret", + "name": "username" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + }, + "systemData": { + "createdAt": "2020-07-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunList.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunList.json new file mode 100644 index 000000000000..b0d6cb39937d --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunList.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dryrunName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/locations/westus/dryruns/dryrunName", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "authInfo": { + "authType": "secret", + "name": "username" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + }, + "systemData": { + "createdAt": "2020-07-12T22:05:09Z" + } + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunUpdate.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunUpdate.json new file mode 100644 index 000000000000..3f87be091230 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunUpdate.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "dryrunName": "dryrunName", + "parameters": { + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name", + "secretInfo": { + "secretType": "rawValue", + "value": "secret" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "dryrunName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/locations/westus/dryruns/dryrunName", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name" + } + }, + "prerequisiteResults": [ + { + "type": "basicError", + "code": "ResourceNotFound", + "message": "Target resource is not found" + }, + { + "type": "permissionsMissing", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc", + "permissions": [ + "Microsoft.DocumentDb/databaseAccounts/write" + ] + } + ], + "operationPreviews": [ + { + "name": "configFirewallRule", + "operationType": "configNetwork", + "description": "Config firewall rule for target service to allow source service access", + "action": "Microsoft.DocumentDb/databaseAccounts/write", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc" + } + ], + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorList.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorList.json new file mode 100644 index 000000000000..ac02963e6953 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/linkers/linkName", + "name": "linkName", + "type": "Microsoft.ServiceLinker/devConnectors", + "properties": { + "authInfo": { + "authType": "secret", + "name": "username" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + }, + "systemData": { + "createdAt": "2020-07-12T22:05:09Z" + } + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/Connectors.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/Connectors.json new file mode 100644 index 000000000000..b774d9142b09 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/Connectors.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "connectorName": "connectorName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/devConnnectors/linkName", + "name": "linkName", + "type": "Microsoft.ServiceLinker/devConnectors", + "properties": { + "authInfo": { + "authType": "systemAssignedIdentity", + "roles": [ + "customizedOwner" + ] + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "publicNetworkSolution": { + "firewallRules": { + "ipRanges": [ + "182.22.120" + ], + "callerClientIP": "true" + }, + "action": "enable", + "deleteOrUpdateBehavior": "ForcedCleanup" + } + }, + "systemData": { + "createdAt": "2020-07-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteConnector.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteConnector.json new file mode 100644 index 000000000000..1dc02aed0953 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteConnector.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "connectorName": "connectorName" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteDryrun.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteDryrun.json new file mode 100644 index 000000000000..b6d84517cba6 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteDryrun.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "dryrunName": "dryrunName" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteLinker.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteLinker.json new file mode 100644 index 000000000000..a2eb35ce6361 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteLinker.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "linkerName": "linkName" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GenerateConfigurations.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GenerateConfigurations.json new file mode 100644 index 000000000000..b51f80725ab6 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GenerateConfigurations.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "connectorName": "connectorName", + "parameters": { + "customizedKeys": { + "ASL_DocumentDb_ConnectionString": "MyConnectionstring" + } + } + }, + "responses": { + "200": { + "body": { + "configurations": [ + { + "name": "MyConnectionstring", + "value": "ConnectionString" + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetConfigurations.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetConfigurations.json new file mode 100644 index 000000000000..39d787a2211d --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetConfigurations.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.App/containerApps/test-app", + "linkerName": "linkName" + }, + "responses": { + "200": { + "body": { + "configurations": [ + { + "name": "AZURE_POSTGRESQL_HOST", + "value": "Host", + "configType": "Default" + }, + { + "name": "AZURE_POSTGRESQL_USER", + "value": "Username", + "configType": "Default" + }, + { + "name": "AZURE_POSTGRESQL_DATABASE", + "value": "DatabaseName", + "configType": "Default" + }, + { + "name": "AZURE_POSTGRESQL_PORT", + "value": "Port", + "configType": "Default" + }, + { + "name": "AZURE_POSTGRESQL_PASSWORD", + "value": "SecretUri", + "configType": "KeyVaultSecret", + "keyVaultReferenceIdentity": "system" + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetDaprConfigurations.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetDaprConfigurations.json new file mode 100644 index 000000000000..cdbc03e325fc --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetDaprConfigurations.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "targetType": "MICROSOFT.STORAGE/STORAGEACCOUNTS/BLOBSERVICES", + "authType": "secret", + "daprProperties": { + "version": "v1", + "componentType": "bindings", + "runtimeVersion": "1.10", + "bindingComponentDirection": "input", + "metadata": [ + { + "name": "containerName", + "description": "The name of the container to be used for Dapr state.", + "required": "true" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetDryrun.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetDryrun.json new file mode 100644 index 000000000000..6545c44b1163 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetDryrun.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "dryrunName": "dryrunName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/dryruns/dryrunName", + "name": "dryrunName", + "type": "Microsoft.ServiceLinker/dryruns", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "authInfo": { + "authType": "secret", + "name": "username" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + }, + "systemData": { + "createdAt": "2020-07-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/Linker.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/Linker.json new file mode 100644 index 000000000000..eabc04aa76e7 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/Linker.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "linkerName": "linkName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "name": "linkName", + "type": "Microsoft.ServiceLinker/links", + "properties": { + "authInfo": { + "authType": "secret", + "name": "name" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "secretStore": { + "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/kvname" + }, + "scope": "AKS-Namespace", + "clientType": "dotnet", + "publicNetworkSolution": { + "action": "enable" + }, + "configurationInfo": { + "deleteOrUpdateBehavior": "ForcedCleanup", + "customizedKeys": { + "AZURE_MYSQL_CONNECTIONSTRING": "myConnectionstring", + "AZURE_MYSQL_SSLMODE": "mySslmode" + }, + "additionalConfigurations": { + "throttlingLimit": "100" + } + } + }, + "systemData": { + "createdAt": "2020-07-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/LinkerGenerateConfigurations.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/LinkerGenerateConfigurations.json new file mode 100644 index 000000000000..20077dc3ba0b --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/LinkerGenerateConfigurations.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "linkerName": "linkName", + "parameters": { + "customizedKeys": { + "ASL_DocumentDb_ConnectionString": "MyConnectionstring" + } + } + }, + "responses": { + "200": { + "body": { + "configurations": [ + { + "name": "MyConnectionstring", + "value": "ConnectionString" + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/LinkerList.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/LinkerList.json new file mode 100644 index 000000000000..99a8f52427c4 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/LinkerList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/links/linkName", + "name": "linkName", + "type": "Microsoft.ServiceLinker/links", + "properties": { + "authInfo": { + "authType": "secret", + "name": "username" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + }, + "systemData": { + "createdAt": "2020-07-12T22:05:09Z" + } + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ListDryrun.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ListDryrun.json new file mode 100644 index 000000000000..4a8dde8c63f0 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ListDryrun.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/dryruns/dryrunName", + "name": "dryrunName", + "type": "Microsoft.ServiceLinker/dryruns", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "authInfo": { + "authType": "secret", + "name": "username" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + }, + "systemData": { + "createdAt": "2020-07-12T22:05:09Z" + } + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/OperationsList.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/OperationsList.json new file mode 100644 index 000000000000..905bfe616da0 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/OperationsList.json @@ -0,0 +1,184 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "display": { + "description": "Register the subscription for Microsoft.ServiceLinker", + "operation": "Register the Microsoft.ServiceLinker", + "provider": "Microsoft.ServiceLinker", + "resource": "Microsoft.ServiceLinker" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/register/action" + }, + { + "display": { + "description": "Unregister the subscription for Microsoft.ServiceLinker", + "operation": "Unregister the Microsoft.ServiceLinker", + "provider": "Microsoft.ServiceLinker", + "resource": "Microsoft.ServiceLinker" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/unregister/action" + }, + { + "display": { + "description": "read operations", + "operation": "read_operations", + "provider": "Microsoft.ServiceLinker", + "resource": "operations" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/operations/read" + }, + { + "display": { + "description": "list dryrun jobs", + "operation": "Dryrun_List", + "provider": "Microsoft.ServiceLinker", + "resource": "dryruns" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/dryruns/read" + }, + { + "display": { + "description": "get a dryrun job", + "operation": "Dryrun_Get", + "provider": "Microsoft.ServiceLinker", + "resource": "dryruns" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/dryruns/read" + }, + { + "display": { + "description": "create a dryrun job to do necessary check before actual creation", + "operation": "Dryrun_Create", + "provider": "Microsoft.ServiceLinker", + "resource": "dryruns" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/dryruns/write" + }, + { + "display": { + "description": "delete a dryrun job", + "operation": "Dryrun_Delete", + "provider": "Microsoft.ServiceLinker", + "resource": "dryruns" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/dryruns/delete" + }, + { + "display": { + "description": "add a dryrun job to do necessary check before actual creation", + "operation": "Dryrun_Update", + "provider": "Microsoft.ServiceLinker", + "resource": "dryruns" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/dryruns/write" + }, + { + "display": { + "description": "read operationStatuses", + "operation": "read_operationStatuses", + "provider": "Microsoft.ServiceLinker", + "resource": "locations/operationStatuses" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/locations/operationStatuses/read" + }, + { + "display": { + "description": "write operationStatuses", + "operation": "write_operationStatuses", + "provider": "Microsoft.ServiceLinker", + "resource": "locations/operationStatuses" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/locations/operationStatuses/write" + }, + { + "display": { + "description": "Returns list of Linkers which connects to the resource.", + "operation": "Linker_List", + "provider": "Microsoft.ServiceLinker", + "resource": "linkers" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/linkers/read" + }, + { + "display": { + "description": "Returns Linker resource for a given name.", + "operation": "Linker_Get", + "provider": "Microsoft.ServiceLinker", + "resource": "linkers" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/linkers/read" + }, + { + "display": { + "description": "Create or update linker resource.", + "operation": "Linker_CreateOrUpdate", + "provider": "Microsoft.ServiceLinker", + "resource": "linkers" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/linkers/write" + }, + { + "display": { + "description": "Delete a link.", + "operation": "Linker_Delete", + "provider": "Microsoft.ServiceLinker", + "resource": "linkers" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/linkers/delete" + }, + { + "display": { + "description": "Operation to update an existing link.", + "operation": "Linker_Update", + "provider": "Microsoft.ServiceLinker", + "resource": "linkers" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/linkers/write" + }, + { + "display": { + "description": "Validate a link.", + "operation": "Linker_Validate", + "provider": "Microsoft.ServiceLinker", + "resource": "linkers" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/linkers/validateLinker/action" + }, + { + "display": { + "description": "list source configurations for a linker.", + "operation": "Linker_ListConfigurations", + "provider": "Microsoft.ServiceLinker", + "resource": "linkers" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/linkers/listConfigurations/action" + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchConnector.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchConnector.json new file mode 100644 index 000000000000..a302ac667d38 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchConnector.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "connectorName": "connectorName", + "parameters": { + "properties": { + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "servicePrincipalSecret", + "clientId": "name", + "principalId": "id", + "secret": "secret" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "type": "Microsoft.ServiceLinker/links", + "name": "linkName", + "properties": { + "authInfo": { + "authType": "servicePrincipalSecret", + "clientId": "name", + "principalId": "id" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "type": "Microsoft.ServiceLinker/links", + "name": "linkName", + "properties": { + "authInfo": { + "authType": "servicePrincipalSecret", + "clientId": "name", + "principalId": "id" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchDryrun.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchDryrun.json new file mode 100644 index 000000000000..c7da10d3eac5 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchDryrun.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "dryrunName": "dryrunName", + "parameters": { + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name", + "secretInfo": { + "secretType": "rawValue", + "value": "secret" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/dryruns/dryrunName", + "type": "Microsoft.ServiceLinker/dryruns", + "name": "dryrunName", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name" + } + }, + "prerequisiteResults": [ + { + "type": "basicError", + "code": "ResourceNotFound", + "message": "Target resource is not found" + }, + { + "type": "permissionsMissing", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc", + "permissions": [ + "Microsoft.DocumentDb/databaseAccounts/write" + ] + } + ], + "operationPreviews": [ + { + "name": "configFirewallRule", + "operationType": "configNetwork", + "description": "Config firewall rule for target service to allow source service access", + "action": "Microsoft.DocumentDb/databaseAccounts/write", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc" + } + ], + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchLinker.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchLinker.json new file mode 100644 index 000000000000..6a85c703e63b --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchLinker.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "linkerName": "linkName", + "parameters": { + "properties": { + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "servicePrincipalSecret", + "clientId": "name", + "principalId": "id", + "secret": "secret" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "type": "Microsoft.ServiceLinker/links", + "name": "linkName", + "properties": { + "authInfo": { + "authType": "servicePrincipalSecret", + "clientId": "name", + "principalId": "id" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "type": "Microsoft.ServiceLinker/links", + "name": "linkName", + "properties": { + "authInfo": { + "authType": "servicePrincipalSecret", + "clientId": "name", + "principalId": "id" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutConnector.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutConnector.json new file mode 100644 index 000000000000..b85bfd26ae2e --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutConnector.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "connectorName": "connectorName", + "parameters": { + "properties": { + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret" + }, + "secretStore": { + "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "type": "Microsoft.ServiceLinker/links", + "name": "linkName", + "properties": { + "authInfo": { + "authType": "secret" + }, + "secretStore": { + "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "type": "Microsoft.ServiceLinker/links", + "name": "linkName", + "properties": { + "authInfo": { + "authType": "secret" + }, + "secretStore": { + "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutDryrun.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutDryrun.json new file mode 100644 index 000000000000..65e6713bb9c6 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutDryrun.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "dryrunName": "dryrunName", + "parameters": { + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name", + "secretInfo": { + "secretType": "rawValue", + "value": "secret" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/dryruns/dryrunName", + "type": "Microsoft.ServiceLinker/dryruns", + "name": "dryrunName", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name" + } + }, + "prerequisiteResults": [ + { + "type": "basicError", + "code": "ResourceNotFound", + "message": "Target resource is not found" + }, + { + "type": "permissionsMissing", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc", + "permissions": [ + "Microsoft.DocumentDb/databaseAccounts/write" + ] + } + ], + "operationPreviews": [ + { + "name": "configFirewallRule", + "operationType": "configNetwork", + "description": "Config firewall rule for target service to allow source service access", + "action": "Microsoft.DocumentDb/databaseAccounts/write", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc" + } + ], + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/dryruns/dryrunName", + "type": "Microsoft.ServiceLinker/dryruns", + "name": "dryrunName", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name" + } + }, + "prerequisiteResults": [ + { + "type": "basicError", + "code": "ResourceNotFound", + "message": "Target resource is not found" + }, + { + "type": "permissionsMissing", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc", + "permissions": [ + "Microsoft.DocumentDb/databaseAccounts/write" + ] + } + ], + "operationPreviews": [ + { + "name": "configFirewallRule", + "operationType": "configNetwork", + "description": "Config firewall rule for target service to allow source service access", + "action": "Microsoft.DocumentDb/databaseAccounts/write", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc" + } + ], + "provisioningState": "Updating" + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutLinker.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutLinker.json new file mode 100644 index 000000000000..f678acb875be --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutLinker.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "linkerName": "linkName", + "parameters": { + "properties": { + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db" + }, + "vNetSolution": { + "type": "serviceEndpoint" + }, + "authInfo": { + "authType": "secret", + "name": "name", + "secretInfo": { + "secretType": "rawValue", + "value": "secret" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceLinker/links", + "name": "linkName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "properties": { + "authInfo": { + "authType": "secret", + "name": "name" + }, + "vNetSolution": { + "type": "serviceEndpoint" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db" + } + } + } + }, + "201": { + "body": { + "type": "Microsoft.ServiceLinker/links", + "name": "linkName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "properties": { + "authInfo": { + "authType": "secret", + "name": "name" + }, + "vNetSolution": { + "type": "serviceEndpoint" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db" + } + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ValidateConnectorSuccess.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ValidateConnectorSuccess.json new file mode 100644 index 000000000000..a2e570267b75 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ValidateConnectorSuccess.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "connectorName": "connectorName" + }, + "responses": { + "200": { + "body": { + "properties": { + "isConnectionAvailable": true, + "reportStartTimeUtc": "2020-07-12T22:05:09Z", + "reportEndTimeUtc": "2020-07-12T22:06:09Z", + "authType": "secret", + "validationDetail": [ + { + "name": "TargetExistence", + "description": "The target existence is validated", + "result": "success" + }, + { + "name": "TargetNetworkAccess", + "description": "Deny public network access is set to yes. Please confirm you are using private endpoint connection to access target resource.", + "result": "warning" + } + ] + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ValidateLinkerSuccess.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ValidateLinkerSuccess.json new file mode 100644 index 000000000000..3bb0f31ce67f --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ValidateLinkerSuccess.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "linkerName": "linkName" + }, + "responses": { + "200": { + "body": { + "properties": { + "isConnectionAvailable": true, + "reportStartTimeUtc": "2020-07-12T22:05:09Z", + "reportEndTimeUtc": "2020-07-12T22:06:09Z", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db", + "targetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db", + "authType": "secret", + "validationDetail": [ + { + "name": "TargetExistence", + "description": "The target existence is validated", + "result": "success" + }, + { + "name": "TargetNetworkAccess", + "description": "Deny public network access is set to yes. Please confirm you are using private endpoint connection to access target resource.", + "result": "warning" + } + ] + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/servicelinker.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/servicelinker.json new file mode 100644 index 000000000000..3be7908389ae --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/servicelinker.json @@ -0,0 +1,2937 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.ServiceLinker", + "description": "Microsoft.ServiceLinker provider", + "version": "2024-07-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.ServiceLinker/locations/{location}/dryruns": { + "get": { + "tags": [ + "Connector" + ], + "operationId": "Connector_ListDryrun", + "description": "list dryrun jobs", + "x-ms-examples": { + "ConnectorDryrunList": { + "$ref": "./examples/ConnectorDryrunList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DryrunList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/dryruns/{dryrunName}": { + "get": { + "tags": [ + "Connector" + ], + "operationId": "Connector_GetDryrun", + "description": "get a dryrun job", + "x-ms-examples": { + "ConnectorDryrunGet": { + "$ref": "./examples/ConnectorDryrunGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dryrunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of dryrun.", + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DryrunResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Connector" + ], + "operationId": "Connector_CreateDryrun", + "description": "create a dryrun job to do necessary check before actual creation", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ConnectorDryrunCreate": { + "$ref": "./examples/ConnectorDryrunCreate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dryrunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of dryrun.", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "description": "dryrun resource.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DryrunResource" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DryrunResource" + } + }, + "201": { + "description": "Long running operation", + "schema": { + "$ref": "#/definitions/DryrunResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Connector" + ], + "operationId": "Connector_UpdateDryrun", + "description": "update a dryrun job to do necessary check before actual creation", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ConnectorDryrunUpdate": { + "$ref": "./examples/ConnectorDryrunUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dryrunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of dryrun.", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "description": "dryrun resource.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DryrunPatch" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DryrunResource" + } + }, + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Connector" + ], + "operationId": "Connector_DeleteDryrun", + "description": "delete a dryrun job", + "x-ms-examples": { + "ConnectorDryrunDelete": { + "$ref": "./examples/ConnectorDryrunDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dryrunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of dryrun.", + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "OK. The job is deleted." + }, + "204": { + "description": "Deleted. The job is not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors": { + "get": { + "deprecated": false, + "description": "Returns list of connector which connects to the resource, which supports to config the target service during the resource provision.", + "operationId": "Connector_List", + "x-ms-examples": { + "ConnectorList": { + "$ref": "./examples/ConnectorList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Connector details.", + "schema": { + "$ref": "#/definitions/ResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName}": { + "get": { + "description": "Returns Connector resource for a given name.", + "operationId": "Connector_Get", + "x-ms-examples": { + "Connector": { + "$ref": "./examples/Connectors.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ConnectorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Connector details.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "description": "Create or update Connector resource.", + "operationId": "Connector_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "PutConnector": { + "$ref": "./examples/PutConnector.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ConnectorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "description": "Connector details.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LinkerResource" + } + } + ], + "responses": { + "200": { + "description": "Successful.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "201": { + "description": "Long running operation.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Connector" + ], + "operationId": "Connector_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "description": "Delete a Connector.", + "x-ms-examples": { + "DeleteConnector": { + "$ref": "./examples/DeleteConnector.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ConnectorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The Connector is deleted." + }, + "202": { + "description": "Long running operation." + }, + "204": { + "description": "Deleted. The Connector is not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Connector" + ], + "operationId": "Connector_Update", + "description": "Operation to update an existing Connector.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "PatchConnector": { + "$ref": "./examples/PatchConnector.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ConnectorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "description": "Connector details.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LinkerPatch" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes a Connector.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "202": { + "description": "Long running operation.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName}/validate": { + "post": { + "tags": [ + "Connector" + ], + "operationId": "Connector_Validate", + "description": "Validate a Connector.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ValidateConnectorSuccess": { + "$ref": "./examples/ValidateConnectorSuccess.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ConnectorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ValidateOperationResult" + } + }, + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName}/generateConfigurations": { + "post": { + "tags": [ + "Connector" + ], + "operationId": "Connector_GenerateConfigurations", + "description": "Generate configurations for a Connector.", + "x-ms-examples": { + "GenerateConfiguration": { + "$ref": "./examples/GenerateConfigurations.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ConnectorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "description": "Connection Info, including format, secret store, etc", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ConfigurationInfo" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ConfigurationResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{resourceUri}/providers/Microsoft.ServiceLinker/linkers": { + "get": { + "deprecated": false, + "description": "Returns list of Linkers which connects to the resource. which supports to config both application and target service during the resource provision.", + "operationId": "Linker_List", + "x-ms-examples": { + "LinkerList": { + "$ref": "./examples/LinkerList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Linker details.", + "schema": { + "$ref": "#/definitions/ResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}": { + "get": { + "description": "Returns Linker resource for a given name.", + "operationId": "Linker_Get", + "x-ms-examples": { + "Linker": { + "$ref": "./examples/Linker.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LinkerNameParameter" + } + ], + "responses": { + "200": { + "description": "Linker details.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "description": "Create or update Linker resource.", + "operationId": "Linker_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "PutLinker": { + "$ref": "./examples/PutLinker.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LinkerNameParameter" + }, + { + "name": "parameters", + "description": "Linker details.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LinkerResource" + } + } + ], + "responses": { + "200": { + "description": "Successful.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "201": { + "description": "Long running operation.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Linkers" + ], + "operationId": "Linker_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "description": "Delete a Linker.", + "x-ms-examples": { + "DeleteLinker": { + "$ref": "./examples/DeleteLinker.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LinkerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The Linker is deleted." + }, + "202": { + "description": "Long running operation." + }, + "204": { + "description": "Deleted. The Linker is not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Linkers" + ], + "operationId": "Linker_Update", + "description": "Operation to update an existing Linker.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "PatchLinker": { + "$ref": "./examples/PatchLinker.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LinkerNameParameter" + }, + { + "name": "parameters", + "description": "Linker details.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LinkerPatch" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes a Linker.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "201": { + "description": "Long running operation.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}/validateLinker": { + "post": { + "tags": [ + "Linkers" + ], + "operationId": "Linker_Validate", + "description": "Validate a Linker.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ValidateLinkerSuccess": { + "$ref": "./examples/ValidateLinkerSuccess.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LinkerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ValidateOperationResult" + } + }, + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}/listConfigurations": { + "post": { + "tags": [ + "Linkers" + ], + "operationId": "Linker_ListConfigurations", + "description": "list source configurations for a Linker.", + "x-ms-examples": { + "GetConfiguration": { + "$ref": "./examples/GetConfigurations.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LinkerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ConfigurationResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{resourceUri}/providers/Microsoft.ServiceLinker/dryruns": { + "get": { + "tags": [ + "Linkers" + ], + "operationId": "Linkers_ListDryrun", + "description": "list dryrun jobs", + "x-ms-examples": { + "ListDryrun": { + "$ref": "./examples/ListDryrun.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DryrunList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.ServiceLinker/dryruns/{dryrunName}": { + "get": { + "tags": [ + "Linkers" + ], + "operationId": "Linkers_GetDryrun", + "description": "get a dryrun job", + "x-ms-examples": { + "GetDryrun": { + "$ref": "./examples/GetDryrun.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dryrunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of dryrun.", + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DryrunResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Linkers" + ], + "operationId": "Linkers_CreateDryrun", + "description": "create a dryrun job to do necessary check before actual creation", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "PutDryrun": { + "$ref": "./examples/PutDryrun.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dryrunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of dryrun.", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "description": "dryrun resource.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DryrunResource" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DryrunResource" + } + }, + "201": { + "description": "Long running operation", + "schema": { + "$ref": "#/definitions/DryrunResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Linkers" + ], + "operationId": "Linkers_UpdateDryrun", + "description": "add a dryrun job to do necessary check before actual creation", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "PatchDryrun": { + "$ref": "./examples/PatchDryrun.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dryrunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of dryrun.", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "description": "dryrun resource.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DryrunPatch" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DryrunResource" + } + }, + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Linkers" + ], + "operationId": "Linkers_DeleteDryrun", + "description": "delete a dryrun job", + "x-ms-examples": { + "DeleteDryrun": { + "$ref": "./examples/DeleteDryrun.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dryrunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of dryrun.", + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "OK. The job is deleted." + }, + "204": { + "description": "Deleted. The job is not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}/generateConfigurations": { + "post": { + "tags": [ + "Linkers" + ], + "operationId": "Linkers_GenerateConfigurations", + "description": "Generate configurations for a Linker.", + "x-ms-examples": { + "GenerateConfiguration": { + "$ref": "./examples/LinkerGenerateConfigurations.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LinkerNameParameter" + }, + { + "name": "parameters", + "description": "Connection Info, including format, secret store, etc", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ConfigurationInfo" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ConfigurationResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.ServiceLinker/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists the available ServiceLinker REST API operations.", + "x-ms-examples": { + "GetConfiguration": { + "$ref": "./examples/OperationsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ServiceLinker/configurationNames": { + "get": { + "tags": [ + "ConfigurationNames" + ], + "operationId": "ConfigurationNames_List", + "description": "Lists the configuration names generated by Service Connector for all target, client types, auth types.", + "x-ms-examples": { + "GetConfigurationNames": { + "$ref": "./examples/ConfigurationNamesList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter options." + }, + { + "name": "$skipToken", + "in": "query", + "required": false, + "type": "string", + "description": "OData skipToken option for pagination." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ConfigurationNameResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.ServiceLinker/daprConfigurations": { + "get": { + "tags": [ + "Linkers" + ], + "operationId": "Linkers_ListDaprConfigurations", + "description": "List the dapr configuration supported by Service Connector.", + "x-ms-examples": { + "GetDaprConfigurations": { + "$ref": "./examples/GetDaprConfigurations.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DaprConfigurationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "TargetServiceType": { + "description": "The target service type.", + "type": "string", + "enum": [ + "AzureResource", + "ConfluentBootstrapServer", + "ConfluentSchemaRegistry", + "SelfHostedServer", + "FabricPlatform" + ], + "x-ms-enum": { + "name": "targetServiceType", + "modelAsString": true + } + }, + "TargetServiceBase": { + "description": "The target service properties", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "description": "The target service type.", + "$ref": "#/definitions/TargetServiceType" + } + }, + "required": [ + "type" + ] + }, + "AzureResourceType": { + "description": "The azure resource type.", + "type": "string", + "enum": [ + "KeyVault", + "AppConfig" + ], + "x-ms-enum": { + "name": "azureResourceType", + "modelAsString": true + } + }, + "AzureResourcePropertiesBase": { + "description": "The azure resource properties", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "description": "The azure resource type.", + "$ref": "#/definitions/AzureResourceType" + } + }, + "required": [ + "type" + ] + }, + "AzureResource": { + "x-ms-discriminator-value": "AzureResource", + "type": "object", + "description": "The azure resource info when target service type is AzureResource", + "allOf": [ + { + "$ref": "#/definitions/TargetServiceBase" + } + ], + "properties": { + "id": { + "description": "The Id of azure resource.", + "type": "string" + }, + "resourceProperties": { + "x-nullable": true, + "description": "The azure resource connection related properties.", + "$ref": "#/definitions/AzureResourcePropertiesBase" + } + } + }, + "AzureKeyVaultProperties": { + "x-ms-discriminator-value": "KeyVault", + "type": "object", + "description": "The resource properties when type is Azure Key Vault", + "allOf": [ + { + "$ref": "#/definitions/AzureResourcePropertiesBase" + } + ], + "properties": { + "connectAsKubernetesCsiDriver": { + "x-nullable": true, + "description": "True if connect via Kubernetes CSI Driver.", + "type": "boolean" + } + } + }, + "AzureAppConfigProperties": { + "x-ms-discriminator-value": "AppConfig", + "type": "object", + "description": "The resource properties when type is Azure App Configuration", + "allOf": [ + { + "$ref": "#/definitions/AzureResourcePropertiesBase" + } + ], + "properties": { + "connectWithKubernetesExtension": { + "x-nullable": true, + "description": "True if connection enables app configuration kubernetes extension.", + "type": "boolean" + } + } + }, + "ConfluentBootstrapServer": { + "x-ms-discriminator-value": "ConfluentBootstrapServer", + "type": "object", + "description": "The service properties when target service type is ConfluentBootstrapServer", + "allOf": [ + { + "$ref": "#/definitions/TargetServiceBase" + } + ], + "properties": { + "endpoint": { + "description": "The endpoint of service.", + "type": "string" + } + } + }, + "FabricPlatform": { + "x-ms-discriminator-value": "FabricPlatform", + "type": "object", + "description": "The service properties when target service type is FabricPlatform", + "allOf": [ + { + "$ref": "#/definitions/TargetServiceBase" + } + ], + "properties": { + "endpoint": { + "description": "The endpoint of service.", + "type": "string" + } + } + }, + "SelfHostedServer": { + "x-ms-discriminator-value": "SelfHostedServer", + "type": "object", + "description": "The service properties when target service type is SelfHostedServer", + "allOf": [ + { + "$ref": "#/definitions/TargetServiceBase" + } + ], + "properties": { + "endpoint": { + "description": "The endpoint of service.", + "type": "string" + } + } + }, + "ConfluentSchemaRegistry": { + "x-ms-discriminator-value": "ConfluentSchemaRegistry", + "type": "object", + "description": "The service properties when target service type is ConfluentSchemaRegistry", + "allOf": [ + { + "$ref": "#/definitions/TargetServiceBase" + } + ], + "properties": { + "endpoint": { + "description": "The endpoint of service.", + "type": "string" + } + } + }, + "DeleteOrUpdateBehavior": { + "description": "The cleanup behavior to indicate whether clean up operation when resource is deleted or updated", + "type": "string", + "enum": [ + "Default", + "ForcedCleanup" + ], + "x-ms-enum": { + "name": "DeleteOrUpdateBehavior", + "modelAsString": true + } + }, + "ClientType": { + "description": "The application client type", + "type": "string", + "enum": [ + "none", + "dotnet", + "java", + "python", + "go", + "php", + "ruby", + "django", + "nodejs", + "springBoot", + "kafka-springBoot", + "jms-springBoot", + "dapr" + ], + "x-ms-enum": { + "name": "clientType", + "modelAsString": true + } + }, + "AuthType": { + "description": "The authentication type.", + "type": "string", + "enum": [ + "systemAssignedIdentity", + "userAssignedIdentity", + "servicePrincipalSecret", + "servicePrincipalCertificate", + "secret", + "accessKey", + "userAccount", + "easyAuthMicrosoftEntraID" + ], + "x-ms-enum": { + "name": "AuthType", + "modelAsString": true + } + }, + "SecretType": { + "description": "The secret type.", + "type": "string", + "enum": [ + "rawValue", + "keyVaultSecretUri", + "keyVaultSecretReference" + ], + "x-ms-enum": { + "name": "SecretType", + "modelAsString": true + } + }, + "SecretSourceType": { + "description": "The type of secret source.", + "type": "string", + "enum": [ + "rawValue", + "keyVaultSecret" + ], + "x-ms-enum": { + "name": "SecretSourceType", + "modelAsString": true + } + }, + "SecretInfoBase": { + "description": "The secret info", + "discriminator": "secretType", + "type": "object", + "properties": { + "secretType": { + "description": "The secret type.", + "$ref": "#/definitions/SecretType" + } + }, + "required": [ + "secretType" + ] + }, + "ValueSecretInfo": { + "x-ms-discriminator-value": "rawValue", + "type": "object", + "description": "The secret info when type is rawValue. It's for scenarios that user input the secret.", + "allOf": [ + { + "$ref": "#/definitions/SecretInfoBase" + } + ], + "properties": { + "value": { + "x-nullable": true, + "description": "The actual value of the secret.", + "type": "string", + "x-ms-secret": true + } + } + }, + "KeyVaultSecretReferenceSecretInfo": { + "x-ms-discriminator-value": "keyVaultSecretReference", + "type": "object", + "description": "The secret info when type is keyVaultSecretReference. It's for scenario that user provides a secret stored in user's keyvault and source is Azure Kubernetes. The key Vault's resource id is linked to secretStore.keyVaultId.", + "allOf": [ + { + "$ref": "#/definitions/SecretInfoBase" + } + ], + "properties": { + "name": { + "description": "Name of the Key Vault secret.", + "type": "string" + }, + "version": { + "x-nullable": true, + "description": "Version of the Key Vault secret.", + "type": "string" + } + } + }, + "KeyVaultSecretUriSecretInfo": { + "x-ms-discriminator-value": "keyVaultSecretUri", + "type": "object", + "description": "The secret info when type is keyVaultSecretUri. It's for scenario that user provides a secret stored in user's keyvault and source is Web App, Spring Cloud or Container App.", + "allOf": [ + { + "$ref": "#/definitions/SecretInfoBase" + } + ], + "properties": { + "value": { + "description": "URI to the keyvault secret", + "type": "string" + } + } + }, + "AuthInfoBase": { + "description": "The authentication info", + "discriminator": "authType", + "type": "object", + "properties": { + "authType": { + "description": "The authentication type.", + "$ref": "#/definitions/AuthType" + }, + "authMode": { + "description": "Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth.", + "$ref": "#/definitions/AuthMode" + } + }, + "required": [ + "authType" + ] + }, + "AccessKeyInfoBase": { + "description": "The access key directly from target resource properties, which target service is Azure Resource, such as Microsoft.Storage", + "x-ms-discriminator-value": "accessKey", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AuthInfoBase" + } + ], + "properties": { + "permissions": { + "description": "Permissions of the accessKey. `Read` and `Write` are for Azure Cosmos DB and Azure App Configuration, `Listen`, `Send` and `Manage` are for Azure Event Hub and Azure Service Bus.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "Read", + "Write", + "Listen", + "Send", + "Manage" + ], + "x-ms-enum": { + "name": "accessKeyPermissions", + "modelAsString": true + } + } + } + } + }, + "DatabaseAadAuthInfo": { + "description": "The extra auth info required by Database AAD authentication.", + "type": "object", + "properties": { + "userName": { + "x-nullable": true, + "description": "Username created in the database which is mapped to a user in AAD.", + "type": "string" + } + } + }, + "SecretAuthInfo": { + "x-ms-discriminator-value": "secret", + "type": "object", + "description": "The authentication info when authType is secret", + "allOf": [ + { + "$ref": "#/definitions/AuthInfoBase" + } + ], + "properties": { + "name": { + "x-nullable": true, + "description": "Username or account name for secret auth.", + "type": "string" + }, + "secretInfo": { + "x-nullable": true, + "description": "Password or key vault secret for secret auth.", + "$ref": "#/definitions/SecretInfoBase" + } + } + }, + "UserAssignedIdentityAuthInfo": { + "x-ms-discriminator-value": "userAssignedIdentity", + "type": "object", + "description": "The authentication info when authType is userAssignedIdentity", + "allOf": [ + { + "$ref": "#/definitions/AuthInfoBase" + }, + { + "$ref": "#/definitions/DatabaseAadAuthInfo" + } + ], + "properties": { + "clientId": { + "description": "Client Id for userAssignedIdentity.", + "type": "string" + }, + "subscriptionId": { + "description": "Subscription id for userAssignedIdentity.", + "type": "string" + }, + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional, this value specifies the Azure role to be assigned" + } + } + }, + "SystemAssignedIdentityAuthInfo": { + "x-ms-discriminator-value": "systemAssignedIdentity", + "type": "object", + "description": "The authentication info when authType is systemAssignedIdentity", + "allOf": [ + { + "$ref": "#/definitions/AuthInfoBase" + }, + { + "$ref": "#/definitions/DatabaseAadAuthInfo" + } + ], + "properties": { + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional, this value specifies the Azure role to be assigned" + } + } + }, + "ServicePrincipalSecretAuthInfo": { + "x-ms-discriminator-value": "servicePrincipalSecret", + "type": "object", + "description": "The authentication info when authType is servicePrincipal secret", + "allOf": [ + { + "$ref": "#/definitions/AuthInfoBase" + }, + { + "$ref": "#/definitions/DatabaseAadAuthInfo" + } + ], + "properties": { + "clientId": { + "description": "ServicePrincipal application clientId for servicePrincipal auth.", + "type": "string" + }, + "principalId": { + "description": "Principal Id for servicePrincipal auth.", + "type": "string" + }, + "secret": { + "description": "Secret for servicePrincipal auth.", + "type": "string", + "x-ms-secret": true + }, + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional, this value specifies the Azure roles to be assigned. Automatically " + } + }, + "required": [ + "clientId", + "principalId", + "secret" + ] + }, + "ServicePrincipalCertificateAuthInfo": { + "x-ms-discriminator-value": "servicePrincipalCertificate", + "type": "object", + "description": "The authentication info when authType is servicePrincipal certificate", + "allOf": [ + { + "$ref": "#/definitions/AuthInfoBase" + } + ], + "properties": { + "clientId": { + "description": "Application clientId for servicePrincipal auth.", + "type": "string" + }, + "principalId": { + "description": "Principal Id for servicePrincipal auth.", + "type": "string" + }, + "certificate": { + "description": "ServicePrincipal certificate for servicePrincipal auth.", + "type": "string", + "x-ms-secret": true + }, + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional, this value specifies the Azure roles to be assigned. Automatically " + } + }, + "required": [ + "clientId", + "principalId", + "certificate" + ] + }, + "UserAccountAuthInfo": { + "x-ms-discriminator-value": "userAccount", + "type": "object", + "description": "The authentication info when authType is user account", + "allOf": [ + { + "$ref": "#/definitions/AuthInfoBase" + }, + { + "$ref": "#/definitions/DatabaseAadAuthInfo" + } + ], + "properties": { + "principalId": { + "description": "Principal Id for user account.", + "type": "string" + }, + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional, this value specifies the Azure roles to be assigned. Automatically " + } + } + }, + "EasyAuthMicrosoftEntraIDAuthInfo": { + "x-ms-discriminator-value": "easyAuthMicrosoftEntraID", + "type": "object", + "description": "The authentication info when authType is EasyAuth Microsoft Entra ID", + "allOf": [ + { + "$ref": "#/definitions/AuthInfoBase" + } + ], + "properties": { + "clientId": { + "description": "Application clientId for EasyAuth Microsoft Entra ID.", + "type": "string" + }, + "secret": { + "description": "Application Secret for EasyAuth Microsoft Entra ID.", + "type": "string", + "x-ms-secret": true + }, + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + } + } + }, + "LinkerResource": { + "type": "object", + "description": "Linker of source and target resource", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource", + "description": "The resource model definition for an Azure Resource Manager proxy resource." + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "The properties of the Linker.", + "$ref": "#/definitions/LinkerProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "x-nullable": true, + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "The system data." + } + } + }, + "LinkerPatch": { + "description": "A Linker to be updated.", + "type": "object", + "properties": { + "properties": { + "description": "Linker properties", + "type": "object", + "x-ms-client-flatten": true, + "$ref": "#/definitions/LinkerProperties" + } + } + }, + "ResourceList": { + "description": "The list of Linker.", + "type": "object", + "properties": { + "nextLink": { + "x-nullable": true, + "description": "The Linker used to get the next page of Linker list.", + "type": "string" + }, + "value": { + "description": "The list of Linkers.", + "type": "array", + "items": { + "$ref": "#/definitions/LinkerResource" + } + } + } + }, + "LinkerProperties": { + "description": "The properties of the Linker.", + "type": "object", + "properties": { + "targetService": { + "$ref": "#/definitions/TargetServiceBase", + "description": "The target service properties" + }, + "authInfo": { + "description": "The authentication type.", + "$ref": "#/definitions/AuthInfoBase" + }, + "clientType": { + "description": "The application client type", + "$ref": "#/definitions/ClientType" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state. " + }, + "vNetSolution": { + "x-nullable": true, + "description": "The VNet solution.", + "$ref": "#/definitions/VNetSolution" + }, + "secretStore": { + "x-nullable": true, + "description": "An option to store secret value in secure place", + "$ref": "#/definitions/SecretStore" + }, + "scope": { + "x-nullable": true, + "type": "string", + "description": "connection scope in source service." + }, + "publicNetworkSolution": { + "x-nullable": true, + "description": "The network solution.", + "$ref": "#/definitions/PublicNetworkSolution" + }, + "configurationInfo": { + "x-nullable": true, + "description": "The connection information consumed by applications, including secrets, connection strings.", + "$ref": "#/definitions/ConfigurationInfo" + } + } + }, + "LinkerConfigurationType": { + "description": "Type of configuration to determine whether the configuration can be modified after creation. KeyvaultSecret means the configuration references a key vault secret, such as App Service/ACA key vault reference. Default means the configuration is real value, such as user name, raw secret, etc.", + "type": "string", + "enum": [ + "Default", + "KeyVaultSecret" + ], + "x-ms-enum": { + "name": "LinkerConfigurationType", + "modelAsString": true + } + }, + "SourceConfiguration": { + "description": "A configuration item for source resource", + "type": "object", + "properties": { + "name": { + "description": "The name of setting.", + "type": "string" + }, + "value": { + "x-nullable": true, + "description": "The value of setting", + "type": "string" + }, + "configType": { + "description": "The type of setting", + "readOnly": true, + "$ref": "#/definitions/LinkerConfigurationType" + }, + "keyVaultReferenceIdentity": { + "x-nullable": true, + "description": "The identity for key vault reference, system or user-assigned managed identity ID", + "type": "string" + }, + "description": { + "x-nullable": true, + "description": "Descriptive information for the configuration", + "type": "string" + } + } + }, + "ConfigurationNameItem": { + "type": "object", + "properties": { + "properties": { + "x-nullable": true, + "description": "The result detail.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConfigurationNames" + } + } + }, + "ConfigurationNames": { + "type": "object", + "description": "The configuration names which will be set based on specific target resource, client type, auth type.", + "properties": { + "targetService": { + "type": "string", + "description": "The target service provider name and resource name." + }, + "clientType": { + "$ref": "#/definitions/ClientType", + "description": "The client type for configuration names." + }, + "authType": { + "$ref": "#/definitions/AuthType", + "description": "The auth type." + }, + "secretType": { + "$ref": "#/definitions/SecretSourceType", + "description": "Indicates where the secrets in configuration from. Used when secrets are from Keyvault." + }, + "daprProperties": { + "description": "Deprecated, please use #/definitions/DaprConfigurationList instead", + "$ref": "#/definitions/DaprProperties" + }, + "names": { + "type": "array", + "description": "The configuration names to be set in compute service environment.", + "items": { + "$ref": "#/definitions/ConfigurationName" + } + } + } + }, + "ConfigurationName": { + "type": "object", + "description": "The configuration names.", + "properties": { + "value": { + "type": "string" + }, + "description": { + "type": "string", + "description": "Description for the configuration name." + }, + "required": { + "type": "boolean", + "description": "Represent the configuration is required or not" + } + } + }, + "ConfigurationNameResult": { + "description": "Configuration Name list which will be set based on different target resource, client type, auth type.", + "type": "object", + "properties": { + "value": { + "description": "Expected configuration names for each target service.", + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationNameItem" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ConfigurationResult": { + "description": "Configurations for source resource, include appSettings, connectionString and serviceBindings", + "type": "object", + "properties": { + "configurations": { + "description": "The configuration properties for source resource.", + "type": "array", + "items": { + "$ref": "#/definitions/SourceConfiguration" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ValidateOperationResult": { + "description": "The validation operation result for a Linker.", + "type": "object", + "properties": { + "properties": { + "x-nullable": true, + "description": "The validation result detail.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ValidateResult" + }, + "resourceId": { + "x-nullable": true, + "description": "Validated Linker id.", + "type": "string" + }, + "status": { + "x-nullable": true, + "description": "Validation operation status.", + "type": "string" + } + } + }, + "ValidateResult": { + "description": "The validation result for a Linker.", + "type": "object", + "properties": { + "linkerName": { + "x-nullable": true, + "description": "The linker name.", + "type": "string" + }, + "isConnectionAvailable": { + "x-nullable": true, + "description": "A boolean value indicating whether the connection is available or not", + "type": "boolean" + }, + "reportStartTimeUtc": { + "x-nullable": true, + "type": "string", + "format": "date-time", + "description": "The start time of the validation report." + }, + "reportEndTimeUtc": { + "x-nullable": true, + "type": "string", + "format": "date-time", + "description": "The end time of the validation report." + }, + "sourceId": { + "x-nullable": true, + "description": "The resource id of the Linker source application.", + "type": "string" + }, + "targetId": { + "x-nullable": true, + "description": "The resource Id of target service.", + "type": "string" + }, + "authType": { + "x-nullable": true, + "description": "The authentication type.", + "$ref": "#/definitions/AuthType" + }, + "validationDetail": { + "description": "The detail of validation result", + "type": "array", + "items": { + "$ref": "#/definitions/ValidationResultItem" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ValidationResultItem": { + "description": "The validation item for a Linker.", + "type": "object", + "properties": { + "name": { + "description": "The validation item name.", + "type": "string" + }, + "description": { + "x-nullable": true, + "description": "The display name of validation item", + "type": "string" + }, + "result": { + "x-nullable": true, + "description": "The result of validation", + "type": "string", + "enum": [ + "success", + "failure", + "warning" + ], + "x-ms-enum": { + "name": "ValidationResultStatus", + "modelAsString": true + } + }, + "errorMessage": { + "x-nullable": true, + "description": "The error message of validation result", + "type": "string" + }, + "errorCode": { + "x-nullable": true, + "description": "The error code of validation result", + "type": "string" + } + } + }, + "VNetSolution": { + "type": "object", + "description": "The VNet solution for linker", + "properties": { + "type": { + "x-nullable": true, + "description": "Type of VNet solution.", + "type": "string", + "enum": [ + "serviceEndpoint", + "privateLink" + ], + "x-ms-enum": { + "name": "vNetSolutionType", + "modelAsString": true + } + }, + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + } + } + }, + "PublicNetworkSolution": { + "type": "object", + "description": "Indicates public network solution, include firewall rules", + "properties": { + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation(such as firewall rules) when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + }, + "action": { + "description": "Optional. Indicates public network solution. If enable, enable public network access of target service with best try. Default is enable. If optOut, opt out public network access configuration.", + "$ref": "#/definitions/ActionType" + }, + "firewallRules": { + "description": "Describe firewall rules of target service to make sure source application could connect to the target.", + "$ref": "#/definitions/FirewallRules" + } + } + }, + "FirewallRules": { + "type": "object", + "description": "Target service's firewall rules. to allow connections from source service.", + "properties": { + "ipRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account." + }, + "azureServices": { + "description": "Allow Azure services to access the target service if true.", + "$ref": "#/definitions/AllowType" + }, + "callerClientIP": { + "description": "Allow caller client IP to access the target service if true. the property is used when connecting local application to target service.", + "$ref": "#/definitions/AllowType" + } + } + }, + "ConfigurationInfo": { + "type": "object", + "description": "The configuration information, used to generate configurations or save to applications", + "properties": { + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + }, + "action": { + "description": "Optional, indicate whether to apply configurations on source application. If enable, generate configurations and applied to the source application. Default is enable. If optOut, no configuration change will be made on source.", + "$ref": "#/definitions/ActionType" + }, + "customizedKeys": { + "description": "Optional. A dictionary of default key name and customized key name mapping. If not specified, default key name will be used for generate configurations", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "daprProperties": { + "description": "Indicates some additional properties for dapr client type", + "$ref": "#/definitions/DaprProperties" + }, + "additionalConfigurations": { + "description": "A dictionary of additional configurations to be added. Service will auto generate a set of basic configurations and this property is to full fill more customized configurations", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "additionalConnectionStringProperties": { + "description": "A dictionary of additional properties to be added in the end of connection string.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "configurationStore": { + "x-nullable": true, + "description": "An option to store configuration into different place", + "$ref": "#/definitions/ConfigurationStore" + } + } + }, + "ConfigurationStore": { + "type": "object", + "description": "An option to store configuration into different place", + "properties": { + "appConfigurationId": { + "x-nullable": true, + "type": "string", + "description": "The app configuration id to store configuration" + } + } + }, + "DaprProperties": { + "type": "object", + "description": "Indicates some additional properties for dapr client type", + "properties": { + "version": { + "x-nullable": true, + "type": "string", + "description": "The dapr component version" + }, + "componentType": { + "x-nullable": true, + "type": "string", + "description": "The dapr component type" + }, + "secretStoreComponent": { + "x-nullable": true, + "type": "string", + "description": "The name of a secret store dapr to retrieve secret" + }, + "metadata": { + "description": "Additional dapr metadata", + "type": "array", + "items": { + "$ref": "#/definitions/DaprMetadata" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "scopes": { + "description": "The dapr component scopes", + "type": "array", + "items": { + "type": "string" + } + }, + "runtimeVersion": { + "x-nullable": true, + "type": "string", + "readOnly": true, + "description": "The runtime version supported by the properties" + }, + "bindingComponentDirection": { + "x-nullable": true, + "type": "string", + "enum": [ + "input", + "output" + ], + "x-ms-enum": { + "name": "DaprBindingComponentDirection", + "modelAsString": true + }, + "readOnly": true, + "description": "The direction supported by the dapr binding component" + } + } + }, + "DaprMetadata": { + "description": "The dapr component metadata.", + "type": "object", + "properties": { + "name": { + "description": "Metadata property name.", + "type": "string" + }, + "value": { + "description": "Metadata property value.", + "type": "string" + }, + "secretRef": { + "description": "The secret name where dapr could get value", + "type": "string" + }, + "description": { + "description": "The description of the metadata, returned from configuration api", + "type": "string" + }, + "required": { + "description": "The value indicating whether the metadata is required or not", + "type": "string", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "DaprMetadataRequired", + "modelAsString": true + } + } + } + }, + "SecretStore": { + "type": "object", + "description": "An option to store secret value in secure place", + "properties": { + "keyVaultId": { + "x-nullable": true, + "type": "string", + "description": "The key vault id to store secret" + }, + "keyVaultSecretName": { + "x-nullable": true, + "type": "string", + "description": "The key vault secret name to store secret, only valid when storing one secret" + } + } + }, + "DryrunList": { + "description": "The list of dryrun.", + "type": "object", + "properties": { + "nextLink": { + "x-nullable": true, + "description": "The link used to get the next page of dryrun list.", + "type": "string" + }, + "value": { + "description": "The list of dryrun.", + "type": "array", + "items": { + "$ref": "#/definitions/DryrunResource" + } + } + } + }, + "DryrunResource": { + "type": "object", + "description": "a dryrun job resource", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource", + "description": "The resource model definition for an Azure Resource Manager proxy resource." + } + ], + "properties": { + "properties": { + "description": "The properties of the dryrun job.", + "$ref": "#/definitions/DryrunProperties", + "x-ms-client-flatten": true + } + } + }, + "DryrunPatch": { + "type": "object", + "description": "a dryrun job to be updated.", + "properties": { + "properties": { + "description": "The properties of the dryrun job.", + "$ref": "#/definitions/DryrunProperties", + "x-ms-client-flatten": true + } + } + }, + "DryrunProperties": { + "description": "The properties of the dryrun job", + "type": "object", + "properties": { + "parameters": { + "description": "The parameters of the dryrun", + "$ref": "#/definitions/DryrunParameters" + }, + "prerequisiteResults": { + "readOnly": true, + "description": "the result of the dryrun", + "type": "array", + "items": { + "$ref": "#/definitions/DryrunPrerequisiteResult" + }, + "x-ms-identifiers": [] + }, + "operationPreviews": { + "readOnly": true, + "description": "the preview of the operations for creation", + "type": "array", + "items": { + "$ref": "#/definitions/DryrunOperationPreview" + }, + "x-ms-identifiers": [] + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state. " + } + } + }, + "DryrunActionName": { + "description": "The name of action for you dryrun job.", + "type": "string", + "enum": [ + "createOrUpdate" + ], + "x-ms-enum": { + "name": "DryrunActionName", + "modelAsString": true + } + }, + "DryrunParameters": { + "description": "The parameters of the dryrun", + "discriminator": "actionName", + "type": "object", + "properties": { + "actionName": { + "$ref": "#/definitions/DryrunActionName" + } + }, + "required": [ + "actionName" + ] + }, + "CreateOrUpdateDryrunParameters": { + "x-ms-discriminator-value": "createOrUpdate", + "type": "object", + "description": "The dryrun parameters for creation or update a linker", + "allOf": [ + { + "$ref": "#/definitions/DryrunParameters" + }, + { + "$ref": "#/definitions/LinkerProperties" + } + ] + }, + "DryrunPrerequisiteResultType": { + "description": "The type of dryrun result.", + "type": "string", + "enum": [ + "basicError", + "permissionsMissing" + ], + "x-ms-enum": { + "name": "DryrunPrerequisiteResultType", + "modelAsString": true + } + }, + "DryrunPrerequisiteResult": { + "description": "A result of dryrun", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/DryrunPrerequisiteResultType" + } + }, + "required": [ + "type" + ] + }, + "BasicErrorDryrunPrerequisiteResult": { + "x-ms-discriminator-value": "basicError", + "description": "The represent of basic error", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DryrunPrerequisiteResult" + } + ], + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + } + }, + "PermissionsMissingDryrunPrerequisiteResult": { + "x-ms-discriminator-value": "permissionsMissing", + "description": "The represent of missing permissions", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DryrunPrerequisiteResult" + } + ], + "properties": { + "scope": { + "description": "The permission scope", + "type": "string" + }, + "permissions": { + "description": "The permission list", + "type": "array", + "items": { + "type": "string" + } + }, + "recommendedRole": { + "description": "The recommended role to resolve permissions missing", + "type": "string" + } + } + }, + "DryrunOperationPreview": { + "description": "The preview of the operations for creation", + "type": "object", + "properties": { + "name": { + "description": "The operation name", + "type": "string" + }, + "operationType": { + "description": "The operation type", + "type": "string", + "enum": [ + "configConnection", + "configNetwork", + "configAuth" + ], + "x-ms-enum": { + "name": "DryrunPreviewOperationType", + "modelAsString": true + } + }, + "description": { + "description": "The description of the operation", + "type": "string" + }, + "action": { + "description": "The action defined by RBAC, refer https://docs.microsoft.com/azure/role-based-access-control/role-definitions#actions-format", + "type": "string" + }, + "scope": { + "description": "The scope of the operation, refer https://docs.microsoft.com/azure/role-based-access-control/scope-overview", + "type": "string" + } + } + }, + "ActionType": { + "description": "Indicates how to apply the connector operations, such as opt out network configuration, opt in configuration.", + "type": "string", + "enum": [ + "enable", + "optOut" + ], + "x-ms-enum": { + "name": "actionType", + "modelAsString": true + } + }, + "AuthMode": { + "description": "Indicates how to apply the authentication configuration operations.", + "type": "string", + "enum": [ + "optInAllAuth", + "optOutAllAuth" + ], + "x-ms-enum": { + "name": "authMode", + "modelAsString": true, + "values": [ + { + "value": "optInAllAuth", + "description": "Default authentication configuration according to the authentication type." + }, + { + "value": "optOutAllAuth", + "description": "Skip all authentication configuration such as enabling managed identity and granting RBAC roles" + } + ] + } + }, + "AllowType": { + "description": "Whether to allow firewall rules.", + "type": "string", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "allowType", + "modelAsString": true + } + }, + "DaprConfigurationList": { + "description": "Dapr configuration list supported by Service Connector", + "type": "object", + "properties": { + "value": { + "description": "The list of dapr configurations", + "type": "array", + "items": { + "$ref": "#/definitions/DaprConfigurationResource" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "DaprConfigurationResource": { + "description": "Represent one resource of the dapr configuration list", + "type": "object", + "properties": { + "properties": { + "description": "The properties of the dapr configuration.", + "$ref": "#/definitions/DaprConfigurationProperties", + "x-ms-client-flatten": true + } + } + }, + "DaprConfigurationProperties": { + "type": "object", + "properties": { + "targetType": { + "type": "string", + "description": "Supported target resource type, extract from resource id, uppercase" + }, + "authType": { + "$ref": "#/definitions/AuthType" + }, + "daprProperties": { + "$ref": "#/definitions/DaprProperties" + } + } + } + }, + "parameters": { + "LinkerNameParameter": { + "name": "linkerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name Linker resource.", + "x-ms-parameter-location": "method" + }, + "ConnectorNameParameter": { + "name": "connectorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of resource.", + "x-ms-parameter-location": "method" + }, + "ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified Azure Resource manager identifier of the resource to be connected.", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "method" + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the target subscription.", + "minLength": 1, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/servicelinker/resource-manager/readme.md b/specification/servicelinker/resource-manager/readme.md index 96b6eb39a705..7d8caa630389 100644 --- a/specification/servicelinker/resource-manager/readme.md +++ b/specification/servicelinker/resource-manager/readme.md @@ -28,7 +28,7 @@ These are the global settings for the ServiceLinker. title: ServiceLinkerManagementClient openapi-type: arm openapi-subtype : rpaas -tag: package-2023-04-01-preview +tag: package-2024-07-01-preview ``` ### Tag: package-2021-11-01-preview @@ -85,6 +85,15 @@ input-file: - Microsoft.ServiceLinker/stable/2024-04-01/servicelinker.json ``` +### Tag: package-2024-07-01-preview + +These settings apply only when `--tag=package-2024-07-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-07-01-preview' +input-file: + - Microsoft.ServiceLinker/preview/2024-07-01-preview/servicelinker.json +``` + ## Suppression ``` yaml From 701ad5a0ab92105df6a35110f87fc146f91aeb00 Mon Sep 17 00:00:00 2001 From: abhi580 <43762309+abhi580@users.noreply.github.com> Date: Fri, 27 Sep 2024 11:32:23 +0530 Subject: [PATCH 32/48] Abhi580 migrate microsoft.migrate nonbreaking 2023 05 01 preview (#28274) * Adds base for updating Microsoft.Migrate/AssessmentProjects from version preview/2023-04-01-preview to version 2023-05-01-preview * Updates readme * Updates API version in new specs and examples * added 2023-05-01-preview changes * added prettierchecks * added prettier checks 2 * added ANF changed * handled failed checks * handled comments 2 * added supressions * fixed relative path for suppression * added final changes * fixed prettier checks * added Enum changes * added supreesion for additionalProperty and provisionaing State * added supression for UnSupportedPatchProperties * handled arm comments * changed totalStorage to float in avsSummary * added vcf BYOL changes * removed external storage ri example * fixed prettier checks * added supression for lintdiff * added final changes and handled comments * added error code fixes * fixed readme --- ...smentOperations_Create_MaximumSet_Gen.json | 146 + ...smentOperations_Delete_MaximumSet_Gen.json | 15 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 25 + ...sessmentOperations_Get_MaximumSet_Gen.json | 65 + ...istByAssessmentProject_MaximumSet_Gen.json | 73 + ...sClusterOperations_Get_MaximumSet_Gen.json | 54 + ...ns_ListByAksAssessment_MaximumSet_Gen.json | 59 + ...ns_ListByAksAssessment_MaximumSet_Gen.json | 47 + ...sOptionsOperations_Get_MaximumSet_Gen.json | 38 + ...istByAssessmentProject_MaximumSet_Gen.json | 42 + ...sSummaryOperations_Get_MaximumSet_Gen.json | 63 + ...ns_ListByAksAssessment_MaximumSet_Gen.json | 67 + ...MachinesOperations_Get_MaximumSet_Gen.json | 129 + ...tions_ListByAssessment_MaximumSet_Gen.json | 137 + ...tabaseV2Operations_Get_MaximumSet_Gen.json | 225 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 233 + ...stanceV2Operations_Get_MaximumSet_Gen.json | 474 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 505 + ...MachinesOperations_Get_MaximumSet_Gen.json | 155 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 163 + ...edEntityOperations_Get_MaximumSet_Gen.json | 330 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 330 + ...WebAppV2Operations_Get_MaximumSet_Gen.json | 63 + ...stByWebAppAssessmentV2_MaximumSet_Gen.json | 71 + ...licationOperations_Get_MaximumSet_Gen.json | 73 + ...ns_ListByAksAssessment_MaximumSet_Gen.json | 81 + ...tOptionsOperations_Get_MaximumSet_Gen.json | 3079 ++ ...istByAssessmentProject_MaximumSet_Gen.json | 3083 ++ ...tSummaryOperations_Get_MaximumSet_Gen.json | 46 + ...istByAssessmentProject_MaximumSet_Gen.json | 50 + ...jectsOperations_Create_MaximumSet_Gen.json | 144 + ...jectsOperations_Delete_MaximumSet_Gen.json | 14 + ...ProjectsOperations_Get_MaximumSet_Gen.json | 69 + ...ns_ListByResourceGroup_MaximumSet_Gen.json | 73 + ...ons_ListBySubscription_MaximumSet_Gen.json | 72 + ...jectsOperations_Update_MaximumSet_Gen.json | 88 + ...mentsOperations_Create_MaximumSet_Gen.json | 236 + ...mentsOperations_Delete_MaximumSet_Gen.json | 16 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 26 + ...essmentsOperations_Get_MaximumSet_Gen.json | 103 + ...Operations_ListByGroup_MaximumSet_Gen.json | 107 + ...MachinesOperations_Get_MaximumSet_Gen.json | 81 + ...ns_ListByAvsAssessment_MaximumSet_Gen.json | 89 + ...tOptionsOperations_Get_MaximumSet_Gen.json | 184 + ...istByAssessmentProject_MaximumSet_Gen.json | 188 + ...mentsOperations_Create_MaximumSet_Gen.json | 326 + ...mentsOperations_Delete_MaximumSet_Gen.json | 16 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 26 + ...essmentsOperations_Get_MaximumSet_Gen.json | 148 + ...Operations_ListByGroup_MaximumSet_Gen.json | 152 + ...sSummaryOperations_Get_MaximumSet_Gen.json | 269 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 273 + ...sSummaryOperations_Get_MaximumSet_Gen.json | 291 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 295 + ...rations_CompareSummary_MaximumSet_Gen.json | 185 + ...sCaseOperations_Create_MaximumSet_Gen.json | 410 + ...sCaseOperations_Delete_MaximumSet_Gen.json | 15 + ...s_GetReportDownloadUrl_MaximumSet_Gen.json | 25 + ...nessCaseOperations_Get_MaximumSet_Gen.json | 151 + ...istByAssessmentProject_MaximumSet_Gen.json | 155 + ...wSummaryOperations_Get_MaximumSet_Gen.json | 123 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 127 + ...sSummaryOperations_Get_MaximumSet_Gen.json | 252 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 256 + ...MachinesOperations_Get_MaximumSet_Gen.json | 40 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 48 + ...MachinesOperations_Get_MaximumSet_Gen.json | 40 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 48 + ...EntitiesOperations_Get_MaximumSet_Gen.json | 41 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 49 + ...dWebAppsOperations_Get_MaximumSet_Gen.json | 38 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 46 + ...roupsOperations_Create_MaximumSet_Gen.json | 85 + ...roupsOperations_Delete_MaximumSet_Gen.json | 15 + .../GroupsOperations_Get_MaximumSet_Gen.json | 44 + ...istByAssessmentProject_MaximumSet_Gen.json | 48 + ...rations_UpdateMachines_MaximumSet_Gen.json | 58 + ...ctorsOperations_Create_MaximumSet_Gen.json | 98 + ...ctorsOperations_Delete_MaximumSet_Gen.json | 15 + ...llectorsOperations_Get_MaximumSet_Gen.json | 45 + ...istByAssessmentProject_MaximumSet_Gen.json | 49 + ...ctorsOperations_Create_MaximumSet_Gen.json | 62 + ...ctorsOperations_Delete_MaximumSet_Gen.json | 15 + ...llectorsOperations_Get_MaximumSet_Gen.json | 33 + ...istByAssessmentProject_MaximumSet_Gen.json | 37 + ...MachinesOperations_Get_MaximumSet_Gen.json | 89 + ...istByAssessmentProject_MaximumSet_Gen.json | 97 + .../Operations_List_MaximumSet_Gen.json | 28 + ...ctionOperations_Delete_MaximumSet_Gen.json | 15 + ...nnectionOperations_Get_MaximumSet_Gen.json | 39 + ...istByAssessmentProject_MaximumSet_Gen.json | 43 + ...ctionOperations_Update_MaximumSet_Gen.json | 76 + ...ResourceOperations_Get_MaximumSet_Gen.json | 37 + ...istByAssessmentProject_MaximumSet_Gen.json | 41 + ...ctorsOperations_Create_MaximumSet_Gen.json | 98 + ...ctorsOperations_Delete_MaximumSet_Gen.json | 15 + ...llectorsOperations_Get_MaximumSet_Gen.json | 45 + ...istByAssessmentProject_MaximumSet_Gen.json | 49 + ...tOptionsOperations_Get_MaximumSet_Gen.json | 1635 + ...istByAssessmentProject_MaximumSet_Gen.json | 1639 + ...entV2Operations_Create_MaximumSet_Gen.json | 219 + ...entV2Operations_Delete_MaximumSet_Gen.json | 16 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 26 + ...ssmentV2Operations_Get_MaximumSet_Gen.json | 94 + ...Operations_ListByGroup_MaximumSet_Gen.json | 254 + ...2SummaryOperations_Get_MaximumSet_Gen.json | 128 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 132 + ...ectorOperations_Create_MaximumSet_Gen.json | 97 + ...ectorOperations_Delete_MaximumSet_Gen.json | 15 + ...ollectorOperations_Get_MaximumSet_Gen.json | 45 + ...istByAssessmentProject_MaximumSet_Gen.json | 49 + ...ctorsOperations_Create_MaximumSet_Gen.json | 98 + ...ctorsOperations_Delete_MaximumSet_Gen.json | 15 + ...llectorsOperations_Get_MaximumSet_Gen.json | 45 + ...istByAssessmentProject_MaximumSet_Gen.json | 49 + ...tOptionsOperations_Get_MaximumSet_Gen.json | 56 + ...istByAssessmentProject_MaximumSet_Gen.json | 60 + ...entV2Operations_Create_MaximumSet_Gen.json | 167 + ...entV2Operations_Delete_MaximumSet_Gen.json | 16 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 26 + ...ssmentV2Operations_Get_MaximumSet_Gen.json | 70 + ...Operations_ListByGroup_MaximumSet_Gen.json | 74 + ...2SummaryOperations_Get_MaximumSet_Gen.json | 61 + ...stByWebAppAssessmentV2_MaximumSet_Gen.json | 65 + ...ectorOperations_Create_MaximumSet_Gen.json | 99 + ...ectorOperations_Delete_MaximumSet_Gen.json | 15 + ...ollectorOperations_Get_MaximumSet_Gen.json | 46 + ...istByAssessmentProject_MaximumSet_Gen.json | 50 + ...cePlanV2Operations_Get_MaximumSet_Gen.json | 52 + ...stByWebAppAssessmentV2_MaximumSet_Gen.json | 60 + .../preview/2023-05-01-preview/migrate.json | 24820 ++++++++++++++++ .../migrate/resource-manager/readme.md | 32 + .../resource-manager/suppressions.yaml | 7 + 133 files changed, 46864 insertions(+) create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksClusterOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/MachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/Operations_List_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/migrate.json create mode 100644 specification/migrate/resource-manager/suppressions.yaml diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..a0d418f94535 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,146 @@ +{ + "title": "AksAssessmentOperations_Create", + "operationId": "AksAssessmentOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "resource": { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "details": { + "webAppCount": 25, + "webServerCount": 29, + "machineCount": 15, + "totalMonthlyCost": 1, + "pricesTimestamp": "2023-11-07T06:51:24.320Z", + "confidenceRatingInPercentage": 1, + "createdTimestamp": "2023-11-07T06:51:24.320Z", + "updatedTimestamp": "2023-11-07T06:51:24.320Z", + "status": "Created" + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + }, + "provisioningState": "Unknown" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment", + "name": "testaksassessment", + "type": "AKSAssessment", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "details": { + "webAppCount": 25, + "webServerCount": 29, + "machineCount": 15, + "totalMonthlyCost": 1, + "pricesTimestamp": "2023-11-07T06:51:24.320Z", + "confidenceRatingInPercentage": 1, + "createdTimestamp": "2023-11-07T06:51:24.320Z", + "updatedTimestamp": "2023-11-07T06:51:24.320Z", + "status": "Created" + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + }, + "provisioningState": "Unknown" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment", + "name": "testaksassessment", + "type": "AKSAssessment", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..a6797bf0e74c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "AksAssessmentOperations_Delete", + "operationId": "AksAssessmentOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..65bcf8c345e3 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "title": "AksAssessmentOperations_DownloadUrl", + "operationId": "AksAssessmentOperations_DownloadUrl", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "vthjjfdenyh", + "expirationTime": "2023-11-07T06:51:25.205Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..379b0af21ae4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,65 @@ +{ + "title": "AksAssessmentOperations_Get", + "operationId": "AksAssessmentOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "details": { + "webAppCount": 25, + "webServerCount": 29, + "machineCount": 15, + "totalMonthlyCost": 1, + "pricesTimestamp": "2023-11-07T06:51:24.320Z", + "confidenceRatingInPercentage": 1, + "createdTimestamp": "2023-11-07T06:51:24.320Z", + "updatedTimestamp": "2023-11-07T06:51:24.320Z", + "status": "Created" + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + }, + "provisioningState": "Unknown" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment", + "name": "testaksassessment", + "type": "AKSAssessment", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..eb1d3d3c010f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "AksAssessmentOperations_ListByAssessmentProject", + "operationId": "AksAssessmentOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "continuationToken": "polt", + "$top": 5, + "$filter": "azekdtdhupdngbqxzdppicwf", + "totalRecordCount": 18, + "projectName": "testproject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "details": { + "webAppCount": 25, + "webServerCount": 29, + "machineCount": 15, + "totalMonthlyCost": 1, + "pricesTimestamp": "2023-11-07T06:51:24.320Z", + "confidenceRatingInPercentage": 1, + "createdTimestamp": "2023-11-07T06:51:24.320Z", + "updatedTimestamp": "2023-11-07T06:51:24.320Z", + "status": "Created" + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + }, + "provisioningState": "Unknown" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment", + "name": "testaksassessment", + "type": "AKSAssessment", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksClusterOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksClusterOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..9c6a658b3732 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksClusterOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,54 @@ +{ + "title": "AksClusterOperations_Get", + "operationId": "AksClusterOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "clusterName": "testaksassessment-cluster" + }, + "responses": { + "200": { + "body": { + "properties": { + "name": "testaksassessment-cluster", + "nodePools": [ + { + "id": "testaksassessmentCostDetail", + "name": "testaksassessmentCostDetail", + "clusterName": "testaksassessment-cluster", + "mode": "User", + "osType": "Linux", + "armSkuName": "StandardDS_v2", + "nodeCount": 1, + "podCount": 1, + "monthlyCost": 10, + "podApproxMonthlyCost": 10 + } + ], + "region": "Unknown", + "userNodePoolCount": 0, + "userNodeCount": 6, + "systemNodePoolCount": 16, + "systemNodeCount": 18, + "podCount": 26, + "monthlyCost": 14 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/clusters/testaksassessment-cluster", + "name": "testaksassessment-cluster", + "type": "AKSAssessmentCluster", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..44c2cc38ac41 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json @@ -0,0 +1,59 @@ +{ + "title": "AksClusterOperations_ListByAksAssessment", + "operationId": "AksClusterOperations_ListByAksAssessment", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "$filter": "sfmesuqkmjezolfjvalm", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "name": "testaksassessment-cluster", + "nodePools": [ + { + "id": "testaksassessmentCostDetail", + "name": "testaksassessmentCostDetail", + "clusterName": "testaksassessment-cluster", + "mode": "User", + "osType": "Linux", + "armSkuName": "StandardDS_v2", + "nodeCount": 1, + "podCount": 1, + "monthlyCost": 10, + "podApproxMonthlyCost": 10 + } + ], + "region": "Unknown", + "userNodePoolCount": 0, + "userNodeCount": 6, + "systemNodePoolCount": 16, + "systemNodeCount": 18, + "podCount": 26, + "monthlyCost": 14 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/clusters/testaksassessment-cluster", + "name": "testaksassessment-cluster", + "type": "AKSAssessmentCluster", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..237b9ac37848 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json @@ -0,0 +1,47 @@ +{ + "title": "AksCostDetailOperations_ListByAksAssessment", + "operationId": "AksCostDetailOperations_ListByAksAssessment", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "$filter": "ww", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "id": "testaksassessmentCostDetail", + "name": "testaksassessmentCostDetail", + "clusterName": "testaksassessment-cluster", + "mode": "User", + "osType": "Linux", + "armSkuName": "StandardDS_v2", + "nodeCount": 16, + "podCount": 7, + "monthlyCost": 6, + "podApproxMonthlyCost": 27 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/costDetails/testaksassessmentCostDetail", + "name": "testaksassessmentCostDetail", + "type": "AKSAssessmentCostDetail", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..ae168b3c0e76 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "title": "AksOptionsOperations_Get", + "operationId": "AksOptionsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "edges": { + "AKS": { + "AzureLocation": [ + "EastAsia" + ] + } + } + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessmentOptions/default", + "name": "default", + "type": "AKSAssessmentOptions", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..4294d53b5da0 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "AksOptionsOperations_ListByAssessmentProject", + "operationId": "AksOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "edges": { + "AKS": { + "AzureLocation": [ + "EastAsia" + ] + } + } + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessmentOptions/default", + "name": "default", + "type": "AKSAssessmentOptions", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..604a335908a9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,63 @@ +{ + "title": "AksSummaryOperations_Get", + "operationId": "AksSummaryOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "summaryName": "AKS" + }, + "responses": { + "200": { + "body": { + "properties": { + "aksAssessmentSummary": { + "skuSummary": { + "StandardDS_v2": { + "count": 17, + "monthlyCost": 18 + } + }, + "webAppSummary": { + "IIS": { + "count": 17, + "monthlyCost": 18 + } + }, + "webServerSummary": { + "IIS": 13 + }, + "webAppCount": 19, + "webServerCount": 28, + "machineCount": 17, + "totalMonthlyCost": 6 + }, + "assessmentName": "testaksassessment", + "summaryName": "testaksassessmentsummary", + "suitabilityPerTarget": { + "AKS": { + "Ready": 11 + } + }, + "monthlyComputeCost": 8, + "monthlyStorageCost": 26, + "confidenceScore": 7 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/summaries/AKS", + "name": "AKS", + "type": "AKSAssessmentSummary", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..c081413b984b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json @@ -0,0 +1,67 @@ +{ + "title": "AksSummaryOperations_ListByAksAssessment", + "operationId": "AksSummaryOperations_ListByAksAssessment", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "aksAssessmentSummary": { + "skuSummary": { + "StandardDS_v2": { + "count": 17, + "monthlyCost": 18 + } + }, + "webAppSummary": { + "IIS": { + "count": 17, + "monthlyCost": 18 + } + }, + "webServerSummary": { + "IIS": 13 + }, + "webAppCount": 19, + "webServerCount": 28, + "machineCount": 17, + "totalMonthlyCost": 6 + }, + "assessmentName": "testaksassessment", + "summaryName": "testaksassessmentsummary", + "suitabilityPerTarget": { + "AKS": { + "Ready": 11 + } + }, + "monthlyComputeCost": 8, + "monthlyStorageCost": 26, + "confidenceScore": 7 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/summaries/AKS", + "name": "AKS", + "type": "AKSAssessmentSummary", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..0fcdfdae30f3 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,129 @@ +{ + "title": "AssessedMachinesOperations_Get", + "operationId": "AssessedMachinesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D8E1C413-E65F-40C0-8A7E-743D6B7A6AE9", + "resourceGroupName": "rgopenapi", + "projectName": "pavqtntysjn", + "groupName": "smawqdmhfngray", + "assessmentName": "qjlumxyqsitd", + "assessedMachineName": "oqxjeheiipjmuo" + }, + "responses": { + "200": { + "body": { + "properties": { + "errors": [], + "disks": { + "6000C297-455f-f81e-37b7-dc17da4433d4": { + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "NumberOfReadOperationsPerSecondMissing", + "recommendedDiskSize": "StandardSSD_E10", + "recommendedDiskType": "StandardSSD", + "gigabytesForRecommendedDiskSize": 17, + "recommendDiskThroughputInMbps": 13, + "recommendedDiskIops": 7, + "monthlyStorageCost": 5, + "name": "6000C297-455f-f81e-37b7-dc17da4433d4", + "displayName": "scsi0:0", + "gigabytesProvisioned": 8, + "megabytesPerSecondOfRead": 9, + "megabytesPerSecondOfWrite": 29, + "numberOfReadOperationsPerSecond": 12, + "numberOfWriteOperationsPerSecond": 28 + } + }, + "monthlyUltraStorageCost": 11, + "hostProcessor": { + "name": "Intel(R) Xeon(R) Gold 5220R CPU @ 2.20GHz", + "numberOfSockets": 2, + "numberOfCoresPerSocket": 24 + }, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 273.792, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 14.88, + "description": null + } + ], + "monthlyBandwidthCost": 4, + "monthlyStorageCost": 10, + "monthlyPremiumStorageCost": 6, + "monthlyStandardSsdStorageCost": 4, + "networkAdapters": { + "4000": { + "suitability": "Suitable", + "suitabilityDetail": "NotApplicable", + "suitabilityExplanation": "MegabytesOfDataTransmittedMissing, MegabytesOfDataRecievedMissing", + "monthlyBandwidthCosts": 4, + "netGigabytesTransmittedPerMonth": 6, + "displayName": "VM Network", + "macAddress": "00:50:56:95:98:e8", + "ipAddresses": [ + "2404:f801:4800:1c:c4c2:1cd:7154:a028" + ], + "megabytesPerSecondReceived": 10, + "megabytesPerSecondTransmitted": 24 + } + }, + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 0, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2018-10-09T00:00:00Z", + "extendedSupportEndDate": "2023-10-10T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "2024-10-08T00:00:00Z", + "extendedSecurityUpdateYear2EndDate": "2025-10-14T00:00:00Z", + "extendedSecurityUpdateYear3EndDate": "2026-10-13T00:00:00Z" + }, + "recommendedSize": "Standard_F4s_v2", + "numberOfCoresForRecommendedSize": 8, + "megabytesOfMemoryForRecommendedSize": 27, + "monthlyComputeCostForRecommendedSize": 1, + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "PercentageOfCoresUtilizedMissing", + "type": "AssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2016 or later (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-26T09:14:13.8168575Z", + "updatedTimestamp": "2023-09-26T09:14:13.8168575Z", + "displayName": "SQLTestDBVM28", + "description": null, + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app18700site/machines/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3_50150976-65ec-de99-1b54-a52710c3066e", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app18700site/vcenters/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3", + "datacenterManagementServerName": "idclab-vcen67.fareast.corp.microsoft.com", + "megabytesOfMemory": 21, + "numberOfCores": 7, + "confidenceRatingInPercentage": 14, + "percentageCoresUtilization": 24, + "percentageMemoryUtilization": 5, + "suitability": "Suitable" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1/assessedMachines/50fa865c-8c5c-4371-b7eb-5b900d7f9451", + "name": "riigi", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments/assessedMachines", + "systemData": { + "createdBy": "jsfqnyqqwykkv", + "createdByType": "sakanwar", + "createdAt": "2023-09-26T12:46:17.892Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T12:46:17.892Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..579f4b0d2fcf --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json @@ -0,0 +1,137 @@ +{ + "title": "AssessedMachinesOperations_ListByAssessment", + "operationId": "AssessedMachinesOperations_ListByAssessment", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D8E1C413-E65F-40C0-8A7E-743D6B7A6AE9", + "resourceGroupName": "rgopenapi", + "$filter": "sbkdovsfqldhdb", + "pageSize": 10, + "continuationToken": "hbyseetshbplfkjmpjhsiurqgt", + "totalRecordCount": 25, + "projectName": "sloqixzfjk", + "groupName": "kjuepxerwseq", + "assessmentName": "rhzcmubwrrkhtocsibu" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "errors": [], + "disks": { + "6000C297-455f-f81e-37b7-dc17da4433d4": { + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "NumberOfReadOperationsPerSecondMissing", + "recommendedDiskSize": "StandardSSD_E10", + "recommendedDiskType": "StandardSSD", + "gigabytesForRecommendedDiskSize": 17, + "recommendDiskThroughputInMbps": 13, + "recommendedDiskIops": 7, + "monthlyStorageCost": 5, + "name": "6000C297-455f-f81e-37b7-dc17da4433d4", + "displayName": "scsi0:0", + "gigabytesProvisioned": 8, + "megabytesPerSecondOfRead": 9, + "megabytesPerSecondOfWrite": 29, + "numberOfReadOperationsPerSecond": 12, + "numberOfWriteOperationsPerSecond": 28 + } + }, + "monthlyUltraStorageCost": 11, + "hostProcessor": { + "name": "Intel(R) Xeon(R) Gold 5220R CPU @ 2.20GHz", + "numberOfSockets": 2, + "numberOfCoresPerSocket": 24 + }, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 273.792, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 14.88, + "description": null + } + ], + "monthlyBandwidthCost": 4, + "monthlyStorageCost": 10, + "monthlyPremiumStorageCost": 6, + "monthlyStandardSsdStorageCost": 4, + "networkAdapters": { + "4000": { + "suitability": "Suitable", + "suitabilityDetail": "NotApplicable", + "suitabilityExplanation": "MegabytesOfDataTransmittedMissing, MegabytesOfDataRecievedMissing", + "monthlyBandwidthCosts": 4, + "netGigabytesTransmittedPerMonth": 6, + "displayName": "VM Network", + "macAddress": "00:50:56:95:98:e8", + "ipAddresses": [ + "2404:f801:4800:1c:c4c2:1cd:7154:a028" + ], + "megabytesPerSecondReceived": 10, + "megabytesPerSecondTransmitted": 24 + } + }, + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 0, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2018-10-09T00:00:00Z", + "extendedSupportEndDate": "2023-10-10T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "2024-10-08T00:00:00Z", + "extendedSecurityUpdateYear2EndDate": "2025-10-14T00:00:00Z", + "extendedSecurityUpdateYear3EndDate": "2026-10-13T00:00:00Z" + }, + "recommendedSize": "Standard_F4s_v2", + "numberOfCoresForRecommendedSize": 8, + "megabytesOfMemoryForRecommendedSize": 27, + "monthlyComputeCostForRecommendedSize": 1, + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "PercentageOfCoresUtilizedMissing", + "type": "AssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2016 or later (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-26T09:14:13.8168575Z", + "updatedTimestamp": "2023-09-26T09:14:13.8168575Z", + "displayName": "SQLTestDBVM28", + "description": null, + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app18700site/machines/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3_50150976-65ec-de99-1b54-a52710c3066e", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app18700site/vcenters/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3", + "datacenterManagementServerName": "idclab-vcen67.fareast.corp.microsoft.com", + "megabytesOfMemory": 21, + "numberOfCores": 7, + "confidenceRatingInPercentage": 14, + "percentageCoresUtilization": 24, + "percentageMemoryUtilization": 5, + "suitability": "Suitable" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1/assessedMachines/50fa865c-8c5c-4371-b7eb-5b900d7f9451", + "name": "riigi", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments/assessedMachines", + "systemData": { + "createdBy": "jsfqnyqqwykkv", + "createdByType": "sakanwar", + "createdAt": "2023-09-26T12:46:17.892Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T12:46:17.892Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..916961c77ed7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,225 @@ +{ + "title": "AssessedSqlDatabaseV2Operations_Get", + "operationId": "AssessedSqlDatabaseV2Operations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "assessedSqlDatabaseName": "858eb860-9e07-417c-91b6-bca1bffb3bf5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlDatabases/858eb860-9e07-417c-91b6-bca1bffb3bf5", + "name": "858eb860-9e07-417c-91b6-bca1bffb3bf5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlDatabases", + "properties": { + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "bufferCacheSizeInMB": 18.875576036866359, + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 9, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2019-07-09T00:00:00Z", + "extendedSupportEndDate": "2024-07-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "azureSqlMISuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 0.0, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "NotSuitable", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "SkuNotFound", + "issueCategory": "Issue", + "impactedObjects": [ + { + "objectName": "Finance_User10", + "objectType": "SqlDatabase" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": { + "azureSqlServiceTier": "GeneralPurpose", + "azureSqlComputeTier": "Provisioned", + "azureSqlHardwareGeneration": "Gen5", + "storageMaxSizeInMB": 1024.0, + "predictedDataSizeInMB": 10.0, + "predictedLogSizeInMB": 5.0, + "cores": 2, + "azureSqlTargetType": "AzureSqlDatabase" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 118.999824, + "monthlyStorageCost": 0.69, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [ + { + "reasoningId": "DatabaseCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsDatabaseStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "TotalStorageConsumedByDataFilesInGB", + "contextValue": "0.01" + }, + { + "contextKey": "TotalStorageConsumedByLogFilesInGB", + "contextValue": "0.005" + }, + { + "contextKey": "TotalRecommendedStorageInGB", + "contextValue": "1024" + } + ] + }, + { + "reasoningId": "MeetsProvisionedComputeTierRequirement", + "reasoningString": null, + "reasoningCategory": "ComputeTier", + "contextParameters": [ + { + "contextKey": "ComputeTier", + "contextValue": "Provisioned" + } + ] + }, + { + "reasoningId": "MeetsServiceTierRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "ServiceTier", + "contextValue": "GeneralPurpose" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "Finance_User10", + "objectType": "SqlDatabase" + } + ] + } + ] + }, + "isDatabaseHighlyAvailable": false, + "linkedAvailabilityGroupOverview": null, + "sizingCriterion": "AsOnPremises", + "machineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/machines/cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "assessedSqlInstanceArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "machineName": "SQLHAVM17", + "instanceName": "MSSQLSERVER", + "databaseName": "Finance_User10", + "databaseSizeInMB": 15.0, + "compatibilityLevel": "CompatLevel120", + "sqlDatabaseSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqldatabases/ea92ba27-3656-5370-8bcc-e5eed9d7ba5e", + "percentageCoresUtilization": 100.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0, + "confidenceRatingInPercentage": 0.0, + "createdTimestamp": "2023-09-08T05:22:34.8572031Z", + "updatedTimestamp": "2023-09-08T05:22:36.4665924Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..d1a70164a4c1 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,233 @@ +{ + "title": "AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2", + "operationId": "AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "$filter": "(contains(Properties/DatabaseName,'adv130'))", + "pageSize": 23, + "totalRecordCount": 1, + "continuationToken": null, + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlDatabases/858eb860-9e07-417c-91b6-bca1bffb3bf5", + "name": "858eb860-9e07-417c-91b6-bca1bffb3bf5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlDatabases", + "properties": { + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "bufferCacheSizeInMB": 18.875576036866359, + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 9, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2019-07-09T00:00:00Z", + "extendedSupportEndDate": "2024-07-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "azureSqlMISuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 0.0, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "NotSuitable", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "SkuNotFound", + "issueCategory": "Issue", + "impactedObjects": [ + { + "objectName": "Finance_User10", + "objectType": "SqlDatabase" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": { + "azureSqlServiceTier": "GeneralPurpose", + "azureSqlComputeTier": "Provisioned", + "azureSqlHardwareGeneration": "Gen5", + "storageMaxSizeInMB": 1024.0, + "predictedDataSizeInMB": 10.0, + "predictedLogSizeInMB": 5.0, + "cores": 2, + "azureSqlTargetType": "AzureSqlDatabase" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 118.999824, + "monthlyStorageCost": 0.69, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [ + { + "reasoningId": "DatabaseCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsDatabaseStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "TotalStorageConsumedByDataFilesInGB", + "contextValue": "0.01" + }, + { + "contextKey": "TotalStorageConsumedByLogFilesInGB", + "contextValue": "0.005" + }, + { + "contextKey": "TotalRecommendedStorageInGB", + "contextValue": "1024" + } + ] + }, + { + "reasoningId": "MeetsProvisionedComputeTierRequirement", + "reasoningString": null, + "reasoningCategory": "ComputeTier", + "contextParameters": [ + { + "contextKey": "ComputeTier", + "contextValue": "Provisioned" + } + ] + }, + { + "reasoningId": "MeetsServiceTierRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "ServiceTier", + "contextValue": "GeneralPurpose" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "Finance_User10", + "objectType": "SqlDatabase" + } + ] + } + ] + }, + "isDatabaseHighlyAvailable": false, + "linkedAvailabilityGroupOverview": null, + "sizingCriterion": "AsOnPremises", + "machineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/machines/cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "assessedSqlInstanceArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "machineName": "SQLHAVM17", + "instanceName": "MSSQLSERVER", + "databaseName": "Finance_User10", + "databaseSizeInMB": 15.0, + "compatibilityLevel": "CompatLevel120", + "sqlDatabaseSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqldatabases/ea92ba27-3656-5370-8bcc-e5eed9d7ba5e", + "percentageCoresUtilization": 100.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0, + "confidenceRatingInPercentage": 0.0, + "createdTimestamp": "2023-09-08T05:22:34.8572031Z", + "updatedTimestamp": "2023-09-08T05:22:36.4665924Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b98abfa180da --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,474 @@ +{ + "title": "AssessedSqlInstanceV2Operations_Get", + "operationId": "AssessedSqlInstanceV2Operations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "assessedSqlInstanceName": "3c6574cf-b4e1-4fdc-93db-6bbcc570dda2" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/3c6574cf-b4e1-4fdc-93db-6bbcc570dda2", + "name": "3c6574cf-b4e1-4fdc-93db-6bbcc570dda2", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlInstances", + "properties": { + "azureSqlVMSuitabilityDetails": { + "azureSqlSku": { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.56 + } + ], + "logDiskSizes": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.56 + } + ], + "azureSqlTargetType": "AzureSqlVirtualMachine" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 32.94432, + "monthlyStorageCost": 3.12, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "MigrateDataFromSourceSqlServerToVM", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "MigrateNonReplicatedDatabasesAndAutoSeedSecondaryIfNeeded", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "MigratePrimaryReplicaAndAllOtherReplicasToIaaS", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "VirtualMachineCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineMemoryRequirement", + "reasoningString": null, + "reasoningCategory": "MemoryType", + "contextParameters": [ + { + "contextKey": "BufferPoolSizeInGB", + "contextValue": "4" + }, + { + "contextKey": "RAMRecommendedInGB", + "contextValue": "8" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "CommaSeperatedManagedDisks", + "contextValue": "2 PremiumSSD(P2)" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineFamilyRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "VirtualMachineSize", + "contextValue": "standardDASv4Family" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlVirtualMachine", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "memoryInUseInMB": 4096.0, + "hasScanOccurred": true, + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "azureSqlMISuitabilityDetails": { + "azureSqlSku": { + "azureSqlServiceTier": "BusinessCritical", + "azureSqlComputeTier": "Provisioned", + "azureSqlHardwareGeneration": "Gen5", + "storageMaxSizeInMB": 32768.0, + "predictedDataSizeInMB": 112.0, + "predictedLogSizeInMB": 112.0, + "cores": 4, + "azureSqlTargetType": "AzureSqlManagedInstance" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 475.999296, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [ + { + "reasoningId": "InstanceCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "4" + } + ] + }, + { + "reasoningId": "MeetsInstanceStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "TotalStorageConsumedByDataFilesInGB", + "contextValue": "0.109" + }, + { + "contextKey": "TotalStorageConsumedByLogFilesInGB", + "contextValue": "0.109" + }, + { + "contextKey": "TotalRecommendedStorageInGB", + "contextValue": "32" + }, + { + "contextKey": "IncrementsInStorageInGB", + "contextValue": "32" + }, + { + "contextKey": "MaxAvailableStorageInGB", + "contextValue": "1024" + } + ] + }, + { + "reasoningId": "MeetsAlwaysOnInstanceReplicaRequirementWithoutSecondaries", + "reasoningString": null, + "reasoningCategory": "AlwaysOnAG", + "contextParameters": [ + { + "contextKey": "AlwaysOnDatabaseServiceTier", + "contextValue": "BusinessCritical" + } + ] + }, + { + "reasoningId": "MeetsProvisionedComputeTierRequirement", + "reasoningString": null, + "reasoningCategory": "ComputeTier", + "contextParameters": [ + { + "contextKey": "ComputeTier", + "contextValue": "Provisioned" + } + ] + }, + { + "reasoningId": "MeetsServiceTierRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "ServiceTier", + "contextValue": "BusinessCritical" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 833.165424, + "monthlyStorageCost": 24.69, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "storageTypeBasedDetails": [ + { + "storageType": "Rows", + "diskSizeInMB": 112.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + }, + { + "storageType": "Log", + "diskSizeInMB": 112.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + ], + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 34, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2021-07-13T00:00:00Z", + "extendedSupportEndDate": "2026-07-14T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "fciMetadata": null, + "availabilityReplicaSummary": { + "numberOfSynchronousReadReplicas": 0, + "numberOfSynchronousNonReadReplicas": 0, + "numberOfAsynchronousReadReplicas": 0, + "numberOfAsynchronousNonReadReplicas": 0, + "numberOfPrimaryReplicas": 6 + }, + "isClustered": false, + "isHighAvailabilityEnabled": true, + "recommendedTargetReasonings": [ + { + "reasoningId": "RecommendedWithWarningsForSQLVM", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "MigrationIssuesCount", + "contextValue": "0" + }, + { + "contextKey": "MigrationWarningsCount", + "contextValue": "1" + }, + { + "contextKey": "RecommendedCost", + "contextValue": "36.06432" + } + ] + }, + { + "reasoningId": "RecommendedCost", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "RecommendedCost", + "contextValue": "36.06432" + } + ] + } + ], + "sizingCriterion": "AsOnPremises", + "machineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/machines/184b8433-6991-45db-9f57-3dd3f6397a60", + "machineName": "SQLAGVM02", + "instanceName": "MSSQLSERVER", + "sqlInstanceSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqlservers/13c17b85-8842-4d50-a640-df0e45e56670", + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2016", + "numberOfCoresAllocated": 2, + "percentageCoresUtilization": 100.0, + "logicalDisks": [ + { + "diskId": "s:", + "diskSizeInMB": 104.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + }, + { + "diskId": "l:", + "diskSizeInMB": 104.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + }, + { + "diskId": "c:", + "diskSizeInMB": 16.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + ], + "databaseSummary": { + "numberOfUserDatabases": 6, + "totalDatabaseSizeInMB": 224.0, + "largestDatabaseSizeInMB": 144.0, + "totalDiscoveredUserDatabases": 7 + }, + "confidenceRatingInPercentage": 0.0, + "createdTimestamp": "2023-09-08T05:22:34.9353438Z", + "updatedTimestamp": "2023-09-08T05:22:35.9666076Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..e43e084aedc9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,505 @@ +{ + "title": "AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2", + "operationId": "AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "$filter": "(contains(Properties/InstanceName,'MSSQLSERVER'))", + "pageSize": 23, + "continuationToken": null, + "totalRecordCount": 1, + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/dhlodhiccy/providers/Microsoft.Migrate/assessmentprojects/dhccy30279project/groups/test_paas_pref_grp_2812/sqlAssessments/test_train_250823/assessedSqlInstances/27b94796-026e-4278-a546-664d46977c0a", + "name": "27b94796-026e-4278-a546-664d46977c0a", + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlInstances", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "properties": { + "azureSqlVMSuitabilityDetails": { + "azureSqlSku": { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [ + { + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.2 + } + ], + "logDiskSizes": [ + { + "diskType": "Premium", + "diskSize": "Premium_P3", + "diskRedundancy": "LRS", + "storageCost": 2.4 + } + ], + "azureSqlTargetType": "AzureSqlVirtualMachine" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 26.361408, + "monthlyStorageCost": 3.6, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 15.0, + "description": null + } + ], + "securitySuitability": "Suitable", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "MigrateDataFromSourceSqlServerToVM", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "MeetsVirtualMachineCpuScalingFactorRequirement", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "CoreUtilizationPercentage", + "contextValue": "0" + }, + { + "contextKey": "AllocatedCores", + "contextValue": "4" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineMemoryRequirement", + "reasoningString": null, + "reasoningCategory": "MemoryType", + "contextParameters": [ + { + "contextKey": "BufferPoolSizeInGB", + "contextValue": "0" + }, + { + "contextKey": "RAMRecommendedInGB", + "contextValue": "8" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineIOPSRequirement", + "reasoningString": null, + "reasoningCategory": "IOPSType", + "contextParameters": [ + { + "contextKey": "VirtualMachineIOPSRequiredInIOPerSec", + "contextValue": "0" + }, + { + "contextKey": "VirtualMachineUncachedDiskIOPSAvailableInIOPerSec", + "contextValue": "3200" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineIOThroughputRequirement", + "reasoningString": null, + "reasoningCategory": "ThroughputType", + "contextParameters": [ + { + "contextKey": "VirtualMachineIOThroughputRequiredInInMBPerSec", + "contextValue": "0" + }, + { + "contextKey": "VirtualMachineIOThroughputUncachedAvailableInIOPerSec", + "contextValue": "48" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "CommaSeperatedManagedDisks", + "contextValue": "1 PremiumSSD_P2,1 PremiumSSD_P3" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineFamilyRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "VirtualMachineSize", + "contextValue": "standardDASv4Family" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlVirtualMachine", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + } + ] + }, + "memoryInUseInMB": 0.0, + "hasScanOccurred": true, + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "azureSqlMISuitabilityDetails": { + "azureSqlSku": { + "azureSqlServiceTier": "GeneralPurpose", + "azureSqlComputeTier": "Provisioned", + "azureSqlHardwareGeneration": "Gen5", + "storageMaxSizeInMB": 65536.0, + "predictedDataSizeInMB": 6696.25, + "predictedLogSizeInMB": 14220.125, + "cores": 4, + "azureSqlTargetType": "AzureSqlManagedInstance" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 199.999104, + "monthlyStorageCost": 3.68, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 15.0, + "description": null + } + ], + "securitySuitability": "Suitable", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "MigrateDataFromSourceSqlServerToMI", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "MeetsInstanceCpuScalingFactorRequirement", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "CoreUtilizationPercentage", + "contextValue": "0" + }, + { + "contextKey": "AllocatedCores", + "contextValue": "4" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "4" + } + ] + }, + { + "reasoningId": "MeetsInstanceStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "TotalStorageConsumedByDataFilesInGB", + "contextValue": "6.539" + }, + { + "contextKey": "TotalStorageConsumedByLogFilesInGB", + "contextValue": "13.887" + }, + { + "contextKey": "TotalRecommendedStorageInGB", + "contextValue": "64" + }, + { + "contextKey": "IncrementsInStorageInGB", + "contextValue": "32" + }, + { + "contextKey": "MaxAvailableStorageInGB", + "contextValue": "2048" + } + ] + }, + { + "reasoningId": "MeetsInstanceIOThroughputRequirement", + "reasoningString": null, + "reasoningCategory": "ThroughputType", + "contextParameters": [ + { + "contextKey": "InstanceLevelThroughputRequiredInMBPerSec", + "contextValue": "0" + }, + { + "contextKey": "InstanceLevelThroughputAvailableInMBPerSec", + "contextValue": "10" + } + ] + }, + { + "reasoningId": "MeetsInstanceIOPSDataLogRequirement", + "reasoningString": null, + "reasoningCategory": "IOPSType", + "contextParameters": [ + { + "contextKey": "InstanceLevelIOPSRequiredInIOPerSec", + "contextValue": "0" + }, + { + "contextKey": "InstanceLevelIOPSAvailableInIOPerSec", + "contextValue": "6000" + } + ] + }, + { + "reasoningId": "MeetsProvisionedComputeTierRequirement", + "reasoningString": null, + "reasoningCategory": "ComputeTier", + "contextParameters": [ + { + "contextKey": "ComputeTier", + "contextValue": "Provisioned" + } + ] + }, + { + "reasoningId": "MeetsServiceTierRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "ServiceTier", + "contextValue": "GeneralPurpose" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 1199.994624, + "monthlyStorageCost": 7.13, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 15.0, + "description": null + } + ], + "securitySuitability": "Suitable", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "MigrateDataFromSourceSqlServerToDB", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "ServerCredentials", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "accessibilitytestdiag917", + "objectType": "ServerCredential" + } + ] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + } + ] + }, + "storageTypeBasedDetails": [ + { + "storageType": "Rows", + "diskSizeInMB": 6696.25, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + }, + { + "storageType": "Log", + "diskSizeInMB": 14220.125, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + ], + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 34, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2021-07-13T00:00:00Z", + "extendedSupportEndDate": "2026-07-14T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "fciMetadata": null, + "availabilityReplicaSummary": null, + "isClustered": false, + "isHighAvailabilityEnabled": false, + "recommendedTargetReasonings": [ + { + "reasoningId": "RecommendedForSQLVM", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "MigrationIssuesCount", + "contextValue": "0" + }, + { + "contextKey": "MigrationWarningsCount", + "contextValue": "0" + }, + { + "contextKey": "RecommendedCost", + "contextValue": "29.961408" + } + ] + }, + { + "reasoningId": "RecommendedCost", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "RecommendedCost", + "contextValue": "29.961408" + } + ] + }, + { + "reasoningId": "SQLMICost", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "SQLMICost", + "contextValue": "203.679104" + } + ] + }, + { + "reasoningId": "SQLDBCost", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "SQLDBCost", + "contextValue": "1207.124624" + } + ] + } + ], + "sizingCriterion": "PerformanceBased", + "machineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/dhlodhiccy/providers/Microsoft.Migrate/assessmentprojects/dhccy30279project/machines/daf51245-560b-4caa-9c18-5409ab93d319", + "machineName": "SQLTestDBVM46", + "instanceName": "MSSQLSERVER", + "sqlInstanceSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/dhlodhiccy/providers/microsoft.offazure/mastersites/dhccy37819mastersite/sqlsites/dhccy37819sqlsites/sqlservers/a5a6441d-9f63-463e-a720-73fecd90a2e4", + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2016", + "numberOfCoresAllocated": 4, + "percentageCoresUtilization": 0.0, + "logicalDisks": [ + { + "diskId": "d:", + "diskSizeInMB": 20916.375, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + ], + "databaseSummary": { + "numberOfUserDatabases": 12, + "totalDatabaseSizeInMB": 20916.375, + "largestDatabaseSizeInMB": 20815.0, + "totalDiscoveredUserDatabases": 12 + }, + "confidenceRatingInPercentage": 0.0, + "createdTimestamp": "2023-08-25T09:20:24.5544874Z", + "updatedTimestamp": "2023-08-25T09:20:25.2195402Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..a7fca64bc148 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,155 @@ +{ + "title": "AssessedSqlMachinesOperations_Get", + "operationId": "AssessedSqlMachinesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "assessedSqlMachineName": "cc64c9dc-b38e-435d-85ad-d509df5d92c6" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlMachines/cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "name": "cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlMachines", + "properties": { + "biosGuid": null, + "fqdn": null, + "sqlInstances": [ + { + "instanceId": "291313e5-e25f-4b6b-9f21-165a2dd03650", + "instanceName": "MSSQLSERVER", + "sqlInstanceSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqlservers/291313e5-e25f-4b6b-9f21-165a2dd03650", + "sqlInstanceEntityId": "b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2014", + "isClustered": true, + "isHighAvailabilityEnabled": true, + "sqlFciState": "Active" + } + ], + "suitabilityDetail": "PercentageOfCoresUtilizedMissing, PercentageOfMemoryUtilizedMissing", + "suitabilityExplanation": "NotApplicable", + "recommendedVmSize": "Standard_D2as_v4", + "recommendedVmFamily": "Dasv4_series", + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Mainstream", + "eta": 64, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2024-01-09T00:00:00Z", + "extendedSupportEndDate": "2029-01-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "recommendedVmSizeNumberOfCores": 2, + "recommendedVmSizeMegabytesOfMemory": 8192.0, + "monthlyComputeCost": 32.94432, + "disks": { + "6000C293-381c-8460-c29b-ef937230e629": { + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "NumberOfReadOperationsPerSecondMissing, NumberOfWriteOperationsPerSecondMissing, MegabytesPerSecondOfReadMissing, MegabytesPerSecondOfWriteMissing", + "recommendedDiskSize": "Premium_P10", + "recommendedDiskType": "Premium", + "recommendedDiskSizeGigabytes": 128, + "recommendDiskThroughputInMbps": 100.0, + "recommendedDiskIops": 500.0, + "monthlyStorageCost": 19.71, + "name": "6000C293-381c-8460-c29b-ef937230e629", + "displayName": "scsi0:0", + "gigabytesProvisioned": 100.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + }, + "networkAdapters": { + "4000": { + "suitability": "Suitable", + "suitabilityDetail": "MegabytesOfDataTransmittedMissing, MegabytesOfDataRecievedMissing", + "suitabilityExplanation": "NotApplicable", + "monthlyBandwidthCosts": 0.0, + "netGigabytesTransmittedPerMonth": 0.0, + "name": "4000", + "displayName": "VM Network", + "macAddress": "00:50:56:82:b7:83", + "ipAddresses": [ + "2404:f801:4800:20:418c:eec9:86c5:aea1", + "2404:f801:4800:20:6113:238d:17f0:b246", + "10.150.91.119", + "10.150.91.138", + "10.150.91.139" + ], + "megabytesPerSecondReceived": 0.0, + "megabytesPerSecondTransmitted": 0.0 + } + }, + "monthlyBandwidthCost": 0.0, + "monthlyStorageCost": 19.71, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "migrationGuidelines": [ + { + "guidelineId": "MigrateNodeSinceItHasActiveFCIInstance", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "UseSharedDiskWitnessForWSFCIfNeeded", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ReconfigureAnyAvailabilityGroupsAfterMigration", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "sizingCriterion": "PerformanceBased", + "type": "SqlAssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2019 (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-08T05:22:34.8416411Z", + "updatedTimestamp": "2023-09-08T05:23:39.1749465Z", + "displayName": "SQLHAVM17", + "description": "", + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/vmwaresites/fci-ankit-test6904site/machines/10-150-91-150-202bfa1a-ad9f-414f-91ff-61f5ca0540aa_5002fdf3-5889-c2f8-86e5-3119b251331b", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/VMwareSites/fci-ankit-test6904site/vcenters/10-150-91-150-202bfa1a-ad9f-414f-91ff-61f5ca0540aa", + "datacenterManagementServerName": "10.150.91.150", + "megabytesOfMemory": 4096.0, + "numberOfCores": 2, + "confidenceRatingInPercentage": 0.0, + "percentageCoresUtilization": 0.0, + "percentageMemoryUtilization": 0.0, + "suitability": "Suitable" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..06215da53218 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,163 @@ +{ + "title": "AssessedSqlMachinesOperations_ListBySqlAssessmentV2", + "operationId": "AssessedSqlMachinesOperations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "$filter": "(contains(Properties/DisplayName,'SQLHAVM17'))", + "pageSize": 23, + "totalRecordCount": 1, + "continuationToken": null, + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlMachines/cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "name": "cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlMachines", + "properties": { + "biosGuid": null, + "fqdn": null, + "sqlInstances": [ + { + "instanceId": "291313e5-e25f-4b6b-9f21-165a2dd03650", + "instanceName": "MSSQLSERVER", + "sqlInstanceSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqlservers/291313e5-e25f-4b6b-9f21-165a2dd03650", + "sqlInstanceEntityId": "b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2014", + "isClustered": true, + "isHighAvailabilityEnabled": true, + "sqlFciState": "Active" + } + ], + "suitabilityDetail": "PercentageOfCoresUtilizedMissing, PercentageOfMemoryUtilizedMissing", + "suitabilityExplanation": "NotApplicable", + "recommendedVmSize": "Standard_D2as_v4", + "recommendedVmFamily": "Dasv4_series", + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Mainstream", + "eta": 64, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2024-01-09T00:00:00Z", + "extendedSupportEndDate": "2029-01-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "recommendedVmSizeNumberOfCores": 2, + "recommendedVmSizeMegabytesOfMemory": 8192.0, + "monthlyComputeCost": 32.94432, + "disks": { + "6000C293-381c-8460-c29b-ef937230e629": { + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "NumberOfReadOperationsPerSecondMissing, NumberOfWriteOperationsPerSecondMissing, MegabytesPerSecondOfReadMissing, MegabytesPerSecondOfWriteMissing", + "recommendedDiskSize": "Premium_P10", + "recommendedDiskType": "Premium", + "recommendedDiskSizeGigabytes": 128, + "recommendDiskThroughputInMbps": 100.0, + "recommendedDiskIops": 500.0, + "monthlyStorageCost": 19.71, + "name": "6000C293-381c-8460-c29b-ef937230e629", + "displayName": "scsi0:0", + "gigabytesProvisioned": 100.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + }, + "networkAdapters": { + "4000": { + "suitability": "Suitable", + "suitabilityDetail": "MegabytesOfDataTransmittedMissing, MegabytesOfDataRecievedMissing", + "suitabilityExplanation": "NotApplicable", + "monthlyBandwidthCosts": 0.0, + "netGigabytesTransmittedPerMonth": 0.0, + "name": "4000", + "displayName": "VM Network", + "macAddress": "00:50:56:82:b7:83", + "ipAddresses": [ + "2404:f801:4800:20:418c:eec9:86c5:aea1", + "2404:f801:4800:20:6113:238d:17f0:b246", + "10.150.91.119", + "10.150.91.138", + "10.150.91.139" + ], + "megabytesPerSecondReceived": 0.0, + "megabytesPerSecondTransmitted": 0.0 + } + }, + "monthlyBandwidthCost": 0.0, + "monthlyStorageCost": 19.71, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "migrationGuidelines": [ + { + "guidelineId": "MigrateNodeSinceItHasActiveFCIInstance", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "UseSharedDiskWitnessForWSFCIfNeeded", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ReconfigureAnyAvailabilityGroupsAfterMigration", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "sizingCriterion": "PerformanceBased", + "type": "SqlAssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2019 (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-08T05:22:34.8416411Z", + "updatedTimestamp": "2023-09-08T05:23:39.1749465Z", + "displayName": "SQLHAVM17", + "description": "", + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/vmwaresites/fci-ankit-test6904site/machines/10-150-91-150-202bfa1a-ad9f-414f-91ff-61f5ca0540aa_5002fdf3-5889-c2f8-86e5-3119b251331b", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/VMwareSites/fci-ankit-test6904site/vcenters/10-150-91-150-202bfa1a-ad9f-414f-91ff-61f5ca0540aa", + "datacenterManagementServerName": "10.150.91.150", + "megabytesOfMemory": 4096.0, + "numberOfCores": 2, + "confidenceRatingInPercentage": 0.0, + "percentageCoresUtilization": 0.0, + "percentageMemoryUtilization": 0.0, + "suitability": "Suitable" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlMachines?api-version=2023-05-01-preview&pageSize=1&continuationToken=%5b%7b%22token%22%3a%22%2bRID%3a%7eOHlvANYGbAopzgkAAAAAAg%3d%3d%23RT%3a1%23TRC%3a1%23ISV%3a2%23IEO%3a65551%23QCF%3a8%23FPC%3aASnOCQAAAAACO84JAAAAAAI%3d%22%2c%22range%22%3a%7b%22min%22%3a%2205C1D9CD673390%22%2c%22max%22%3a%2205C1DFFFFFFFF4%22%7d%7d%5d&totalRecordCount=19" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..1bb7d4898f01 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,330 @@ +{ + "title": "AssessedSqlRecommendedEntityOperations_Get", + "operationId": "AssessedSqlRecommendedEntityOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "recommendedAssessedEntityName": "cc64c9dc-b38e-435d-85ad-d509df5d92c6" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/recommendedAssessedEntities/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "name": "b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/recommendedAssessedEntities", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "properties": { + "azureSqlVMSuitabilityDetails": { + "azureSqlSku": { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [], + "logDiskSizes": [], + "azureSqlTargetType": "AzureSqlVirtualMachine" + }, + "replicaAzureSqlSku": [ + { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [], + "logDiskSizes": [], + "azureSqlTargetType": "AzureSqlVirtualMachine" + } + ], + "sharedResources": { + "sharedDataDisks": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.6380000000000001 + } + ], + "sharedLogDisks": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.6380000000000001 + } + ], + "sharedTempDbDisks": [], + "numberOfMounts": 2, + "quorumWitness": { + "quorumWitnessType": "Disk" + } + }, + "monthlyComputeCost": 65.88864, + "monthlyStorageCost": 3.276, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": true, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "ProvisionInstanceAsFciOnSqlVM", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ProvisionDisksBasedOnLayoutInSku", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ProvisionSharedDiskForQuorum", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "MigrateNonReplicatedDatabasesAndAutoSeedSecondaryIfNeeded", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "VirtualMachineCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineMemoryRequirement", + "reasoningString": null, + "reasoningCategory": "MemoryType", + "contextParameters": [ + { + "contextKey": "BufferPoolSizeInGB", + "contextValue": "4" + }, + { + "contextKey": "RAMRecommendedInGB", + "contextValue": "8" + } + ] + }, + { + "reasoningId": "AlwaysOnVirtualMachineFCIDiskWitness", + "reasoningString": null, + "reasoningCategory": "AlwaysOnFCI", + "contextParameters": [] + }, + { + "reasoningId": "AlwaysOnVirtualMachineFCISharedZRSDisks", + "reasoningString": null, + "reasoningCategory": "AlwaysOnFCI", + "contextParameters": [] + }, + { + "reasoningId": "MeetsVirtualMachineStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "CommaSeperatedManagedDisks", + "contextValue": "" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineFamilyRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "VirtualMachineSize", + "contextValue": "standardDASv4Family" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlVirtualMachine", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "machineName": "FC7-SQL2K14.FPL.COM", + "instanceName": "MSSQLSERVER", + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 9, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2019-07-09T00:00:00Z", + "extendedSupportEndDate": "2024-07-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "dbCount": 217, + "discoveredDBCount": 217, + "hasScanOccurred": true, + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "azureSqlMISuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 0.0, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "NotSuitable", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "SkuNotFound", + "issueCategory": "Issue", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 25822.9618079999, + "monthlyStorageCost": 149.73, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "assessedSqlEntityArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "isClustered": true, + "isHighAvailabilityEnabled": true, + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2014", + "sizingCriterion": "AsOnPremises" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..348298f89a97 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,330 @@ +{ + "title": "AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2", + "operationId": "AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "$filter": "(contains(Properties/InstanceName,'MSSQLSERVER'))", + "pageSize": 23, + "continuationToken": null, + "totalRecordCount": 1, + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/recommendedAssessedEntities/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "name": "b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/recommendedAssessedEntities", + "properties": { + "azureSqlVMSuitabilityDetails": { + "azureSqlSku": { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [], + "logDiskSizes": [], + "azureSqlTargetType": "AzureSqlVirtualMachine" + }, + "replicaAzureSqlSku": [ + { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [], + "logDiskSizes": [], + "azureSqlTargetType": "AzureSqlVirtualMachine" + } + ], + "sharedResources": { + "sharedDataDisks": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.6380000000000001 + } + ], + "sharedLogDisks": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.6380000000000001 + } + ], + "sharedTempDbDisks": [], + "numberOfMounts": 2, + "quorumWitness": { + "quorumWitnessType": "Disk" + } + }, + "monthlyComputeCost": 65.88864, + "monthlyStorageCost": 3.276, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": true, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "ProvisionInstanceAsFciOnSqlVM", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ProvisionDisksBasedOnLayoutInSku", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ProvisionSharedDiskForQuorum", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "MigrateNonReplicatedDatabasesAndAutoSeedSecondaryIfNeeded", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "VirtualMachineCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineMemoryRequirement", + "reasoningString": null, + "reasoningCategory": "MemoryType", + "contextParameters": [ + { + "contextKey": "BufferPoolSizeInGB", + "contextValue": "4" + }, + { + "contextKey": "RAMRecommendedInGB", + "contextValue": "8" + } + ] + }, + { + "reasoningId": "AlwaysOnVirtualMachineFCIDiskWitness", + "reasoningString": null, + "reasoningCategory": "AlwaysOnFCI", + "contextParameters": [] + }, + { + "reasoningId": "AlwaysOnVirtualMachineFCISharedZRSDisks", + "reasoningString": null, + "reasoningCategory": "AlwaysOnFCI", + "contextParameters": [] + }, + { + "reasoningId": "MeetsVirtualMachineStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "CommaSeperatedManagedDisks", + "contextValue": "" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineFamilyRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "VirtualMachineSize", + "contextValue": "standardDASv4Family" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlVirtualMachine", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "machineName": "FC7-SQL2K14.FPL.COM", + "instanceName": "MSSQLSERVER", + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 9, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2019-07-09T00:00:00Z", + "extendedSupportEndDate": "2024-07-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "dbCount": 217, + "discoveredDBCount": 217, + "hasScanOccurred": true, + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "azureSqlMISuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 0.0, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "NotSuitable", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "SkuNotFound", + "issueCategory": "Issue", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 25822.9618079999, + "monthlyStorageCost": 149.73, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "assessedSqlEntityArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "isClustered": true, + "isHighAvailabilityEnabled": true, + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2014", + "sizingCriterion": "AsOnPremises" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/recommendedAssessedEntities?api-version=2023-05-01-preview&pageSize=1&continuationToken=%5b%7b%22token%22%3a%22%2bRID%3a%7eOHlvAMMvEvMxeAsAAAAABQ%3d%3d%23RT%3a1%23TRC%3a1%23ISV%3a2%23IEO%3a65567%23QCF%3a8%23FPC%3aATF4CwAAAAAFRXgLAAAAAAU%3d%22%2c%22range%22%3a%7b%22min%22%3a%2205C1D32F43775C%22%2c%22max%22%3a%2205C1DFFFFFFFFC%22%7d%7d%5d&totalRecordCount=21" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..6f7c1705b8a6 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,63 @@ +{ + "title": "AssessedWebAppV2Operations_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "AssessedWebAppV2Operations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "assessedWebAppName": "webapp1" + }, + "responses": { + "200": { + "body": { + "properties": { + "webAppType": "IIS", + "targetSpecificResult": { + "azureAppService": { + "assessmentResult": { + "appServicePlanName": "plan-001-azureappservice", + "suitability": "Suitable", + "securitySuitability": "Unknown", + "webAppSkuName": "Isolated", + "webAppSkuSize": "I1" + }, + "migrationIssues": [ + { + "issueId": "AppPoolIdentityCheck", + "issueCategory": "Info", + "issueDescriptionList": [ + "SpecificUser (SharePoint - 80), SpecificUser (SecurityTokenServiceApplicationPool)" + ] + } + ] + } + }, + "appServicePlanName": "plan-001-azureappservice,plan-001-azureappservicecontainer", + "machineName": "a404-r1w28r2-1", + "serverArmId": null, + "webServerName": "IIS Server", + "webAppName": "100%WebSite", + "discoveredWebAppId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sumukk-ccy-bcs/providers/microsoft.offazure/mastersites/sumukk-ccy-bcs9880mastersite/webappsites/sumukk-ccy-bcs9880webappsites/iiswebapplications/aa096c1b26cd80dd76e547d61d722d04e1779a9c8d95ae1baa91bdb226eb5c3d-9e55bf838a799e058f7c0478ff1029d5224456ab0a1c30f3a8779ba7bb841e88", + "discoveredMachineId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sumukk-ccy-bcs/providers/microsoft.offazure/vmwaresites/sumukk-ccy-bcs4557site/machines/idclab-vcen67-fareast-corp-micr-49743448-0440-4c6b-8300-eec352b87e73_5037cd30-828f-f362-c62c-d1715b8ede4c", + "confidenceRatingInPercentage": null, + "createdTimestamp": "2023-11-03T05:42:51.551Z", + "updatedTimestamp": "2023-11-03T05:42:51.551Z" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/assessedWebApps/e1c05a87-93c7-4b01-bf19-a4db9bf791a8", + "name": "e1c05a87-93c7-4b01-bf19-a4db9bf791a8", + "type": "Microsoft.Migrate/assessmentprojects/groups/webAppAssessments/assessedWebApps", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..e04d18b4ae19 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,71 @@ +{ + "title": "AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "AssessedWebAppV2Operations_ListByWebAppAssessmentV2", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "$filter": "", + "pageSize": 23, + "continuationToken": "pwqummugahjguraaqqssuwmxic", + "totalRecordCount": 6, + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "akgugrp2", + "assessmentName": "assess1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "webAppType": "IIS", + "targetSpecificResult": { + "azureAppService": { + "assessmentResult": { + "appServicePlanName": "plan-003-azureappservicecontainer", + "suitability": "ConditionallySuitable", + "securitySuitability": "Suitable", + "webAppSkuName": "Premium_V3", + "webAppSkuSize": "P1 v3" + }, + "migrationIssues": [ + { + "issueId": "AuthCheckContainer", + "issueCategory": "Info", + "issueDescriptionList": [ + "windowsAuthentication (/)" + ] + } + ] + } + }, + "appServicePlanName": "plan-001-azureappservice", + "machineName": "windows-2k16", + "serverArmId": null, + "webServerName": "IIS Server", + "webAppName": "Microsoft Azure Migrate App Containerization", + "discoveredWebAppId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sumukk-ccy-bcs/providers/microsoft.offazure/mastersites/sumukk-ccy-bcs9880mastersite/webappsites/sumukk-ccy-bcs9880webappsites/iiswebapplications/70c2efd9345164750ddf889a474512530466d8f7aaa85052b59a73ff6a4d41b1-ae625d98de8e57d253ae9812590de37f17f382bcd47da01c2f3f9be5350ae98e", + "discoveredMachineId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sumukk-ccy-bcs/providers/microsoft.offazure/vmwaresites/sumukk-ccy-bcs4557site/machines/idclab-vcen67-fareast-corp-micr-49743448-0440-4c6b-8300-eec352b87e73_5015ed4a-5f13-8cd3-a4d4-1ec729e836ff", + "confidenceRatingInPercentage": 11, + "createdTimestamp": "2023-11-03T05:42:51.551Z", + "updatedTimestamp": "2023-11-03T05:42:51.551Z" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/groups/akgugrp2/webAppAssessments/akgutestappsvc2/assessedWebApps/2d4423e1-9b0d-466f-a2f1-4f68adaa3c76", + "name": "2d4423e1-9b0d-466f-a2f1-4f68adaa3c76", + "type": "Microsoft.Migrate/assessmentprojects/groups/webAppAssessments/assessedWebApps", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..ce2fec0cc3a0 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "AssessedWebApplicationOperations_Get", + "operationId": "AssessedWebApplicationOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "assessedWorkload": "testaksassessmentapp" + }, + "responses": { + "200": { + "body": { + "properties": { + "suitabilityResult": { + "readiness": "Unknown", + "suitability": "NotSuitable", + "failedChecks": [ + { + "name": "check", + "behavior": "Issue", + "description": "check", + "cause": "check", + "recommendation": "upgrade IIS version", + "moreInfo": { + "title": "title", + "url": "https://www.bing.com" + } + } + ], + "suggestedMigrationTool": "None" + }, + "recommendationResult": { + "request": { + "cores": 12, + "memory": 28 + }, + "limit": { + "cores": 18, + "memory": 13 + }, + "osType": "Linux", + "clusterName": "testaksassessment-cluster", + "nodePoolId": "testaksassessmentCostDetail", + "nodePoolName": "testaksassessmentCostDetail", + "nodePoolArmSkuName": "StandardDS_v2", + "approxMonthlyCost": 3 + }, + "discoveryArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/webApps/webapp", + "displayName": "webapp", + "webServerArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/webServers/webserver", + "webServerDisplayName": "webserver", + "machineArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/machines/machine", + "machineDisplayName": "machine", + "webAppType": "IIS" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentprojects/testproject/aksAssessments/testaksassessment/assessedWebApps/testaksassessmentapp", + "name": "testaksassessmentapp", + "type": "AssessedWebApplication", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..51daadff6ff7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json @@ -0,0 +1,81 @@ +{ + "title": "AssessedWebApplicationOperations_ListByAksAssessment", + "operationId": "AssessedWebApplicationOperations_ListByAksAssessment", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "continuationToken": "gjilveslqiowaembajtj", + "$top": 13, + "$filter": "zqvpvrpvghjnxamq", + "totalRecordCount": 23, + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "suitabilityResult": { + "readiness": "Unknown", + "suitability": "NotSuitable", + "failedChecks": [ + { + "name": "check", + "behavior": "Issue", + "description": "check", + "cause": "check", + "recommendation": "upgrade IIS version", + "moreInfo": { + "title": "title", + "url": "https://www.bing.com" + } + } + ], + "suggestedMigrationTool": "None" + }, + "recommendationResult": { + "request": { + "cores": 12, + "memory": 28 + }, + "limit": { + "cores": 18, + "memory": 13 + }, + "osType": "Linux", + "clusterName": "testaksassessment-cluster", + "nodePoolId": "testaksassessmentCostDetail", + "nodePoolName": "testaksassessmentCostDetail", + "nodePoolArmSkuName": "StandardDS_v2", + "approxMonthlyCost": 3 + }, + "discoveryArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/webApps/webapp", + "displayName": "webapp", + "webServerArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/webServers/webserver", + "webServerDisplayName": "webserver", + "machineArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/machines/machine", + "machineDisplayName": "machine", + "webAppType": "IIS" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentprojects/testproject/aksAssessments/testaksassessment/assessedWebApps/testaksassessmentapp", + "name": "testaksassessmentapp", + "type": "AssessedWebApplication", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..4bf59fede16d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,3079 @@ +{ + "title": "AssessmentOptionsOperations_Get", + "operationId": "AssessmentOptionsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "assessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "vmFamilies": [ + { + "familyName": "Basic_A0_A4", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Standard_A0_A7", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Av2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "D_series", + "targetLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "ChinaEast", + "ChinaNorth", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized" + ] + }, + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dsv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "DC_Series", + "targetLocations": [ + "EastUs", + "WestEurope" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage", + "Confidential" + ] + }, + { + "familyName": "DS_series", + "targetLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "ChinaEast", + "ChinaNorth", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "DSv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Esv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ev5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Eav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Esv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Esv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ev3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ev4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "F_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized" + ] + }, + { + "familyName": "Fs_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Fsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "G_series", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "CanadaEast", + "EastUs2", + "JapanEast", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "GS_series", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "CanadaEast", + "EastUs2", + "JapanEast", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Lsv2_series", + "targetLocations": [ + "AustraliaEast", + "CentralIndia", + "CentralUs", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "StorageOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Msv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + } + ], + "reservedInstanceVmFamilies": [ + "D_series", + "Dv2_series", + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "Dv3_series", + "Dv4_series", + "Dv5_series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Edv5_series", + "Esv5_series", + "Ev5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "Esv3_series", + "Esv4_series", + "Ev3_series", + "Ev4_series", + "F_series", + "Fs_series", + "Fsv2_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "AustraliaCentral", + "AustraliaCentral2", + "CanadaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "KoreaCentral", + "KoreaSouth", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia", + "USGovIowa" + ], + "reservedInstanceSupportedCurrencies": [ + "USD", + "DKK", + "CAD", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SEK", + "GBP", + "INR", + "BRL", + "TWD", + "EUR", + "CHF", + "AUD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P", + "MSAZRUSGOV0003P" + ], + "ultraDiskVmFamilies": [ + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Dasv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Dsv3_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Dsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Dsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Dv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Esv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Ev5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Easv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Esv3_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Esv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Fs_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Fsv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Lsv2_series", + "targetLocations": [ + "CentralIndia", + "GermanyWestCentral", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Msv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + } + ], + "premiumDiskVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Ddsv4_series", + "Ddsv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "DC_Series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Esv5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Esv3_series", + "Esv4_series", + "Fs_series", + "Fsv2_series", + "GS_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "savingsPlanVmFamilies": [ + "D_series", + "Dv2_series", + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "Dv3_series", + "Dv4_series", + "Dv5_series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Edv5_series", + "Esv5_series", + "Ev5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "Esv3_series", + "Esv4_series", + "Ev3_series", + "Ev4_series", + "F_series", + "Fs_series", + "Fsv2_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "savingsPlanSupportedLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "AustraliaCentral", + "AustraliaCentral2", + "CanadaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorwayEast", + "NorwayWest", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestUs2", + "PolandCentral" + ] + }, + "type": "Microsoft.Migrate/assessmentprojects/{assessmentOptionsName}", + "name": "default", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/assessmentOptions/default", + "systemData": { + "createdBy": "asd", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "tnmop", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..85fd43eb9807 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,3083 @@ +{ + "title": "AssessmentOptionsOperations_ListByAssessmentProject", + "operationId": "AssessmentOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "A926B99C-7F4C-4556-871E-20CB8C6ADB56", + "resourceGroupName": "rgmigrate", + "projectName": "fhodvffhuoqwbysrrqbizete" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "vmFamilies": [ + { + "familyName": "Basic_A0_A4", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Standard_A0_A7", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Av2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "D_series", + "targetLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "ChinaEast", + "ChinaNorth", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized" + ] + }, + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dsv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "DC_Series", + "targetLocations": [ + "EastUs", + "WestEurope" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage", + "Confidential" + ] + }, + { + "familyName": "DS_series", + "targetLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "ChinaEast", + "ChinaNorth", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "DSv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Esv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ev5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Eav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Esv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Esv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ev3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ev4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "F_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized" + ] + }, + { + "familyName": "Fs_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Fsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "G_series", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "CanadaEast", + "EastUs2", + "JapanEast", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "GS_series", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "CanadaEast", + "EastUs2", + "JapanEast", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Lsv2_series", + "targetLocations": [ + "AustraliaEast", + "CentralIndia", + "CentralUs", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "StorageOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Msv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + } + ], + "reservedInstanceVmFamilies": [ + "D_series", + "Dv2_series", + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "Dv3_series", + "Dv4_series", + "Dv5_series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Edv5_series", + "Esv5_series", + "Ev5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "Esv3_series", + "Esv4_series", + "Ev3_series", + "Ev4_series", + "F_series", + "Fs_series", + "Fsv2_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "AustraliaCentral", + "AustraliaCentral2", + "CanadaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "KoreaCentral", + "KoreaSouth", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia", + "USGovIowa" + ], + "reservedInstanceSupportedCurrencies": [ + "USD", + "DKK", + "CAD", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SEK", + "GBP", + "INR", + "BRL", + "TWD", + "EUR", + "CHF", + "AUD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P", + "MSAZRUSGOV0003P" + ], + "ultraDiskVmFamilies": [ + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Dasv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Dsv3_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Dsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Dsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Dv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Esv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Ev5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Easv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Esv3_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Esv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Fs_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Fsv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Lsv2_series", + "targetLocations": [ + "CentralIndia", + "GermanyWestCentral", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Msv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + } + ], + "premiumDiskVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Ddsv4_series", + "Ddsv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "DC_Series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Esv5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Esv3_series", + "Esv4_series", + "Fs_series", + "Fsv2_series", + "GS_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "savingsPlanVmFamilies": [ + "D_series", + "Dv2_series", + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "Dv3_series", + "Dv4_series", + "Dv5_series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Edv5_series", + "Esv5_series", + "Ev5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "Esv3_series", + "Esv4_series", + "Ev3_series", + "Ev4_series", + "F_series", + "Fs_series", + "Fsv2_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "savingsPlanSupportedLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "AustraliaCentral", + "AustraliaCentral2", + "CanadaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorwayEast", + "NorwayWest", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestUs2", + "PolandCentral" + ] + }, + "type": "Microsoft.Migrate/assessmentprojects/{assessmentOptionsName}", + "name": "default", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/assessmentOptions/default", + "systemData": { + "createdBy": "asd", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "tnmop", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..9696871525df --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "AssessmentProjectSummaryOperations_Get", + "operationId": "AssessmentProjectSummaryOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "piyushapp1", + "projectName": "PiyushApp15328project", + "projectSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "errorSummaryAffectedEntities": [ + { + "assessmentType": "MachineAssessment", + "count": 1 + }, + { + "assessmentType": "AvsAssessment", + "count": 2 + } + ], + "numberOfPrivateEndpointConnections": 0, + "numberOfGroups": 4, + "numberOfMachines": 4, + "numberOfImportMachines": 0, + "numberOfAssessments": 2, + "lastAssessmentTimestamp": "2023-09-15T07:23:46.901Z" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/piyushapp1/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/projectSummary/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/projectSummary", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..ee2e155990e9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,50 @@ +{ + "title": "AssessmentProjectSummaryOperations_ListByAssessmentProject", + "operationId": "AssessmentProjectSummaryOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "piyushapp1", + "projectName": "PiyushApp15328project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "errorSummaryAffectedEntities": [ + { + "assessmentType": "MachineAssessment", + "count": 1 + }, + { + "assessmentType": "AvsAssessment", + "count": 2 + } + ], + "numberOfPrivateEndpointConnections": 0, + "numberOfGroups": 4, + "numberOfMachines": 4, + "numberOfImportMachines": 0, + "numberOfAssessments": 2, + "lastAssessmentTimestamp": "2023-09-15T07:23:46.901Z" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/piyushapp1/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/projectSummary/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/projectSummary", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/abcdef" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..58f9bd54652f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,144 @@ +{ + "title": "AssessmentProjectsOperations_Create", + "operationId": "AssessmentProjectsOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "resource": { + "properties": { + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..acd27b03c6a8 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "title": "AssessmentProjectsOperations_Delete", + "operationId": "AssessmentProjectsOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "A926B99C-7F4C-4556-871E-20CB8C6ADB56", + "resourceGroupName": "rgmigrate", + "projectName": "zqrsyncwahgydqvwuchkfd" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..cc5ab980f796 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,69 @@ +{ + "title": "AssessmentProjectsOperations_Get", + "operationId": "AssessmentProjectsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project" + }, + "responses": { + "200": { + "body": { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..ca1d41e95a05 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "AssessmentProjectsOperations_ListByResourceGroup", + "operationId": "AssessmentProjectsOperations_ListByResourceGroup", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects?api-version=2023-05-01-preview&%24skiptoken=1ZFNboMwEIXv4nWMCT9pihRVKGIXqirAASZ44joIG82YtGqUu9c9Rndv8Unfe3oP4fA7nKybWFQPcWze%2b3N9GrpmqD9EJT5DWLhSagYHBmd0IYGflTAZ%2fax4vfBIdgnWO1bFRWcA6VVmMchC717k6xb2soSizHNd7ndpqgjZrzSiIb8urBgmcF9AaiF%2ftxqJVWtH8uyvIWmtIQiogBmZ%2f9yRuuEY%2bA0WK%2b%2bRjuJDlma5THO5LcVGNHXXD132L9s%2fNwJoro0hNHG37v2ELn5Qn1vx%2fAU%3d" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..a03eb31ea4fa --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,72 @@ +{ + "title": "AssessmentProjectsOperations_ListBySubscription", + "operationId": "AssessmentProjectsOperations_ListBySubscription", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/abcdefg" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..52c73465808e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json @@ -0,0 +1,88 @@ +{ + "title": "AssessmentProjectsOperations_Update", + "operationId": "AssessmentProjectsOperations_Update", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "properties": { + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "properties": { + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..fcdc9440e53d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,236 @@ +{ + "title": "AssessmentsOperations_Create", + "operationId": "AssessmentsOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm1", + "resource": { + "properties": { + "eaSubscriptionId": "kwsu", + "azurePricingTier": "Standard", + "azureStorageRedundancy": "Unknown", + "reservedInstance": "None", + "azureHybridUseBenefit": "Unknown", + "linuxAzureHybridUseBenefit": "Unknown", + "azureDiskTypes": [ + "Premium", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 26 + }, + "groupType": "Default", + "assessmentType": "Unknown", + "azureLocation": "njxbwdtsxzhichsnk", + "azureOfferCode": "Unknown", + "currency": "Unknown", + "scalingFactor": 24, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "status": "Created", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "assessmentErrorSummary": {}, + "monthlyUltraStorageCost": 21, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 547.584, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 44.64, + "description": null + } + ], + "eaSubscriptionId": null, + "azurePricingTier": "Standard", + "azureStorageRedundancy": "LocallyRedundant", + "reservedInstance": "RI3Year", + "azureHybridUseBenefit": "Yes", + "linuxAzureHybridUseBenefit": "Yes", + "azureDiskTypes": [ + "Premium", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "monthlyComputeCost": 10, + "monthlyBandwidthCost": 21, + "monthlyStorageCost": 20, + "monthlyPremiumStorageCost": 13, + "monthlyStandardSsdStorageCost": 3, + "suitabilitySummary": { + "suitable": 3 + }, + "numberOfMachines": 3, + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 20 + }, + "distributionBySupportStatus": { + "extended": 3 + }, + "distributionByServicePackInsight": {}, + "distributionByOsName": { + "microsoft Windows Server 2016 or later (64-bit)": 3 + }, + "groupType": "Default", + "assessmentType": "MachineAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 24, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 28, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T09:14:05.7322406Z", + "updatedTimestamp": "2023-09-26T09:14:05.7322406Z", + "status": "Created", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1", + "name": "asm1", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-26T09:36:29.583Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T09:36:29.583Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "assessmentErrorSummary": {}, + "monthlyUltraStorageCost": 21, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 547.584, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 44.64, + "description": null + } + ], + "eaSubscriptionId": null, + "azurePricingTier": "Standard", + "azureStorageRedundancy": "LocallyRedundant", + "reservedInstance": "RI3Year", + "azureHybridUseBenefit": "Yes", + "linuxAzureHybridUseBenefit": "Yes", + "azureDiskTypes": [ + "Premium", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "monthlyComputeCost": 10, + "monthlyBandwidthCost": 21, + "monthlyStorageCost": 20, + "monthlyPremiumStorageCost": 13, + "monthlyStandardSsdStorageCost": 3, + "suitabilitySummary": { + "suitable": 3 + }, + "numberOfMachines": 3, + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 20 + }, + "distributionBySupportStatus": { + "extended": 3 + }, + "distributionByServicePackInsight": {}, + "distributionByOsName": { + "microsoft Windows Server 2016 or later (64-bit)": 3 + }, + "groupType": "Default", + "assessmentType": "MachineAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 24, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 28, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T09:14:05.7322406Z", + "updatedTimestamp": "2023-09-26T09:14:05.7322406Z", + "status": "Created", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1", + "name": "asm1", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-26T09:36:29.583Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T09:36:29.583Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..958ef8165c9d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "AssessmentsOperations_Delete", + "operationId": "AssessmentsOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..64a23188c49e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Get download URL for the assessment report.", + "operationId": "AssessmentsOperations_DownloadUrl", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm1", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "uri/uri/uri", + "expirationTime": "2023-09-26T09:36:57.114Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..04f31ac72755 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,103 @@ +{ + "title": "AssessmentsOperations_Get", + "operationId": "AssessmentsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm1" + }, + "responses": { + "200": { + "body": { + "properties": { + "assessmentErrorSummary": {}, + "monthlyUltraStorageCost": 21, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 547.584, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 44.64, + "description": null + } + ], + "eaSubscriptionId": null, + "azurePricingTier": "Standard", + "azureStorageRedundancy": "LocallyRedundant", + "reservedInstance": "RI3Year", + "azureHybridUseBenefit": "Yes", + "linuxAzureHybridUseBenefit": "Yes", + "azureDiskTypes": [ + "Premium", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "monthlyComputeCost": 10, + "monthlyBandwidthCost": 21, + "monthlyStorageCost": 20, + "monthlyPremiumStorageCost": 13, + "monthlyStandardSsdStorageCost": 3, + "suitabilitySummary": { + "suitable": 3 + }, + "numberOfMachines": 3, + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 20 + }, + "distributionBySupportStatus": { + "extended": 3 + }, + "distributionByServicePackInsight": {}, + "distributionByOsName": { + "microsoft Windows Server 2016 or later (64-bit)": 3 + }, + "groupType": "Default", + "assessmentType": "MachineAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 24, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 28, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T09:14:05.7322406Z", + "updatedTimestamp": "2023-09-26T09:14:05.7322406Z", + "status": "Created", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1", + "name": "asm1", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-26T09:36:29.583Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T09:36:29.583Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..d0611cc70e56 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json @@ -0,0 +1,107 @@ +{ + "title": "AssessmentsOperations_ListByGroup", + "operationId": "AssessmentsOperations_ListByGroup", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "assessmentErrorSummary": {}, + "monthlyUltraStorageCost": 21, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 547.584, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 44.64, + "description": null + } + ], + "eaSubscriptionId": null, + "azurePricingTier": "Standard", + "azureStorageRedundancy": "LocallyRedundant", + "reservedInstance": "RI3Year", + "azureHybridUseBenefit": "Yes", + "linuxAzureHybridUseBenefit": "Yes", + "azureDiskTypes": [ + "Premium", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "monthlyComputeCost": 10, + "monthlyBandwidthCost": 21, + "monthlyStorageCost": 20, + "monthlyPremiumStorageCost": 13, + "monthlyStandardSsdStorageCost": 3, + "suitabilitySummary": { + "suitable": 3 + }, + "numberOfMachines": 3, + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 20 + }, + "distributionBySupportStatus": { + "extended": 3 + }, + "distributionByServicePackInsight": {}, + "distributionByOsName": { + "microsoft Windows Server 2016 or later (64-bit)": 3 + }, + "groupType": "Default", + "assessmentType": "MachineAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 24, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 28, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T09:14:05.7322406Z", + "updatedTimestamp": "2023-09-26T09:14:05.7322406Z", + "status": "Created", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1", + "name": "asm1", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-26T09:36:29.583Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T09:36:29.583Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..044fcc80ff5d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,81 @@ +{ + "title": "AvsAssessedMachinesOperations_Get", + "operationId": "AvsAssessedMachinesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2", + "avsAssessedMachineName": "b6d6fc6f-796f-4c16-96af-a6d22e0f12f7" + }, + "responses": { + "200": { + "body": { + "properties": { + "errors": [], + "disks": { + "6000C297-455f-f81e-37b7-dc17da4433d4": { + "name": "6000C297-455f-f81e-37b7-dc17da4433d4", + "displayName": "scsi0:0", + "gigabytesProvisioned": 80.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0, + "assessedExternalStorageType": "AnfPremium", + "estimatedDiskSizeInGB": 14, + "suitabilityDetail": "None" + } + }, + "networkAdapters": { + "4000": { + "macAddress": "00:50:56:95:7a:57", + "ipAddresses": [ + "2404:f801:4800:25:38fe:66de:64e4:5a26", + "10.150.9.214" + ], + "displayName": "VM Network", + "megabytesPerSecondReceived": 0.0, + "megabytesPerSecondTransmitted": 0.0 + } + }, + "storageInUseGB": 0.0, + "suitabilityExplanation": "IpV6NotSupported", + "suitabilityDetail": "None", + "type": "AvsAssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2016 or later (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-26T13:35:59.2324082Z", + "updatedTimestamp": "2023-09-26T13:35:59.2324082Z", + "displayName": "CustomerAE24Feb", + "description": "Microsoft Azure Migration Image on Windows Server 2016", + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app18700site/machines/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3_501505aa-baaa-af9d-8315-5a45209fd255", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app18700site/vcenters/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3", + "datacenterManagementServerName": "idclab-vcen67.fareast.corp.microsoft.com", + "megabytesOfMemory": 32768.0, + "numberOfCores": 8, + "confidenceRatingInPercentage": null, + "percentageCoresUtilization": 0.0, + "percentageMemoryUtilization": 0.0, + "suitability": "ConditionallySuitable" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2/avsAssessedMachines/18895660-c5e5-4247-8cfc-cd24e1fe57f3", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments/avsAssessedMachines", + "name": "18895660-c5e5-4247-8cfc-cd24e1fe57f3", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..9c4d52535114 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json @@ -0,0 +1,89 @@ +{ + "title": "AvsAssessedMachinesOperations_ListByAvsAssessment", + "operationId": "AvsAssessedMachinesOperations_ListByAvsAssessment", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2", + "$filter": "ujmwhhuloficljxcjyc", + "pageSize": 6, + "continuationToken": "qwrjeiukbcicfrkqlqsfukfc", + "totalRecordCount": 19 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "errors": [], + "disks": { + "6000C297-455f-f81e-37b7-dc17da4433d4": { + "name": "6000C297-455f-f81e-37b7-dc17da4433d4", + "displayName": "scsi0:0", + "gigabytesProvisioned": 80.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0, + "assessedExternalStorageType": "AnfPremium", + "estimatedDiskSizeInGB": 14, + "suitabilityDetail": "None" + } + }, + "networkAdapters": { + "4000": { + "macAddress": "00:50:56:95:7a:57", + "ipAddresses": [ + "2404:f801:4800:25:38fe:66de:64e4:5a26", + "10.150.9.214" + ], + "displayName": "VM Network", + "megabytesPerSecondReceived": 0.0, + "megabytesPerSecondTransmitted": 0.0 + } + }, + "storageInUseGB": 0.0, + "suitabilityExplanation": "IpV6NotSupported", + "suitabilityDetail": "None", + "type": "AvsAssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2016 or later (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-26T13:35:59.2324082Z", + "updatedTimestamp": "2023-09-26T13:35:59.2324082Z", + "displayName": "CustomerAE24Feb", + "description": "Microsoft Azure Migration Image on Windows Server 2016", + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app18700site/machines/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3_501505aa-baaa-af9d-8315-5a45209fd255", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app18700site/vcenters/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3", + "datacenterManagementServerName": "idclab-vcen67.fareast.corp.microsoft.com", + "megabytesOfMemory": 32768.0, + "numberOfCores": 8, + "confidenceRatingInPercentage": null, + "percentageCoresUtilization": 0.0, + "percentageMemoryUtilization": 0.0, + "suitability": "ConditionallySuitable" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2/avsAssessedMachines/18895660-c5e5-4247-8cfc-cd24e1fe57f3", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments/avsAssessedMachines", + "name": "18895660-c5e5-4247-8cfc-cd24e1fe57f3", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..1d4e5ae2b06e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,184 @@ +{ + "title": "AvsAssessmentOptionsOperations_Get", + "operationId": "AvsAssessmentOptionsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "avsAssessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "avsNodes": [ + { + "nodeType": "AV36", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + }, + { + "nodeType": "AV36P", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "EastUs2", + "WestUs", + "QatarCentral", + "WestEurope" + ] + }, + { + "nodeType": "AV52", + "targetLocations": [ + "WestEurope", + "UkSouth", + "EastUs2" + ] + } + ], + "avsExternalStorageTypes": [ + { + "storageType": "AnfStandard", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + }, + { + "storageType": "AnfPremium", + "targetLocations": [ + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + } + ], + "failuresToTolerateAndRaidLevelValues": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt2Raid1", + "Ftt2Raid6", + "Ftt3Raid1" + ], + "reservedInstanceAvsNodes": [ + "AV36", + "AV36P", + "AV52" + ], + "reservedInstanceSupportedLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral", + "WestUs2", + "QatarCentral" + ], + "reservedInstanceSupportedCurrencies": [ + "USD", + "DKK", + "CAD", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SEK", + "GBP", + "INR", + "BRL", + "TWD", + "EUR", + "CHF", + "AUD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P" + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/avsAssessmentOptions/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/{assessmentOptionsName}", + "systemData": { + "createdBy": "asd", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "tnmop", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..d6d5f7e75d2c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,188 @@ +{ + "title": "AvsAssessmentOptionsOperations_ListByAssessmentProject", + "operationId": "AvsAssessmentOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "avsNodes": [ + { + "nodeType": "AV36", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + }, + { + "nodeType": "AV36P", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "EastUs2", + "WestUs", + "QatarCentral", + "WestEurope" + ] + }, + { + "nodeType": "AV52", + "targetLocations": [ + "WestEurope", + "UkSouth", + "EastUs2" + ] + } + ], + "avsExternalStorageTypes": [ + { + "storageType": "AnfStandard", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + }, + { + "storageType": "AnfPremium", + "targetLocations": [ + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + } + ], + "failuresToTolerateAndRaidLevelValues": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt2Raid1", + "Ftt2Raid6", + "Ftt3Raid1" + ], + "reservedInstanceAvsNodes": [ + "AV36", + "AV36P", + "AV52" + ], + "reservedInstanceSupportedLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral", + "WestUs2", + "QatarCentral" + ], + "reservedInstanceSupportedCurrencies": [ + "USD", + "DKK", + "CAD", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SEK", + "GBP", + "INR", + "BRL", + "TWD", + "EUR", + "CHF", + "AUD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P" + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/avsAssessmentOptions/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/{assessmentOptionsName}", + "systemData": { + "createdBy": "asd", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "tnmop", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..8443a2476cc4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,326 @@ +{ + "title": "AvsAssessmentsOperations_Create", + "operationId": "AvsAssessmentsOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2", + "resource": { + "properties": { + "failuresToTolerateAndRaidLevel": "Unknown", + "failuresToTolerateAndRaidLevelList": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt3Raid1" + ], + "vcpuOversubscription": 4.0, + "nodeType": "Unknown", + "nodeTypes": [ + "AV36", + "AV52", + "AV36P", + "AV64" + ], + "avsAssessmentScenario": "NewAvsSddc", + "externalStorageTypes": [ + "AnfStandard", + "AnfPremium", + "AnfUltra" + ], + "isVcfByolEnabled": true, + "reservedInstance": "RI3Year", + "suitability": "Unknown", + "suitabilityExplanation": "Unknown", + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "isStretchClusterEnabled": true, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "status": "Created", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "failuresToTolerateAndRaidLevel": "Unknown", + "failuresToTolerateAndRaidLevelList": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt3Raid1" + ], + "vcpuOversubscription": 4.0, + "nodeType": "Unknown", + "nodeTypes": [ + "AV36", + "AV36P", + "AV52" + ], + "avsAssessmentScenario": "NewAvsSddc", + "externalStorageTypes": [ + "AnfStandard", + "AnfPremium", + "AnfUltra" + ], + "isVcfByolEnabled": true, + "costComponents": [ + { + "name": "MonthlyAvsNodeCost", + "value": 9088.5, + "description": "Monthly Cost of AVS Nodes." + }, + { + "name": "MonthlyAvsExternalStorageCost", + "value": 600.0, + "description": "Monthly AVS External Storage Cost for Assessment." + }, + { + "name": "MonthlyAvsNetworkCost", + "value": 120, + "description": "Monthly AVS Cost of Network." + }, + { + "name": "MonthlyVcfByolCostDifference", + "value": 7088.5, + "description": "Monthly compute cost difference between VCF BYOL and non VCF BYOL SKUs" + } + ], + "reservedInstance": "RI3Year", + "totalMonthlyCost": 9808.5, + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "numberOfNodes": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 77.43, + "totalCpuCores": 108.0, + "totalRamInGB": 1728.0, + "totalStorageInGB": 48128.0, + "numberOfMachines": 3, + "avsEstimatedNodes": [ + { + "monthlyPrice": 9088.5, + "nodeType": "AV36", + "nodeNumber": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 76.99, + "totalCpu": 108.0, + "totalRam": 1728.0, + "totalStorage": 46080.0, + "pricingModel": "RI3Year", + "fttRaidLevel": "Ftt1Raid1" + } + ], + "avsEstimatedExternalStorages": [ + { + "monthlyPrice": 250.0, + "storageType": "AnfStandard", + "totalStorageInGB": 1024.0, + "storageUtilization": 97.0 + }, + { + "monthlyPrice": 350.0, + "storageType": "AnfPremium", + "totalStorageInGB": 1024.0, + "storageUtilization": 78.0 + } + ], + "avsEstimatedNetworks": [ + { + "monthlyPrice": 120, + "networkType": "ExpressRouteUltra" + } + ], + "suitabilitySummary": { + "conditionallySuitable": 3 + }, + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "limitingFactor": "Storage", + "assessmentErrorSummary": {}, + "isStretchClusterEnabled": false, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "confidenceRatingInPercentage": 100.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T13:35:56.5983656Z", + "updatedTimestamp": "2023-09-26T13:36:01.1699411Z", + "status": "Completed", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2", + "name": "asm2", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "failuresToTolerateAndRaidLevel": "Unknown", + "failuresToTolerateAndRaidLevelList": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt3Raid1" + ], + "vcpuOversubscription": 4.0, + "nodeType": "Unknown", + "avsAssessmentScenario": "NewAvsSddc", + "nodeTypes": [ + "AV36", + "AV52", + "AV36P" + ], + "externalStorageTypes": [ + "AnfStandard", + "AnfPremium", + "AnfUltra" + ], + "isVcfByolEnabled": true, + "costComponents": [ + { + "name": "MonthlyAvsNodeCost", + "value": 9088.5, + "description": "Monthly Cost of AVS Nodes." + }, + { + "name": "MonthlyExternalStorageCost", + "value": 600.0, + "description": "Monthly External Storage Cost for Assessment." + }, + { + "name": "MonthlyNetworkCost", + "value": 120, + "description": "Monthly Cost of Network." + } + ], + "reservedInstance": "RI3Year", + "totalMonthlyCost": 9808.5, + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "numberOfNodes": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 77.43, + "totalCpuCores": 108.0, + "totalRamInGB": 1728.0, + "totalStorageInGB": 48128.0, + "numberOfMachines": 3, + "avsEstimatedNodes": [ + { + "monthlyPrice": 9088.5, + "nodeType": "AV36", + "nodeNumber": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 76.99, + "totalCpu": 108.0, + "totalRam": 1728.0, + "totalStorage": 46080.0, + "pricingModel": "RI3Year", + "fttRaidLevel": "Ftt1Raid1" + } + ], + "avsEstimatedExternalStorages": [ + { + "monthlyPrice": 250.0, + "storageType": "AnfStandard", + "totalStorageInGB": 1024.0, + "storageUtilization": 97.0 + }, + { + "monthlyPrice": 350.0, + "storageType": "AnfPremium", + "totalStorageInGB": 1024.0, + "storageUtilization": 78.0 + } + ], + "avsEstimatedNetworks": [ + { + "monthlyPrice": 120, + "networkType": "ExpressRouteUltra" + } + ], + "suitabilitySummary": { + "conditionallySuitable": 3 + }, + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "limitingFactor": "Storage", + "assessmentErrorSummary": {}, + "isStretchClusterEnabled": false, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "confidenceRatingInPercentage": 100.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T13:35:56.5983656Z", + "updatedTimestamp": "2023-09-26T13:36:01.1699411Z", + "status": "Completed", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2", + "name": "asm2", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..376b0f0cf896 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "AvsAssessmentsOperations_Delete", + "operationId": "AvsAssessmentsOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..d0832a337560 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Get download URL for the assessment report.", + "operationId": "AvsAssessmentsOperations_DownloadUrl", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "fagqmlysjfwtt", + "expirationTime": "2023-09-15T07:22:40.818Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..220145e6ff94 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,148 @@ +{ + "title": "AvsAssessmentsOperations_Get", + "operationId": "AvsAssessmentsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2" + }, + "responses": { + "200": { + "body": { + "properties": { + "failuresToTolerateAndRaidLevel": "Unknown", + "failuresToTolerateAndRaidLevelList": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt3Raid1" + ], + "vcpuOversubscription": 4.0, + "nodeType": "Unknown", + "avsAssessmentScenario": "NewAvsSddc", + "nodeTypes": [ + "AV36", + "AV36P", + "AV52" + ], + "externalStorageTypes": [ + "AnfStandard", + "AnfPremium", + "AnfUltra" + ], + "isVcfByolEnabled": true, + "costComponents": [ + { + "name": "MonthlyAvsNodeCost", + "value": 9088.5, + "description": "Monthly Cost of AVS Nodes." + }, + { + "name": "MonthlyAvsExternalStorageCost", + "value": 600.0, + "description": "Monthly AVS External Storage Cost for Assessment." + }, + { + "name": "MonthlyAvsNetworkCost", + "value": 120, + "description": "Monthly AVS Cost of Network." + }, + { + "name": "MonthlyVcfByolCostDifference", + "value": 7088.5, + "description": "Monthly compute cost difference between VCF BYOL and non VCF BYOL SKUs" + } + ], + "reservedInstance": "RI3Year", + "totalMonthlyCost": 9808.5, + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "numberOfNodes": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 77.43, + "totalCpuCores": 108.0, + "totalRamInGB": 1728.0, + "totalStorageInGB": 48128.0, + "numberOfMachines": 3, + "avsEstimatedNodes": [ + { + "monthlyPrice": 9088.5, + "nodeType": "AV36", + "nodeNumber": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 76.99, + "totalCpu": 108.0, + "totalRam": 1728.0, + "totalStorage": 46080.0, + "pricingModel": "RI3Year", + "fttRaidLevel": "Ftt1Raid1" + } + ], + "avsEstimatedExternalStorages": [ + { + "monthlyPrice": 250.0, + "storageType": "AnfStandard", + "totalStorageInGB": 1024.0, + "storageUtilization": 97.0 + }, + { + "monthlyPrice": 350.0, + "storageType": "AnfPremium", + "totalStorageInGB": 1024.0, + "storageUtilization": 78.0 + } + ], + "avsEstimatedNetworks": [ + { + "monthlyPrice": 120, + "networkType": "ExpressRouteUltra" + } + ], + "suitabilitySummary": { + "conditionallySuitable": 3 + }, + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "limitingFactor": "Storage", + "assessmentErrorSummary": {}, + "isStretchClusterEnabled": false, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "confidenceRatingInPercentage": 100.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T13:35:56.5983656Z", + "updatedTimestamp": "2023-09-26T13:36:01.1699411Z", + "status": "Completed", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2", + "name": "asm2", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments", + "systemData": { + "createdBy": "sjghfaivpyryuvovuvcqegaorvhp", + "createdByType": "User", + "createdAt": "2024-02-15T18:24:02.548Z", + "lastModifiedBy": "fjkmzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-15T18:24:02.548Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..2914243e803b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json @@ -0,0 +1,152 @@ +{ + "title": "AvsAssessmentsOperations_ListByGroup", + "operationId": "AvsAssessmentsOperations_ListByGroup", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "failuresToTolerateAndRaidLevel": "Unknown", + "failuresToTolerateAndRaidLevelList": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt3Raid1" + ], + "vcpuOversubscription": 4.0, + "nodeType": "Unknown", + "avsAssessmentScenario": "NewAvsSddc", + "nodeTypes": [ + "AV36", + "AV36P", + "AV52" + ], + "externalStorageTypes": [ + "AnfStandard", + "AnfPremium", + "AnfUltra" + ], + "isVcfByolEnabled": true, + "costComponents": [ + { + "name": "MonthlyAvsNodeCost", + "value": 9088.5, + "description": "Monthly Cost of AVS Nodes." + }, + { + "name": "MonthlyAvsExternalStorageCost", + "value": 600.0, + "description": "Monthly AVS External Storage Cost for Assessment." + }, + { + "name": "MonthlyAvsNetworkCost", + "value": 120, + "description": "Monthly AVS Cost of Network." + }, + { + "name": "MonthlyVcfByolCostDifference", + "value": 7088.5, + "description": "Monthly compute cost difference between VCF BYOL and non VCF BYOL SKUs" + } + ], + "reservedInstance": "RI3Year", + "totalMonthlyCost": 9808.5, + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "numberOfNodes": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 77.43, + "totalCpuCores": 108.0, + "totalRamInGB": 1728.0, + "totalStorageInGB": 48128.0, + "numberOfMachines": 3, + "avsEstimatedNodes": [ + { + "monthlyPrice": 9088.5, + "nodeType": "AV36", + "nodeNumber": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 76.99, + "totalCpu": 108.0, + "totalRam": 1728.0, + "totalStorage": 46080.0, + "pricingModel": "RI3Year", + "fttRaidLevel": "Ftt1Raid1" + } + ], + "avsEstimatedExternalStorages": [ + { + "monthlyPrice": 250.0, + "storageType": "AnfStandard", + "totalStorageInGB": 1024.0, + "storageUtilization": 97.0 + }, + { + "monthlyPrice": 350.0, + "storageType": "AnfPremium", + "totalStorageInGB": 1024.0, + "storageUtilization": 78.0 + } + ], + "avsEstimatedNetworks": [ + { + "monthlyPrice": 120, + "networkType": "ExpressRouteUltra" + } + ], + "suitabilitySummary": { + "conditionallySuitable": 3 + }, + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "limitingFactor": "Storage", + "assessmentErrorSummary": {}, + "isStretchClusterEnabled": false, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "confidenceRatingInPercentage": 100.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T13:35:56.5983656Z", + "updatedTimestamp": "2023-09-26T13:36:01.1699411Z", + "status": "Completed", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2", + "name": "asm2", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments", + "systemData": { + "createdBy": "sjghfaivpyryuvovuvcqegaorvhp", + "createdByType": "User", + "createdAt": "2024-02-15T18:24:02.548Z", + "lastModifiedBy": "fjkmzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-15T18:24:02.548Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..893a17d43ac3 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,269 @@ +{ + "title": "BusinessCaseAvsSummaryOperations_Get", + "operationId": "BusinessCaseAvsSummaryOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "avsSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "azureAvsSummary": { + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "avsNodeSummary": { + "serversSuitableForMigration": 28, + "totalNumberOfServers": 4, + "cores": 17, + "memoryGb": 19, + "avsNodeCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "linuxAhubSavings": 18, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "estimatedCost": 29, + "osLicensingCost": 18, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedAvsNodeTypeSummary": [ + { + "avsNodeType": "AV36", + "numberOfNodes": 16, + "failuresToTolerateAndRaidLevel": "Ftt1Raid1" + } + ], + "estimatedExternalStorage": [ + { + "storageType": "AnfStandard", + "totalStorageInGB": 1024.0, + "storageUtilization": 97.0, + "totalStorageCost": 250 + }, + { + "storageType": "AnfPremium", + "totalStorageInGB": 1024.0, + "storageUtilization": 99.0, + "totalStorageCost": 350 + } + ], + "estimatedNetwork": [ + { + "skuType": "ExpressRouteUltra", + "cost": 200 + } + ], + "estimatedCostWithVcfByol": 24.0 + }, + "avsCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "linuxAhubSavings": 18, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + }, + "onPremisesAvsSummary": { + "servers": 29, + "cores": 26, + "memoryGb": 4, + "cpuUtilization": 24, + "memoryUtilization": 10, + "storageUtilization": 26, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesIaasCostForDecommissioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "osLicensingDetails": [ + { + "osType": "Windows", + "totalCost": 11, + "decomissionCost": 29 + } + ], + "distributionByOperatingSystem": [ + { + "osClassificationType": "WindowsOSInSupport", + "count": 4 + } + ], + "onPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionByVirtualization": [ + { + "virtualizationType": "Vmware", + "count": 30 + } + ], + "iaasOsSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "iaasSqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "distributionByOperatingSystemVersion": [ + { + "type": "Microsoft Windows Server 2016 Datacenter", + "count": 27 + } + ], + "distributionBySqlVersion": [ + { + "type": "SQL Server 2012", + "count": 27 + } + ], + "distributionBySqlEdition": [ + { + "type": "Enterprise Evaluation Edition", + "count": 27 + } + ] + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/avsSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/avsSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..db75126ff536 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,273 @@ +{ + "title": "BusinessCaseAvsSummaryOperations_ListByBusinessCase", + "operationId": "BusinessCaseAvsSummaryOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "azureAvsSummary": { + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "avsNodeSummary": { + "serversSuitableForMigration": 28, + "totalNumberOfServers": 4, + "cores": 17, + "memoryGb": 19, + "avsNodeCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "linuxAhubSavings": 18, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "estimatedCost": 29, + "osLicensingCost": 18, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedAvsNodeTypeSummary": [ + { + "avsNodeType": "AV36", + "numberOfNodes": 16, + "failuresToTolerateAndRaidLevel": "Ftt1Raid1" + } + ], + "estimatedExternalStorage": [ + { + "storageType": "AnfStandard", + "totalStorageInGB": 1024.0, + "storageUtilization": 97.0, + "totalStorageCost": 250 + }, + { + "storageType": "AnfPremium", + "totalStorageInGB": 1024.0, + "storageUtilization": 99.0, + "totalStorageCost": 350 + } + ], + "estimatedNetwork": [ + { + "skuType": "ExpressRouteUltra", + "cost": 200 + } + ], + "estimatedCostWithVcfByol": 24.0 + }, + "avsCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "linuxAhubSavings": 18, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + }, + "onPremisesAvsSummary": { + "servers": 29, + "cores": 26, + "memoryGb": 4, + "cpuUtilization": 24, + "memoryUtilization": 10, + "storageUtilization": 26, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesIaasCostForDecommissioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "osLicensingDetails": [ + { + "osType": "Windows", + "totalCost": 11, + "decomissionCost": 29 + } + ], + "distributionByOperatingSystem": [ + { + "osClassificationType": "WindowsOSInSupport", + "count": 4 + } + ], + "onPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionByVirtualization": [ + { + "virtualizationType": "Vmware", + "count": 30 + } + ], + "iaasOsSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "iaasSqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "distributionByOperatingSystemVersion": [ + { + "type": "Microsoft Windows Server 2016 Datacenter", + "count": 27 + } + ], + "distributionBySqlVersion": [ + { + "type": "SQL Server 2012", + "count": 27 + } + ], + "distributionBySqlEdition": [ + { + "type": "Enterprise Evaluation Edition", + "count": 27 + } + ] + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/avsSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/avsSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..1d7482a205d5 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,291 @@ +{ + "title": "BusinessCaseIaasSummaryOperations_Get", + "operationId": "BusinessCaseIaasSummaryOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "iaasSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "azureIaasSummary": { + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "azureIaasVmSummary": { + "serversSuitableForMigration": 15, + "totalNumberOfServers": 27, + "cores": 6, + "memoryGb": 26, + "azureVmCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "estimatedCost": 19, + "osLicensingCost": 12, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedVmFamilySummary": [ + { + "azureVmFamily": "Standard_F4", + "numberOfMachines": 26 + } + ], + "costByStorageType": [ + { + "storageType": "StandardSsd", + "cost": 12 + } + ] + }, + "azureIaasSqlSummary": { + "totalSqlEntities": 7, + "suitableSqlEntities": 21, + "azureSqlCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "estimatedCost": 23, + "osLicensingCost": 8, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedVmFamilySummary": [ + { + "azureVmFamily": "Standard_F4", + "numberOfMachines": 26 + } + ], + "costByStorageType": [ + { + "storageType": "StandardSsd", + "cost": 12 + } + ] + }, + "azureIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + }, + "onPremisesIaasSummary": { + "servers": 29, + "cores": 26, + "memoryGb": 4, + "cpuUtilization": 24, + "memoryUtilization": 10, + "storageUtilization": 26, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesIaasCostForDecommissioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "osLicensingDetails": [ + { + "osType": "Windows", + "totalCost": 11, + "decomissionCost": 29 + } + ], + "distributionByOperatingSystem": [ + { + "osClassificationType": "LinuxOSInSupport", + "count": 4 + } + ], + "onPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionByVirtualization": [ + { + "virtualizationType": "Vmware", + "count": 30 + } + ], + "iaasOsSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "iaasSqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "distributionByOperatingSystemVersion": [ + { + "type": "Ubuntu", + "count": 27 + } + ], + "distributionBySqlVersion": [ + { + "type": "SQL Server 2012", + "count": 27 + } + ], + "distributionBySqlEdition": [ + { + "type": "Enterprise Evaluation Edition", + "count": 27 + } + ] + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/iaasSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/iaasSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..c17c6c692c91 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,295 @@ +{ + "title": "BusinessCaseIaasSummaryOperations_ListByBusinessCase", + "operationId": "BusinessCaseIaasSummaryOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "azureIaasSummary": { + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "azureIaasVmSummary": { + "serversSuitableForMigration": 15, + "totalNumberOfServers": 27, + "cores": 6, + "memoryGb": 26, + "azureVmCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "estimatedCost": 19, + "osLicensingCost": 12, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedVmFamilySummary": [ + { + "azureVmFamily": "Standard_F4", + "numberOfMachines": 26 + } + ], + "costByStorageType": [ + { + "storageType": "StandardSsd", + "cost": 12 + } + ] + }, + "azureIaasSqlSummary": { + "totalSqlEntities": 7, + "suitableSqlEntities": 21, + "azureSqlCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "estimatedCost": 23, + "osLicensingCost": 8, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedVmFamilySummary": [ + { + "azureVmFamily": "Standard_F4", + "numberOfMachines": 26 + } + ], + "costByStorageType": [ + { + "storageType": "StandardSsd", + "cost": 12 + } + ] + }, + "azureIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + }, + "onPremisesIaasSummary": { + "servers": 29, + "cores": 26, + "memoryGb": 4, + "cpuUtilization": 24, + "memoryUtilization": 10, + "storageUtilization": 26, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesIaasCostForDecommissioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "osLicensingDetails": [ + { + "osType": "Windows", + "totalCost": 11, + "decomissionCost": 29 + } + ], + "distributionByOperatingSystem": [ + { + "osClassificationType": "LinuxOSInSupport", + "count": 4 + } + ], + "onPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionByVirtualization": [ + { + "virtualizationType": "Vmware", + "count": 30 + } + ], + "iaasOsSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "iaasSqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "distributionByOperatingSystemVersion": [ + { + "type": "Ubuntu", + "count": 27 + } + ], + "distributionBySqlVersion": [ + { + "type": "SQL Server 2012", + "count": 27 + } + ], + "distributionBySqlEdition": [ + { + "type": "Enterprise Evaluation Edition", + "count": 27 + } + ] + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/iaasSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/iaasSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json new file mode 100644 index 000000000000..e3f35a21e286 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json @@ -0,0 +1,185 @@ +{ + "title": "Get Compare summary report for Business case.", + "operationId": "BusinessCaseOperations_CompareSummary", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "body": {} + }, + "responses": { + "200": { + "body": { + "azurePaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "azureIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "azureAvsCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesPaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesAvsCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesPaasDecommissionedCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesIaasDecommissionedCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesAvsDecommissionedCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..86c849d71731 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,410 @@ +{ + "title": "BusinessCaseOperations_Create", + "operationId": "BusinessCaseOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "resource": { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 83, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-11-08T07:10:07.764Z", + "performanceDataEndTime": "2023-11-08T07:10:07.764Z", + "comfortFactor": 29, + "performanceUtilizationPercentile": 4, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 83, + "wacc": 79, + "networkCostPercentage": 40, + "iaasLaborCostPercentage": 94, + "paasLaborCostPercentage": 47, + "avsLaborCostPercentage": 0, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 12, + "price": 16, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 27, + "softwareAssuranceCost": 16 + } + ], + "windowsServerLicensing": { + "licenseCost": 9, + "softwareAssuranceCost": 1, + "licensesPerCore": 11 + }, + "rhelLinuxServerLicensing": { + "licenseCost": 9 + }, + "suseLinuxServerLicensing": { + "licenseCost": 9 + }, + "virtualizationSoftwareSettings": { + "numberOfPhysicalCoresPerLicense": 17, + "softwareAssuranceCost": 14, + "licenseAndSupportList": [ + { + "licenseType": "VSphereStandard", + "licenseCost": 8, + "basicSupportCost": 22, + "productionSupportCost": 22 + } + ] + } + }, + "storageSettings": { + "costPerGbPerMonth": 22, + "maintainanceCostPercentageToAcquisitionCost": 1 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 50, + "maintenanceCostPercentage": 48 + }, + "facilitySettings": { + "facilitiesCost": 7 + }, + "laborSettings": { + "physicalServersPerAdmin": 6, + "virtualMachinesPerAdmin": 24, + "hourlyAdminCost": 25 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 14, + "sqlServerSecurityCostPerServerPerYear": 7 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 2, + "softwareAssuranceCost": 11, + "licenseAndSupportList": [ + { + "licenseCost": 4, + "licenseType": "Standard" + } + ] + }, + "vsphereManagementSettings": { + "licenseAndSupportList": [ + { + "licenseType": "VSphereServerStandard", + "licenseCost": 6, + "basicSupportCost": 1, + "productionSupportCost": 18 + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 23, + "supportCost": 9 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 10, + "patchingCostPerServerPerYear": 18, + "dataProtectionCostPerServerPerYear": 18 + } + } + } + }, + "state": "InProgress" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 83, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-11-08T07:10:07.764Z", + "performanceDataEndTime": "2023-11-08T07:10:07.764Z", + "comfortFactor": 29, + "performanceUtilizationPercentile": 4, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 83, + "wacc": 79, + "networkCostPercentage": 40, + "iaasLaborCostPercentage": 94, + "paasLaborCostPercentage": 47, + "avsLaborCostPercentage": 0, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 12, + "price": 16, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 27, + "softwareAssuranceCost": 16 + } + ], + "windowsServerLicensing": { + "licenseCost": 9, + "softwareAssuranceCost": 1, + "licensesPerCore": 11 + }, + "rhelLinuxServerLicensing": { + "licenseCost": 9 + }, + "suseLinuxServerLicensing": { + "licenseCost": 9 + }, + "virtualizationSoftwareSettings": { + "numberOfPhysicalCoresPerLicense": 17, + "softwareAssuranceCost": 14, + "licenseAndSupportList": [ + { + "licenseType": "VSphereStandard", + "licenseCost": 8, + "basicSupportCost": 22, + "productionSupportCost": 22 + } + ] + } + }, + "storageSettings": { + "costPerGbPerMonth": 22, + "maintainanceCostPercentageToAcquisitionCost": 1 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 50, + "maintenanceCostPercentage": 48 + }, + "facilitySettings": { + "facilitiesCost": 7 + }, + "laborSettings": { + "physicalServersPerAdmin": 6, + "virtualMachinesPerAdmin": 24, + "hourlyAdminCost": 25 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 14, + "sqlServerSecurityCostPerServerPerYear": 7 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 2, + "softwareAssuranceCost": 11, + "licenseAndSupportList": [ + { + "licenseCost": 4, + "licenseType": "Standard" + } + ] + }, + "vsphereManagementSettings": { + "licenseAndSupportList": [ + { + "licenseType": "VSphereServerStandard", + "licenseCost": 6, + "basicSupportCost": 1, + "productionSupportCost": 18 + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 23, + "supportCost": 9 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 10, + "patchingCostPerServerPerYear": 18, + "dataProtectionCostPerServerPerYear": 18 + } + } + } + }, + "state": "Completed", + "reportStatusDetails": [ + { + "reportType": "Excel", + "reportStatus": "Completed" + } + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case", + "name": "sample-business-case", + "type": "Microsoft.Migrate/assessmentProjects/businessCases", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 83, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-11-08T07:10:07.764Z", + "performanceDataEndTime": "2023-11-08T07:10:07.764Z", + "comfortFactor": 29, + "performanceUtilizationPercentile": 4, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 83, + "wacc": 79, + "networkCostPercentage": 40, + "iaasLaborCostPercentage": 94, + "paasLaborCostPercentage": 47, + "avsLaborCostPercentage": 0, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 12, + "price": 16, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 27, + "softwareAssuranceCost": 16 + } + ], + "windowsServerLicensing": { + "licenseCost": 9, + "softwareAssuranceCost": 1, + "licensesPerCore": 11 + }, + "rhelLinuxServerLicensing": { + "licenseCost": 9 + }, + "suseLinuxServerLicensing": { + "licenseCost": 9 + }, + "virtualizationSoftwareSettings": { + "numberOfPhysicalCoresPerLicense": 17, + "softwareAssuranceCost": 14, + "licenseAndSupportList": [ + { + "licenseType": "VSphereStandard", + "licenseCost": 8, + "basicSupportCost": 22, + "productionSupportCost": 22 + } + ] + } + }, + "storageSettings": { + "costPerGbPerMonth": 22, + "maintainanceCostPercentageToAcquisitionCost": 1 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 50, + "maintenanceCostPercentage": 48 + }, + "facilitySettings": { + "facilitiesCost": 7 + }, + "laborSettings": { + "physicalServersPerAdmin": 6, + "virtualMachinesPerAdmin": 24, + "hourlyAdminCost": 25 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 14, + "sqlServerSecurityCostPerServerPerYear": 7 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 2, + "softwareAssuranceCost": 11, + "licenseAndSupportList": [ + { + "licenseCost": 4, + "licenseType": "Standard" + } + ] + }, + "vsphereManagementSettings": { + "licenseAndSupportList": [ + { + "licenseType": "VSphereServerStandard", + "licenseCost": 6, + "basicSupportCost": 1, + "productionSupportCost": 18 + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 23, + "supportCost": 9 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 10, + "patchingCostPerServerPerYear": 18, + "dataProtectionCostPerServerPerYear": 18 + } + } + } + }, + "state": "Completed", + "reportStatusDetails": [ + { + "reportType": "Excel", + "reportStatus": "Completed" + } + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case", + "name": "sample-business-case", + "type": "Microsoft.Migrate/assessmentProjects/businessCases", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..02c258c77124 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "BusinessCaseOperations_Delete", + "operationId": "BusinessCaseOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..215c3249743e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "title": "Get download URL for the business case report.", + "operationId": "BusinessCaseOperations_GetReportDownloadUrl", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "body": {} + }, + "responses": { + "200": { + "body": { + "businessCaseReportUrl": "mxwaejake", + "expirationTime": "2023-11-08T07:10:20.491Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..0cc302e6c3df --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,151 @@ +{ + "title": "BusinessCaseOperations_Get", + "operationId": "BusinessCaseOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 52, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-10-05T11:57:41.237Z", + "performanceDataEndTime": "2023-10-05T11:57:41.237Z", + "comfortFactor": 8, + "performanceUtilizationPercentile": 64, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 44, + "wacc": 5, + "networkCostPercentage": 71, + "iaasLaborCostPercentage": 73, + "paasLaborCostPercentage": 50, + "avsLaborCostPercentage": 69, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 5, + "price": 14, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 14, + "softwareAssuranceCost": 13 + } + ], + "windowsServerLicensing": { + "licenseCost": 13, + "softwareAssuranceCost": 14, + "licensesPerCore": 8 + }, + "rhelLinuxServerLicensing": { + "licenseCost": 9 + }, + "suseLinuxServerLicensing": { + "licenseCost": 9 + }, + "virtualizationSoftwareSettings": { + "numberOfPhysicalCoresPerLicense": 11, + "softwareAssuranceCost": 28, + "licenseAndSupportList": [ + { + "licenseType": "VSphereStandard", + "licenseCost": 16, + "basicSupportCost": 7, + "productionSupportCost": 25 + } + ] + } + }, + "storageSettings": { + "costPerGbPerMonth": 15, + "maintainanceCostPercentageToAcquisitionCost": 91 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 79, + "maintenanceCostPercentage": 82 + }, + "facilitySettings": { + "facilitiesCost": 12 + }, + "laborSettings": { + "physicalServersPerAdmin": 30, + "virtualMachinesPerAdmin": 1, + "hourlyAdminCost": 15 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 2, + "sqlServerSecurityCostPerServerPerYear": 23 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 21, + "softwareAssuranceCost": 1, + "licenseAndSupportList": [ + { + "licenseCost": 12, + "licenseType": "Standard" + } + ] + }, + "vsphereManagementSettings": { + "licenseAndSupportList": [ + { + "licenseType": "VSphereServerStandard", + "licenseCost": 9, + "basicSupportCost": 11, + "productionSupportCost": 24 + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 6, + "supportCost": 2 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 15, + "patchingCostPerServerPerYear": 15, + "dataProtectionCostPerServerPerYear": 28 + } + } + } + }, + "state": "Completed", + "reportStatusDetails": [ + { + "reportType": "Excel", + "reportStatus": "Completed" + } + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5E8485F1-A440-404E-9F91-AFAC5A9993B2/resourceGroups/rgv2023-05-01-preview/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case", + "name": "sample-business-case", + "type": "Microsoft.Migrate/assessmentProjects/businessCases", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-10-05T11:57:41.238Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-05T11:57:41.238Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..b572a90d604f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,155 @@ +{ + "title": "BusinessCaseOperations_ListByAssessmentProject", + "operationId": "BusinessCaseOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 52, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-10-05T11:57:41.237Z", + "performanceDataEndTime": "2023-10-05T11:57:41.237Z", + "comfortFactor": 8, + "performanceUtilizationPercentile": 64, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 44, + "wacc": 5, + "networkCostPercentage": 71, + "iaasLaborCostPercentage": 73, + "paasLaborCostPercentage": 50, + "avsLaborCostPercentage": 69, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 5, + "price": 14, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 14, + "softwareAssuranceCost": 13 + } + ], + "windowsServerLicensing": { + "licenseCost": 13, + "softwareAssuranceCost": 14, + "licensesPerCore": 8 + }, + "rhelLinuxServerLicensing": { + "licenseCost": 9 + }, + "suseLinuxServerLicensing": { + "licenseCost": 9 + }, + "virtualizationSoftwareSettings": { + "numberOfPhysicalCoresPerLicense": 11, + "softwareAssuranceCost": 28, + "licenseAndSupportList": [ + { + "licenseType": "VSphereStandard", + "licenseCost": 16, + "basicSupportCost": 7, + "productionSupportCost": 25 + } + ] + } + }, + "storageSettings": { + "costPerGbPerMonth": 15, + "maintainanceCostPercentageToAcquisitionCost": 91 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 79, + "maintenanceCostPercentage": 82 + }, + "facilitySettings": { + "facilitiesCost": 12 + }, + "laborSettings": { + "physicalServersPerAdmin": 30, + "virtualMachinesPerAdmin": 1, + "hourlyAdminCost": 15 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 2, + "sqlServerSecurityCostPerServerPerYear": 23 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 21, + "softwareAssuranceCost": 1, + "licenseAndSupportList": [ + { + "licenseCost": 12, + "licenseType": "Standard" + } + ] + }, + "vsphereManagementSettings": { + "licenseAndSupportList": [ + { + "licenseType": "VSphereServerStandard", + "licenseCost": 9, + "basicSupportCost": 11, + "productionSupportCost": 24 + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 6, + "supportCost": 2 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 15, + "patchingCostPerServerPerYear": 15, + "dataProtectionCostPerServerPerYear": 28 + } + } + } + }, + "state": "Completed", + "reportStatusDetails": [ + { + "reportType": "Excel", + "reportStatus": "Completed" + } + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5E8485F1-A440-404E-9F91-AFAC5A9993B2/resourceGroups/rgv2023-05-01-preview/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/businessCase1", + "name": "businessCase1", + "type": "Microsoft.Migrate/assessmentProjects/businessCases", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-10-05T11:57:41.238Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-05T11:57:41.238Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..cb0486793f9f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,123 @@ +{ + "title": "BusinessCaseOverviewSummaryOperations_Get", + "operationId": "BusinessCaseOverviewSummaryOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "overviewSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "totalAzureCost": 20, + "totalAzureIaasCost": 29, + "totalAzurePaasCost": 18, + "totalAzureAvsCost": 21, + "windowsAhubSavings": 26, + "linuxAhubSavings": 26, + "sqlAhubSavings": 29, + "totalOnPremisesCost": 20, + "esuSavingsFor4years": 20, + "managementCostSavings": 19, + "securityCostSavings": 8, + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "serversDiscovered": { + "vmWare": 6, + "hyperV": 28, + "physical": 16, + "notApplicable": 13 + }, + "utilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "iaasOsDistribution": { + "windows": 5, + "linux": 22, + "other": 14 + }, + "osSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "sqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "paasDistribution": { + "sqlServers": 28, + "iisWebServers": 9, + "webAppDistribution": { + "key683": 28 + } + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/overviewSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/overviewSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..8b85ff7b12ce --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,127 @@ +{ + "title": "BusinessCaseOverviewSummaryOperations_ListByBusinessCase", + "operationId": "BusinessCaseOverviewSummaryOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "totalAzureCost": 20, + "totalAzureIaasCost": 29, + "totalAzurePaasCost": 18, + "totalAzureAvsCost": 21, + "windowsAhubSavings": 26, + "linuxAhubSavings": 26, + "sqlAhubSavings": 29, + "totalOnPremisesCost": 20, + "esuSavingsFor4years": 20, + "managementCostSavings": 19, + "securityCostSavings": 8, + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "serversDiscovered": { + "vmWare": 6, + "hyperV": 28, + "physical": 16, + "notApplicable": 13 + }, + "utilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "iaasOsDistribution": { + "windows": 5, + "linux": 22, + "other": 14 + }, + "osSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "sqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "paasDistribution": { + "sqlServers": 28, + "iisWebServers": 9, + "webAppDistribution": { + "key683": 28 + } + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/overviewSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/overviewSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..96f3b16c2228 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,252 @@ +{ + "title": "BusinessCasePaasSummaryOperations_Get", + "operationId": "BusinessCasePaasSummaryOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "paasSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "azure": { + "totalSqlEntities": 1, + "suitableSqlEntities": 8, + "totalWebApps": 22, + "suitableWebApps": 8, + "cores": 3, + "memory": 29, + "storage": 8, + "estimatedCostByTarget": { + "azureSqlMiCost": 27, + "azureSqlDbCost": 6, + "appServiceCost": 5, + "appServiceContainerCost": 23, + "azureKubernetesServiceCost": 22 + }, + "estimatedSqlServerLicensingCost": 18, + "azureSqlSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "distributionByServiceTier": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ], + "distributionByServiceTierForSqlMi": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ], + "distributionByServiceTierForSqlDb": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ] + }, + "azureAppServiceSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 6, + "count": 27 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "azureAppServiceContainerSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 14, + "count": 30 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "azureKubernetesServiceSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 14, + "count": 30 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "totalAzurePaasCost": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + }, + "onPremises": { + "totalServers": 29, + "cpuUtilization": 18, + "memoryUtilization": 14, + "totalOnPremisesPaasCost": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesPaasCostForDecommisioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesPaasLicensingCost": { + "version": null, + "totalCost": 29, + "decomissionServerCost": 1 + }, + "onPremisesSqlSummary": { + "sqlInstances": 26, + "sqlDatabases": 21, + "distributionBySqlVersion": [ + { + "sqlVersion": "SQL Server 2019", + "numberOfInstances": 20 + } + ], + "sqlOnPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionBySqlEdition": [ + { + "type": "Enterprise Edition (64-bit)", + "count": 27 + } + ] + }, + "onPremisesWebAppSummary": { + "numberOfWebServers": 1, + "numberOfWebApplications": 27, + "numberOfWebAppsPerType": { + "key2586": 28 + } + }, + "osSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "sqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + } + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/paasSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/paasSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..9ee7b6b127b4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,256 @@ +{ + "title": "BusinessCasePaasSummaryOperations_ListByBusinessCase", + "operationId": "BusinessCasePaasSummaryOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "azure": { + "totalSqlEntities": 1, + "suitableSqlEntities": 8, + "totalWebApps": 22, + "suitableWebApps": 8, + "cores": 3, + "memory": 29, + "storage": 8, + "estimatedCostByTarget": { + "azureSqlMiCost": 27, + "azureSqlDbCost": 6, + "appServiceCost": 5, + "appServiceContainerCost": 23, + "azureKubernetesServiceCost": 22 + }, + "estimatedSqlServerLicensingCost": 18, + "azureSqlSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "distributionByServiceTier": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ], + "distributionByServiceTierForSqlMi": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ], + "distributionByServiceTierForSqlDb": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ] + }, + "azureAppServiceSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 6, + "count": 27 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "azureAppServiceContainerSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 14, + "count": 30 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "azureKubernetesServiceSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 14, + "count": 30 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "totalAzurePaasCost": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + }, + "onPremises": { + "totalServers": 29, + "cpuUtilization": 18, + "memoryUtilization": 14, + "totalOnPremisesPaasCost": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesPaasCostForDecommisioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesPaasLicensingCost": { + "version": null, + "totalCost": 29, + "decomissionServerCost": 1 + }, + "onPremisesSqlSummary": { + "sqlInstances": 26, + "sqlDatabases": 21, + "distributionBySqlVersion": [ + { + "sqlVersion": "SQL Server 2019", + "numberOfInstances": 20 + } + ], + "sqlOnPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionBySqlEdition": [ + { + "type": "Enterprise Edition (64-bit)", + "count": 27 + } + ] + }, + "onPremisesWebAppSummary": { + "numberOfWebServers": 1, + "numberOfWebApplications": 27, + "numberOfWebAppsPerType": { + "key2586": 28 + } + }, + "osSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "sqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + } + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/paasSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/paasSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..2c2eb7cd6b53 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "EvaluatedAvsMachinesOperations_Get", + "operationId": "EvaluatedAvsMachinesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "evaluatedAvsMachineName": "a404-r1w16-1.FPL.COM" + }, + "responses": { + "200": { + "body": { + "properties": { + "machineId": "a404-r1w16-1.FPL.COM", + "serverName": "a404-r1w16-1.FPL.COM", + "virtualizationType": "Vmware", + "activityState": "inconclusive", + "operatingSystemName": "Ubuntu", + "recommendedAzureTarget": "AzureVm", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedavsmachine/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedavsmachine", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..064037b1ffab --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "EvaluatedAvsMachinesOperations_ListByBusinessCase", + "operationId": "EvaluatedAvsMachinesOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "$filter": "zcwvgkjkvddoylnfkgclpytp", + "pageSize": 9, + "continuationToken": "er", + "totalRecordCount": 2, + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "machineId": "a404-r1w16-1.FPL.COM", + "serverName": "a404-r1w16-1.FPL.COM", + "virtualizationType": "Vmware", + "activityState": "inconclusive", + "operatingSystemName": "Ubuntu", + "recommendedAzureTarget": "AzureVm", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedavsmachine/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedavsmachine", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..fc339892f0fd --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "EvaluatedMachinesOperations_Get", + "operationId": "EvaluatedMachinesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "evaluatedMachineName": "a404-r1w16-1.FPL.COM" + }, + "responses": { + "200": { + "body": { + "properties": { + "machineId": "a404-r1w16-1.FPL.COM", + "serverName": "a404-r1w16-1.FPL.COM", + "virtualizationType": "Vmware", + "activityState": "inconclusive", + "operatingSystemName": "Ubuntu", + "recommendedAzureTarget": "AzureVm", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedmachine/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedmachine", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..35ed7d9ee09f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "EvaluatedMachinesOperations_ListByBusinessCase", + "operationId": "EvaluatedMachinesOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "$filter": "fyiccra", + "pageSize": 16, + "continuationToken": "mipqzxorbubmdjm", + "totalRecordCount": 28, + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "machineId": "a404-r1w16-1.FPL.COM", + "serverName": "a404-r1w16-1.FPL.COM", + "virtualizationType": "Vmware", + "activityState": "inconclusive", + "operatingSystemName": "Ubuntu", + "recommendedAzureTarget": "AzureVm", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedmachine/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedmachine", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..46dd3278c512 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "EvaluatedSqlEntitiesOperations_Get", + "operationId": "EvaluatedSqlEntitiesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "evaluatedSqlEntityName": "a404-r1w16-1.FPL.COM" + }, + "responses": { + "200": { + "body": { + "properties": { + "serverName": "a404-r1w16-1.FPL.COM", + "activityState": "active", + "sqlVersion": null, + "sqlEdition": null, + "recommendedAzureTarget": "AzureVirtualMachine", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "virtualizationType": "Vmware", + "dbCount": 1, + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedsqlentity/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedsqlentity", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..84d57567bd54 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "EvaluatedSqlEntitiesOperations_ListByBusinessCase", + "operationId": "EvaluatedSqlEntitiesOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "$filter": "rukrirndrwnypcf", + "pageSize": 13, + "continuationToken": "bqkhzxsvqhnarrffqtgeytrznivh", + "totalRecordCount": 12, + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "serverName": "a404-r1w16-1.FPL.COM", + "activityState": "active", + "sqlVersion": null, + "sqlEdition": null, + "recommendedAzureTarget": "AzureVirtualMachine", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "virtualizationType": "Vmware", + "dbCount": 1, + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedsqlentity/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedsqlentity", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..25cc686cab57 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "title": "EvaluatedWebAppsOperations_Get", + "operationId": "EvaluatedWebAppsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "evaluatedWebAppName": "a404-r1w16-1.FPL.COM" + }, + "responses": { + "200": { + "body": { + "properties": { + "recommendedAzureTarget": "AzureVm", + "recommendedAzureSkuName": "Premium_V3", + "recommendedAzureSkuSize": "P1 v3", + "serverName": "a404-r1w16-1.FPL.COM", + "workload": "WebApps", + "activityState": "active", + "readyForMigration": "Ready" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedwebapp/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedwebapp", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..b35da02ac34c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "EvaluatedWebAppsOperations_ListByBusinessCase", + "operationId": "EvaluatedWebAppsOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "$filter": "pwrvmthelxikwweggf", + "pageSize": 18, + "continuationToken": "oizcutotskmhqxxmpwiqzvzyaubjt", + "totalRecordCount": 2, + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "recommendedAzureTarget": "AzureVm", + "recommendedAzureSkuName": "Premium_V3", + "recommendedAzureSkuSize": "P1 v3", + "serverName": "a404-r1w16-1.FPL.COM", + "workload": "WebApps", + "activityState": "active", + "readyForMigration": "Ready" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedwebapp/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedwebapp", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..8b3211b9c547 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,85 @@ +{ + "title": "GroupsOperations_Create", + "operationId": "GroupsOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "resource": { + "properties": { + "groupStatus": "Completed", + "groupType": "Default", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..236bfa69b784 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "GroupsOperations_Delete", + "operationId": "GroupsOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..2e8c0bc491a1 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "GroupsOperations_Get", + "operationId": "GroupsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..bb8806e74610 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "GroupsOperations_ListByAssessmentProject", + "operationId": "GroupsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json new file mode 100644 index 000000000000..92535ad483eb --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json @@ -0,0 +1,58 @@ +{ + "title": "Update machines in group.", + "operationId": "GroupsOperations_UpdateMachines", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "body": { + "eTag": "*", + "properties": { + "operationType": "Add", + "machines": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/machines/18895660-c5e5-4247-8cfc-cd24e1fe57f3" + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..2c525d06629b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,98 @@ +{ + "title": "HypervCollectorsOperations_Create", + "operationId": "HypervCollectorsOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "hypervCollectorName": "test-697cecollector", + "resource": { + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/hypervcollectors/test-697cecollector", + "name": "test-697cecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/hypervcollectors", + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "createdTimestamp": "2022-07-06T17:35:52.7505235Z", + "updatedTimestamp": "2023-02-16T12:23:47.9845327Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/hypervcollectors/test-697cecollector", + "name": "test-697cecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/hypervcollectors", + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "createdTimestamp": "2022-07-06T17:35:52.7505235Z", + "updatedTimestamp": "2023-02-16T12:23:47.9845327Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..350f931b1618 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "HypervCollectorsOperations_Delete", + "operationId": "HypervCollectorsOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "hypervCollectorName": "test-697cecollector" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..f3606e653d5b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "HypervCollectorsOperations_Get", + "operationId": "HypervCollectorsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "hypervCollectorName": "test-697cecollector" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/hypervcollectors/test-697cecollector", + "name": "test-697cecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/hypervcollectors", + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "createdTimestamp": "2022-07-06T17:35:52.7505235Z", + "updatedTimestamp": "2023-02-16T12:23:47.9845327Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..70558c2a051c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "HypervCollectorsOperations_ListByAssessmentProject", + "operationId": "HypervCollectorsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/hypervcollectors/test-697cecollector", + "name": "test-697cecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/hypervcollectors", + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "createdTimestamp": "2022-07-06T17:35:52.7505235Z", + "updatedTimestamp": "2023-02-16T12:23:47.9845327Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..e8904f39703b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,62 @@ +{ + "title": "ImportCollectorsOperations_Create", + "operationId": "ImportCollectorsOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "importCollectorName": "importCollectore7d5", + "resource": { + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/importcollectors/importCollectore7d5", + "name": "importCollectore7d5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/importcollectors", + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "createdTimestamp": "2021-10-01T11:04:34.3408113Z", + "updatedTimestamp": "2023-02-16T12:23:48.3830682Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/importcollectors/importCollectore7d5", + "name": "importCollectore7d5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/importcollectors", + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "createdTimestamp": "2021-10-01T11:04:34.3408113Z", + "updatedTimestamp": "2023-02-16T12:23:48.3830682Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..7919004da039 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "ImportCollectorsOperations_Delete", + "operationId": "ImportCollectorsOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "importCollectorName": "importCollectore7d5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..d441848e7fd4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "ImportCollectorsOperations_Get", + "operationId": "ImportCollectorsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "importCollectorName": "importCollectore7d5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/importcollectors/importCollectore7d5", + "name": "importCollectore7d5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/importcollectors", + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "createdTimestamp": "2021-10-01T11:04:34.3408113Z", + "updatedTimestamp": "2023-02-16T12:23:48.3830682Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..cd8e5436ce84 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "ImportCollectorsOperations_ListByAssessmentProject", + "operationId": "ImportCollectorsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/importcollectors/importCollectore7d5", + "name": "importCollectore7d5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/importcollectors", + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "createdTimestamp": "2021-10-01T11:04:34.3408113Z", + "updatedTimestamp": "2023-02-16T12:23:48.3830682Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/MachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/MachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..159426f8d68c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/MachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,89 @@ +{ + "title": "MachinesOperations_Get", + "operationId": "MachinesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "machineName": "55082b89-99e2-4c40-b63f-d4f4d6ba961d" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/machines/55082b89-99e2-4c40-b63f-d4f4d6ba961d", + "name": "55082b89-99e2-4c40-b63f-d4f4d6ba961d", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/machines", + "properties": { + "workloadSummary": { + "oracleInstances": 0, + "springApps": 0 + }, + "errors": [], + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 0, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2018-10-09T00:00:00Z", + "extendedSupportEndDate": "2023-10-10T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "2024-10-08T00:00:00Z", + "extendedSecurityUpdateYear2EndDate": "2025-10-14T00:00:00Z", + "extendedSecurityUpdateYear3EndDate": "2026-10-13T00:00:00Z" + }, + "hostProcessor": null, + "discoveryMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app48697site/machines/idclab-vcen65-fareast-corp-micr-7071f35f-082c-4333-9ca9-3fdd5254db17_50379cec-8534-dcd7-0c7e-b16f6572bf94", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app48697site/vcenters/idclab-vcen65-fareast-corp-micr-7071f35f-082c-4333-9ca9-3fdd5254db17", + "datacenterManagementServerName": "idclab-vcen65.fareast.corp.microsoft.com", + "bootType": "BIOS", + "displayName": "a410-r1w12r2-7", + "megabytesOfMemory": 30720.0, + "numberOfCores": 8, + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2012 (64-bit)", + "operatingSystemVersion": null, + "description": "", + "createdTimestamp": "2021-08-31T14:31:19.465845Z", + "disks": { + "6000C29d-4e28-24a9-eaee-02fa5a17dadf": { + "gigabytesAllocated": 150.0, + "displayName": "scsi0:0" + }, + "6000C297-a876-f49f-c202-0289620d5223": { + "gigabytesAllocated": 250.0, + "displayName": "scsi0:1" + }, + "6000C295-4e9d-4322-6690-aff91beffb82": { + "gigabytesAllocated": 50.0, + "displayName": "scsi0:2" + } + }, + "groups": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/azure-vmwaresolution-ame-15389", + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/rajoshtest" + ], + "networkAdapters": { + "4000": { + "macAddress": "00:50:56:b7:04:06", + "ipAddresses": [], + "displayName": "VM Network" + } + }, + "sqlInstances": [], + "webApplications": [], + "updatedTimestamp": "2023-08-03T16:22:11.2610571Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..b009dd1f59cb --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,97 @@ +{ + "title": "MachinesOperations_ListByAssessmentProject", + "operationId": "MachinesOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "$filter": null, + "pageSize": 1, + "continuationToken": null, + "totalRecordCount": 1, + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/machines/55082b89-99e2-4c40-b63f-d4f4d6ba961d", + "name": "55082b89-99e2-4c40-b63f-d4f4d6ba961d", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/machines", + "properties": { + "workloadSummary": { + "oracleInstances": 0, + "springApps": 0 + }, + "errors": [], + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 0, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2018-10-09T00:00:00Z", + "extendedSupportEndDate": "2023-10-10T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "2024-10-08T00:00:00Z", + "extendedSecurityUpdateYear2EndDate": "2025-10-14T00:00:00Z", + "extendedSecurityUpdateYear3EndDate": "2026-10-13T00:00:00Z" + }, + "hostProcessor": null, + "discoveryMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app48697site/machines/idclab-vcen65-fareast-corp-micr-7071f35f-082c-4333-9ca9-3fdd5254db17_50379cec-8534-dcd7-0c7e-b16f6572bf94", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app48697site/vcenters/idclab-vcen65-fareast-corp-micr-7071f35f-082c-4333-9ca9-3fdd5254db17", + "datacenterManagementServerName": "idclab-vcen65.fareast.corp.microsoft.com", + "bootType": "BIOS", + "displayName": "a410-r1w12r2-7", + "megabytesOfMemory": 30720.0, + "numberOfCores": 8, + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2012 (64-bit)", + "operatingSystemVersion": null, + "description": "", + "createdTimestamp": "2021-08-31T14:31:19.465845Z", + "disks": { + "6000C29d-4e28-24a9-eaee-02fa5a17dadf": { + "gigabytesAllocated": 150.0, + "displayName": "scsi0:0" + }, + "6000C297-a876-f49f-c202-0289620d5223": { + "gigabytesAllocated": 250.0, + "displayName": "scsi0:1" + }, + "6000C295-4e9d-4322-6690-aff91beffb82": { + "gigabytesAllocated": 50.0, + "displayName": "scsi0:2" + } + }, + "groups": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/azure-vmwaresolution-ame-15389", + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/rajoshtest" + ], + "networkAdapters": { + "4000": { + "macAddress": "00:50:56:b7:04:06", + "ipAddresses": [], + "displayName": "VM Network" + } + }, + "sqlInstances": [], + "webApplications": [], + "updatedTimestamp": "2023-08-03T16:22:11.2610571Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/Operations_List_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..a47c702d4ad9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2023-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AksAssessmentOperations_Get", + "isDataAction": true, + "display": { + "provider": "Microsoft.Migrate", + "resource": "AKSAssessment", + "operation": "GET", + "description": "AKSAssessment" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..bb4441759275 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "PrivateEndpointConnectionOperations_Delete", + "operationId": "PrivateEndpointConnectionOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "privateEndpointConnectionName": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..1ed91c2f7f5b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,39 @@ +{ + "title": "PrivateEndpointConnectionOperations_Get", + "operationId": "PrivateEndpointConnectionOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "privateEndpointConnectionName": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7" + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/privateEndpointConnections/sakanwar1204project1634pe", + "name": "sakanwar1204project1634pe", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..a0ee06195281 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,43 @@ +{ + "title": "PrivateEndpointConnectionOperations_ListByAssessmentProject", + "operationId": "PrivateEndpointConnectionOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/privateEndpointConnections/sakanwar1204project1634pe", + "name": "sakanwar1204project1634pe", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/avol" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..56ea66251470 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json @@ -0,0 +1,76 @@ +{ + "title": "PrivateEndpointConnectionOperations_Update", + "operationId": "PrivateEndpointConnectionOperations_Update", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "privateEndpointConnectionName": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "resource": { + "properties": { + "privateEndpoint": {}, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/privateEndpointConnections/sakanwar1204project1634pe", + "name": "sakanwar1204project1634pe", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "201": { + "headers": {}, + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/privateEndpointConnections/sakanwar1204project1634pe", + "name": "sakanwar1204project1634pe", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..66add9e9ec82 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "PrivateLinkResourceOperations_Get", + "operationId": "PrivateLinkResourceOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "privateLinkResourceName": "Default" + }, + "responses": { + "200": { + "body": { + "properties": { + "requiredMembers": [ + "CollectorAgent" + ], + "requiredZoneNames": [ + "privatelink.test.migration.windowsazure.com" + ], + "groupId": "Default" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateLinkResources/Default", + "name": "Default", + "type": "Microsoft.Migrate/assessmentprojects/privateLinkResources", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..b07930fdc471 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "PrivateLinkResourceOperations_ListByAssessmentProject", + "operationId": "PrivateLinkResourceOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "requiredMembers": [ + "CollectorAgent" + ], + "requiredZoneNames": [ + "privatelink.test.migration.windowsazure.com" + ], + "groupId": "Default" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateLinkResources/Default", + "name": "Default", + "type": "Microsoft.Migrate/assessmentprojects/privateLinkResources", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/abcd" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..b405d3d54016 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,98 @@ +{ + "title": "ServerCollectorsOperations_Create", + "operationId": "ServerCollectorsOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "serverCollectorName": "walter389fcollector", + "resource": { + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/servercollectors/walter389fcollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "walter389fcollector", + "type": "Microsoft.Migrate/assessmentprojects/servercollectors", + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "createdTimestamp": "2023-05-29T13:35:13.3621563Z", + "updatedTimestamp": "2023-09-25T07:28:34.8075563Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/servercollectors/walter389fcollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "walter389fcollector", + "type": "Microsoft.Migrate/assessmentprojects/servercollectors", + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "createdTimestamp": "2023-05-29T13:35:13.3621563Z", + "updatedTimestamp": "2023-09-25T07:28:34.8075563Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..be1cd1d47d55 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "ServerCollectorsOperations_Delete", + "operationId": "ServerCollectorsOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "serverCollectorName": "walter389fcollector" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..f89f2bc2a89b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "ServerCollectorsOperations_Get", + "operationId": "ServerCollectorsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "serverCollectorName": "walter389fcollector" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/servercollectors/walter389fcollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "walter389fcollector", + "type": "Microsoft.Migrate/assessmentprojects/servercollectors", + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "createdTimestamp": "2023-05-29T13:35:13.3621563Z", + "updatedTimestamp": "2023-09-25T07:28:34.8075563Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..8ef3c807b70b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "ServerCollectorsOperations_ListByAssessmentProject", + "operationId": "ServerCollectorsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/servercollectors/walter389fcollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "walter389fcollector", + "type": "Microsoft.Migrate/assessmentprojects/servercollectors", + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "createdTimestamp": "2023-05-29T13:35:13.3621563Z", + "updatedTimestamp": "2023-09-25T07:28:34.8075563Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..870a5fe98991 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,1635 @@ +{ + "title": "SqlAssessmentOptionsOperations_Get", + "operationId": "SqlAssessmentOptionsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "assessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.Migrate/assessmentprojects/sqlAssessmentOptions", + "systemData": { + "createdAt": "2023-09-25T10:16:46.5581628Z", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "2023-09-25T10:16:46.5581628Z", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "properties": { + "vmFamilies": [ + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Eav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + } + ], + "reservedInstanceVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Edsv5_series", + "Edv5_series", + "Eadsv5_series", + "Easv4_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "premiumDiskVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Edsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "savingsPlanVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Edsv5_series", + "Edv5_series", + "Eadsv5_series", + "Easv4_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "savingsPlanSupportedLocations": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral" + ], + "savingsPlanSupportedLocationsForPaas": [], + "reservedInstanceSupportedLocationsForIaas": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "ItalyNorth", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "savingsPlanSupportedOffers": [ + "SavingsPlan1Year", + "SavingsPlan3Year" + ], + "sqlSkus": [ + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "NorwayWest", + "CanadaCentral", + "CanadaEast", + "GermanyNorth", + "SouthAfricaWest", + "EastAsia", + "NorwayEast", + "WestUs2", + "SouthIndia", + "EastUs", + "SouthCentralUs", + "UAENorth", + "AustraliaSoutheast", + "PolandCentral", + "KoreaCentral", + "UkWest", + "SwitzerlandNorth", + "NorthCentralUs", + "SoutheastAsia", + "BrazilSouth", + "FranceSouth", + "SwitzerlandWest", + "SwedenCentral", + "WestUs", + "AustraliaCentral2", + "NorthEurope", + "WestIndia", + "FranceCentral", + "ItalyNorth", + "KoreaSouth", + "GermanyWestCentral", + "JapanEast", + "WestEurope", + "WestCentralUs", + "SouthAfricaNorth", + "AustraliaCentral", + "UAECentral", + "UkSouth", + "JapanWest", + "CentralIndia", + "EastUs2", + "AustraliaEast", + "CentralUs", + "QatarCentral", + "ChinaNorth2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "BusinessCritical", + "targetLocations": [ + "AustraliaEast", + "SoutheastAsia", + "WestIndia", + "CanadaEast", + "NorthEurope", + "UAENorth", + "SouthAfricaNorth", + "EastUs", + "NorthCentralUs", + "BrazilSouth", + "WestCentralUs", + "UAECentral", + "CanadaCentral", + "JapanEast", + "CentralUs", + "FranceSouth", + "ItalyNorth", + "SouthCentralUs", + "UkWest", + "NorwayEast", + "FranceCentral", + "CentralIndia", + "AustraliaCentral2", + "EastAsia", + "WestUs", + "SouthAfricaWest", + "SwitzerlandWest", + "QatarCentral", + "AustraliaSoutheast", + "WestUs2", + "KoreaSouth", + "NorwayWest", + "GermanyWestCentral", + "JapanWest", + "UkSouth", + "WestEurope", + "KoreaCentral", + "EastUs2", + "SwedenCentral", + "AustraliaCentral", + "SouthIndia", + "GermanyNorth", + "SwitzerlandNorth", + "PolandCentral", + "ChinaEast2", + "ChinaEast", + "ChinaNorth", + "ChinaNorth2", + "USGovIowa", + "USGovVirginia", + "USGovArizona", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "PremiumSeriesMemoryOptimized", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "UAECentral", + "FranceSouth", + "SwitzerlandNorth", + "CentralIndia", + "NorthEurope", + "SwedenCentral", + "WestCentralUs", + "CanadaEast", + "AustraliaSoutheast", + "EastAsia", + "UAENorth", + "SwitzerlandWest", + "BrazilSouth", + "EastUs2", + "GermanyWestCentral", + "FranceCentral", + "WestUs", + "AustraliaCentral", + "NorwayWest", + "QatarCentral", + "WestUs2", + "UkWest", + "KoreaSouth", + "JapanWest", + "CanadaCentral", + "SoutheastAsia", + "PolandCentral", + "KoreaCentral", + "SouthCentralUs", + "GermanyNorth", + "ItalyNorth", + "EastUs", + "SouthAfricaWest", + "CentralUs", + "AustraliaEast", + "NorwayEast", + "WestEurope", + "WestIndia", + "NorthCentralUs", + "UkSouth", + "AustraliaCentral2", + "SouthAfricaNorth", + "JapanEast", + "SouthIndia", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovIowa", + "USGovVirginia" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "PremiumSeries", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "CentralIndia", + "AustraliaCentral", + "UAENorth", + "KoreaCentral", + "UAECentral", + "AustraliaSoutheast", + "SoutheastAsia", + "ItalyNorth", + "AustraliaEast", + "WestUs2", + "AustraliaCentral2", + "BrazilSouth", + "FranceSouth", + "JapanEast", + "NorthCentralUs", + "NorthEurope", + "PolandCentral", + "NorwayWest", + "UkSouth", + "SouthAfricaNorth", + "CanadaEast", + "WestIndia", + "GermanyWestCentral", + "NorwayEast", + "SwitzerlandWest", + "KoreaSouth", + "SwedenCentral", + "JapanWest", + "CentralUs", + "QatarCentral", + "WestEurope", + "CanadaCentral", + "SouthIndia", + "GermanyNorth", + "WestCentralUs", + "EastUs", + "SwitzerlandNorth", + "FranceCentral", + "SouthAfricaWest", + "UkWest", + "WestUs", + "SouthCentralUs", + "EastUs2", + "EastAsia", + "ChinaNorth2", + "ChinaEast2", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "GeneralPurpose", + "targetLocations": [ + "EastUs2", + "SouthCentralUs", + "GermanyWestCentral", + "AustraliaCentral", + "SouthAfricaWest", + "GermanyNorth", + "CanadaEast", + "WestUs", + "WestUs2", + "CanadaCentral", + "SouthAfricaNorth", + "FranceCentral", + "CentralUs", + "NorwayEast", + "JapanEast", + "UkWest", + "WestCentralUs", + "FranceSouth", + "BrazilSouth", + "KoreaSouth", + "EastAsia", + "UAENorth", + "CentralIndia", + "NorthEurope", + "AustraliaEast", + "KoreaCentral", + "SwitzerlandNorth", + "SwedenCentral", + "WestEurope", + "AustraliaCentral2", + "EastUs", + "PolandCentral", + "NorthCentralUs", + "UAECentral", + "ItalyNorth", + "SouthIndia", + "WestIndia", + "SoutheastAsia", + "AustraliaSoutheast", + "NorwayWest", + "JapanWest", + "SwitzerlandWest", + "QatarCentral", + "UkSouth", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "ChinaEast", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlManagedInstance", + "serviceTier": "GeneralPurpose", + "targetLocations": [ + "PolandCentral", + "JapanEast", + "SoutheastAsia", + "GermanyNorth", + "AustraliaCentral", + "UAECentral", + "GermanyWestCentral", + "NorwayWest", + "NorwayEast", + "AustraliaCentral2", + "SwitzerlandNorth", + "UAENorth", + "FranceSouth", + "BrazilSouth", + "CanadaEast", + "EastUs2", + "WestEurope", + "JapanWest", + "WestUs2", + "FranceCentral", + "WestIndia", + "SouthCentralUs", + "KoreaSouth", + "NorthEurope", + "SouthAfricaWest", + "SouthAfricaNorth", + "EastAsia", + "EastUs", + "ItalyNorth", + "SwedenCentral", + "KoreaCentral", + "AustraliaSoutheast", + "QatarCentral", + "CentralIndia", + "CanadaCentral", + "CentralUs", + "AustraliaEast", + "NorthCentralUs", + "WestCentralUs", + "SouthIndia", + "WestUs", + "UkSouth", + "SwitzerlandWest", + "UkWest", + "ChinaEast", + "ChinaNorth2", + "ChinaEast2", + "ChinaNorth", + "USGovTexas", + "USGovArizona", + "USGovIowa", + "USGovVirginia" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlManagedInstance", + "serviceTier": "BusinessCritical", + "targetLocations": [ + "NorwayWest", + "NorthEurope", + "GermanyNorth", + "KoreaSouth", + "EastUs2", + "CentralIndia", + "SoutheastAsia", + "SwedenCentral", + "WestUs", + "JapanEast", + "WestEurope", + "AustraliaEast", + "SouthAfricaNorth", + "UkSouth", + "UAENorth", + "NorthCentralUs", + "SouthAfricaWest", + "CanadaEast", + "UkWest", + "CentralUs", + "SouthCentralUs", + "WestUs2", + "NorwayEast", + "JapanWest", + "PolandCentral", + "WestCentralUs", + "EastAsia", + "SouthIndia", + "ItalyNorth", + "QatarCentral", + "FranceCentral", + "CanadaCentral", + "SwitzerlandWest", + "UAECentral", + "AustraliaCentral", + "SwitzerlandNorth", + "KoreaCentral", + "WestIndia", + "BrazilSouth", + "EastUs", + "FranceSouth", + "AustraliaCentral2", + "AustraliaSoutheast", + "GermanyWestCentral", + "ChinaEast2", + "ChinaEast", + "ChinaNorth2", + "ChinaNorth", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + } + ], + "reservedInstanceSqlTargets": [ + "AzureSqlDatabase", + "AzureSqlManagedInstance" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "ItalyNorth", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "reservedInstanceSupportedCurrencies": [ + "USD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P", + "MSAZRUSGOV0003P" + ], + "supportedOffers": [ + "MSAZR0003P" + ] + }, + "name": "default", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/sqlAssessmentOptions/default" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..7a5b8dc8a6f9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,1639 @@ +{ + "title": "SqlAssessmentOptionsOperations_ListByAssessmentProject", + "operationId": "SqlAssessmentOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.Migrate/assessmentprojects/sqlAssessmentOptions", + "systemData": { + "createdAt": "2023-09-25T10:16:46.5581628Z", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "2023-09-25T10:16:46.5581628Z", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "properties": { + "vmFamilies": [ + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Eav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + } + ], + "reservedInstanceVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Edsv5_series", + "Edv5_series", + "Eadsv5_series", + "Easv4_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "premiumDiskVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Edsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "savingsPlanVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Edsv5_series", + "Edv5_series", + "Eadsv5_series", + "Easv4_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "savingsPlanSupportedLocations": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral" + ], + "savingsPlanSupportedLocationsForPaas": [], + "reservedInstanceSupportedLocationsForIaas": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "ItalyNorth", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "savingsPlanSupportedOffers": [ + "SavingsPlan1Year", + "SavingsPlan3Year" + ], + "sqlSkus": [ + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "NorwayWest", + "CanadaCentral", + "CanadaEast", + "GermanyNorth", + "SouthAfricaWest", + "EastAsia", + "NorwayEast", + "WestUs2", + "SouthIndia", + "EastUs", + "SouthCentralUs", + "UAENorth", + "AustraliaSoutheast", + "PolandCentral", + "KoreaCentral", + "UkWest", + "SwitzerlandNorth", + "NorthCentralUs", + "SoutheastAsia", + "BrazilSouth", + "FranceSouth", + "SwitzerlandWest", + "SwedenCentral", + "WestUs", + "AustraliaCentral2", + "NorthEurope", + "WestIndia", + "FranceCentral", + "ItalyNorth", + "KoreaSouth", + "GermanyWestCentral", + "JapanEast", + "WestEurope", + "WestCentralUs", + "SouthAfricaNorth", + "AustraliaCentral", + "UAECentral", + "UkSouth", + "JapanWest", + "CentralIndia", + "EastUs2", + "AustraliaEast", + "CentralUs", + "QatarCentral", + "ChinaNorth2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "BusinessCritical", + "targetLocations": [ + "AustraliaEast", + "SoutheastAsia", + "WestIndia", + "CanadaEast", + "NorthEurope", + "UAENorth", + "SouthAfricaNorth", + "EastUs", + "NorthCentralUs", + "BrazilSouth", + "WestCentralUs", + "UAECentral", + "CanadaCentral", + "JapanEast", + "CentralUs", + "FranceSouth", + "ItalyNorth", + "SouthCentralUs", + "UkWest", + "NorwayEast", + "FranceCentral", + "CentralIndia", + "AustraliaCentral2", + "EastAsia", + "WestUs", + "SouthAfricaWest", + "SwitzerlandWest", + "QatarCentral", + "AustraliaSoutheast", + "WestUs2", + "KoreaSouth", + "NorwayWest", + "GermanyWestCentral", + "JapanWest", + "UkSouth", + "WestEurope", + "KoreaCentral", + "EastUs2", + "SwedenCentral", + "AustraliaCentral", + "SouthIndia", + "GermanyNorth", + "SwitzerlandNorth", + "PolandCentral", + "ChinaEast2", + "ChinaEast", + "ChinaNorth", + "ChinaNorth2", + "USGovIowa", + "USGovVirginia", + "USGovArizona", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "PremiumSeriesMemoryOptimized", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "UAECentral", + "FranceSouth", + "SwitzerlandNorth", + "CentralIndia", + "NorthEurope", + "SwedenCentral", + "WestCentralUs", + "CanadaEast", + "AustraliaSoutheast", + "EastAsia", + "UAENorth", + "SwitzerlandWest", + "BrazilSouth", + "EastUs2", + "GermanyWestCentral", + "FranceCentral", + "WestUs", + "AustraliaCentral", + "NorwayWest", + "QatarCentral", + "WestUs2", + "UkWest", + "KoreaSouth", + "JapanWest", + "CanadaCentral", + "SoutheastAsia", + "PolandCentral", + "KoreaCentral", + "SouthCentralUs", + "GermanyNorth", + "ItalyNorth", + "EastUs", + "SouthAfricaWest", + "CentralUs", + "AustraliaEast", + "NorwayEast", + "WestEurope", + "WestIndia", + "NorthCentralUs", + "UkSouth", + "AustraliaCentral2", + "SouthAfricaNorth", + "JapanEast", + "SouthIndia", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovIowa", + "USGovVirginia" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "PremiumSeries", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "CentralIndia", + "AustraliaCentral", + "UAENorth", + "KoreaCentral", + "UAECentral", + "AustraliaSoutheast", + "SoutheastAsia", + "ItalyNorth", + "AustraliaEast", + "WestUs2", + "AustraliaCentral2", + "BrazilSouth", + "FranceSouth", + "JapanEast", + "NorthCentralUs", + "NorthEurope", + "PolandCentral", + "NorwayWest", + "UkSouth", + "SouthAfricaNorth", + "CanadaEast", + "WestIndia", + "GermanyWestCentral", + "NorwayEast", + "SwitzerlandWest", + "KoreaSouth", + "SwedenCentral", + "JapanWest", + "CentralUs", + "QatarCentral", + "WestEurope", + "CanadaCentral", + "SouthIndia", + "GermanyNorth", + "WestCentralUs", + "EastUs", + "SwitzerlandNorth", + "FranceCentral", + "SouthAfricaWest", + "UkWest", + "WestUs", + "SouthCentralUs", + "EastUs2", + "EastAsia", + "ChinaNorth2", + "ChinaEast2", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "GeneralPurpose", + "targetLocations": [ + "EastUs2", + "SouthCentralUs", + "GermanyWestCentral", + "AustraliaCentral", + "SouthAfricaWest", + "GermanyNorth", + "CanadaEast", + "WestUs", + "WestUs2", + "CanadaCentral", + "SouthAfricaNorth", + "FranceCentral", + "CentralUs", + "NorwayEast", + "JapanEast", + "UkWest", + "WestCentralUs", + "FranceSouth", + "BrazilSouth", + "KoreaSouth", + "EastAsia", + "UAENorth", + "CentralIndia", + "NorthEurope", + "AustraliaEast", + "KoreaCentral", + "SwitzerlandNorth", + "SwedenCentral", + "WestEurope", + "AustraliaCentral2", + "EastUs", + "PolandCentral", + "NorthCentralUs", + "UAECentral", + "ItalyNorth", + "SouthIndia", + "WestIndia", + "SoutheastAsia", + "AustraliaSoutheast", + "NorwayWest", + "JapanWest", + "SwitzerlandWest", + "QatarCentral", + "UkSouth", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "ChinaEast", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlManagedInstance", + "serviceTier": "GeneralPurpose", + "targetLocations": [ + "PolandCentral", + "JapanEast", + "SoutheastAsia", + "GermanyNorth", + "AustraliaCentral", + "UAECentral", + "GermanyWestCentral", + "NorwayWest", + "NorwayEast", + "AustraliaCentral2", + "SwitzerlandNorth", + "UAENorth", + "FranceSouth", + "BrazilSouth", + "CanadaEast", + "EastUs2", + "WestEurope", + "JapanWest", + "WestUs2", + "FranceCentral", + "WestIndia", + "SouthCentralUs", + "KoreaSouth", + "NorthEurope", + "SouthAfricaWest", + "SouthAfricaNorth", + "EastAsia", + "EastUs", + "ItalyNorth", + "SwedenCentral", + "KoreaCentral", + "AustraliaSoutheast", + "QatarCentral", + "CentralIndia", + "CanadaCentral", + "CentralUs", + "AustraliaEast", + "NorthCentralUs", + "WestCentralUs", + "SouthIndia", + "WestUs", + "UkSouth", + "SwitzerlandWest", + "UkWest", + "ChinaEast", + "ChinaNorth2", + "ChinaEast2", + "ChinaNorth", + "USGovTexas", + "USGovArizona", + "USGovIowa", + "USGovVirginia" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlManagedInstance", + "serviceTier": "BusinessCritical", + "targetLocations": [ + "NorwayWest", + "NorthEurope", + "GermanyNorth", + "KoreaSouth", + "EastUs2", + "CentralIndia", + "SoutheastAsia", + "SwedenCentral", + "WestUs", + "JapanEast", + "WestEurope", + "AustraliaEast", + "SouthAfricaNorth", + "UkSouth", + "UAENorth", + "NorthCentralUs", + "SouthAfricaWest", + "CanadaEast", + "UkWest", + "CentralUs", + "SouthCentralUs", + "WestUs2", + "NorwayEast", + "JapanWest", + "PolandCentral", + "WestCentralUs", + "EastAsia", + "SouthIndia", + "ItalyNorth", + "QatarCentral", + "FranceCentral", + "CanadaCentral", + "SwitzerlandWest", + "UAECentral", + "AustraliaCentral", + "SwitzerlandNorth", + "KoreaCentral", + "WestIndia", + "BrazilSouth", + "EastUs", + "FranceSouth", + "AustraliaCentral2", + "AustraliaSoutheast", + "GermanyWestCentral", + "ChinaEast2", + "ChinaEast", + "ChinaNorth2", + "ChinaNorth", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + } + ], + "reservedInstanceSqlTargets": [ + "AzureSqlDatabase", + "AzureSqlManagedInstance" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "ItalyNorth", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "reservedInstanceSupportedCurrencies": [ + "USD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P", + "MSAZRUSGOV0003P" + ], + "supportedOffers": [ + "MSAZR0003P" + ] + }, + "name": "default", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/sqlAssessmentOptions/default" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..a40eb6a666c6 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json @@ -0,0 +1,219 @@ +{ + "title": "SqlAssessmentV2Operations_Create", + "operationId": "SqlAssessmentV2Operations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "resource": { + "properties": { + "entityUptime": { + "daysPerMonth": 30, + "hoursPerDay": 24 + }, + "osLicense": "Unknown", + "optimizationLogic": "MinimizeCost", + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Automatic", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Eadsv5_series" + ] + }, + "environmentType": "Production", + "reservedInstance": "None", + "reservedInstanceForVm": "None", + "sqlServerLicense": "Unknown", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "azureOfferCodeForVm": "MSAZR0003P", + "currency": "USD", + "percentile": "Percentile95", + "scalingFactor": 1, + "timeRange": "Day", + "discountPercentage": 0, + "sizingCriterion": "PerformanceBased", + "multiSubnetIntent": "DisasterRecovery", + "asyncCommitModeIntent": "DisasterRecovery", + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1", + "name": "test_swagger_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-07T05:21:45.9644382Z", + "perfDataEndTime": "2023-09-08T05:21:45.9644382Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-08T05:21:45.9800654Z", + "updatedTimestamp": "2023-09-08T05:23:45.2686461Z", + "status": "Completed", + "schemaVersion": "2.0" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1", + "name": "test_swagger_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-07T05:21:45.9644382Z", + "perfDataEndTime": "2023-09-08T05:21:45.9644382Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-08T05:21:45.9800654Z", + "updatedTimestamp": "2023-09-08T05:23:45.2686461Z", + "status": "Completed", + "schemaVersion": "2.0" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..f2e38db2e96e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "SqlAssessmentV2Operations_Delete", + "operationId": "SqlAssessmentV2Operations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..7acc1a52c057 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Get download URL for the assessment report.", + "operationId": "SqlAssessmentV2Operations_DownloadUrl", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "fagqmlysjfwtt", + "expirationTime": "2023-09-15T07:22:40.818Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b58cef26efcb --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,94 @@ +{ + "title": "SqlAssessmentV2Operations_Get", + "operationId": "SqlAssessmentV2Operations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1", + "name": "test_swagger_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-07T05:21:45.9644382Z", + "perfDataEndTime": "2023-09-08T05:21:45.9644382Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-08T05:21:45.9800654Z", + "updatedTimestamp": "2023-09-08T05:23:45.2686461Z", + "status": "Completed", + "schemaVersion": "2.0" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..b96c917afe29 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json @@ -0,0 +1,254 @@ +{ + "title": "SqlAssessmentV2Operations_ListByGroup", + "operationId": "SqlAssessmentV2Operations_ListByGroup", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_assmt_hadr_1", + "name": "test_assmt_hadr_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-02-16T16:14:03.477007Z", + "perfDataEndTime": "2023-02-17T16:14:03.477007Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2022-12-20T00:00:00Z", + "createdTimestamp": "2023-01-04T14:17:43.1744405Z", + "updatedTimestamp": "2023-02-17T16:16:25.1524275Z", + "status": "Completed", + "schemaVersion": "2.0" + } + }, + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_assmt_hadr_2", + "name": "test_assmt_hadr_2", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-06T07:47:29.6769501Z", + "perfDataEndTime": "2023-09-07T07:47:29.6769501Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-07T07:47:29.6925964Z", + "updatedTimestamp": "2023-09-07T07:49:26.5732595Z", + "status": "Completed", + "schemaVersion": "2.0" + } + }, + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1", + "name": "test_swagger_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-07T05:21:45.9644382Z", + "perfDataEndTime": "2023-09-08T05:21:45.9644382Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-08T05:21:45.9800654Z", + "updatedTimestamp": "2023-09-08T05:23:45.2686461Z", + "status": "Completed", + "schemaVersion": "2.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..908b43ec5209 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,128 @@ +{ + "title": "SqlAssessmentV2SummaryOperations_Get", + "operationId": "SqlAssessmentV2SummaryOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "summaryName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/summaries/default", + "name": "default", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/summaries", + "properties": { + "assessmentSummary": { + "azureSqlManagedInstance": { + "suitabilitySummary": { + "notSuitable": 7, + "readinessUnknown": 15, + "suitableForSqlMI": 1 + }, + "monthlyComputeCost": 4581.992448, + "monthlyStorageCost": 0.0, + "monthlyLicenseCost": 6568.5107999999991, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureSqlVirtualMachine": { + "suitabilitySummary": { + "suitableForSqlVM": 21, + "readinessUnknown": 2 + }, + "monthlyComputeCost": 889.49663999999962, + "monthlyStorageCost": 73.943999999999988, + "monthlyLicenseCost": 25281.36, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureSqlDatabase": { + "suitabilitySummary": { + "readinessUnknown": 1468, + "suitableForSqlDB": 16 + }, + "monthlyComputeCost": 175079.07398399821, + "monthlyStorageCost": 1054.8825000000395, + "monthlyLicenseCost": 214401.07883999476, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureVirtualMachine": { + "suitabilitySummary": { + "suitableForVM": 19 + }, + "monthlyComputeCost": 625.94207999999981, + "monthlyStorageCost": 374.48999999999995, + "monthlyLicenseCost": 1300.5120000000002, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "recommended": { + "suitabilitySummary": { + "suitableForSqlVM": 19, + "suitableForVM": 4 + }, + "monthlyComputeCost": 823.60799999999972, + "monthlyStorageCost": 100.88400000000002, + "monthlyLicenseCost": 22912.896, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + } + }, + "distributionBySupportStatus": { + "extended": 11, + "outOfSupport": 9, + "mainstream": 3 + }, + "distributionByServicePackInsight": { + "unknown": 23 + }, + "distributionBySqlVersion": { + "sql Server 2014": 4, + "sql Server 2012": 9, + "sql Server 2019": 3, + "sql Server 2016": 5, + "sql Server 2017": 2 + }, + "distributionBySqlEdition": { + "enterprise Edition: Core-based Licensing (64-bit)": 15, + "web Edition": 1, + "express Edition (64-bit)": 2, + "enterprise Evaluation Edition (64-bit)": 1, + "enterprise Edition: Core-based Licensing": 1, + "enterprise Edition (64-bit)": 1, + "standard Edition (64-bit)": 2 + }, + "instanceDistributionBySizingCriterion": { + "performanceBased": 0, + "asOnPremises": 0, + "perfBasedFallbackToAsOnPremises": 23 + }, + "databaseDistributionBySizingCriterion": { + "performanceBased": 0, + "asOnPremises": 0, + "perfBasedFallbackToAsOnPremises": 1484 + }, + "numberOfMachines": 19, + "numberOfSqlInstances": 23, + "numberOfSqlDatabases": 1484, + "numberOfFciInstances": 4, + "numberOfSqlAvailabilityGroups": 5 + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..a974ed1660e7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,132 @@ +{ + "title": "SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2", + "operationId": "SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/summaries/default", + "name": "default", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/summaries", + "properties": { + "assessmentSummary": { + "azureSqlManagedInstance": { + "suitabilitySummary": { + "notSuitable": 7, + "readinessUnknown": 15, + "suitableForSqlMI": 1 + }, + "monthlyComputeCost": 4581.992448, + "monthlyStorageCost": 0.0, + "monthlyLicenseCost": 6568.5107999999991, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureSqlVirtualMachine": { + "suitabilitySummary": { + "suitableForSqlVM": 21, + "readinessUnknown": 2 + }, + "monthlyComputeCost": 889.49663999999962, + "monthlyStorageCost": 73.943999999999988, + "monthlyLicenseCost": 25281.36, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureSqlDatabase": { + "suitabilitySummary": { + "readinessUnknown": 1468, + "suitableForSqlDB": 16 + }, + "monthlyComputeCost": 175079.07398399821, + "monthlyStorageCost": 1054.8825000000395, + "monthlyLicenseCost": 214401.07883999476, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureVirtualMachine": { + "suitabilitySummary": { + "suitableForVM": 19 + }, + "monthlyComputeCost": 625.94207999999981, + "monthlyStorageCost": 374.48999999999995, + "monthlyLicenseCost": 1300.5120000000002, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "recommended": { + "suitabilitySummary": { + "suitableForSqlVM": 19, + "suitableForVM": 4 + }, + "monthlyComputeCost": 823.60799999999972, + "monthlyStorageCost": 100.88400000000002, + "monthlyLicenseCost": 22912.896, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + } + }, + "distributionBySupportStatus": { + "extended": 11, + "outOfSupport": 9, + "mainstream": 3 + }, + "distributionByServicePackInsight": { + "unknown": 23 + }, + "distributionBySqlVersion": { + "sql Server 2014": 4, + "sql Server 2012": 9, + "sql Server 2019": 3, + "sql Server 2016": 5, + "sql Server 2017": 2 + }, + "distributionBySqlEdition": { + "enterprise Edition: Core-based Licensing (64-bit)": 15, + "web Edition": 1, + "express Edition (64-bit)": 2, + "enterprise Evaluation Edition (64-bit)": 1, + "enterprise Edition: Core-based Licensing": 1, + "enterprise Edition (64-bit)": 1, + "standard Edition (64-bit)": 2 + }, + "instanceDistributionBySizingCriterion": { + "performanceBased": 0, + "asOnPremises": 0, + "perfBasedFallbackToAsOnPremises": 23 + }, + "databaseDistributionBySizingCriterion": { + "performanceBased": 0, + "asOnPremises": 0, + "perfBasedFallbackToAsOnPremises": 1484 + }, + "numberOfMachines": 19, + "numberOfSqlInstances": 23, + "numberOfSqlDatabases": 1484, + "numberOfFciInstances": 4, + "numberOfSqlAvailabilityGroups": 5 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..7dad7d97a34b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,97 @@ +{ + "title": "SqlCollectorOperations_Create", + "operationId": "SqlCollectorOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "collectorName": "fci-test0c1esqlsitecollector", + "resource": { + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-test6904project/sqlcollectors/fci-test0c1esqlsitecollector", + "name": "fci-test0c1esqlsitecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/sqlcollectors", + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites", + "createdTimestamp": "2022-11-22T09:50:37.1061418Z", + "updatedTimestamp": "2023-02-16T12:17:52.9185188Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-test6904project/sqlcollectors/fci-test0c1esqlsitecollector", + "name": "fci-test0c1esqlsitecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/sqlcollectors", + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites", + "createdTimestamp": "2022-11-22T09:50:37.1061418Z", + "updatedTimestamp": "2023-02-16T12:17:52.9185188Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..6fcfd6243e85 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "SqlCollectorOperations_Delete", + "operationId": "SqlCollectorOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "collectorName": "fci-test0c1esqlsitecollector" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..8d8c73d771a5 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "SqlCollectorOperations_Get", + "operationId": "SqlCollectorOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "collectorName": "fci-test0c1esqlsitecollector" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-test6904project/sqlcollectors/fci-test0c1esqlsitecollector", + "name": "fci-test0c1esqlsitecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/sqlcollectors", + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites", + "createdTimestamp": "2022-11-22T09:50:37.1061418Z", + "updatedTimestamp": "2023-02-16T12:17:52.9185188Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..9e322501d3ea --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "SqlCollectorOperations_ListByAssessmentProject", + "operationId": "SqlCollectorOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/sqlcollectors/fci-ankit-test0c1esqlsitecollector", + "name": "fci-ankit-test0c1esqlsitecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/sqlcollectors", + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites", + "createdTimestamp": "2022-11-22T09:50:37.1061418Z", + "updatedTimestamp": "2023-02-16T12:17:52.9185188Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..6039ffa97e75 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,98 @@ +{ + "title": "VmwareCollectorsOperations_Create", + "operationId": "VmwareCollectorsOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "vmWareCollectorName": "Vmware2258collector", + "resource": { + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/vmwarecollectors/Vmware2258collector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "Vmware2258collector", + "type": "Microsoft.Migrate/assessmentprojects/vmwarecollectors", + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "createdTimestamp": "2022-03-28T13:41:17.5560477Z", + "updatedTimestamp": "2023-02-16T12:23:45.9695649Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/vmwarecollectors/Vmware2258collector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "Vmware2258collector", + "type": "Microsoft.Migrate/assessmentprojects/vmwarecollectors", + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "createdTimestamp": "2022-03-28T13:41:17.5560477Z", + "updatedTimestamp": "2023-02-16T12:23:45.9695649Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..99c229a6db40 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "VmwareCollectorsOperations_Delete", + "operationId": "VmwareCollectorsOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "vmWareCollectorName": "Vmware2258collector" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..05f39123a1ab --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "VmwareCollectorsOperations_Get", + "operationId": "VmwareCollectorsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "vmWareCollectorName": "Vmware2258collector" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/vmwarecollectors/Vmware2258collector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "Vmware2258collector", + "type": "Microsoft.Migrate/assessmentprojects/vmwarecollectors", + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "createdTimestamp": "2022-03-28T13:41:17.5560477Z", + "updatedTimestamp": "2023-02-16T12:23:45.9695649Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..c819f602be15 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "VmwareCollectorsOperations_ListByAssessmentProject", + "operationId": "VmwareCollectorsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/vmwarecollectors/Vmware2258collector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "Vmware2258collector", + "type": "Microsoft.Migrate/assessmentprojects/vmwarecollectors", + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "createdTimestamp": "2022-03-28T13:41:17.5560477Z", + "updatedTimestamp": "2023-02-16T12:23:45.9695649Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b48e8c4873c4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,56 @@ +{ + "title": "WebAppAssessmentOptionsOperations_Get", + "operationId": "WebAppAssessmentOptionsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "assessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "webAppSkus": [ + { + "webAppTier": "Premium_V3", + "targetLocations": [ + "WestEurope" + ] + } + ], + "savingsPlanSupportedLocations": [ + "WestEurope" + ], + "reservedInstanceSupportedLocations": [ + "WestEurope" + ], + "reservedInstanceSupportedCurrencies": [ + "USD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P" + ], + "reservedInstanceSupportedWebAppTiers": [ + "Premium_V3" + ], + "savingsPlanSupportedWebAppTiers": [ + "Premium_V3" + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webAppAssessmentOptions/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/webAppAssessmentOptions", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..d3a440e7fb3b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,60 @@ +{ + "title": "WebAppAssessmentOptionsOperations_ListByAssessmentProject", + "operationId": "WebAppAssessmentOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "92EA264C-A8A7-4192-A5E5-D9B487409240", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "webAppSkus": [ + { + "webAppTier": "Premium_V3", + "targetLocations": [ + "PolandCentral" + ] + } + ], + "savingsPlanSupportedLocations": [ + "Unknown" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaSoutheast" + ], + "reservedInstanceSupportedCurrencies": [ + "USD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P" + ], + "reservedInstanceSupportedWebAppTiers": [ + "Premium_V3" + ], + "savingsPlanSupportedWebAppTiers": [ + "Premium_V3" + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webAppAssessmentOptions/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/webAppAssessmentOptions", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-06T05:40:17.507Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-06T05:40:17.507Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..bb14673c0e02 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json @@ -0,0 +1,167 @@ +{ + "title": "WebAppAssessmentV2Operations_Create_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "resource": { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "status": "Created" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "pricesTimestamp": "2023-11-03T05:42:45.496Z", + "createdTimestamp": "2023-11-03T05:42:45.496Z", + "updatedTimestamp": "2023-11-03T05:42:45.496Z", + "status": "Created", + "schemaVersion": "2.0", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-v2-test", + "name": "anraghun-v2-test", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": "eatnpvdxza", + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": "rnfkzoaidy", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "pricesTimestamp": "2023-11-03T05:42:45.496Z", + "createdTimestamp": "2023-11-03T05:42:45.496Z", + "updatedTimestamp": "2023-11-03T05:42:45.496Z", + "status": "Created", + "schemaVersion": "2.0", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-v2-test", + "name": "anraghun-v2-test", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": "eatnpvdxza", + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": "rnfkzoaidy", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..ab39129ddebd --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "WebAppAssessmentV2Operations_Delete_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..15631ba5ae4d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_DownloadUrl", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "https://assessmentsrvcanccysa2.blob.core.windows.net/cc1325ff-d42f-4c45-bfb6-12069e45becb/anraghun-selfhost-v2anraghun-v2-testWebAppAssessment.xlsx?sv=2018-03-28&sr=b&sig=NYBG6gJmofvIQsk1K1tewWfX51BpFZWsvIy7gBXNYUE%3D&st=2023-11-03T05%3A51%3A39Z&se=2023-11-03T06%3A26%3A39Z&sp=r", + "expirationTime": "2023-11-03T05:42:09.465Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..53b3facf4279 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,70 @@ +{ + "title": "WebAppAssessmentV2Operations_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-v2-test" + }, + "responses": { + "200": { + "body": { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "Unknown", + "currency": "MSAZR0003P", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "pricesTimestamp": "2023-11-03T05:42:45.496Z", + "createdTimestamp": "2023-11-03T05:42:45.496Z", + "updatedTimestamp": "2023-11-03T05:42:45.496Z", + "status": "Created", + "schemaVersion": "2.0", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2", + "name": "anraghun-selfhost-v2", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..e64efd28c39f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json @@ -0,0 +1,74 @@ +{ + "title": "WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_ListByGroup", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "pricesTimestamp": "2023-11-03T05:42:45.496Z", + "createdTimestamp": "2023-11-03T05:42:45.496Z", + "updatedTimestamp": "2023-11-03T05:42:45.496Z", + "status": "Created", + "schemaVersion": "2.0", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2", + "name": "anraghun-selfhost-v2", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b4792774b016 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,61 @@ +{ + "title": "WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2SummaryOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "summaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "assessmentSummary": { + "discoveredEntitiesSummary": { + "numberOfServers": 15, + "numberOfWebApps": 6, + "numberOfMachines": 24, + "webServerSummary": { + "iis": 13 + }, + "webAppSummary": { + "iis": 30 + } + } + }, + "targetSpecificSummary": { + "azureAppService": { + "readinessSummary": { + "suitable": 13 + }, + "recommendationResultSkuDetails": { + "isolated": { + "totalMonthlyCost": 21, + "monthlySecurityCost": 3, + "skuName": "Isolated", + "skuSize": "I1", + "appServicePlanCount": 4 + } + } + } + } + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/summaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..a10fdde3de45 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,65 @@ +{ + "title": "WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "assessmentSummary": { + "discoveredEntitiesSummary": { + "numberOfServers": 15, + "numberOfWebApps": 6, + "numberOfMachines": 24, + "webServerSummary": { + "iis": 13 + }, + "webAppSummary": { + "iis": 30 + } + } + }, + "targetSpecificSummary": { + "azureAppService": { + "readinessSummary": { + "conditionallySuitable": 13 + }, + "recommendationResultSkuDetails": { + "isolated": { + "totalMonthlyCost": 584, + "monthlySecurityCost": 0, + "skuName": "Isolated", + "skuSize": "I1", + "appServicePlanCount": 2 + } + } + } + } + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/summaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/anxenhw" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..9339ee47caf4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,99 @@ +{ + "title": "WebAppCollectorOperations_Create", + "operationId": "WebAppCollectorOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "collectorName": "collector1", + "resource": { + "properties": { + "agentProperties": { + "id": "fed93df5-b787-4e3f-a764-e3d2b9101a59-agent", + "version": null, + "lastHeartbeatUtc": "2023-11-03T05:43:02.078Z", + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "agentProperties": { + "id": "fed93df5-b787-4e3f-a764-e3d2b9101a59-agent", + "version": null, + "lastHeartbeatUtc": "2023-11-03T05:43:02.078Z", + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites", + "createdTimestamp": "2023-11-03T05:43:02.078Z", + "updatedTimestamp": "2023-11-03T05:43:02.078Z", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "name": "sumukk-ccy-bcs4a93webappsitecollector", + "type": "Microsoft.Migrate/assessmentprojects/webappcollectors", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "agentProperties": { + "id": "fed93df5-b787-4e3f-a764-e3d2b9101a59-agent", + "version": null, + "lastHeartbeatUtc": "2023-11-03T05:43:02.078Z", + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites", + "createdTimestamp": "2023-11-03T05:43:02.078Z", + "updatedTimestamp": "2023-11-03T05:43:02.078Z", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "name": "sumukk-ccy-bcs4a93webappsitecollector", + "type": "Microsoft.Migrate/assessmentprojects/webappcollectors", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..a451d12ce142 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "WebAppCollectorOperations_Delete", + "operationId": "WebAppCollectorOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "collectorName": "collector1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..2b35e4770378 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "WebAppCollectorOperations_Get", + "operationId": "WebAppCollectorOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "collectorName": "collector1" + }, + "responses": { + "200": { + "body": { + "properties": { + "agentProperties": { + "id": "fed93df5-b787-4e3f-a764-e3d2b9101a59-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites", + "createdTimestamp": "2023-11-03T05:43:02.078Z", + "updatedTimestamp": "2023-11-03T05:43:02.078Z", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "name": "sumukk-ccy-bcs4a93webappsitecollector", + "type": "Microsoft.Migrate/assessmentprojects/webappcollectors", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..216dd036df36 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,50 @@ +{ + "title": "WebAppCollectorOperations_ListByAssessmentProject", + "operationId": "WebAppCollectorOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "agentProperties": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "version": null, + "lastHeartbeatUtc": "2023-11-03T05:43:02.078Z", + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites", + "createdTimestamp": "2023-11-03T05:43:02.078Z", + "updatedTimestamp": "2023-11-03T05:43:02.078Z", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "name": "sumukk-ccy-bcs4a93webappsitecollector", + "type": "Microsoft.Migrate/assessmentprojects/webappcollectors", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..53fceead7c22 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,52 @@ +{ + "title": "WebAppServicePlanV2Operations_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppServicePlanV2Operations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "webAppServicePlanName": "plan-001" + }, + "responses": { + "200": { + "body": { + "properties": { + "webAppType": "IIS", + "webAppTargetType": "AzureAppService", + "webAppServicePlanName": "Plan-001", + "numberOfWebApps": 2, + "monthlyCost": 20, + "storage": 25, + "scaleOutInstances": 8, + "cores": 17, + "ram": 18, + "webAppSkuName": "Isolated", + "webAppSkuSize": "I1", + "createdTimestamp": "2023-11-03T05:42:59.387Z", + "updatedTimestamp": "2023-11-03T05:42:59.387Z", + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 16, + "description": null + } + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/webAppServicePlans/plan-002-azureappservice", + "name": "plan-002-azureappservice", + "type": "Microsoft.Migrate/assessmentprojects/groups/webAppAssessments/webAppServicePlans", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..95878e631a15 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,60 @@ +{ + "title": "WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppServicePlanV2Operations_ListByWebAppAssessmentV2", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "$filter": "okepiszphg", + "pageSize": 18, + "$skipToken": "hcpyxryhoumfkypulwpsxxkzuu", + "totalRecordCount": 14, + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "webAppType": "IIS", + "webAppTargetType": "AzureAppService", + "webAppServicePlanName": "Plan-001", + "numberOfWebApps": 2, + "monthlyCost": 20, + "storage": 25, + "scaleOutInstances": 8, + "cores": 17, + "ram": 18, + "webAppSkuName": "Isolated", + "webAppSkuSize": "I1", + "createdTimestamp": "2023-11-03T05:42:59.387Z", + "updatedTimestamp": "2023-11-03T05:42:59.387Z", + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 16, + "description": null + } + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/webAppServicePlans/plan-002-azureappservice", + "name": "plan-002-azureappservice", + "type": "Microsoft.Migrate/assessmentprojects/groups/webAppAssessments/webAppServicePlans", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/migrate.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/migrate.json new file mode 100644 index 000000000000..4780abbd83fd --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/migrate.json @@ -0,0 +1,24820 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Migrate Assessment Service", + "version": "2023-05-01-preview", + "description": "Azure Migrate Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "AssessmentProjectsOperations" + }, + { + "name": "AssessmentProjectSummaryOperations" + }, + { + "name": "MachinesOperations" + }, + { + "name": "GroupsOperations" + }, + { + "name": "AssessmentsOperations" + }, + { + "name": "AssessmentOptionsOperations" + }, + { + "name": "AssessedMachinesOperations" + }, + { + "name": "HypervCollectorsOperations" + }, + { + "name": "VmwareCollectorsOperations" + }, + { + "name": "ServerCollectorsOperations" + }, + { + "name": "ImportCollectorsOperations" + }, + { + "name": "PrivateEndpointConnectionOperations" + }, + { + "name": "PrivateLinkResourceOperations" + }, + { + "name": "AvsAssessmentsOperations" + }, + { + "name": "AvsAssessmentOptionsOperations" + }, + { + "name": "AvsAssessedMachinesOperations" + }, + { + "name": "SqlAssessmentV2SummaryOperations" + }, + { + "name": "SqlAssessmentV2Operations" + }, + { + "name": "SqlAssessmentOptionsOperations" + }, + { + "name": "AssessedSqlMachinesOperations" + }, + { + "name": "AssessedSqlRecommendedEntityOperations" + }, + { + "name": "AssessedSqlInstanceV2Operations" + }, + { + "name": "AssessedSqlDatabaseV2Operations" + }, + { + "name": "SqlCollectorOperations" + }, + { + "name": "WebAppAssessmentV2SummaryOperations" + }, + { + "name": "WebAppAssessmentV2Operations" + }, + { + "name": "WebAppAssessmentOptionsOperations" + }, + { + "name": "AssessedWebAppV2Operations" + }, + { + "name": "WebAppServicePlanV2Operations" + }, + { + "name": "WebAppCollectorOperations" + }, + { + "name": "BusinessCaseOperations" + }, + { + "name": "BusinessCaseIaasSummaryOperations" + }, + { + "name": "BusinessCasePaasSummaryOperations" + }, + { + "name": "BusinessCaseOverviewSummaryOperations" + }, + { + "name": "BusinessCaseAvsSummaryOperations" + }, + { + "name": "EvaluatedMachinesOperations" + }, + { + "name": "EvaluatedSqlEntitiesOperations" + }, + { + "name": "EvaluatedWebAppsOperations" + }, + { + "name": "EvaluatedAvsMachinesOperations" + }, + { + "name": "AKSAssessmentOperations" + }, + { + "name": "AssessedWebApplicationOperations" + }, + { + "name": "AKSOptionsOperations" + }, + { + "name": "AKSSummaryOperations" + }, + { + "name": "AKSClusterOperations" + }, + { + "name": "AKSCostDetailOperations" + } + ], + "paths": { + "/providers/Microsoft.Migrate/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List_MaximumSet_Gen": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Migrate/assessmentProjects": { + "get": { + "operationId": "AssessmentProjectsOperations_ListBySubscription", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "List AssessmentProject resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProjectListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects": { + "get": { + "operationId": "AssessmentProjectsOperations_ListByResourceGroup", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "List AssessmentProject resources by resource group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProjectListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}": { + "get": { + "operationId": "AssessmentProjectsOperations_Get", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "Get a AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProject" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentProjectsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "AssessmentProjectsOperations_Create", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "Create a AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AssessmentProject" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AssessmentProject' update operation succeeded", + "schema": { + "$ref": "#/definitions/AssessmentProject" + } + }, + "201": { + "description": "Resource 'AssessmentProject' create operation succeeded", + "schema": { + "$ref": "#/definitions/AssessmentProject" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AssessmentProjectsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "AssessmentProjectsOperations_Update", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "Update a AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AssessmentProjectUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProject" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AssessmentProjectsOperations_Update_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "AssessmentProjectsOperations_Delete", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "Delete a AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentProjectsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessmentOptions": { + "get": { + "operationId": "AksOptionsOperations_ListByAssessmentProject", + "tags": [ + "AKSOptionsOperations" + ], + "description": "List AKSAssessmentOptions resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSAssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessmentOptions/{assessmentOptionsName}": { + "get": { + "operationId": "AksOptionsOperations_Get", + "tags": [ + "AKSOptionsOperations" + ], + "description": "Get a AKSAssessmentOptions", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentOptionsName", + "in": "path", + "description": "AKS Assessment Options Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSAssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AksOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments": { + "get": { + "operationId": "AksAssessmentOperations_ListByAssessmentProject", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "List AKSAssessment resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Continuation Token Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Page Size Query Parameter.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total Record Count Query Parameter.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSAssessmentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}": { + "get": { + "operationId": "AksAssessmentOperations_Get", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "Get a AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSAssessment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksAssessmentOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "AksAssessmentOperations_Create", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "Create a AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AKSAssessment" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AKSAssessment' update operation succeeded", + "schema": { + "$ref": "#/definitions/AKSAssessment" + } + }, + "201": { + "description": "Resource 'AKSAssessment' create operation succeeded", + "schema": { + "$ref": "#/definitions/AKSAssessment" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AksAssessmentOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "AksAssessmentOperations_Delete", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "Delete a AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksAssessmentOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/assessedWebApps": { + "get": { + "operationId": "AssessedWebApplicationOperations_ListByAksAssessment", + "tags": [ + "AssessedWebApplicationOperations" + ], + "description": "List AssessedWebApplication resources by AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Continuation Token Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Page Size Query Parameter.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total Record Count Query Parameter.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedWebApplicationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen": { + "$ref": "./examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/assessedWebApps/{assessedWorkload}": { + "get": { + "operationId": "AssessedWebApplicationOperations_Get", + "tags": [ + "AssessedWebApplicationOperations" + ], + "description": "Get a AssessedWebApplication", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedWorkload", + "in": "path", + "description": "Assessed Web Application Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedWebApplication" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedWebApplicationOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/clusters": { + "get": { + "operationId": "AksClusterOperations_ListByAksAssessment", + "tags": [ + "AKSClusterOperations" + ], + "description": "List AKSCluster resources by AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksClusterOperations_ListByAksAssessment_MaximumSet_Gen": { + "$ref": "./examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/clusters/{clusterName}": { + "get": { + "operationId": "AksClusterOperations_Get", + "tags": [ + "AKSClusterOperations" + ], + "description": "Get a AKSCluster", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "clusterName", + "in": "path", + "description": "AKS Cluster Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSCluster" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksClusterOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AksClusterOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/costDetails": { + "get": { + "operationId": "AksCostDetailOperations_ListByAksAssessment", + "tags": [ + "AKSCostDetailOperations" + ], + "description": "List AKSCostDetail resources by AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSCostDetailListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen": { + "$ref": "./examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "AksAssessmentOperations_DownloadUrl", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "Get URL for downloading AKS Assessment Report.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AksAssessmentOperations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/summaries": { + "get": { + "operationId": "AksSummaryOperations_ListByAksAssessment", + "tags": [ + "AKSSummaryOperations" + ], + "description": "List AKSSummary resources by AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen": { + "$ref": "./examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/summaries/{summaryName}": { + "get": { + "operationId": "AksSummaryOperations_Get", + "tags": [ + "AKSSummaryOperations" + ], + "description": "Get a AKSSummary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "summaryName", + "in": "path", + "description": "AKS Assessment Summary Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AksSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessmentOptions": { + "get": { + "operationId": "AssessmentOptionsOperations_ListByAssessmentProject", + "tags": [ + "AssessmentOptionsOperations" + ], + "description": "List AssessmentOptions resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessmentOptions/{assessmentOptionsName}": { + "get": { + "operationId": "AssessmentOptionsOperations_Get", + "tags": [ + "AssessmentOptionsOperations" + ], + "description": "Get a AssessmentOptions", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentOptionsName", + "in": "path", + "description": " assessment options ARM name. Accepted value is 'default'", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessmentOptions": { + "get": { + "operationId": "AvsAssessmentOptionsOperations_ListByAssessmentProject", + "tags": [ + "AvsAssessmentOptionsOperations" + ], + "description": "List AvsAssessmentOptions resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessmentOptions/{avsAssessmentOptionsName}": { + "get": { + "operationId": "AvsAssessmentOptionsOperations_Get", + "tags": [ + "AvsAssessmentOptionsOperations" + ], + "description": "Get a AvsAssessmentOptions", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "avsAssessmentOptionsName", + "in": "path", + "description": "AVS Assessment options ARM name. Accepted value is 'default'", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvsAssessmentOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases": { + "get": { + "operationId": "BusinessCaseOperations_ListByAssessmentProject", + "tags": [ + "BusinessCaseOperations" + ], + "description": "List BusinessCase resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/BusinessCaseListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}": { + "get": { + "operationId": "BusinessCaseOperations_Get", + "tags": [ + "BusinessCaseOperations" + ], + "description": "Get a BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/BusinessCase" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "BusinessCaseOperations_Create", + "tags": [ + "BusinessCaseOperations" + ], + "description": "Create a BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/BusinessCase" + } + } + ], + "responses": { + "200": { + "description": "Resource 'BusinessCase' update operation succeeded", + "schema": { + "$ref": "#/definitions/BusinessCase" + } + }, + "201": { + "description": "Resource 'BusinessCase' create operation succeeded", + "schema": { + "$ref": "#/definitions/BusinessCase" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BusinessCaseOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "BusinessCaseOperations_Delete", + "tags": [ + "BusinessCaseOperations" + ], + "description": "Delete a BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/avsSummaries": { + "get": { + "operationId": "BusinessCaseAvsSummaryOperations_ListByBusinessCase", + "tags": [ + "BusinessCaseAvsSummaryOperations" + ], + "description": "List AvsSummary resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/avsSummaries/{avsSummaryName}": { + "get": { + "operationId": "BusinessCaseAvsSummaryOperations_Get", + "tags": [ + "BusinessCaseAvsSummaryOperations" + ], + "description": "Get a AvsSummary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "avsSummaryName", + "in": "path", + "description": "Gets the Name of the Avs Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/compareSummary": { + "post": { + "operationId": "BusinessCaseOperations_CompareSummary", + "tags": [ + "BusinessCaseOperations" + ], + "summary": "Get Compare summary report for Business case.", + "description": "A long-running resource action.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/CompareSummary" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BusinessCaseOperations_CompareSummary_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedAvsMachines": { + "get": { + "operationId": "EvaluatedAvsMachinesOperations_ListByBusinessCase", + "tags": [ + "EvaluatedAvsMachinesOperations" + ], + "description": "List EvaluatedAvsMachine resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedAvsMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedAvsMachines/{evaluatedAvsMachineName}": { + "get": { + "operationId": "EvaluatedAvsMachinesOperations_Get", + "tags": [ + "EvaluatedAvsMachinesOperations" + ], + "description": "Get a EvaluatedAvsMachine", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "evaluatedAvsMachineName", + "in": "path", + "description": "Business case Evaluated AVS machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedAvsMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedMachines": { + "get": { + "operationId": "EvaluatedMachinesOperations_ListByBusinessCase", + "tags": [ + "EvaluatedMachinesOperations" + ], + "description": "List EvaluatedMachine resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedMachines/{evaluatedMachineName}": { + "get": { + "operationId": "EvaluatedMachinesOperations_Get", + "tags": [ + "EvaluatedMachinesOperations" + ], + "description": "Get a EvaluatedMachine", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "evaluatedMachineName", + "in": "path", + "description": "Business case Evaluated machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EvaluatedMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedSqlEntities": { + "get": { + "operationId": "EvaluatedSqlEntitiesOperations_ListByBusinessCase", + "tags": [ + "EvaluatedSqlEntitiesOperations" + ], + "description": "List EvaluatedSqlEntity resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedSqlEntityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedSqlEntities/{evaluatedSqlEntityName}": { + "get": { + "operationId": "EvaluatedSqlEntitiesOperations_Get", + "tags": [ + "EvaluatedSqlEntitiesOperations" + ], + "description": "Get a EvaluatedSqlEntity", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "evaluatedSqlEntityName", + "in": "path", + "description": "Business case Evaluated sql entity ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedSqlEntity" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedWebApps": { + "get": { + "operationId": "EvaluatedWebAppsOperations_ListByBusinessCase", + "tags": [ + "EvaluatedWebAppsOperations" + ], + "description": "List EvaluatedWebApp resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedWebAppListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedWebApps/{evaluatedWebAppName}": { + "get": { + "operationId": "EvaluatedWebAppsOperations_Get", + "tags": [ + "EvaluatedWebAppsOperations" + ], + "description": "Get a EvaluatedWebApp", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "evaluatedWebAppName", + "in": "path", + "description": "Business case Evaluated web App ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedWebApp" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EvaluatedWebAppsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/getReportDownloadUrl": { + "post": { + "operationId": "BusinessCaseOperations_GetReportDownloadUrl", + "tags": [ + "BusinessCaseOperations" + ], + "summary": "Get download URL for the business case report.", + "description": "Get the URL for downloading the business case in a report format.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ReportDownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/iaasSummaries": { + "get": { + "operationId": "BusinessCaseIaasSummaryOperations_ListByBusinessCase", + "tags": [ + "BusinessCaseIaasSummaryOperations" + ], + "description": "List IaasSummary resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/IaasSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/iaasSummaries/{iaasSummaryName}": { + "get": { + "operationId": "BusinessCaseIaasSummaryOperations_Get", + "tags": [ + "BusinessCaseIaasSummaryOperations" + ], + "description": "Get a IaasSummary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "iaasSummaryName", + "in": "path", + "description": "Gets the Name of the Iaas Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/IaasSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/overviewSummaries": { + "get": { + "operationId": "BusinessCaseOverviewSummaryOperations_ListByBusinessCase", + "tags": [ + "BusinessCaseOverviewSummaryOperations" + ], + "description": "List OverviewSummary resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OverviewSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/overviewSummaries/{overviewSummaryName}": { + "get": { + "operationId": "BusinessCaseOverviewSummaryOperations_Get", + "tags": [ + "BusinessCaseOverviewSummaryOperations" + ], + "description": "Get a OverviewSummary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "overviewSummaryName", + "in": "path", + "description": "Gets the Name of the Overview Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OverviewSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/paasSummaries": { + "get": { + "operationId": "BusinessCasePaasSummaryOperations_ListByBusinessCase", + "tags": [ + "BusinessCasePaasSummaryOperations" + ], + "description": "List PaasSummary resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PaasSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/paasSummaries/{paasSummaryName}": { + "get": { + "operationId": "BusinessCasePaasSummaryOperations_Get", + "tags": [ + "BusinessCasePaasSummaryOperations" + ], + "description": "Get a PaasSummary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "paasSummaryName", + "in": "path", + "description": "Gets the Name of the Paas Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PaasSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups": { + "get": { + "operationId": "GroupsOperations_ListByAssessmentProject", + "tags": [ + "GroupsOperations" + ], + "description": "List Group resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/GroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GroupsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}": { + "get": { + "operationId": "GroupsOperations_Get", + "tags": [ + "GroupsOperations" + ], + "description": "Get a Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Group" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GroupsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "GroupsOperations_Create", + "tags": [ + "GroupsOperations" + ], + "description": "Create a Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Group" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Group' update operation succeeded", + "schema": { + "$ref": "#/definitions/Group" + } + }, + "201": { + "description": "Resource 'Group' create operation succeeded", + "schema": { + "$ref": "#/definitions/Group" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "GroupsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "GroupsOperations_Delete", + "tags": [ + "GroupsOperations" + ], + "description": "Delete a Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GroupsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments": { + "get": { + "operationId": "AssessmentsOperations_ListByGroup", + "tags": [ + "AssessmentsOperations" + ], + "description": "List Assessment resources by Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentsOperations_ListByGroup_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}": { + "get": { + "operationId": "AssessmentsOperations_Get", + "tags": [ + "AssessmentsOperations" + ], + "description": "Get a Assessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Assessment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "AssessmentsOperations_Create", + "tags": [ + "AssessmentsOperations" + ], + "description": "Create a Assessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Assessment" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Assessment' update operation succeeded", + "schema": { + "$ref": "#/definitions/Assessment" + } + }, + "201": { + "description": "Resource 'Assessment' create operation succeeded", + "schema": { + "$ref": "#/definitions/Assessment" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AssessmentsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "AssessmentsOperations_Delete", + "tags": [ + "AssessmentsOperations" + ], + "description": "Delete a Assessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}/assessedMachines": { + "get": { + "operationId": "AssessedMachinesOperations_ListByAssessment", + "tags": [ + "AssessedMachinesOperations" + ], + "description": "List AssessedMachine resources by Assessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen": { + "$ref": "./examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}/assessedMachines/{assessedMachineName}": { + "get": { + "operationId": "AssessedMachinesOperations_Get", + "tags": [ + "AssessedMachinesOperations" + ], + "description": "Get a AssessedMachine", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedMachineName", + "in": "path", + "description": "Machine assessment Assessed Machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "AssessmentsOperations_DownloadUrl", + "tags": [ + "AssessmentsOperations" + ], + "summary": "Get download URL for the assessment report.", + "description": "Get the URL for downloading the assessment in a report format.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AssessmentsOperations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments": { + "get": { + "operationId": "AvsAssessmentsOperations_ListByGroup", + "tags": [ + "AvsAssessmentsOperations" + ], + "description": "List AvsAssessment resources by Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessmentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}": { + "get": { + "operationId": "AvsAssessmentsOperations_Get", + "tags": [ + "AvsAssessmentsOperations" + ], + "description": "Get a AvsAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvsAssessmentsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "AvsAssessmentsOperations_Create", + "tags": [ + "AvsAssessmentsOperations" + ], + "description": "Create a AvsAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AvsAssessment" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AvsAssessment' update operation succeeded", + "schema": { + "$ref": "#/definitions/AvsAssessment" + } + }, + "201": { + "description": "Resource 'AvsAssessment' create operation succeeded", + "schema": { + "$ref": "#/definitions/AvsAssessment" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AvsAssessmentsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "AvsAssessmentsOperations_Delete", + "tags": [ + "AvsAssessmentsOperations" + ], + "description": "Delete a AvsAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvsAssessmentsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}/avsAssessedMachines": { + "get": { + "operationId": "AvsAssessedMachinesOperations_ListByAvsAssessment", + "tags": [ + "AvsAssessedMachinesOperations" + ], + "description": "List AvsAssessedMachine resources by AvsAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessedMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}/avsAssessedMachines/{avsAssessedMachineName}": { + "get": { + "operationId": "AvsAssessedMachinesOperations_Get", + "tags": [ + "AvsAssessedMachinesOperations" + ], + "description": "Get a AvsAssessedMachine", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "avsAssessedMachineName", + "in": "path", + "description": "AVS assessment Assessed Machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessedMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvsAssessedMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "AvsAssessmentsOperations_DownloadUrl", + "tags": [ + "AvsAssessmentsOperations" + ], + "summary": "Get download URL for the assessment report.", + "description": "Get the URL for downloading the assessment in a report format.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments": { + "get": { + "operationId": "SqlAssessmentV2Operations_ListByGroup", + "tags": [ + "SqlAssessmentV2Operations" + ], + "description": "List SqlAssessmentV2 resources by Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}": { + "get": { + "operationId": "SqlAssessmentV2Operations_Get", + "tags": [ + "SqlAssessmentV2Operations" + ], + "description": "Get a SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlAssessmentV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "SqlAssessmentV2Operations_Create", + "tags": [ + "SqlAssessmentV2Operations" + ], + "description": "Create a SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlAssessmentV2" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SqlAssessmentV2' update operation succeeded", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2" + } + }, + "201": { + "description": "Resource 'SqlAssessmentV2' create operation succeeded", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SqlAssessmentV2Operations_Create_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "SqlAssessmentV2Operations_Delete", + "tags": [ + "SqlAssessmentV2Operations" + ], + "description": "Delete a SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlAssessmentV2Operations_Delete_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlDatabases": { + "get": { + "operationId": "AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2", + "tags": [ + "AssessedSqlDatabaseV2Operations" + ], + "description": "List AssessedSqlDatabaseV2 resources by SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlDatabaseV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlDatabases/{assessedSqlDatabaseName}": { + "get": { + "operationId": "AssessedSqlDatabaseV2Operations_Get", + "tags": [ + "AssessedSqlDatabaseV2Operations" + ], + "description": "Get a AssessedSqlDatabaseV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedSqlDatabaseName", + "in": "path", + "description": "Sql assessment Assessed Databases ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlDatabaseV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlInstances": { + "get": { + "operationId": "AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2", + "tags": [ + "AssessedSqlInstanceV2Operations" + ], + "description": "List AssessedSqlInstanceV2 resources by SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlInstanceV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlInstances/{assessedSqlInstanceName}": { + "get": { + "operationId": "AssessedSqlInstanceV2Operations_Get", + "tags": [ + "AssessedSqlInstanceV2Operations" + ], + "description": "Get a AssessedSqlInstanceV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedSqlInstanceName", + "in": "path", + "description": "Sql assessment Assessed Instance ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlInstanceV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlMachines": { + "get": { + "operationId": "AssessedSqlMachinesOperations_ListBySqlAssessmentV2", + "tags": [ + "AssessedSqlMachinesOperations" + ], + "description": "List AssessedSqlMachine resources by SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlMachines/{assessedSqlMachineName}": { + "get": { + "operationId": "AssessedSqlMachinesOperations_Get", + "tags": [ + "AssessedSqlMachinesOperations" + ], + "description": "Get a AssessedSqlMachine", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedSqlMachineName", + "in": "path", + "description": "Sql assessment Assessed Machine ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedSqlMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "SqlAssessmentV2Operations_DownloadUrl", + "tags": [ + "SqlAssessmentV2Operations" + ], + "summary": "Get download URL for the assessment report.", + "description": "Get the URL for downloading the assessment in a report format.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/recommendedAssessedEntities": { + "get": { + "operationId": "AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2", + "tags": [ + "AssessedSqlRecommendedEntityOperations" + ], + "description": "List AssessedSqlRecommendedEntity resources by SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlRecommendedEntityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/recommendedAssessedEntities/{recommendedAssessedEntityName}": { + "get": { + "operationId": "AssessedSqlRecommendedEntityOperations_Get", + "tags": [ + "AssessedSqlRecommendedEntityOperations" + ], + "description": "Get a AssessedSqlRecommendedEntity", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "recommendedAssessedEntityName", + "in": "path", + "description": "Sql assessment Assessed Recommended Entity ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlRecommendedEntity" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/summaries": { + "get": { + "operationId": "SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2", + "tags": [ + "SqlAssessmentV2SummaryOperations" + ], + "description": "List SqlAssessmentV2Summary resources by SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2SummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/summaries/{summaryName}": { + "get": { + "operationId": "SqlAssessmentV2SummaryOperations_Get", + "tags": [ + "SqlAssessmentV2SummaryOperations" + ], + "description": "Get a SqlAssessmentV2Summary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "summaryName", + "in": "path", + "description": "Gets the Name of the SQL Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2Summary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/updateMachines": { + "post": { + "operationId": "GroupsOperations_UpdateMachines", + "tags": [ + "GroupsOperations" + ], + "summary": "Update machines in group.", + "description": "Update machines in group by adding or removing machines.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateGroupBody" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Group" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "GroupsOperations_UpdateMachines_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments": { + "get": { + "operationId": "WebAppAssessmentV2Operations_ListByGroup", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "description": "List WebAppAssessmentV2 resources by Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}": { + "get": { + "operationId": "WebAppAssessmentV2Operations_Get", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "description": "Get a WebAppAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppAssessmentV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "WebAppAssessmentV2Operations_Create", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "description": "Create a WebAppAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2" + } + } + ], + "responses": { + "200": { + "description": "Resource 'WebAppAssessmentV2' update operation succeeded", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2" + } + }, + "201": { + "description": "Resource 'WebAppAssessmentV2' create operation succeeded", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebAppAssessmentV2Operations_Create_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "WebAppAssessmentV2Operations_Delete", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "description": "Delete a WebAppAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppAssessmentV2Operations_Delete_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/assessedWebApps": { + "get": { + "operationId": "AssessedWebAppV2Operations_ListByWebAppAssessmentV2", + "tags": [ + "AssessedWebAppV2Operations" + ], + "description": "List AssessedWebAppV2 resources by WebAppAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedWebAppV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/assessedWebApps/{assessedWebAppName}": { + "get": { + "operationId": "AssessedWebAppV2Operations_Get", + "tags": [ + "AssessedWebAppV2Operations" + ], + "description": "Get a AssessedWebAppV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedWebAppName", + "in": "path", + "description": "Assessed web app ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedWebAppV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedWebAppV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "WebAppAssessmentV2Operations_DownloadUrl", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "summary": "Get download URL for the assessment report.", + "description": "Get the URL for downloading the assessment in a report format.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/summaries": { + "get": { + "operationId": "WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2", + "tags": [ + "WebAppAssessmentV2SummaryOperations" + ], + "description": "List WebAppAssessmentV2Summary resources by WebAppAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2SummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/summaries/{summaryName}": { + "get": { + "operationId": "WebAppAssessmentV2SummaryOperations_Get", + "tags": [ + "WebAppAssessmentV2SummaryOperations" + ], + "description": "Get a WebAppAssessmentV2Summary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "summaryName", + "in": "path", + "description": "Gets the Name of the Web app Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2Summary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/webAppServicePlans": { + "get": { + "operationId": "WebAppServicePlanV2Operations_ListByWebAppAssessmentV2", + "tags": [ + "WebAppServicePlanV2Operations" + ], + "description": "List WebAppServicePlanV2 resources by WebAppAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppServicePlanV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/webAppServicePlans/{webAppServicePlanName}": { + "get": { + "operationId": "WebAppServicePlanV2Operations_Get", + "tags": [ + "WebAppServicePlanV2Operations" + ], + "description": "Get a WebAppServicePlanV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "webAppServicePlanName", + "in": "path", + "description": "Web app service plan ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppServicePlanV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppServicePlanV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/hypervcollectors": { + "get": { + "operationId": "HypervCollectorsOperations_ListByAssessmentProject", + "tags": [ + "HypervCollectorsOperations" + ], + "description": "List HypervCollector resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/hypervcollectors/{hypervCollectorName}": { + "get": { + "operationId": "HypervCollectorsOperations_Get", + "tags": [ + "HypervCollectorsOperations" + ], + "description": "Get a HypervCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "hypervCollectorName", + "in": "path", + "description": "Hyper-V collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervCollectorsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "HypervCollectorsOperations_Create", + "tags": [ + "HypervCollectorsOperations" + ], + "description": "Create a HypervCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "hypervCollectorName", + "in": "path", + "description": "Hyper-V collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/HypervCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'HypervCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/HypervCollector" + } + }, + "201": { + "description": "Resource 'HypervCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/HypervCollector" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "HypervCollectorsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "HypervCollectorsOperations_Delete", + "tags": [ + "HypervCollectorsOperations" + ], + "description": "Delete a HypervCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "hypervCollectorName", + "in": "path", + "description": "Hyper-V collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervCollectorsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/importcollectors": { + "get": { + "operationId": "ImportCollectorsOperations_ListByAssessmentProject", + "tags": [ + "ImportCollectorsOperations" + ], + "description": "List ImportCollector resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/importcollectors/{importCollectorName}": { + "get": { + "operationId": "ImportCollectorsOperations_Get", + "tags": [ + "ImportCollectorsOperations" + ], + "description": "Get a ImportCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "importCollectorName", + "in": "path", + "description": "Import collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportCollectorsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "ImportCollectorsOperations_Create", + "tags": [ + "ImportCollectorsOperations" + ], + "description": "Create a ImportCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "importCollectorName", + "in": "path", + "description": "Import collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ImportCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ImportCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/ImportCollector" + } + }, + "201": { + "description": "Resource 'ImportCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/ImportCollector" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ImportCollectorsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "ImportCollectorsOperations_Delete", + "tags": [ + "ImportCollectorsOperations" + ], + "description": "Delete a ImportCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "importCollectorName", + "in": "path", + "description": "Import collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportCollectorsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/machines": { + "get": { + "operationId": "MachinesOperations_ListByAssessmentProject", + "tags": [ + "MachinesOperations" + ], + "description": "List Machine resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "MachinesOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/machines/{machineName}": { + "get": { + "operationId": "MachinesOperations_Get", + "tags": [ + "MachinesOperations" + ], + "description": "Get a Machine", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "machineName", + "in": "path", + "description": "Assessible Machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/MachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections": { + "get": { + "operationId": "PrivateEndpointConnectionOperations_ListByAssessmentProject", + "tags": [ + "PrivateEndpointConnectionOperations" + ], + "description": "List PrivateEndpointConnection resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "operationId": "PrivateEndpointConnectionOperations_Get", + "tags": [ + "PrivateEndpointConnectionOperations" + ], + "description": "Get a PrivateEndpointConnection", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Private endpoint connection ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "PrivateEndpointConnectionOperations_Update", + "tags": [ + "PrivateEndpointConnectionOperations" + ], + "description": "Create a PrivateEndpointConnection", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Private endpoint connection ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "Resource 'PrivateEndpointConnection' update operation succeeded", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Resource 'PrivateEndpointConnection' create operation succeeded", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PrivateEndpointConnectionOperations_Update_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "PrivateEndpointConnectionOperations_Delete", + "tags": [ + "PrivateEndpointConnectionOperations" + ], + "description": "Delete a PrivateEndpointConnection", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Private endpoint connection ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateLinkResources": { + "get": { + "operationId": "PrivateLinkResourceOperations_ListByAssessmentProject", + "tags": [ + "PrivateLinkResourceOperations" + ], + "description": "List PrivateLinkResource resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateLinkResources/{privateLinkResourceName}": { + "get": { + "operationId": "PrivateLinkResourceOperations_Get", + "tags": [ + "PrivateLinkResourceOperations" + ], + "description": "Get a PrivateLinkResource", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "privateLinkResourceName", + "in": "path", + "description": "Private link resource ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkResourceOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/projectSummary": { + "get": { + "operationId": "AssessmentProjectSummaryOperations_ListByAssessmentProject", + "tags": [ + "AssessmentProjectSummaryOperations" + ], + "description": "List AssessmentProjectSummary resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProjectSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/projectSummary/{projectSummaryName}": { + "get": { + "operationId": "AssessmentProjectSummaryOperations_Get", + "tags": [ + "AssessmentProjectSummaryOperations" + ], + "description": "Get a AssessmentProjectSummary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "projectSummaryName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProjectSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentProjectSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/servercollectors": { + "get": { + "operationId": "ServerCollectorsOperations_ListByAssessmentProject", + "tags": [ + "ServerCollectorsOperations" + ], + "description": "List ServerCollector resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/servercollectors/{serverCollectorName}": { + "get": { + "operationId": "ServerCollectorsOperations_Get", + "tags": [ + "ServerCollectorsOperations" + ], + "description": "Get a ServerCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "serverCollectorName", + "in": "path", + "description": "Physical server collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerCollectorsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "ServerCollectorsOperations_Create", + "tags": [ + "ServerCollectorsOperations" + ], + "description": "Create a ServerCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "serverCollectorName", + "in": "path", + "description": "Physical server collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ServerCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/ServerCollector" + } + }, + "201": { + "description": "Resource 'ServerCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/ServerCollector" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ServerCollectorsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "ServerCollectorsOperations_Delete", + "tags": [ + "ServerCollectorsOperations" + ], + "description": "Delete a ServerCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "serverCollectorName", + "in": "path", + "description": "Physical server collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerCollectorsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessmentOptions": { + "get": { + "operationId": "SqlAssessmentOptionsOperations_ListByAssessmentProject", + "tags": [ + "SqlAssessmentOptionsOperations" + ], + "description": "List SqlAssessmentOptions resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessmentOptions/{assessmentOptionsName}": { + "get": { + "operationId": "SqlAssessmentOptionsOperations_Get", + "tags": [ + "SqlAssessmentOptionsOperations" + ], + "description": "Get a SqlAssessmentOptions", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentOptionsName", + "in": "path", + "description": "Sql assessment options ARM name. Accepted values is 'default'", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlAssessmentOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlcollectors": { + "get": { + "operationId": "SqlCollectorOperations_ListByAssessmentProject", + "tags": [ + "SqlCollectorOperations" + ], + "description": "List SqlCollector resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlcollectors/{collectorName}": { + "get": { + "operationId": "SqlCollectorOperations_Get", + "tags": [ + "SqlCollectorOperations" + ], + "description": "Get a SqlCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Sql collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlCollectorOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlCollectorOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "SqlCollectorOperations_Create", + "tags": [ + "SqlCollectorOperations" + ], + "description": "Create a SqlCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Sql collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SqlCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/SqlCollector" + } + }, + "201": { + "description": "Resource 'SqlCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/SqlCollector" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SqlCollectorOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/SqlCollectorOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "SqlCollectorOperations_Delete", + "tags": [ + "SqlCollectorOperations" + ], + "description": "Delete a SqlCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Sql collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlCollectorOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/vmwarecollectors": { + "get": { + "operationId": "VmwareCollectorsOperations_ListByAssessmentProject", + "tags": [ + "VmwareCollectorsOperations" + ], + "description": "List VmwareCollector resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/vmwarecollectors/{vmWareCollectorName}": { + "get": { + "operationId": "VmwareCollectorsOperations_Get", + "tags": [ + "VmwareCollectorsOperations" + ], + "description": "Get a VmwareCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "vmWareCollectorName", + "in": "path", + "description": "VMware collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VmwareCollectorsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "VmwareCollectorsOperations_Create", + "tags": [ + "VmwareCollectorsOperations" + ], + "description": "Create a VmwareCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "vmWareCollectorName", + "in": "path", + "description": "VMware collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VmwareCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'VmwareCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/VmwareCollector" + } + }, + "201": { + "description": "Resource 'VmwareCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/VmwareCollector" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VmwareCollectorsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "VmwareCollectorsOperations_Delete", + "tags": [ + "VmwareCollectorsOperations" + ], + "description": "Delete a VmwareCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "vmWareCollectorName", + "in": "path", + "description": "VMware collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VmwareCollectorsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppAssessmentOptions": { + "get": { + "operationId": "WebAppAssessmentOptionsOperations_ListByAssessmentProject", + "tags": [ + "WebAppAssessmentOptionsOperations" + ], + "description": "List WebAppAssessmentOptions resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppAssessmentOptions/{assessmentOptionsName}": { + "get": { + "operationId": "WebAppAssessmentOptionsOperations_Get", + "tags": [ + "WebAppAssessmentOptionsOperations" + ], + "description": "Get a WebAppAssessmentOptions", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentOptionsName", + "in": "path", + "description": "Web app assessment options ARM name. Accepted values is 'default'", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppCollectors": { + "get": { + "operationId": "WebAppCollectorOperations_ListByAssessmentProject", + "tags": [ + "WebAppCollectorOperations" + ], + "description": "List WebAppCollector resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppCollectors/{collectorName}": { + "get": { + "operationId": "WebAppCollectorOperations_Get", + "tags": [ + "WebAppCollectorOperations" + ], + "description": "Get a WebAppCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Web app collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppCollectorOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "WebAppCollectorOperations_Create", + "tags": [ + "WebAppCollectorOperations" + ], + "description": "Create a WebAppCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Web app collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WebAppCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'WebAppCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/WebAppCollector" + } + }, + "201": { + "description": "Resource 'WebAppCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/WebAppCollector" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebAppCollectorOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "WebAppCollectorOperations_Delete", + "tags": [ + "WebAppCollectorOperations" + ], + "description": "Delete a WebAppCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Web app collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppCollectorOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "AKSAssessment": { + "type": "object", + "description": "ARM model of AKS Assessment.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSAssessmentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSAssessmentDetails": { + "type": "object", + "description": "Data model of AKS Assessment Details.", + "properties": { + "webAppCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of web apps.", + "readOnly": true + }, + "webServerCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of web servers.", + "readOnly": true + }, + "machineCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of machines.", + "readOnly": true + }, + "totalMonthlyCost": { + "type": "number", + "format": "float", + "description": "Gets the total monthly cost.", + "readOnly": true + } + }, + "required": [ + "webAppCount", + "webServerCount", + "machineCount", + "totalMonthlyCost" + ], + "allOf": [ + { + "$ref": "#/definitions/AssessmentDetails" + } + ] + }, + "AKSAssessmentListResult": { + "type": "object", + "description": "The response of a AKSAssessment list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSAssessment items on this page", + "items": { + "$ref": "#/definitions/AKSAssessment" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSAssessmentOptions": { + "type": "object", + "description": "ARM model of AKS Assessment Options.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSAssessmentOptionsProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSAssessmentOptionsListResult": { + "type": "object", + "description": "The response of a AKSAssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSAssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/AKSAssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSAssessmentOptionsProperties": { + "type": "object", + "description": "ARM model of AKS Assessment Options Properties.", + "allOf": [ + { + "$ref": "#/definitions/OptionsArmPropertiesBase" + } + ] + }, + "AKSAssessmentProperties": { + "type": "object", + "description": "ARM model of AKS Assessment Properties.", + "properties": { + "settings": { + "$ref": "#/definitions/AKSAssessmentSettings", + "description": "Gets or sets AKS Assessment Settings." + }, + "details": { + "$ref": "#/definitions/AKSAssessmentDetails", + "description": "Gets AKS Assessment Details.", + "readOnly": true + } + }, + "required": [ + "settings" + ], + "allOf": [ + { + "$ref": "#/definitions/AssessmentPropertiesBase" + } + ] + }, + "AKSAssessmentSettings": { + "type": "object", + "description": "Data model of AKS Assessment Settings.", + "properties": { + "category": { + "$ref": "#/definitions/AzureVmCategory", + "description": "Gets or sets azure VM category." + }, + "savingsOptions": { + "$ref": "#/definitions/SavingsOptions", + "description": "Gets or sets savings options." + }, + "consolidation": { + "$ref": "#/definitions/ConsolidationType", + "description": "Gets or sets consolidation type." + }, + "pricingTier": { + "$ref": "#/definitions/PricingTier", + "description": "Gets or sets pricing tier." + } + }, + "required": [ + "category", + "savingsOptions", + "consolidation", + "pricingTier" + ], + "allOf": [ + { + "$ref": "#/definitions/AssessmentSettings" + } + ] + }, + "AKSAssessmentSummary": { + "type": "object", + "description": "Data model of AKS Assessment Summary.", + "properties": { + "skuSummary": { + "type": "object", + "description": "Gets SKU summary.", + "additionalProperties": { + "$ref": "#/definitions/SummaryDetails" + }, + "readOnly": true + }, + "webAppSummary": { + "type": "object", + "description": "Gets web app summary.", + "additionalProperties": { + "$ref": "#/definitions/SummaryDetails" + }, + "readOnly": true + }, + "webServerSummary": { + "type": "object", + "description": "Gets web server summary.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "webAppCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of web apps.", + "readOnly": true + }, + "webServerCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of web servers.", + "readOnly": true + }, + "machineCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of machines.", + "readOnly": true + }, + "totalMonthlyCost": { + "type": "number", + "format": "float", + "description": "Gets the total monthly cost.", + "readOnly": true + } + }, + "required": [ + "skuSummary", + "webAppSummary", + "webServerSummary", + "webAppCount", + "webServerCount", + "machineCount", + "totalMonthlyCost" + ] + }, + "AKSCluster": { + "type": "object", + "description": "ARM model of AKS Cluster.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSClusterProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSClusterListResult": { + "type": "object", + "description": "The response of a AKSCluster list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSCluster items on this page", + "items": { + "$ref": "#/definitions/AKSCluster" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSClusterProperties": { + "type": "object", + "description": "ARM model of AKS Cluster Properties.", + "allOf": [ + { + "$ref": "#/definitions/Cluster" + } + ] + }, + "AKSCostDetail": { + "type": "object", + "description": "ARM model of AKS Cost Detail.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSCostDetailProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSCostDetailListResult": { + "type": "object", + "description": "The response of a AKSCostDetail list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSCostDetail items on this page", + "items": { + "$ref": "#/definitions/AKSCostDetail" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSCostDetailProperties": { + "type": "object", + "description": "ARM model of AKS Cost Detail Properties.", + "allOf": [ + { + "$ref": "#/definitions/NodePool" + } + ] + }, + "AKSSummary": { + "type": "object", + "description": "ARM model of AKS Summary.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSSummaryListResult": { + "type": "object", + "description": "The response of a AKSSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSSummary items on this page", + "items": { + "$ref": "#/definitions/AKSSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSSummaryProperties": { + "type": "object", + "description": "ARM model of AKS Summary Properties.", + "properties": { + "aksAssessmentSummary": { + "$ref": "#/definitions/AKSAssessmentSummary", + "description": "Gets AKS assessment summary.", + "readOnly": true + } + }, + "required": [ + "aksAssessmentSummary" + ], + "allOf": [ + { + "$ref": "#/definitions/SummaryPropertiesBase" + } + ] + }, + "ApiVersions": { + "type": "string", + "description": "Common API Versions for Assessment Project Tracked Resource.", + "enum": [ + "2019-10-01", + "2020-01-01", + "2020-05-01-preview", + "2022-02-02-preview", + "2022-08-01-preview", + "2023-03-03", + "2023-03-15", + "2023-04-01-preview", + "2023-05-01-preview", + "2023-07-07-preview" + ], + "x-ms-enum": { + "name": "ApiVersions", + "modelAsString": true, + "values": [ + { + "name": "v2019_10_01", + "value": "2019-10-01", + "description": "2019-10-01 API Version." + }, + { + "name": "v2020_01_01", + "value": "2020-01-01", + "description": "2020-01-01 API Version." + }, + { + "name": "v2020_05_01_preview", + "value": "2020-05-01-preview", + "description": "2020-05-01-preview API Version." + }, + { + "name": "v2022_02_02_preview", + "value": "2022-02-02-preview", + "description": "2022-02-02-preview API Version." + }, + { + "name": "v2022_08_01_preview", + "value": "2022-08-01-preview", + "description": "2022-08-01-preview API Version." + }, + { + "name": "v2023_03_03", + "value": "2023-03-03", + "description": "2023-03-03 API Version." + }, + { + "name": "v2023_03_15", + "value": "2023-03-15", + "description": "2023-03-15 API Version." + }, + { + "name": "v2023_04_01_preview", + "value": "2023-04-01-preview", + "description": "2023-04-01-preview API Version." + }, + { + "name": "v2023_05_01_preview", + "value": "2023-05-01-preview", + "description": "2023-05-01-preview API Version." + }, + { + "name": "v2023_07_07_preview", + "value": "2023-07-07-preview", + "description": "2023-07-07-preview API Version." + } + ] + } + }, + "AppServiceSku": { + "type": "object", + "description": "The app service SKU with corresponding cost.", + "properties": { + "skuName": { + "type": "string", + "description": "The SKU name.", + "readOnly": true + }, + "cost": { + "type": "number", + "format": "float", + "description": "The cost details.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of service plans recommended.", + "readOnly": true + } + } + }, + "AppSvcContainerSettings": { + "type": "object", + "description": "App service container settings.", + "properties": { + "isolationRequired": { + "type": "boolean", + "description": "Gets or sets the isolation required." + } + }, + "required": [ + "isolationRequired" + ] + }, + "AppSvcNativeSettings": { + "type": "object", + "description": "App service native settings.", + "properties": { + "isolationRequired": { + "type": "boolean", + "description": "Gets or sets the isolation required." + } + }, + "required": [ + "isolationRequired" + ] + }, + "AssessedDisk": { + "type": "object", + "properties": { + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability." + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureDiskSuitabilityExplanation", + "description": "Gets the suitability explanation." + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureDiskSuitabilityDetail", + "description": "Gets the suitability detail." + }, + "recommendedDiskSize": { + "$ref": "#/definitions/AzureDiskSize", + "description": "Gets the recommended disk size." + }, + "recommendedDiskType": { + "$ref": "#/definitions/AzureDiskType", + "description": "Gets the recommended disk type." + }, + "gigabytesForRecommendedDiskSize": { + "type": "integer", + "format": "int32", + "description": "Gets the recommended disk size." + }, + "recommendDiskThroughputInMbps": { + "type": "number", + "format": "float", + "description": "Gets the recommended disk throughput." + }, + "recommendedDiskIops": { + "type": "number", + "format": "float", + "description": "Gets the recommended disk iops." + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost." + }, + "name": { + "type": "string", + "description": "Gets the name." + }, + "displayName": { + "type": "string", + "description": "Gets the machine display name." + }, + "gigabytesProvisioned": { + "type": "number", + "format": "float", + "description": "Gets the gigabytes provisioned." + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of write." + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of read operations per second." + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of write operations per second." + } + } + }, + "AssessedDiskData": { + "type": "object", + "description": "Assessed Disk data. Used in Assessed SQL machine DTO.", + "properties": { + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability." + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureDiskSuitabilityExplanation", + "description": "Gets the suitability explanation." + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureDiskSuitabilityDetail", + "description": "Gets the suitability detail." + }, + "recommendedDiskSize": { + "$ref": "#/definitions/AzureDiskSize", + "description": "Gets the recommended disk size." + }, + "recommendedDiskType": { + "$ref": "#/definitions/AzureDiskType", + "description": "Gets the recommended disk type." + }, + "recommendedDiskSizeGigabytes": { + "type": "integer", + "format": "int32", + "description": "Gets the recommended disk size." + }, + "recommendDiskThroughputInMbps": { + "type": "number", + "format": "float", + "description": "Gets the recommended disk throughput." + }, + "recommendedDiskIops": { + "type": "number", + "format": "float", + "description": "Gets the recommended disk iops." + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost." + }, + "name": { + "type": "string", + "description": "Gets the name." + }, + "displayName": { + "type": "string", + "description": "Gets the machine display name." + }, + "gigabytesProvisioned": { + "type": "number", + "format": "float", + "description": "Gets the gigabytes provisioned." + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of write." + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of read operations per second." + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of write operations per second." + } + } + }, + "AssessedMachine": { + "type": "object", + "description": "Machine assessment Assessed Machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedMachineListResult": { + "type": "object", + "description": "The response of a AssessedMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedMachine items on this page", + "items": { + "$ref": "#/definitions/AssessedMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedMachineProperties": { + "type": "object", + "description": "Assessed machine properties class.", + "properties": { + "errors": { + "type": "array", + "description": "List of errors for this machine.", + "items": { + "$ref": "#/definitions/Error" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "disks": { + "type": "object", + "description": "Dictionary of disks attached to the machine. Key is ID of disk. Value is a disk object.", + "additionalProperties": { + "$ref": "#/definitions/AssessedDisk" + }, + "readOnly": true + }, + "monthlyUltraStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly ultra storage cost.", + "readOnly": true + }, + "hostProcessor": { + "$ref": "#/definitions/ProcessorInfo", + "description": "Gets or sets the processor details of the host." + }, + "costComponents": { + "type": "array", + "description": "Gets or sets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "x-ms-identifiers": [] + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "monthlyBandwidthCost": { + "type": "number", + "format": "float", + "description": "Monthly networking cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly storage cost.", + "readOnly": true + }, + "monthlyPremiumStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly premium storage cost.", + "readOnly": true + }, + "monthlyStandardSsdStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly standard SSD storage cost.", + "readOnly": true + }, + "networkAdapters": { + "type": "object", + "description": "List of Network Adapters that were assessed as part of this machine's\nassessment.", + "additionalProperties": { + "$ref": "#/definitions/AssessedNetworkAdapter" + }, + "readOnly": true + }, + "recommendedSize": { + "$ref": "#/definitions/AzureVmSize", + "description": "Recommended Azure Size for the machine.", + "readOnly": true + }, + "numberOfCoresForRecommendedSize": { + "type": "integer", + "format": "int32", + "description": "Number of cores for recommended size. Read Only.", + "readOnly": true + }, + "megabytesOfMemoryForRecommendedSize": { + "type": "number", + "format": "float", + "description": "Megabytes of memory for recommended size. Read Only.", + "readOnly": true + }, + "monthlyComputeCostForRecommendedSize": { + "type": "number", + "format": "float", + "description": "Monthly Compute cost calculated for Recommended size, for a 31-day month.", + "readOnly": true + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureVmSuitabilityExplanation", + "description": "Gets the explanation if machine is not suitable for cloud.", + "readOnly": true + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureVmSuitabilityDetail", + "description": "Gets the details if machine is not suitable for cloud.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/AssessedMachineType", + "description": "Assessed machine type.", + "readOnly": true + }, + "bootType": { + "$ref": "#/definitions/MachineBootType", + "description": "Boot type of machine discovered in private data center.", + "readOnly": true + }, + "operatingSystemType": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemVersion": { + "type": "string", + "description": "Operating system version as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemArchitecture": { + "$ref": "#/definitions/GuestOperatingSystemArchitecture", + "description": "Operating system architecture as reported by datacenter management solution.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine last updated.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name of the Machine.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description for the machine.", + "readOnly": true + }, + "datacenterMachineArmId": { + "type": "string", + "description": "Data center machine ARM id.", + "readOnly": true + }, + "datacenterManagementServerArmId": { + "type": "string", + "description": "Data center management server ARM id.", + "readOnly": true + }, + "datacenterManagementServerName": { + "type": "string", + "description": "Data center management server name.", + "readOnly": true + }, + "megabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Megabytes of memory found allocated for the machine in private data center.", + "readOnly": true + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores found on the machine.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Cores Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "percentageMemoryUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Memory Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets a value indicating whether machine is suitable for the cloud platform\nselected.", + "readOnly": true + } + } + }, + "AssessedMachineType": { + "type": "string", + "enum": [ + "Unknown", + "AssessedMachine", + "AvsAssessedMachine", + "SqlAssessedMachine" + ], + "x-ms-enum": { + "name": "AssessedMachineType", + "modelAsString": true + } + }, + "AssessedNetworkAdapter": { + "type": "object", + "description": "Assessed Network Adapter.", + "properties": { + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability." + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureNetworkAdapterSuitabilityDetail", + "description": "Gets the suitability detail." + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureNetworkAdapterSuitabilityExplanation", + "description": "Gets the suitability explanation." + }, + "monthlyBandwidthCosts": { + "type": "number", + "format": "float", + "description": "Gets the monthly bandwidth costs." + }, + "netGigabytesTransmittedPerMonth": { + "type": "number", + "format": "float", + "description": "Gets the net gigabytes transmitted per month." + }, + "displayName": { + "type": "string", + "description": "Gets the display name." + }, + "macAddress": { + "type": "string", + "description": "Gets the mac address." + }, + "ipAddresses": { + "type": "array", + "description": "Gets the ip addresses.", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "megabytesPerSecondReceived": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second received." + }, + "megabytesPerSecondTransmitted": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second transmitted." + } + } + }, + "AssessedSqlDatabaseV2": { + "type": "object", + "description": "Assessed SQL database web model class.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedSqlDatabaseV2Properties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedSqlDatabaseV2ListResult": { + "type": "object", + "description": "The response of a AssessedSqlDatabaseV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedSqlDatabaseV2 items on this page", + "items": { + "$ref": "#/definitions/AssessedSqlDatabaseV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedSqlDatabaseV2Properties": { + "type": "object", + "description": "Assessed SQL database properties web model.", + "properties": { + "recommendedAzureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets or sets the recommended azure SQL target type.", + "readOnly": true + }, + "recommendedSuitability": { + "$ref": "#/definitions/RecommendedSuitability", + "description": "Gets or sets the recommended azure SQL suitability.", + "readOnly": true + }, + "bufferCacheSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregated cache size of this database. This is a performance\ndata metric for this DB.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "azureSqlMISuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "Gets or sets the azure SQL MI suitability details.", + "readOnly": true + }, + "azureSqlDBSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "Gets or sets the azure SQL DB suitability details.", + "readOnly": true + }, + "isDatabaseHighlyAvailable": { + "type": "boolean", + "description": "Gets a value indicating whether the assessed SQL database is highly available\nor not.", + "readOnly": true + }, + "linkedAvailabilityGroupOverview": { + "$ref": "#/definitions/SqlAvailabilityGroupDataOverview", + "description": "Gets the linked availability group overview if the database being assessed is\nhighly available.", + "readOnly": true + }, + "machineArmId": { + "type": "string", + "description": "Machine arm id.", + "readOnly": true + }, + "assessedSqlInstanceArmId": { + "type": "string", + "description": "Assessed SQL instance arm id.", + "readOnly": true + }, + "machineName": { + "type": "string", + "description": "Machine display name.", + "readOnly": true + }, + "instanceName": { + "type": "string", + "description": "SQL instance name.", + "readOnly": true + }, + "databaseName": { + "type": "string", + "description": "SQL database name.", + "readOnly": true + }, + "databaseSizeInMB": { + "type": "number", + "format": "float", + "description": "SQL database size in megabytes.", + "readOnly": true + }, + "compatibilityLevel": { + "$ref": "#/definitions/CompatibilityLevel", + "description": "Database compatibility level.", + "readOnly": true + }, + "sqlDatabaseSdsArmId": { + "type": "string", + "description": "SQL database SDS arm id.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "The percentage of the total number of cores being utilized by the SQL database.", + "readOnly": true + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "The read throughput of the SQL database.", + "readOnly": true + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "The write throughput of the SQL database.", + "readOnly": true + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "The read operations per second of the SQL database.", + "readOnly": true + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "The write operations per second of the SQL database.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL database first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL database last updated.", + "readOnly": true + } + } + }, + "AssessedSqlInstanceDatabaseSummary": { + "type": "object", + "description": "Assessed Sql Instance Database Summary.", + "properties": { + "numberOfUserDatabases": { + "type": "integer", + "format": "int32", + "description": "Gets the number of user databases." + }, + "totalDatabaseSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the total database size in MB." + }, + "largestDatabaseSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the largest database size in MB." + }, + "totalDiscoveredUserDatabases": { + "type": "integer", + "format": "int32", + "description": "Gets the total discovered user databases." + } + } + }, + "AssessedSqlInstanceDiskDetails": { + "type": "object", + "description": "Assessed Sql Instance Disk Details.", + "properties": { + "diskId": { + "type": "string", + "description": "Gets the disk id." + }, + "diskSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the disk size in mb." + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of write." + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of read operations per second." + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of write operations per second." + } + } + }, + "AssessedSqlInstanceStorageDetails": { + "type": "object", + "description": "Assessed Sql Instance Storage Details.", + "properties": { + "storageType": { + "type": "string", + "description": "Gets the storage type." + }, + "diskSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the disk size in mb." + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of read operations per second." + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of write operations per second." + } + } + }, + "AssessedSqlInstanceSummary": { + "type": "object", + "description": "Assessed Sql Instance Summary.", + "properties": { + "instanceId": { + "type": "string", + "description": "Gets the instance id." + }, + "instanceName": { + "type": "string", + "description": "Gets the instance name." + }, + "sqlInstanceSdsArmId": { + "type": "string", + "description": "Gets the instance arm id." + }, + "sqlInstanceEntityId": { + "type": "string", + "description": "Gets the instance entity id." + }, + "sqlEdition": { + "type": "string", + "description": "Gets the Sql edition." + }, + "sqlVersion": { + "type": "string", + "description": "Gets the Sql version." + }, + "isClustered": { + "type": "boolean", + "description": "Gets whether Sql is clustered." + }, + "isHighAvailabilityEnabled": { + "type": "boolean", + "description": "Gets whether Sql is highly available." + }, + "sqlFciState": { + "$ref": "#/definitions/SqlFCIState", + "description": "Gets the Sql Fci state." + } + } + }, + "AssessedSqlInstanceV2": { + "type": "object", + "description": "Assessed SQL instance web model class.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedSqlInstanceV2Properties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedSqlInstanceV2ListResult": { + "type": "object", + "description": "The response of a AssessedSqlInstanceV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedSqlInstanceV2 items on this page", + "items": { + "$ref": "#/definitions/AssessedSqlInstanceV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedSqlInstanceV2Properties": { + "type": "object", + "description": "Assessed SQL instance properties web model.", + "properties": { + "memoryInUseInMB": { + "type": "number", + "format": "float", + "description": "Gets or sets the memory used by SQL instance in megabytes.", + "readOnly": true + }, + "hasScanOccurred": { + "type": "boolean", + "description": "Gets or sets a value indicating whether SQL instance has been deep discovered.", + "readOnly": true + }, + "recommendedAzureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets or sets the recommended azure SQL target type.", + "readOnly": true + }, + "recommendedSuitability": { + "$ref": "#/definitions/RecommendedSuitability", + "description": "Gets or sets the recommended azure SQL suitability.", + "readOnly": true + }, + "azureSqlMISuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "SQL instance azure SQL MI suitability details.", + "readOnly": true + }, + "azureSqlDBSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "SQL instance azure SQL DB suitability details.", + "readOnly": true + }, + "azureSqlVMSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2IaasSuitabilityData", + "description": "SQL instance azure SQL VM suitability details.", + "readOnly": true + }, + "storageTypeBasedDetails": { + "type": "array", + "description": "Gets the storage details.", + "items": { + "$ref": "#/definitions/AssessedSqlInstanceStorageDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "fciMetadata": { + "$ref": "#/definitions/SqlFCIMetadata", + "description": "Gets the FCI metadata if this instance represents an FCI instance.", + "readOnly": true + }, + "availabilityReplicaSummary": { + "$ref": "#/definitions/SqlAvailabilityReplicaSummary", + "description": "Gets the overview counts of availability replicas in the assessed instance, by\ncommit mode and read type.", + "readOnly": true + }, + "isClustered": { + "type": "boolean", + "description": "Gets a value indicating whether the SQL instance is clustered or not.", + "readOnly": true + }, + "isHighAvailabilityEnabled": { + "type": "boolean", + "description": "Gets a value indicating whether the high availability is enabled or not.", + "readOnly": true + }, + "recommendedTargetReasonings": { + "type": "array", + "description": "Gets the list of recommended target reasoning.", + "items": { + "$ref": "#/definitions/SqlRecommendationReasoning" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "machineArmId": { + "type": "string", + "description": "Machine arm id.", + "readOnly": true + }, + "machineName": { + "type": "string", + "description": "Machine display name.", + "readOnly": true + }, + "instanceName": { + "type": "string", + "description": "SQL instance name.", + "readOnly": true + }, + "sqlInstanceSdsArmId": { + "type": "string", + "description": "SQL instance SDS arm id.", + "readOnly": true + }, + "sqlEdition": { + "type": "string", + "description": "SQL instance edition.", + "readOnly": true + }, + "sqlVersion": { + "type": "string", + "description": "SQL instance version.", + "readOnly": true + }, + "numberOfCoresAllocated": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores assigned to the SQL instance.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "The percentage of the total number of cores being utilized by the SQL instance.", + "readOnly": true + }, + "logicalDisks": { + "type": "array", + "description": "The logical disk details.", + "items": { + "$ref": "#/definitions/AssessedSqlInstanceDiskDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "databaseSummary": { + "$ref": "#/definitions/AssessedSqlInstanceDatabaseSummary", + "description": "The databases summary.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL instance first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL instance last updated.", + "readOnly": true + } + } + }, + "AssessedSqlMachine": { + "type": "object", + "description": "SQL Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedSqlMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedSqlMachineListResult": { + "type": "object", + "description": "The response of a AssessedSqlMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedSqlMachine items on this page", + "items": { + "$ref": "#/definitions/AssessedSqlMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedSqlMachineProperties": { + "type": "object", + "description": "Assessed SQL machine properties.", + "properties": { + "biosGuid": { + "type": "string", + "description": "Gets or sets the BIOS GUID for the machine.", + "readOnly": true + }, + "fqdn": { + "type": "string", + "description": "Gets or sets the FQDN for the machine.", + "readOnly": true + }, + "sqlInstances": { + "type": "array", + "description": "Gets the list of SQL instances discovered on the machine.", + "items": { + "$ref": "#/definitions/AssessedSqlInstanceSummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureVmSuitabilityDetail", + "description": "Gets or sets the detailed messages that were set on the machine during\nevaluation.", + "readOnly": true + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureVmSuitabilityExplanation", + "description": "Gets or sets the explanation if machine is not suitable for cloud.", + "readOnly": true + }, + "recommendedVmSize": { + "$ref": "#/definitions/AzureVmSize", + "description": "Gets or sets the Recommended Azure Size for the machine.", + "readOnly": true + }, + "recommendedVmFamily": { + "$ref": "#/definitions/AzureVmFamily", + "description": "Gets or sets the Recommended Azure VM Family for the machine.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "recommendedVmSizeNumberOfCores": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Number of cores for recommended size.", + "readOnly": true + }, + "recommendedVmSizeMegabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Gets or sets the Megabytes of memory for recommended size.", + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the monthly compute cost calculated for recommended size.", + "readOnly": true + }, + "disks": { + "type": "object", + "description": "Gets the list of data disks that were assessed as part of this assessment.", + "additionalProperties": { + "$ref": "#/definitions/AssessedDiskData" + }, + "readOnly": true + }, + "networkAdapters": { + "type": "object", + "description": "Gets the list of network adapters that were assessed as part of this assessment.", + "additionalProperties": { + "$ref": "#/definitions/SqlAssessedNetworkAdapter" + }, + "readOnly": true + }, + "monthlyBandwidthCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the monthly networking cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the monthly total storage cost.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Gets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "x-ms-identifiers": [] + }, + "securitySuitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability for Microsoft cloud defender.", + "readOnly": true + }, + "migrationGuidelines": { + "type": "array", + "description": "Gets the list of migration guidelines applicable.", + "items": { + "$ref": "#/definitions/SqlMigrationGuideline" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "bootType": { + "$ref": "#/definitions/MachineBootType", + "description": "Boot type of machine discovered in private data center.", + "readOnly": true + }, + "operatingSystemType": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemVersion": { + "type": "string", + "description": "Operating system version as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemArchitecture": { + "$ref": "#/definitions/GuestOperatingSystemArchitecture", + "description": "Operating system architecture as reported by datacenter management solution.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine last updated.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name of the Machine.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/AssessedMachineType", + "description": "Assessed machine type.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description for the machine.", + "readOnly": true + }, + "datacenterMachineArmId": { + "type": "string", + "description": "Data center machine ARM id.", + "readOnly": true + }, + "datacenterManagementServerArmId": { + "type": "string", + "description": "Data center management server ARM id.", + "readOnly": true + }, + "datacenterManagementServerName": { + "type": "string", + "description": "Data center management server name.", + "readOnly": true + }, + "megabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Megabytes of memory found allocated for the machine in private data center.", + "readOnly": true + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores found on the machine.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Cores Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "percentageMemoryUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Memory Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets a value indicating whether machine is suitable for the cloud platform\nselected.", + "readOnly": true + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion.", + "readOnly": true + } + } + }, + "AssessedSqlRecommendedEntity": { + "type": "object", + "description": "SQL Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedSqlRecommendedEntityProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedSqlRecommendedEntityListResult": { + "type": "object", + "description": "The response of a AssessedSqlRecommendedEntity list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedSqlRecommendedEntity items on this page", + "items": { + "$ref": "#/definitions/AssessedSqlRecommendedEntity" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedSqlRecommendedEntityProperties": { + "type": "object", + "description": "Assessed SQL recommended entity properties.", + "properties": { + "machineName": { + "type": "string", + "description": "Gets or sets machine name.", + "readOnly": true + }, + "instanceName": { + "type": "string", + "description": "Gets or sets SQL instance name.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "dbCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets assessed database count.", + "readOnly": true + }, + "discoveredDBCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the total discovered database count.", + "readOnly": true + }, + "hasScanOccurred": { + "type": "boolean", + "description": "Gets or sets a value indicating whether instance deep discovery has occurred or\nnot.", + "readOnly": true + }, + "recommendedAzureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets or sets the recommended azure SQL target type.", + "readOnly": true + }, + "recommendedSuitability": { + "$ref": "#/definitions/RecommendedSuitability", + "description": "Gets or sets the recommended azure SQL suitability.", + "readOnly": true + }, + "azureSqlMISuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "SQL instance azure SQL MI suitability details.", + "readOnly": true + }, + "azureSqlDBSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "SQL instance azure SQL DB suitability details.", + "readOnly": true + }, + "azureSqlVMSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2IaasSuitabilityData", + "description": "SQL instance azure SQL VM suitability details.", + "readOnly": true + }, + "assessedSqlEntityArmId": { + "type": "string", + "description": "Gets or sets Arm id of assessed entity." + }, + "isClustered": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the SQL instance is clustered or not.", + "readOnly": true + }, + "isHighAvailabilityEnabled": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the high availability is enabled or not.", + "readOnly": true + }, + "sqlEdition": { + "type": "string", + "description": "Gets the SQL edition from the recommended entity if applicable.", + "readOnly": true + }, + "sqlVersion": { + "type": "string", + "description": "Gets the SQL version from the recommended entity if applicable.", + "readOnly": true + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion.", + "readOnly": true + } + } + }, + "AssessedWebApp": { + "type": "object", + "description": "Data model of Assessed Web App.", + "properties": { + "suitabilityResult": { + "$ref": "#/definitions/SuitabilityResult", + "description": "Gets suitability result.", + "readOnly": true + }, + "recommendationResult": { + "$ref": "#/definitions/RecommendationResult", + "description": "Gets recommendation result.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/WebApp" + } + ] + }, + "AssessedWebAppV2": { + "type": "object", + "description": "Assessed Web app web model class.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedWebAppV2Properties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedWebAppV2ListResult": { + "type": "object", + "description": "The response of a AssessedWebAppV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedWebAppV2 items on this page", + "items": { + "$ref": "#/definitions/AssessedWebAppV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedWebAppV2Properties": { + "type": "object", + "description": "Assessed Web app database properties web model.", + "properties": { + "webAppType": { + "$ref": "#/definitions/WebAppType", + "description": "Gets or sets the web app type.", + "readOnly": true + }, + "targetSpecificResult": { + "type": "object", + "description": "Gets or sets the target specific result.", + "additionalProperties": { + "$ref": "#/definitions/TargetSpecificResult" + }, + "readOnly": true + }, + "appServicePlanName": { + "type": "string", + "description": "Gets or sets the app service plan name.", + "readOnly": true + }, + "machineName": { + "type": "string", + "description": "Gets the machine name.", + "readOnly": true + }, + "serverArmId": { + "type": "string", + "description": "Gets or sets the server ARM Id.", + "readOnly": true + }, + "webServerName": { + "type": "string", + "description": "Gets or sets the web server name.", + "readOnly": true + }, + "webAppName": { + "type": "string", + "description": "Gets or sets web app name.", + "readOnly": true + }, + "discoveredWebAppId": { + "type": "string", + "description": "Gets the discovered web app ID.", + "readOnly": true + }, + "discoveredMachineId": { + "type": "string", + "description": "Machine arm id.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL database first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed Web app database last updated.", + "readOnly": true + } + }, + "required": [ + "appServicePlanName", + "machineName" + ] + }, + "AssessedWebApplication": { + "type": "object", + "description": "ARM model of Assessed Web Application.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedWebApplicationProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedWebApplicationListResult": { + "type": "object", + "description": "The response of a AssessedWebApplication list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedWebApplication items on this page", + "items": { + "$ref": "#/definitions/AssessedWebApplication" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedWebApplicationProperties": { + "type": "object", + "description": "ARM model of Assessed Web Application Properties.", + "allOf": [ + { + "$ref": "#/definitions/AssessedWebApp" + } + ] + }, + "Assessment": { + "type": "object", + "description": "Machine assessment resource.", + "properties": { + "properties": { + "$ref": "#/definitions/MachineAssessmentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessmentDetails": { + "type": "object", + "description": "Data model of Details of Assessment Computation.", + "properties": { + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets last time when rates were queried.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Gets Confidence score.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets date and time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets date and time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Gets assessment status.", + "readOnly": true + } + }, + "required": [ + "createdTimestamp", + "updatedTimestamp", + "status" + ] + }, + "AssessmentListResult": { + "type": "object", + "description": "The response of a Assessment list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Assessment items on this page", + "items": { + "$ref": "#/definitions/Assessment" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessmentOptions": { + "type": "object", + "description": "Assessment options resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessmentOptionsProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessmentOptionsListResult": { + "type": "object", + "description": "The response of a AssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/AssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessmentOptionsProperties": { + "type": "object", + "description": "Assessment options properties.", + "properties": { + "vmFamilies": { + "type": "array", + "description": "Dictionary of VM families grouped by vm family name describing the targeted\nazure locations of VM family and the category of the family.", + "items": { + "$ref": "#/definitions/VmFamilyOptions" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "reservedInstanceVmFamilies": { + "type": "array", + "description": "List of supported VM Families.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "reservedInstanceSupportedLocations": { + "type": "array", + "description": "List of supported Azure regions for reserved instances.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "reservedInstanceSupportedCurrencies": { + "type": "array", + "description": "List of supported currencies for reserved instances.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "reservedInstanceSupportedOffers": { + "type": "array", + "description": "List of supported Azure offer codes for reserved instances.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "ultraDiskVmFamilies": { + "type": "array", + "description": "Ultra disk related assessment options.", + "items": { + "$ref": "#/definitions/UltraDiskAssessmentOptions" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "premiumDiskVmFamilies": { + "type": "array", + "description": "List of VM Families that support premium disks for assessments.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "savingsPlanVmFamilies": { + "type": "array", + "description": "List of VM Families that support Savings plan offer for assessments.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "savingsPlanSupportedLocations": { + "type": "array", + "description": "List of Azure locations that support Savings plan offer for assessments.", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "AssessmentProject": { + "type": "object", + "description": "An Assessment project site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/ProjectProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "AssessmentProjectListResult": { + "type": "object", + "description": "The response of a AssessmentProject list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessmentProject items on this page", + "items": { + "$ref": "#/definitions/AssessmentProject" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessmentProjectSummary": { + "type": "object", + "description": "Assessment project summary resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessmentProjectSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessmentProjectSummaryListResult": { + "type": "object", + "description": "The response of a AssessmentProjectSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessmentProjectSummary items on this page", + "items": { + "$ref": "#/definitions/AssessmentProjectSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessmentProjectSummaryProperties": { + "type": "object", + "description": "Assessment project summary properties class.", + "properties": { + "errorSummaryAffectedEntities": { + "type": "array", + "description": "Gets the Error summary by feature. Contains number of affected Entities per\nfeature.", + "items": { + "$ref": "#/definitions/ErrorSummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "numberOfPrivateEndpointConnections": { + "type": "integer", + "format": "int32", + "description": "Gets the number of private endpoint connections.", + "readOnly": true + }, + "numberOfGroups": { + "type": "integer", + "format": "int32", + "description": "Gets the number of groups created in this project.", + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Gets the number of machines part of this project.", + "readOnly": true + }, + "numberOfImportMachines": { + "type": "integer", + "format": "int32", + "description": "Gets the number of import machines part of this project.", + "readOnly": true + }, + "numberOfAssessments": { + "type": "integer", + "format": "int32", + "description": "Gets the number of assessments created in this project.", + "readOnly": true + }, + "lastAssessmentTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets the last assessment timestamp.", + "readOnly": true + } + } + }, + "AssessmentProjectUpdate": { + "type": "object", + "description": "The type used for update operations of the AssessmentProject.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/AssessmentProjectUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "AssessmentProjectUpdateProperties": { + "type": "object", + "description": "The updatable properties of the AssessmentProject.", + "properties": { + "assessmentSolutionId": { + "type": "string", + "description": "Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects." + }, + "projectStatus": { + "$ref": "#/definitions/ProjectStatus", + "description": "Assessment project status." + }, + "customerWorkspaceId": { + "type": "string", + "description": "The ARM id of service map workspace created by customer." + }, + "customerWorkspaceLocation": { + "type": "string", + "description": "Location of service map workspace created by customer." + }, + "publicNetworkAccess": { + "type": "string", + "description": "This value can be set to 'enabled' to avoid breaking changes on existing\ncustomer resources and templates. If set to 'disabled', traffic over public\ninterface is not allowed, and private endpoint connections would be the\nexclusive access method." + }, + "customerStorageAccountArmId": { + "type": "string", + "description": "The ARM id of the storage account used for interactions when public access is\ndisabled." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "AssessmentPropertiesBase": { + "type": "object", + "description": "Base ARM model of Assessment ARM properties.", + "properties": { + "scope": { + "$ref": "#/definitions/AssessmentScopeParameters", + "description": "Gets or sets scope parameters to identify inventory items for assessment." + } + }, + "allOf": [ + { + "$ref": "#/definitions/MutableArmResource" + } + ] + }, + "AssessmentResult": { + "type": "object", + "description": "Assessment results.", + "properties": { + "appServicePlanName": { + "type": "string", + "description": "Gets or sets the app service plan name." + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets or sets the suitability." + }, + "securitySuitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets or sets the security suitability." + }, + "webAppSkuName": { + "type": "string", + "description": "Gets or sets the web app sku name." + }, + "webAppSkuSize": { + "type": "string", + "description": "Gets or sets the web app sku size." + } + }, + "required": [ + "appServicePlanName", + "suitability", + "securitySuitability", + "webAppSkuName", + "webAppSkuSize" + ] + }, + "AssessmentScopeParameters": { + "type": "object", + "description": "Data model of Assessment Scope Parameters.", + "properties": { + "serverGroupId": { + "type": "string", + "description": "Gets or sets the server group id." + } + } + }, + "AssessmentSettings": { + "type": "object", + "description": "Base data model of Assessment Settings.", + "properties": { + "azureLocation": { + "type": "string", + "description": "Gets or sets azure location." + }, + "environmentType": { + "$ref": "#/definitions/AzureEnvironmentType", + "description": "Gets or sets environment type." + }, + "licensingProgram": { + "$ref": "#/definitions/LicensingProgram", + "description": "Gets or sets licensing program." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Gets or sets currency." + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Gets or sets discount percentage." + }, + "sizingCriteria": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Gets or sets sizing criteria." + }, + "performanceData": { + "$ref": "#/definitions/PerfDataSettings", + "description": "Gets or sets performance data settings." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Gets or sets scaling factor." + } + }, + "required": [ + "azureLocation", + "environmentType", + "licensingProgram", + "currency", + "sizingCriteria" + ] + }, + "AssessmentSizingCriterion": { + "type": "string", + "description": "Assessment Sizing Criteria.", + "enum": [ + "PerformanceBased", + "AsOnPremises" + ], + "x-ms-enum": { + "name": "AssessmentSizingCriterion", + "modelAsString": true, + "values": [ + { + "name": "PerformanceBased", + "value": "PerformanceBased", + "description": "Performance Data based Sizing." + }, + { + "name": "AsOnPremises", + "value": "AsOnPremises", + "description": "As On Premises or Static Data based Sizing." + } + ] + } + }, + "AssessmentStage": { + "type": "string", + "enum": [ + "InProgress", + "UnderReview", + "Approved" + ], + "x-ms-enum": { + "name": "AssessmentStage", + "modelAsString": true + } + }, + "AssessmentStatus": { + "type": "string", + "description": "Assessment Status.", + "enum": [ + "Created", + "Updated", + "Running", + "Completed", + "Invalid", + "OutOfSync", + "OutDated", + "Deleted" + ], + "x-ms-enum": { + "name": "AssessmentStatus", + "modelAsString": true, + "values": [ + { + "name": "Created", + "value": "Created", + "description": "Assessment is Created." + }, + { + "name": "Updated", + "value": "Updated", + "description": "Assessment is Updated." + }, + { + "name": "Running", + "value": "Running", + "description": "Assessment is currently running." + }, + { + "name": "Completed", + "value": "Completed", + "description": "Assessment is Completed or Ready." + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Assessment is Failed i.e. it is now invalid." + }, + { + "name": "OutOfSync", + "value": "OutOfSync", + "description": "Assessment is Out of Sync." + }, + { + "name": "OutDated", + "value": "OutDated", + "description": "Assessment is Out Dated." + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "Assessment is Deleted." + } + ] + } + }, + "AssessmentType": { + "type": "string", + "enum": [ + "Unknown", + "MachineAssessment", + "AvsAssessment", + "SqlAssessment", + "WebAppAssessment" + ], + "x-ms-enum": { + "name": "AssessmentType", + "modelAsString": true + } + }, + "AsyncCommitModeIntent": { + "type": "string", + "enum": [ + "None", + "HighAvailability", + "DisasterRecovery" + ], + "x-ms-enum": { + "name": "AsyncCommitModeIntent", + "modelAsString": true + } + }, + "AvsAssessedDisk": { + "type": "object", + "description": "AVS assessed disk web model class.", + "properties": { + "name": { + "type": "string", + "description": "Gets the ID of the disk.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets the display name of the disk.", + "readOnly": true + }, + "gigabytesProvisioned": { + "type": "number", + "format": "float", + "description": "Gigabytes Provisioned for a disk in private data center.", + "readOnly": true + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Disk Read Throughput in MB/s.", + "readOnly": true + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Disk Write Throughput in MB/s.", + "readOnly": true + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Read Operations per second.", + "readOnly": true + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Write Operations per second.", + "readOnly": true + }, + "assessedExternalStorageType": { + "$ref": "#/definitions/ExternalStorageType", + "description": "Associated storage Type recommended for Disk.", + "readOnly": true + }, + "estimatedDiskSizeInGB": { + "type": "number", + "format": "float", + "description": "Estimated Disk Size in GB.", + "readOnly": true + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureDiskSuitabilityDetail", + "description": "Gets the suitability detail.", + "readOnly": true + } + } + }, + "AvsAssessedMachine": { + "type": "object", + "description": "AVS assessment Assessed Machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AvsAssessedMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AvsAssessedMachineListResult": { + "type": "object", + "description": "The response of a AvsAssessedMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AvsAssessedMachine items on this page", + "items": { + "$ref": "#/definitions/AvsAssessedMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AvsAssessedMachineProperties": { + "type": "object", + "description": "AVS assessed machine properties web model.", + "properties": { + "errors": { + "type": "array", + "description": "List of errors for this machine.", + "items": { + "$ref": "#/definitions/Error" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "disks": { + "type": "object", + "description": "List of Disks that were assessed as part of this machine's assessment.", + "additionalProperties": { + "$ref": "#/definitions/AvsAssessedDisk" + }, + "readOnly": true + }, + "networkAdapters": { + "type": "object", + "description": "List of Network Adapters that were assessed as part of this machine's\nassessment.", + "additionalProperties": { + "$ref": "#/definitions/AvsAssessedNetworkAdapter" + }, + "readOnly": true + }, + "storageInUseGB": { + "type": "number", + "format": "float", + "description": "Gets the storage in use.", + "readOnly": true + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureAvsVmSuitabilityExplanation", + "description": "Gets the explanation if machine is not suitable for cloud.", + "readOnly": true + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureAvsVmSuitabilityDetail", + "description": "Gets the details if machine is not suitable for cloud.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/AssessedMachineType", + "description": "Assessed machine type.", + "readOnly": true + }, + "bootType": { + "$ref": "#/definitions/MachineBootType", + "description": "Boot type of machine discovered in private data center.", + "readOnly": true + }, + "operatingSystemType": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemVersion": { + "type": "string", + "description": "Operating system version as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemArchitecture": { + "$ref": "#/definitions/GuestOperatingSystemArchitecture", + "description": "Operating system architecture as reported by datacenter management solution.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine last updated.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name of the Machine.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description for the machine.", + "readOnly": true + }, + "datacenterMachineArmId": { + "type": "string", + "description": "Data center machine ARM id.", + "readOnly": true + }, + "datacenterManagementServerArmId": { + "type": "string", + "description": "Data center management server ARM id.", + "readOnly": true + }, + "datacenterManagementServerName": { + "type": "string", + "description": "Data center management server name.", + "readOnly": true + }, + "megabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Megabytes of memory found allocated for the machine in private data center.", + "readOnly": true + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores found on the machine.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Cores Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "percentageMemoryUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Memory Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets a value indicating whether machine is suitable for the cloud platform\nselected.", + "readOnly": true + } + } + }, + "AvsAssessedNetworkAdapter": { + "type": "object", + "description": "Second level object returned as part of AVS AssessedMachine REST resource.", + "properties": { + "macAddress": { + "type": "string", + "description": "Mac address of the NIC.", + "readOnly": true + }, + "ipAddresses": { + "type": "array", + "description": "IP V4 addresses for the machine.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets the display name of the network adapter.", + "readOnly": true + }, + "megabytesPerSecondReceived": { + "type": "number", + "format": "float", + "description": "Gets the Received data for Network Adapter in MB/s.\n This value is\nthe percentile of historical data based on options selected in Assessment.", + "readOnly": true + }, + "megabytesPerSecondTransmitted": { + "type": "number", + "format": "float", + "description": "Gets the Transmitted data for Network Adapter in MB/s.\n This value\nis the percentile of historical data based on options selected in Assessment.", + "readOnly": true + } + } + }, + "AvsAssessment": { + "type": "object", + "description": "AVS assessment resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AvsAssessmentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AvsAssessmentListResult": { + "type": "object", + "description": "The response of a AvsAssessment list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AvsAssessment items on this page", + "items": { + "$ref": "#/definitions/AvsAssessment" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AvsAssessmentOptions": { + "type": "object", + "description": "AVS Assessment options resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AvsAssessmentOptionsProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AvsAssessmentOptionsListResult": { + "type": "object", + "description": "The response of a AvsAssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AvsAssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/AvsAssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AvsAssessmentOptionsProperties": { + "type": "object", + "description": "AVS Assessment options properties.", + "properties": { + "avsNodes": { + "type": "array", + "description": "AVS SKU Nodes.", + "items": { + "$ref": "#/definitions/AvsSkuOptions" + }, + "x-ms-identifiers": [] + }, + "avsExternalStorageTypes": { + "type": "array", + "description": "AVS External Storage Types Supported.", + "items": { + "$ref": "#/definitions/AvsExternalStorageOptions" + }, + "x-ms-identifiers": [] + }, + "failuresToTolerateAndRaidLevelValues": { + "type": "array", + "description": "FTT and Raid level values.", + "items": { + "$ref": "#/definitions/FttAndRaidLevel" + } + }, + "reservedInstanceAvsNodes": { + "type": "array", + "description": "List of AVS nodes for RI.", + "items": { + "$ref": "#/definitions/AzureAvsNodeType" + } + }, + "reservedInstanceSupportedLocations": { + "type": "array", + "description": "List of supported Azure regions for reserved instances.", + "items": { + "$ref": "#/definitions/AzureLocation" + } + }, + "reservedInstanceSupportedCurrencies": { + "type": "array", + "description": "List of supported currencies for reserved instances.", + "items": { + "$ref": "#/definitions/AzureCurrency" + } + }, + "reservedInstanceSupportedOffers": { + "type": "array", + "description": "List of supported Azure offer codes for reserved instances.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + } + } + } + }, + "AvsAssessmentProperties": { + "type": "object", + "description": "Properties of the AVS assessment.", + "properties": { + "assessmentErrorSummary": { + "type": "object", + "description": "Gets the assessment error summary.\n This is the number of machines\naffected by each type of error in this assessment.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "failuresToTolerateAndRaidLevel": { + "$ref": "#/definitions/FttAndRaidLevel", + "description": "Failures to tolerate and RAID level in a common property." + }, + "failuresToTolerateAndRaidLevelList": { + "type": "array", + "description": "List of Failures to tolerate and RAID levels in a common property.", + "items": { + "$ref": "#/definitions/FttAndRaidLevel" + } + }, + "vcpuOversubscription": { + "type": "number", + "format": "float", + "description": "VCPU over subscription." + }, + "nodeType": { + "$ref": "#/definitions/AzureAvsNodeType", + "description": "AVS node type." + }, + "nodeTypes": { + "type": "array", + "description": "AVS node types.", + "items": { + "$ref": "#/definitions/AzureAvsNodeType" + } + }, + "externalStorageTypes": { + "type": "array", + "description": "List of AVS external storage types.", + "items": { + "$ref": "#/definitions/ExternalStorageType" + } + }, + "avsAssessmentScenario": { + "$ref": "#/definitions/AvsAssessmentScenario", + "description": "AVS Assessment Scenario." + }, + "isVcfByolEnabled": { + "type": "boolean", + "description": "Is VCF license applied" + }, + "costComponents": { + "type": "array", + "description": "collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "reservedInstance": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Reserved instance." + }, + "totalMonthlyCost": { + "type": "number", + "format": "float", + "description": "Total monthly cost.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets or sets the Assessment cloud suitability.", + "readOnly": true + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureAvsSuitabilityExplanation", + "description": "Gets or sets the Assessment suitability explanation.", + "readOnly": true + }, + "numberOfNodes": { + "type": "integer", + "format": "int32", + "description": "Recommended number of nodes.", + "readOnly": true + }, + "cpuUtilization": { + "type": "number", + "format": "float", + "description": "Predicted CPU utilization.", + "readOnly": true + }, + "ramUtilization": { + "type": "number", + "format": "float", + "description": "Predicted RAM utilization.", + "readOnly": true + }, + "storageUtilization": { + "type": "number", + "format": "float", + "description": "Predicted storage utilization.", + "readOnly": true + }, + "totalCpuCores": { + "type": "number", + "format": "float", + "description": "Predicted total CPU cores used.", + "readOnly": true + }, + "totalRamInGB": { + "type": "number", + "format": "float", + "description": "Predicted total RAM used in GB.", + "readOnly": true + }, + "totalStorageInGB": { + "type": "number", + "format": "float", + "description": "Predicted total Storage used in GB.", + "readOnly": true + }, + "avsEstimatedNodes": { + "type": "array", + "description": "EstimatedNodes AVS SKU for Assessment.", + "items": { + "$ref": "#/definitions/AvsEstimatedNode" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "avsEstimatedExternalStorages": { + "type": "array", + "description": "Estimated External Storage for Assessment.", + "items": { + "$ref": "#/definitions/AvsEstimatedExternalStorage" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "avsEstimatedNetworks": { + "type": "array", + "description": "Estimated External Storage for Assessment.", + "items": { + "$ref": "#/definitions/AvsEstimatedNetwork" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Number of machines part of the assessment.", + "readOnly": true + }, + "suitabilitySummary": { + "type": "object", + "description": "Cloud suitability summary for all the machines in the assessment.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "memOvercommit": { + "type": "number", + "format": "float", + "description": "Memory overcommit." + }, + "dedupeCompression": { + "type": "number", + "format": "float", + "description": "De-duplication compression." + }, + "limitingFactor": { + "type": "string", + "description": "Limiting factor.", + "readOnly": true + }, + "isStretchClusterEnabled": { + "type": "boolean", + "description": "Is Stretch Cluster Enabled." + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "Gets the group type for the assessment.", + "readOnly": true + }, + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Assessment type of the assessment.", + "readOnly": true + }, + "azureLocation": { + "$ref": "#/definitions/AzureLocation", + "description": "Azure Location or Azure region where to which the machines will be migrated." + }, + "azureOfferCode": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Azure Offer code according to which cost estimation is done." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Currency in which prices should be reported." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Percentage of buffer that user wants on performance metrics when recommending\nAzure sizes." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Percentile of the utilization data values to be considered while assessing\nmachines." + }, + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Time Range for which the historic utilization data should be considered for\nassessment." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time to consider performance data for assessment." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time to consider performance data for assessment." + }, + "stage": { + "$ref": "#/definitions/AssessmentStage", + "description": "User configurable setting to display the Stage of Assessment.", + "readOnly": true + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Custom discount percentage." + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion." + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when the Azure Prices were queried. Date-Time represented in ISO-8601\nformat.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Whether assessment is in valid state and all machines have been assessed.", + "readOnly": true + }, + "schemaVersion": { + "type": "string", + "description": "Schema version.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "AvsExternalStorageOptions": { + "type": "object", + "description": "AVS External Storage specific options.", + "properties": { + "storageType": { + "$ref": "#/definitions/ExternalStorageType", + "description": "AVS external storage type." + }, + "targetLocations": { + "type": "array", + "description": "List of locations where this storage type is available.", + "items": { + "$ref": "#/definitions/AzureLocation" + } + } + } + }, + "AvsNodeSummary": { + "type": "object", + "description": "Azure Avs Node summary.", + "properties": { + "serversSuitableForMigration": { + "type": "integer", + "format": "int32", + "description": "Servers suitable for migration.", + "readOnly": true + }, + "totalNumberOfServers": { + "type": "integer", + "format": "int32", + "description": "The total number of servers.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "The total number of Avs VM cores.", + "readOnly": true + }, + "memoryGb": { + "type": "number", + "format": "float", + "description": "The total memory in GB.", + "readOnly": true + }, + "avsNodeCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "estimatedCost": { + "type": "number", + "format": "float", + "description": "Estimated cost.", + "readOnly": true + }, + "osLicensingCost": { + "type": "number", + "format": "float", + "description": "OS licensing cost.", + "readOnly": true + }, + "estimatedCostByRecommendedOffer": { + "type": "array", + "description": "Estimated cost by offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendedAvsNodeTypeSummary": { + "type": "array", + "description": "The recommended VM family summary.", + "items": { + "$ref": "#/definitions/RecommendedAvsNodeTypeSummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "estimatedExternalStorage": { + "type": "array", + "description": "Estimated External Storage", + "items": { + "$ref": "#/definitions/EstimatedExternalStorage" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "estimatedNetwork": { + "type": "array", + "description": "Estimated Network", + "items": { + "$ref": "#/definitions/EstimatedNetwork" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "estimatedCostWithVcfByol": { + "type": "number", + "format": "float", + "description": "Estimated Cost With VCF BYOL", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Represents errors which might have occurred while calculating AVS Node Summary", + "items": { + "$ref": "#/definitions/ErrorDetail" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AvsEstimatedExternalStorage": { + "type": "object", + "description": "Details on the Estimated External Storage for AVS Assessment.", + "properties": { + "monthlyPrice": { + "type": "number", + "format": "float", + "description": "Total monthly cost for type of storage." + }, + "storageType": { + "$ref": "#/definitions/ExternalStorageType", + "description": "Recommended External Storage." + }, + "totalStorageInGB": { + "type": "number", + "format": "float", + "description": "Predicted total Storage used in GB." + }, + "storageUtilization": { + "type": "number", + "format": "float", + "description": "Predicted storage utilization." + } + } + }, + "AvsEstimatedNetwork": { + "type": "object", + "description": "Details on the Estimated Network Costs for AVS Assessment.", + "properties": { + "monthlyPrice": { + "type": "number", + "format": "float", + "description": "Monthly cost for network type." + }, + "networkType": { + "$ref": "#/definitions/NetworkSkuType", + "description": "Recommended Network Sku." + } + } + }, + "AvsEstimatedNode": { + "type": "object", + "description": "Details on the Estimated nodes for AVS Assessment.", + "properties": { + "monthlyPrice": { + "type": "number", + "format": "float", + "description": "Total monthly cost for type and number of nodes." + }, + "nodeType": { + "$ref": "#/definitions/AzureAvsNodeType", + "description": "Recommended SKU." + }, + "nodeNumber": { + "type": "integer", + "format": "int32", + "description": "Number of nodes that will be needed." + }, + "cpuUtilization": { + "type": "number", + "format": "float", + "description": "Predicted CPU utilization." + }, + "ramUtilization": { + "type": "number", + "format": "float", + "description": "Predicted RAM utilization." + }, + "storageUtilization": { + "type": "number", + "format": "float", + "description": "Predicted storage utilization." + }, + "totalCpu": { + "type": "number", + "format": "float", + "description": "Predicted total CPU cores across the set of nodes." + }, + "totalRam": { + "type": "number", + "format": "float", + "description": "Predicted total RAM used in GB." + }, + "totalStorage": { + "type": "number", + "format": "float", + "description": "Predicted total Storage used in GB." + }, + "pricingModel": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Pricing model indicates what hour multiplier to use while estimating the Nodes cost." + }, + "fttRaidLevel": { + "$ref": "#/definitions/FttAndRaidLevel", + "description": "FttRaidLevel recommended for Node." + } + } + }, + "AvsSkuOptions": { + "type": "object", + "description": "AVS SKU specific options.", + "properties": { + "nodeType": { + "$ref": "#/definitions/AzureAvsNodeType", + "description": "AVS Node type." + }, + "targetLocations": { + "type": "array", + "description": "List of locations where this node type is available.", + "items": { + "$ref": "#/definitions/AzureLocation" + } + } + } + }, + "AvsSummary": { + "type": "object", + "description": "Avs summary REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AvsSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AvsSummaryListResult": { + "type": "object", + "description": "The response of a AvsSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AvsSummary items on this page", + "items": { + "$ref": "#/definitions/AvsSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AvsSummaryProperties": { + "type": "object", + "description": "Avs summary properties class.", + "properties": { + "azureAvsSummary": { + "$ref": "#/definitions/AzureAvsSummary", + "description": "The Azure Avs summary.", + "readOnly": true + }, + "onPremisesAvsSummary": { + "$ref": "#/definitions/OnPremisesIaasSummary", + "description": "The on premises IaaS summary.", + "readOnly": true + } + } + }, + "AzureAppServiceContainerSummary": { + "type": "object", + "description": "Shows Azure App Service Container summary.", + "properties": { + "estimatedCostByOffer": { + "type": "array", + "description": "Estimated cost by recommendation offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySku": { + "type": "array", + "description": "Distribution by SKU.", + "items": { + "$ref": "#/definitions/WebAppTargetSku" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByApp": { + "type": "array", + "description": "Distribution by application type.", + "items": { + "$ref": "#/definitions/WebAppDistribution" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureAppServiceSummary": { + "type": "object", + "description": "Shows Azure App Service summary.", + "properties": { + "estimatedCostByOffer": { + "type": "array", + "description": "Estimated cost by recommendation offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySku": { + "type": "array", + "description": "Distribution by SKU.", + "items": { + "$ref": "#/definitions/AppServiceSku" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByApp": { + "type": "array", + "description": "Distribution by application type.", + "items": { + "$ref": "#/definitions/WebAppDistribution" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureAvsNodeType": { + "type": "string", + "enum": [ + "Unknown", + "AV36", + "AV36P", + "AV52", + "AV64" + ], + "x-ms-enum": { + "name": "AzureAvsNodeType", + "modelAsString": true + } + }, + "AzureAvsSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "UnsupportedLocationForSelectedNode", + "InternalErrorInRecommendation", + "UnsupportedLocationForSelectedExternalStorageTypes" + ], + "x-ms-enum": { + "name": "AzureAvsSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureAvsSummary": { + "type": "object", + "description": "The Azure AVS summary.", + "properties": { + "yearOnYearEstimates": { + "$ref": "#/definitions/YearOnYearEstimates", + "description": "Shows the year-on-year cost overall.", + "readOnly": true + }, + "avsNodeSummary": { + "$ref": "#/definitions/AvsNodeSummary", + "description": "Avs virtual machine summary.", + "readOnly": true + }, + "avsCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + } + } + }, + "AzureAvsVmSuitabilityDetail": { + "type": "string", + "enum": [ + "None", + "PercentageOfCoresUtilizedMissing", + "PercentageOfMemoryUtilizedMissing", + "PercentageOfCoresUtilizedOutOfRange", + "PercentageOfMemoryUtilizedOutOfRange", + "PercentageOfStorageUtilizedOutOfRange" + ], + "x-ms-enum": { + "name": "AzureAvsVmSuitabilityDetail", + "modelAsString": true + } + }, + "AzureAvsVmSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "IpV6NotSupported", + "UnsupportedOperatingSystem" + ], + "x-ms-enum": { + "name": "AzureAvsVmSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureCurrency": { + "type": "string", + "description": "Currency for Azure.", + "enum": [ + "Unknown", + "USD", + "DKK", + "CAD", + "IDR", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SAR", + "ZAR", + "SEK", + "TRY", + "GBP", + "MXN", + "MYR", + "INR", + "HKD", + "BRL", + "TWD", + "EUR", + "CHF", + "ARS", + "AUD", + "CNY" + ], + "x-ms-enum": { + "name": "AzureCurrency", + "modelAsString": true + } + }, + "AzureDiskSize": { + "type": "string", + "enum": [ + "Unknown", + "Standard_S4", + "Standard_S6", + "Standard_S10", + "Standard_S15", + "Standard_S20", + "Standard_S30", + "Standard_S40", + "Standard_S50", + "Standard_S60", + "Standard_S70", + "Standard_S80", + "Premium_P4", + "Premium_P6", + "Premium_P10", + "Premium_P15", + "Premium_P20", + "Premium_P30", + "Premium_P40", + "Premium_P50", + "Premium_P60", + "Premium_P70", + "Premium_P80", + "StandardSSD_E10", + "StandardSSD_E15", + "StandardSSD_E20", + "StandardSSD_E30", + "StandardSSD_E40", + "StandardSSD_E50", + "StandardSSD_E60", + "StandardSSD_E70", + "StandardSSD_E80", + "StandardSSD_E4", + "StandardSSD_E6", + "StandardSSD_E1", + "StandardSSD_E2", + "StandardSSD_E3", + "Premium_P1", + "Premium_P2", + "Premium_P3", + "Ultra", + "PremiumV2" + ], + "x-ms-enum": { + "name": "AzureDiskSize", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "StandardS4", + "value": "Standard_S4" + }, + { + "name": "StandardS6", + "value": "Standard_S6" + }, + { + "name": "StandardS10", + "value": "Standard_S10" + }, + { + "name": "StandardS15", + "value": "Standard_S15" + }, + { + "name": "StandardS20", + "value": "Standard_S20" + }, + { + "name": "StandardS30", + "value": "Standard_S30" + }, + { + "name": "StandardS40", + "value": "Standard_S40" + }, + { + "name": "StandardS50", + "value": "Standard_S50" + }, + { + "name": "StandardS60", + "value": "Standard_S60" + }, + { + "name": "StandardS70", + "value": "Standard_S70" + }, + { + "name": "StandardS80", + "value": "Standard_S80" + }, + { + "name": "PremiumP4", + "value": "Premium_P4" + }, + { + "name": "PremiumP6", + "value": "Premium_P6" + }, + { + "name": "PremiumP10", + "value": "Premium_P10" + }, + { + "name": "PremiumP15", + "value": "Premium_P15" + }, + { + "name": "PremiumP20", + "value": "Premium_P20" + }, + { + "name": "PremiumP30", + "value": "Premium_P30" + }, + { + "name": "PremiumP40", + "value": "Premium_P40" + }, + { + "name": "PremiumP50", + "value": "Premium_P50" + }, + { + "name": "PremiumP60", + "value": "Premium_P60" + }, + { + "name": "PremiumP70", + "value": "Premium_P70" + }, + { + "name": "PremiumP80", + "value": "Premium_P80" + }, + { + "name": "StandardSSDE10", + "value": "StandardSSD_E10" + }, + { + "name": "StandardSSDE15", + "value": "StandardSSD_E15" + }, + { + "name": "StandardSSDE20", + "value": "StandardSSD_E20" + }, + { + "name": "StandardSSDE30", + "value": "StandardSSD_E30" + }, + { + "name": "StandardSSDE40", + "value": "StandardSSD_E40" + }, + { + "name": "StandardSSDE50", + "value": "StandardSSD_E50" + }, + { + "name": "StandardSSDE60", + "value": "StandardSSD_E60" + }, + { + "name": "StandardSSDE70", + "value": "StandardSSD_E70" + }, + { + "name": "StandardSSDE80", + "value": "StandardSSD_E80" + }, + { + "name": "StandardSSDE4", + "value": "StandardSSD_E4" + }, + { + "name": "StandardSSDE6", + "value": "StandardSSD_E6" + }, + { + "name": "StandardSSDE1", + "value": "StandardSSD_E1" + }, + { + "name": "StandardSSDE2", + "value": "StandardSSD_E2" + }, + { + "name": "StandardSSDE3", + "value": "StandardSSD_E3" + }, + { + "name": "PremiumP1", + "value": "Premium_P1" + }, + { + "name": "PremiumP2", + "value": "Premium_P2" + }, + { + "name": "PremiumP3", + "value": "Premium_P3" + }, + { + "name": "Ultra", + "value": "Ultra" + }, + { + "name": "PremiumV2", + "value": "PremiumV2" + } + ] + } + }, + "AzureDiskSuitabilityDetail": { + "type": "string", + "enum": [ + "None", + "NumberOfReadOperationsPerSecondMissing", + "NumberOfWriteOperationsPerSecondMissing", + "MegabytesPerSecondOfReadMissing", + "MegabytesPerSecondOfWriteMissing", + "DiskGigabytesConsumedMissing", + "DiskGigabytesProvisionedMissing", + "NumberOfReadOperationsPerSecondOutOfRange", + "NumberOfWriteOperationsPerSecondOutOfRange", + "MegabytesPerSecondOfReadOutOfRange", + "MegabytesPerSecondOfWriteOutOfRange", + "DiskGigabytesConsumedOutOfRange", + "DiskGigabytesProvisionedOutOfRange" + ], + "x-ms-enum": { + "name": "AzureDiskSuitabilityDetail", + "modelAsString": true + } + }, + "AzureDiskSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "DiskSizeGreaterThanSupported", + "NoSuitableDiskSizeForIops", + "NoSuitableDiskSizeForThroughput", + "NoDiskSizeFoundInSelectedLocation", + "NoDiskSizeFoundForSelectedRedundancy", + "InternalErrorOccurredForDiskEvaluation", + "NoEaPriceFoundForDiskSize" + ], + "x-ms-enum": { + "name": "AzureDiskSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureDiskType": { + "type": "string", + "enum": [ + "Unknown", + "Standard", + "StandardSSD", + "Premium", + "StandardOrPremium", + "Ultra", + "PremiumV2" + ], + "x-ms-enum": { + "name": "AzureDiskType", + "modelAsString": true + } + }, + "AzureEnvironmentType": { + "type": "string", + "description": "Environment Type for Azure.", + "enum": [ + "Unknown", + "DevTest", + "Production" + ], + "x-ms-enum": { + "name": "AzureEnvironmentType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates missing data." + }, + { + "name": "DevTest", + "value": "DevTest", + "description": "Development or Test Environment." + }, + { + "name": "Production", + "value": "Production", + "description": "Production Environment." + } + ] + } + }, + "AzureHybridUseBenefit": { + "type": "string", + "enum": [ + "Unknown", + "Yes", + "No" + ], + "x-ms-enum": { + "name": "AzureHybridUseBenefit", + "modelAsString": true + } + }, + "AzureIaasSqlSummary": { + "type": "object", + "description": "Azure Iaas sql server summary.", + "properties": { + "totalSqlEntities": { + "type": "integer", + "format": "int32", + "description": "Total SQL entities.", + "readOnly": true + }, + "suitableSqlEntities": { + "type": "integer", + "format": "int32", + "description": "Suitable SQL entities.", + "readOnly": true + }, + "azureSqlCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "estimatedCost": { + "type": "number", + "format": "float", + "description": "Estimated cost.", + "readOnly": true + }, + "osLicensingCost": { + "type": "number", + "format": "float", + "description": "OS licensing cost.", + "readOnly": true + }, + "estimatedCostByRecommendedOffer": { + "type": "array", + "description": "Estimated cost by offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendedVmFamilySummary": { + "type": "array", + "description": "The recommended VM family summary.", + "items": { + "$ref": "#/definitions/RecommendedVmFamilySummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "costByStorageType": { + "type": "array", + "description": "The cost by storage type.", + "items": { + "$ref": "#/definitions/CostByStorageType" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureIaasSummary": { + "type": "object", + "description": "The Azure IaaS summary.", + "properties": { + "yearOnYearEstimates": { + "$ref": "#/definitions/YearOnYearEstimates", + "description": "Shows the year-on-year cost overall.", + "readOnly": true + }, + "azureIaasVmSummary": { + "$ref": "#/definitions/AzureIaasVmSummary", + "description": "Azure Iaas virtual machine summary.", + "readOnly": true + }, + "azureIaasSqlSummary": { + "$ref": "#/definitions/AzureIaasSqlSummary", + "description": "Azure Iaas sql server summary.", + "readOnly": true + }, + "azureIaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + } + } + }, + "AzureIaasVmSummary": { + "type": "object", + "description": "Azure Iaas virtual machine summary.", + "properties": { + "serversSuitableForMigration": { + "type": "integer", + "format": "int32", + "description": "Servers suitable for migration.", + "readOnly": true + }, + "totalNumberOfServers": { + "type": "integer", + "format": "int32", + "description": "The total number of servers.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "The total number of IaaS VM cores.", + "readOnly": true + }, + "memoryGb": { + "type": "number", + "format": "float", + "description": "The total memory in GB.", + "readOnly": true + }, + "azureVmCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "estimatedCost": { + "type": "number", + "format": "float", + "description": "Estimated cost.", + "readOnly": true + }, + "osLicensingCost": { + "type": "number", + "format": "float", + "description": "OS licensing cost.", + "readOnly": true + }, + "estimatedCostByRecommendedOffer": { + "type": "array", + "description": "Estimated cost by offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendedVmFamilySummary": { + "type": "array", + "description": "The recommended VM family summary.", + "items": { + "$ref": "#/definitions/RecommendedVmFamilySummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "costByStorageType": { + "type": "array", + "description": "The cost by storage type.", + "items": { + "$ref": "#/definitions/CostByStorageType" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureKubernetesServiceSummary": { + "type": "object", + "description": "Shows Azure Kubernetes Service summary.", + "properties": { + "estimatedCostByOffer": { + "type": "array", + "description": "Estimated cost by recommendation offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySku": { + "type": "array", + "description": "Distribution by SKU.", + "items": { + "$ref": "#/definitions/WebAppTargetSku" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByApp": { + "type": "array", + "description": "Distribution by application type.", + "items": { + "$ref": "#/definitions/WebAppDistribution" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureLocation": { + "type": "string", + "description": "Location for Azure.", + "enum": [ + "Unknown", + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "CentralIndia", + "SouthIndia", + "WestIndia", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "WestCentralUs", + "GermanyCentral", + "GermanyNortheast", + "ChinaNorth", + "ChinaEast", + "USGovArizona", + "USGovTexas", + "USGovIowa", + "USGovVirginia", + "USDoDCentral", + "USDoDEast", + "FranceCentral", + "AustraliaCentral", + "SouthAfricaNorth", + "FranceSouth", + "AustraliaCentral2", + "SouthAfricaWest", + "GermanyNorth", + "GermanyWestCentral", + "NorwayEast", + "NorwayWest", + "ChinaEast2", + "ChinaNorth2", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UAECentral", + "UsNatEast", + "UsNatWest", + "UsSecEast", + "UsSecCentral", + "UsSecWest", + "SwedenCentral", + "QatarCentral" + ], + "x-ms-enum": { + "name": "AzureLocation", + "modelAsString": true + } + }, + "AzureManagedDiskSkuDTO": { + "type": "object", + "description": "Class representing an Azure Managed Disk SKU.", + "properties": { + "diskType": { + "$ref": "#/definitions/AzureManagedDiskSkuDTODiskType", + "description": "Gets the Type (\"tier\") of disk - e.g. standard, premium, ultra.", + "readOnly": true + }, + "diskSize": { + "$ref": "#/definitions/AzureDiskSize", + "description": "Gets the Size of the managed disk - e.g. P30, P40.", + "readOnly": true + }, + "diskRedundancy": { + "$ref": "#/definitions/AzureManagedDiskSkuDTODiskRedundancy", + "description": "Gets disk redundancy - e.g. LRS, ZRS.", + "readOnly": true + }, + "storageCost": { + "type": "number", + "format": "float", + "description": "Gets the managed disk storage cost.", + "readOnly": true + }, + "recommendedSizeInGib": { + "type": "number", + "format": "float", + "description": "Gets the recommended in GB of the managed disk.", + "readOnly": true + }, + "recommendedThroughputInMbps": { + "type": "number", + "format": "float", + "description": "Gets the recommended throughput in MBPS of the managed disk.", + "readOnly": true + }, + "recommendedIops": { + "type": "number", + "format": "float", + "description": "Gets the recommended IOPS of the managed disk.", + "readOnly": true + } + } + }, + "AzureManagedDiskSkuDTODiskRedundancy": { + "type": "string", + "enum": [ + "Unknown", + "LRS", + "ZRS" + ], + "x-ms-enum": { + "name": "AzureManagedDiskSkuDTODiskRedundancy", + "modelAsString": true + } + }, + "AzureManagedDiskSkuDTODiskType": { + "type": "string", + "enum": [ + "Unknown", + "Standard", + "StandardSSD", + "Premium", + "StandardOrPremium", + "Ultra", + "PremiumV2" + ], + "x-ms-enum": { + "name": "AzureManagedDiskSkuDTODiskType", + "modelAsString": true + } + }, + "AzureNetworkAdapterSuitabilityDetail": { + "type": "string", + "enum": [ + "None", + "MegabytesOfDataTransmittedMissing", + "MegabytesOfDataTransmittedOutOfRange", + "MegabytesOfDataRecievedMissing", + "MegabytesOfDataRecievedOutOfRange" + ], + "x-ms-enum": { + "name": "AzureNetworkAdapterSuitabilityDetail", + "modelAsString": true + } + }, + "AzureNetworkAdapterSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "InternalErrorOccurred" + ], + "x-ms-enum": { + "name": "AzureNetworkAdapterSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureOfferCode": { + "type": "string", + "enum": [ + "Unknown", + "MSAZR0003P", + "MSAZR0044P", + "MSAZR0059P", + "MSAZR0060P", + "MSAZR0062P", + "MSAZR0063P", + "MSAZR0064P", + "MSAZR0029P", + "MSAZR0022P", + "MSAZR0023P", + "MSAZR0148P", + "MSAZR0025P", + "MSAZR0036P", + "MSAZR0120P", + "MSAZR0121P", + "MSAZR0122P", + "MSAZR0123P", + "MSAZR0124P", + "MSAZR0125P", + "MSAZR0126P", + "MSAZR0127P", + "MSAZR0128P", + "MSAZR0129P", + "MSAZR0130P", + "MSAZR0111P", + "MSAZR0144P", + "MSAZR0149P", + "MSMCAZR0044P", + "MSMCAZR0059P", + "MSMCAZR0060P", + "MSMCAZR0063P", + "MSMCAZR0120P", + "MSMCAZR0121P", + "MSMCAZR0125P", + "MSMCAZR0128P", + "MSAZRDE0003P", + "MSAZRDE0044P", + "MSAZRUSGOV0003P", + "EA", + "MSAZR0243P", + "SavingsPlan1Year", + "SavingsPlan3Year" + ], + "x-ms-enum": { + "name": "AzureOfferCode", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "Msazr0003P", + "value": "MSAZR0003P" + }, + { + "name": "Msazr0044P", + "value": "MSAZR0044P" + }, + { + "name": "Msazr0059P", + "value": "MSAZR0059P" + }, + { + "name": "Msazr0060P", + "value": "MSAZR0060P" + }, + { + "name": "Msazr0062P", + "value": "MSAZR0062P" + }, + { + "name": "Msazr0063P", + "value": "MSAZR0063P" + }, + { + "name": "Msazr0064P", + "value": "MSAZR0064P" + }, + { + "name": "Msazr0029P", + "value": "MSAZR0029P" + }, + { + "name": "Msazr0022P", + "value": "MSAZR0022P" + }, + { + "name": "Msazr0023P", + "value": "MSAZR0023P" + }, + { + "name": "Msazr0148P", + "value": "MSAZR0148P" + }, + { + "name": "Msazr0025P", + "value": "MSAZR0025P" + }, + { + "name": "Msazr0036P", + "value": "MSAZR0036P" + }, + { + "name": "Msazr0120P", + "value": "MSAZR0120P" + }, + { + "name": "Msazr0121P", + "value": "MSAZR0121P" + }, + { + "name": "Msazr0122P", + "value": "MSAZR0122P" + }, + { + "name": "Msazr0123P", + "value": "MSAZR0123P" + }, + { + "name": "Msazr0124P", + "value": "MSAZR0124P" + }, + { + "name": "Msazr0125P", + "value": "MSAZR0125P" + }, + { + "name": "Msazr0126P", + "value": "MSAZR0126P" + }, + { + "name": "Msazr0127P", + "value": "MSAZR0127P" + }, + { + "name": "Msazr0128P", + "value": "MSAZR0128P" + }, + { + "name": "Msazr0129P", + "value": "MSAZR0129P" + }, + { + "name": "Msazr0130P", + "value": "MSAZR0130P" + }, + { + "name": "Msazr0111P", + "value": "MSAZR0111P" + }, + { + "name": "Msazr0144P", + "value": "MSAZR0144P" + }, + { + "name": "Msazr0149P", + "value": "MSAZR0149P" + }, + { + "name": "Msmcazr0044P", + "value": "MSMCAZR0044P" + }, + { + "name": "Msmcazr0059P", + "value": "MSMCAZR0059P" + }, + { + "name": "Msmcazr0060P", + "value": "MSMCAZR0060P" + }, + { + "name": "Msmcazr0063P", + "value": "MSMCAZR0063P" + }, + { + "name": "Msmcazr0120P", + "value": "MSMCAZR0120P" + }, + { + "name": "Msmcazr0121P", + "value": "MSMCAZR0121P" + }, + { + "name": "Msmcazr0125P", + "value": "MSMCAZR0125P" + }, + { + "name": "Msmcazr0128P", + "value": "MSMCAZR0128P" + }, + { + "name": "Msazrde0003P", + "value": "MSAZRDE0003P" + }, + { + "name": "Msazrde0044P", + "value": "MSAZRDE0044P" + }, + { + "name": "Msazrusgov0003P", + "value": "MSAZRUSGOV0003P" + }, + { + "name": "EA", + "value": "EA" + }, + { + "name": "Msazr0243P", + "value": "MSAZR0243P" + }, + { + "name": "SavingsPlan1Year", + "value": "SavingsPlan1Year" + }, + { + "name": "SavingsPlan3Year", + "value": "SavingsPlan3Year" + } + ] + } + }, + "AzurePaasSummary": { + "type": "object", + "description": "Shows the PaaS Azure summary.", + "properties": { + "totalSqlEntities": { + "type": "integer", + "format": "int32", + "description": "Number of Sql instances.", + "readOnly": true + }, + "suitableSqlEntities": { + "type": "integer", + "format": "int32", + "description": "Suitable Sql instances.", + "readOnly": true + }, + "totalWebApps": { + "type": "integer", + "format": "int32", + "description": "Number of web applications.", + "readOnly": true + }, + "suitableWebApps": { + "type": "integer", + "format": "int32", + "description": "Suitable web applications.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "Number of cores.", + "readOnly": true + }, + "memory": { + "type": "number", + "format": "float", + "description": "Memory Utilization.", + "readOnly": true + }, + "storage": { + "type": "number", + "format": "float", + "description": "Storage Utilization.", + "readOnly": true + }, + "estimatedCostByTarget": { + "$ref": "#/definitions/EstimatedCostByTarget", + "description": "Shows the estimated cost by target.", + "readOnly": true + }, + "estimatedSqlServerLicensingCost": { + "type": "number", + "format": "float", + "description": "estimated SQL Server licensing cost.", + "readOnly": true + }, + "azureSqlSummary": { + "$ref": "#/definitions/AzureSqlSummary", + "description": "Shows the Azure SQL details.", + "readOnly": true + }, + "azureAppServiceSummary": { + "$ref": "#/definitions/AzureAppServiceSummary", + "description": "Shows Azure App Service summary.", + "readOnly": true + }, + "azureAppServiceContainerSummary": { + "$ref": "#/definitions/AzureAppServiceContainerSummary", + "description": "Shows Azure App Service Container summary.", + "readOnly": true + }, + "azureKubernetesServiceSummary": { + "$ref": "#/definitions/AzureKubernetesServiceSummary", + "description": "Shows Azure Kubernetes Service summary.", + "readOnly": true + }, + "totalAzurePaasCost": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + } + } + }, + "AzurePricingTier": { + "type": "string", + "enum": [ + "Standard", + "Basic" + ], + "x-ms-enum": { + "name": "AzurePricingTier", + "modelAsString": true + } + }, + "AzureQuorumWitnessDTO": { + "type": "object", + "description": "Quorum Witness.", + "properties": { + "quorumWitnessType": { + "$ref": "#/definitions/AzureQuorumWitnessDTOQuorumWitnessType", + "description": "Gets quorum witness type.", + "readOnly": true + } + } + }, + "AzureQuorumWitnessDTOQuorumWitnessType": { + "type": "string", + "enum": [ + "Unknown", + "Cloud", + "Disk" + ], + "x-ms-enum": { + "name": "AzureQuorumWitnessDTOQuorumWitnessType", + "modelAsString": true + } + }, + "AzureReservedInstance": { + "type": "string", + "enum": [ + "None", + "RI1Year", + "RI3Year" + ], + "x-ms-enum": { + "name": "AzureReservedInstance", + "modelAsString": true + } + }, + "AzureResourceProperties": { + "type": "object", + "description": "Common properties for all azure tracked and proxy resources.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "AzureResourceProperties2": { + "type": "object", + "description": "Common properties for all azure tracked and proxy resources.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState2", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "AzureSecurityOfferingType": { + "type": "string", + "enum": [ + "NO", + "MDC" + ], + "x-ms-enum": { + "name": "AzureSecurityOfferingType", + "modelAsString": true + } + }, + "AzureSettings": { + "type": "object", + "description": "Azure settings for a business case.", + "properties": { + "targetLocation": { + "type": "string", + "description": "Gets or sets azure location." + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Gets azure Discount percentage.", + "minimum": 0, + "maximum": 100 + }, + "currency": { + "$ref": "#/definitions/BusinessCaseCurrency", + "description": "Business case Currency.", + "default": "USD" + }, + "businessCaseType": { + "$ref": "#/definitions/MigrationStrategy", + "description": "Migration Strategy.", + "default": "OptimizeForCost" + }, + "workloadDiscoverySource": { + "$ref": "#/definitions/DiscoverySource", + "description": "Workload discovery source.", + "default": "Appliance" + }, + "performanceDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets start time to use for performance." + }, + "performanceDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets end time to use for performance." + }, + "comfortFactor": { + "type": "number", + "format": "float", + "description": "Gets comfort factor.", + "default": 1 + }, + "performanceUtilizationPercentile": { + "type": "number", + "format": "float", + "description": "Gets utilization percentile for performance.", + "default": 95, + "minimum": 0, + "maximum": 100 + }, + "perYearMigrationCompletionPercentage": { + "type": "object", + "description": "Gets migration completion percentage per year.", + "additionalProperties": { + "format": "float", + "type": "number" + } + }, + "infrastructureGrowthRate": { + "type": "number", + "format": "float", + "description": "Gets infrastructure growth rate.", + "default": 5, + "minimum": 0, + "maximum": 100 + }, + "wacc": { + "type": "number", + "format": "float", + "description": "Gets wACC percentage.", + "minimum": 0, + "maximum": 100 + }, + "networkCostPercentage": { + "type": "number", + "format": "float", + "description": "Gets network cost percentage.", + "default": 5, + "minimum": 0, + "maximum": 100 + }, + "iaasLaborCostPercentage": { + "type": "number", + "format": "float", + "description": "Gets IaaS labour cost percentage.", + "default": 75, + "minimum": 0, + "maximum": 100 + }, + "paasLaborCostPercentage": { + "type": "number", + "format": "float", + "description": "Gets PaaS labour cost percentage.", + "default": 60, + "minimum": 0, + "maximum": 100 + }, + "avsLaborCostPercentage": { + "type": "number", + "format": "float", + "description": "Gets Avs labour cost percentage.", + "default": 75, + "minimum": 0, + "maximum": 100 + }, + "savingsOption": { + "$ref": "#/definitions/SavingsOption", + "description": "Gets the business case savings option type.", + "default": "RI3Year" + } + }, + "required": [ + "targetLocation", + "currency" + ] + }, + "AzureSqlDataBaseType": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "SingleDatabase", + "ElasticPool" + ], + "x-ms-enum": { + "name": "AzureSqlDataBaseType", + "modelAsString": true + } + }, + "AzureSqlIaasSkuDTO": { + "type": "object", + "description": "Class representing Azure SQL IAAS SKU.", + "properties": { + "virtualMachineSize": { + "$ref": "#/definitions/AzureVirtualMachineSkuDTO", + "description": "Gets the The Azure Compute Virtual Machine.", + "readOnly": true + }, + "dataDiskSizes": { + "type": "array", + "description": "Gets the The list of data disk sizes.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "logDiskSizes": { + "type": "array", + "description": "Gets the The list of log disk sizes.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "azureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets the target type.", + "readOnly": true + } + } + }, + "AzureSqlInstanceType": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "SingleInstance", + "InstancePools" + ], + "x-ms-enum": { + "name": "AzureSqlInstanceType", + "modelAsString": true + } + }, + "AzureSqlPaasSkuDTO": { + "type": "object", + "description": "Class representing Azure SQL PAAS SKU.", + "properties": { + "azureSqlServiceTier": { + "$ref": "#/definitions/AzureSqlServiceTier", + "description": "Gets the service tier.", + "readOnly": true + }, + "azureSqlComputeTier": { + "$ref": "#/definitions/ComputeTier", + "description": "Gets the compute tier.", + "readOnly": true + }, + "azureSqlHardwareGeneration": { + "$ref": "#/definitions/HardwareGeneration", + "description": "Gets the hardware generation.", + "readOnly": true + }, + "storageMaxSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the storage maximum size in megabytes.", + "readOnly": true + }, + "predictedDataSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the predicted data size in megabytes in the Azure SQL, will impact the\nbilling cost.", + "readOnly": true + }, + "predictedLogSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the predicted log size in megabytes in the Azure SQL, will impact the\nbilling cost.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "Gets the number of cores.", + "readOnly": true + }, + "azureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets the target type.", + "readOnly": true + } + } + }, + "AzureSqlPurchaseModel": { + "type": "string", + "enum": [ + "Unknown", + "VCore", + "DTU" + ], + "x-ms-enum": { + "name": "AzureSqlPurchaseModel", + "modelAsString": true + } + }, + "AzureSqlServiceTier": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "GeneralPurpose", + "BusinessCritical", + "HyperScale" + ], + "x-ms-enum": { + "name": "AzureSqlServiceTier", + "modelAsString": true + } + }, + "AzureSqlSummary": { + "type": "object", + "description": "Shows the Azure SQL details.", + "properties": { + "estimatedCostByOffer": { + "type": "array", + "description": "Estimated cost by recommended offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByServiceTier": { + "type": "array", + "description": "Distribution by service tiers, retaining just to support older Business cases.", + "items": { + "$ref": "#/definitions/SqlServiceTier" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByServiceTierForSqlMi": { + "type": "array", + "description": "Distribution by service tiers for SQL MI.", + "items": { + "$ref": "#/definitions/SqlServiceTier" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByServiceTierForSqlDb": { + "type": "array", + "description": "Distribution by service tiers for SQL DB.", + "items": { + "$ref": "#/definitions/SqlServiceTier" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureStorageRedundancy": { + "type": "string", + "enum": [ + "Unknown", + "LocallyRedundant", + "ZoneRedundant", + "GeoRedundant", + "ReadAccessGeoRedundant" + ], + "x-ms-enum": { + "name": "AzureStorageRedundancy", + "modelAsString": true + } + }, + "AzureVirtualMachineSkuDTO": { + "type": "object", + "description": "Azure Virtual Machine SKU.", + "properties": { + "azureVmFamily": { + "$ref": "#/definitions/AzureVmFamily", + "description": "Gets the Virtual Machine Family, for example : standardMSFamily.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "Gets the Compute Size in vCores.", + "readOnly": true + }, + "azureSkuName": { + "$ref": "#/definitions/AzureVmSize", + "description": "Gets the Virtual Machine SKU name,: E.g. : Standard_F16s.", + "readOnly": true + }, + "availableCores": { + "type": "integer", + "format": "int32", + "description": "Gets the Available vCores. This can be less than the vCores in the Constrained\nvCPU VM Sizes.", + "readOnly": true + }, + "maxNetworkInterfaces": { + "type": "integer", + "format": "int32", + "description": "Gets the Max network interfaces.", + "readOnly": true + } + } + }, + "AzureVmCategory": { + "type": "string", + "description": "Azure VM Category.", + "enum": [ + "All", + "ComputeOptimized", + "GeneralPurpose", + "GpuOptimized", + "HighPerformanceCompute", + "MemoryOptimized", + "StorageOptimized", + "Isolated" + ], + "x-ms-enum": { + "name": "AzureVmCategory", + "modelAsString": true, + "values": [ + { + "name": "All", + "value": "All", + "description": "Indicates All categories of VM." + }, + { + "name": "ComputeOptimized", + "value": "ComputeOptimized", + "description": "Compute Optimized." + }, + { + "name": "GeneralPurpose", + "value": "GeneralPurpose", + "description": "General Purpose." + }, + { + "name": "GpuOptimized", + "value": "GpuOptimized", + "description": "GPU Optimized." + }, + { + "name": "HighPerformanceCompute", + "value": "HighPerformanceCompute", + "description": "High Performance Compute." + }, + { + "name": "MemoryOptimized", + "value": "MemoryOptimized", + "description": "Memory Optimized." + }, + { + "name": "StorageOptimized", + "value": "StorageOptimized", + "description": "Storage Optimized." + }, + { + "name": "Isolated", + "value": "Isolated", + "description": "Isolated VM." + } + ] + } + }, + "AzureVmFamily": { + "type": "string", + "enum": [ + "Unknown", + "Basic_A0_A4", + "Standard_A0_A7", + "Standard_A8_A11", + "Av2_series", + "D_series", + "Dv2_series", + "DS_series", + "DSv2_series", + "F_series", + "Fs_series", + "G_series", + "GS_series", + "H_series", + "Ls_series", + "Dsv3_series", + "Dv3_series", + "Fsv2_series", + "Ev3_series", + "Esv3_series", + "M_series", + "DC_Series", + "Lsv2_series", + "Ev4_series", + "Esv4_series", + "Edv4_series", + "Edsv4_series", + "Dv4_series", + "Dsv4_series", + "Ddv4_series", + "Ddsv4_series", + "Easv4_series", + "Dasv4_series", + "Mv2_series", + "Eav4_series", + "Dav4_series", + "Msv2_series", + "Mdsv2_series", + "Dv5_series", + "Dsv5_series", + "Ddv5_series", + "Ddsv5_series", + "Dasv5_series", + "Dadsv5_series", + "Ev5_series", + "Esv5_series", + "Edv5_series", + "Edsv5_series", + "Easv5_series", + "Eadsv5_series", + "Ebsv5_series", + "Ebdsv5_series" + ], + "x-ms-enum": { + "name": "AzureVmFamily", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "BasicA0A4", + "value": "Basic_A0_A4" + }, + { + "name": "StandardA0A7", + "value": "Standard_A0_A7" + }, + { + "name": "StandardA8A11", + "value": "Standard_A8_A11" + }, + { + "name": "Av2Series", + "value": "Av2_series" + }, + { + "name": "DSeries", + "value": "D_series" + }, + { + "name": "Dv2Series", + "value": "Dv2_series" + }, + { + "name": "DSSeries", + "value": "DS_series" + }, + { + "name": "DSv2Series", + "value": "DSv2_series" + }, + { + "name": "FSeries", + "value": "F_series" + }, + { + "name": "FsSeries", + "value": "Fs_series" + }, + { + "name": "GSeries", + "value": "G_series" + }, + { + "name": "GSSeries", + "value": "GS_series" + }, + { + "name": "HSeries", + "value": "H_series" + }, + { + "name": "LsSeries", + "value": "Ls_series" + }, + { + "name": "Dsv3Series", + "value": "Dsv3_series" + }, + { + "name": "Dv3Series", + "value": "Dv3_series" + }, + { + "name": "Fsv2Series", + "value": "Fsv2_series" + }, + { + "name": "Ev3Series", + "value": "Ev3_series" + }, + { + "name": "Esv3Series", + "value": "Esv3_series" + }, + { + "name": "MSeries", + "value": "M_series" + }, + { + "name": "DCSeries", + "value": "DC_Series" + }, + { + "name": "Lsv2Series", + "value": "Lsv2_series" + }, + { + "name": "Ev4Series", + "value": "Ev4_series" + }, + { + "name": "Esv4Series", + "value": "Esv4_series" + }, + { + "name": "Edv4Series", + "value": "Edv4_series" + }, + { + "name": "Edsv4Series", + "value": "Edsv4_series" + }, + { + "name": "Dv4Series", + "value": "Dv4_series" + }, + { + "name": "Dsv4Series", + "value": "Dsv4_series" + }, + { + "name": "Ddv4Series", + "value": "Ddv4_series" + }, + { + "name": "Ddsv4Series", + "value": "Ddsv4_series" + }, + { + "name": "Easv4Series", + "value": "Easv4_series" + }, + { + "name": "Dasv4Series", + "value": "Dasv4_series" + }, + { + "name": "Mv2Series", + "value": "Mv2_series" + }, + { + "name": "Eav4Series", + "value": "Eav4_series" + }, + { + "name": "Dav4Series", + "value": "Dav4_series" + }, + { + "name": "Msv2Series", + "value": "Msv2_series" + }, + { + "name": "Mdsv2Series", + "value": "Mdsv2_series" + }, + { + "name": "Dv5Series", + "value": "Dv5_series" + }, + { + "name": "Dsv5Series", + "value": "Dsv5_series" + }, + { + "name": "Ddv5Series", + "value": "Ddv5_series" + }, + { + "name": "Ddsv5Series", + "value": "Ddsv5_series" + }, + { + "name": "Dasv5Series", + "value": "Dasv5_series" + }, + { + "name": "Dadsv5Series", + "value": "Dadsv5_series" + }, + { + "name": "Ev5Series", + "value": "Ev5_series" + }, + { + "name": "Esv5Series", + "value": "Esv5_series" + }, + { + "name": "Edv5Series", + "value": "Edv5_series" + }, + { + "name": "Edsv5Series", + "value": "Edsv5_series" + }, + { + "name": "Easv5Series", + "value": "Easv5_series" + }, + { + "name": "Eadsv5Series", + "value": "Eadsv5_series" + }, + { + "name": "Ebsv5Series", + "value": "Ebsv5_series" + }, + { + "name": "Ebdsv5Series", + "value": "Ebdsv5_series" + } + ] + } + }, + "AzureVmSize": { + "type": "string", + "enum": [ + "Unknown", + "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_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_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_F1", + "Standard_F2", + "Standard_F4", + "Standard_F8", + "Standard_F16", + "Standard_F1s", + "Standard_F2s", + "Standard_F4s", + "Standard_F8s", + "Standard_F16s", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5", + "Standard_H8", + "Standard_H16", + "Standard_H8m", + "Standard_H16m", + "Standard_H16r", + "Standard_H16mr", + "Standard_L4s", + "Standard_L8s", + "Standard_L16s", + "Standard_L32s", + "Standard_D2s_v3", + "Standard_D4s_v3", + "Standard_D8s_v3", + "Standard_D16s_v3", + "Standard_D32s_v3", + "Standard_D64s_v3", + "Standard_D2_v3", + "Standard_D4_v3", + "Standard_D8_v3", + "Standard_D16_v3", + "Standard_D32_v3", + "Standard_D64_v3", + "Standard_F2s_v2", + "Standard_F4s_v2", + "Standard_F8s_v2", + "Standard_F16s_v2", + "Standard_F32s_v2", + "Standard_F64s_v2", + "Standard_F72s_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_M64s", + "Standard_M64ms", + "Standard_M128s", + "Standard_M128ms", + "Standard_DC2s", + "Standard_DC4s", + "Standard_E20_v3", + "Standard_E20s_v3", + "Standard_E64i_v3", + "Standard_E64is_v3", + "Standard_M8ms", + "Standard_M16ms", + "Standard_M32ls", + "Standard_M32ms", + "Standard_M32ts", + "Standard_M64", + "Standard_M64ls", + "Standard_M64m", + "Standard_M128", + "Standard_M128m", + "Standard_L8s_v2", + "Standard_L16s_v2", + "Standard_L32s_v2", + "Standard_L48s_v2", + "Standard_L64s_v2", + "Standard_L80s_v2", + "Standard_D2_v4", + "Standard_D4_v4", + "Standard_D8_v4", + "Standard_D16_v4", + "Standard_D32_v4", + "Standard_D48_v4", + "Standard_D64_v4", + "Standard_D2s_v4", + "Standard_D4s_v4", + "Standard_D8s_v4", + "Standard_D16s_v4", + "Standard_D32s_v4", + "Standard_D48s_v4", + "Standard_D64s_v4", + "Standard_D2d_v4", + "Standard_D4d_v4", + "Standard_D8d_v4", + "Standard_D16d_v4", + "Standard_D32d_v4", + "Standard_D48d_v4", + "Standard_D64d_v4", + "Standard_D2ds_v4", + "Standard_D4ds_v4", + "Standard_D8ds_v4", + "Standard_D16ds_v4", + "Standard_D32ds_v4", + "Standard_D48ds_v4", + "Standard_D64ds_v4", + "Standard_E2_v4", + "Standard_E4_v4", + "Standard_E8_v4", + "Standard_E16_v4", + "Standard_E20_v4", + "Standard_E32_v4", + "Standard_E48_v4", + "Standard_E64_v4", + "Standard_E2s_v4", + "Standard_E4s_v4", + "Standard_E8s_v4", + "Standard_E16s_v4", + "Standard_E20s_v4", + "Standard_E32s_v4", + "Standard_E48s_v4", + "Standard_E64s_v4", + "Standard_E2d_v4", + "Standard_E4d_v4", + "Standard_E8d_v4", + "Standard_E16d_v4", + "Standard_E20d_v4", + "Standard_E32d_v4", + "Standard_E48d_v4", + "Standard_E64d_v4", + "Standard_E2ds_v4", + "Standard_E4ds_v4", + "Standard_E8ds_v4", + "Standard_E16ds_v4", + "Standard_E20ds_v4", + "Standard_E32ds_v4", + "Standard_E48ds_v4", + "Standard_E64ds_v4", + "Standard_E2as_v4", + "Standard_E4as_v4", + "Standard_E8as_v4", + "Standard_E16as_v4", + "Standard_E20as_v4", + "Standard_E32as_v4", + "Standard_E48as_v4", + "Standard_E64as_v4", + "Standard_E96as_v4", + "Standard_D2as_v4", + "Standard_D4as_v4", + "Standard_D8as_v4", + "Standard_D16as_v4", + "Standard_D32as_v4", + "Standard_D48as_v4", + "Standard_D64as_v4", + "Standard_D96as_v4", + "Standard_M208ms_v2", + "Standard_M208s_v2", + "Standard_M416ms_v2", + "Standard_M416s_v2", + "Standard_F48s_v2", + "Standard_E48_v3", + "Standard_E48s_v3", + "Standard_E80is_v4", + "Standard_E80ids_v4", + "Standard_E2a_v4", + "Standard_E4a_v4", + "Standard_E8a_v4", + "Standard_E16a_v4", + "Standard_E20a_v4", + "Standard_E32a_v4", + "Standard_E48a_v4", + "Standard_E64a_v4", + "Standard_E96a_v4", + "Standard_D2a_v4", + "Standard_D4a_v4", + "Standard_D8a_v4", + "Standard_D16a_v4", + "Standard_D32a_v4", + "Standard_D48a_v4", + "Standard_D64a_v4", + "Standard_D96a_v4", + "Standard_M32ms_v2", + "Standard_M64s_v2", + "Standard_M64ms_v2", + "Standard_M128s_v2", + "Standard_M128ms_v2", + "Standard_M192is_v2", + "Standard_M192ims_v2", + "Standard_M32dms_v2", + "Standard_M64ds_v2", + "Standard_M64dms_v2", + "Standard_M128ds_v2", + "Standard_M128dms_v2", + "Standard_M192ids_v2", + "Standard_M192idms_v2", + "Standard_D2_v5", + "Standard_D4_v5", + "Standard_D8_v5", + "Standard_D16_v5", + "Standard_D32_v5", + "Standard_D48_v5", + "Standard_D64_v5", + "Standard_D96_v5", + "Standard_D2s_v5", + "Standard_D4s_v5", + "Standard_D8s_v5", + "Standard_D16s_v5", + "Standard_D32s_v5", + "Standard_D48s_v5", + "Standard_D64s_v5", + "Standard_D96s_v5", + "Standard_D2d_v5", + "Standard_D4d_v5", + "Standard_D8d_v5", + "Standard_D16d_v5", + "Standard_D32d_v5", + "Standard_D48d_v5", + "Standard_D64d_v5", + "Standard_D96d_v5", + "Standard_D2ds_v5", + "Standard_D4ds_v5", + "Standard_D8ds_v5", + "Standard_D16ds_v5", + "Standard_D32ds_v5", + "Standard_D48ds_v5", + "Standard_D64ds_v5", + "Standard_D96ds_v5", + "Standard_D2as_v5", + "Standard_D4as_v5", + "Standard_D8as_v5", + "Standard_D16as_v5", + "Standard_D32as_v5", + "Standard_D48as_v5", + "Standard_D64as_v5", + "Standard_D96as_v5", + "Standard_D2ads_v5", + "Standard_D4ads_v5", + "Standard_D8ads_v5", + "Standard_D16ads_v5", + "Standard_D32ads_v5", + "Standard_D48ads_v5", + "Standard_D64ads_v5", + "Standard_D96ads_v5", + "Standard_E2_v5", + "Standard_E4_v5", + "Standard_E8_v5", + "Standard_E16_v5", + "Standard_E20_v5", + "Standard_E32_v5", + "Standard_E48_v5", + "Standard_E64_v5", + "Standard_E96_v5", + "Standard_E104i_v5", + "Standard_E2s_v5", + "Standard_E4s_v5", + "Standard_E8s_v5", + "Standard_E16s_v5", + "Standard_E20s_v5", + "Standard_E32s_v5", + "Standard_E48s_v5", + "Standard_E64s_v5", + "Standard_E96s_v5", + "Standard_E104is_v5", + "Standard_E2d_v5", + "Standard_E4d_v5", + "Standard_E8d_v5", + "Standard_E16d_v5", + "Standard_E20d_v5", + "Standard_E32d_v5", + "Standard_E48d_v5", + "Standard_E64d_v5", + "Standard_E96d_v5", + "Standard_E104id_v5", + "Standard_E2ds_v5", + "Standard_E4ds_v5", + "Standard_E8ds_v5", + "Standard_E16ds_v5", + "Standard_E20ds_v5", + "Standard_E32ds_v5", + "Standard_E48ds_v5", + "Standard_E64ds_v5", + "Standard_E96ds_v5", + "Standard_E104ids_v5", + "Standard_E2as_v5", + "Standard_E4as_v5", + "Standard_E8as_v5", + "Standard_E16as_v5", + "Standard_E20as_v5", + "Standard_E32as_v5", + "Standard_E48as_v5", + "Standard_E64as_v5", + "Standard_E96as_v5", + "Standard_E2ads_v5", + "Standard_E4ads_v5", + "Standard_E8ads_v5", + "Standard_E16ads_v5", + "Standard_E20ads_v5", + "Standard_E32ads_v5", + "Standard_E48ads_v5", + "Standard_E64ads_v5", + "Standard_E96ads_v5", + "Standard_M8_2ms", + "Standard_M8_4ms", + "Standard_M16_4ms", + "Standard_M16_8ms", + "Standard_M32_8ms", + "Standard_M32_16ms", + "Standard_M64_32ms", + "Standard_M64_16ms", + "Standard_M128_64ms", + "Standard_M128_32ms", + "Standard_E4_2s_v3", + "Standard_E8_4s_v3", + "Standard_E8_2s_v3", + "Standard_E16_8s_v3", + "Standard_E16_4s_v3", + "Standard_E32_16s_v3", + "Standard_E32_8s_v3", + "Standard_E64_32s_v3", + "Standard_E64_16s_v3", + "Standard_E4_2s_v4", + "Standard_E8_4s_v4", + "Standard_E8_2s_v4", + "Standard_E16_8s_v4", + "Standard_E16_4s_v4", + "Standard_E32_16s_v4", + "Standard_E32_8s_v4", + "Standard_E64_32s_v4", + "Standard_E64_16s_v4", + "Standard_E4_2ds_v4", + "Standard_E8_4ds_v4", + "Standard_E8_2ds_v4", + "Standard_E16_8ds_v4", + "Standard_E16_4ds_v4", + "Standard_E32_16ds_v4", + "Standard_E32_8ds_v4", + "Standard_E64_32ds_v4", + "Standard_E64_16ds_v4", + "Standard_E4_2as_v4", + "Standard_E8_4as_v4", + "Standard_E8_2as_v4", + "Standard_E16_8as_v4", + "Standard_E16_4as_v4", + "Standard_E32_16as_v4", + "Standard_E32_8as_v4", + "Standard_E64_32as_v4", + "Standard_E64_16as_v4", + "Standard_E96_48as_v4", + "Standard_E96_24as_v4", + "Standard_E4_2ads_v5", + "Standard_E8_4ads_v5", + "Standard_E8_2ads_v5", + "Standard_E16_8ads_v5", + "Standard_E16_4ads_v5", + "Standard_E32_16ads_v5", + "Standard_E32_8ads_v5", + "Standard_E64_32ads_v5", + "Standard_E64_16ads_v5", + "Standard_E96_48ads_v5", + "Standard_E96_24ads_v5", + "Standard_E4_2s_v5", + "Standard_E8_4s_v5", + "Standard_E8_2s_v5", + "Standard_E16_8s_v5", + "Standard_E16_4s_v5", + "Standard_E32_16s_v5", + "Standard_E32_8s_v5", + "Standard_E64_32s_v5", + "Standard_E64_16s_v5", + "Standard_E96_48s_v5", + "Standard_E96_24s_v5", + "Standard_E4_2ds_v5", + "Standard_E8_4ds_v5", + "Standard_E8_2ds_v5", + "Standard_E16_8ds_v5", + "Standard_E16_4ds_v5", + "Standard_E32_16ds_v5", + "Standard_E32_8ds_v5", + "Standard_E64_32ds_v5", + "Standard_E64_16ds_v5", + "Standard_E96_48ds_v5", + "Standard_E96_24ds_v5", + "Standard_E4_2as_v5", + "Standard_E8_4as_v5", + "Standard_E8_2as_v5", + "Standard_E16_8as_v5", + "Standard_E16_4as_v5", + "Standard_E32_16as_v5", + "Standard_E32_8as_v5", + "Standard_E64_32as_v5", + "Standard_E64_16as_v5", + "Standard_E96_48as_v5", + "Standard_E96_24as_v5", + "Standard_GS4_8", + "Standard_GS4_4", + "Standard_GS5_16", + "Standard_GS5_8", + "Standard_DS11_1_v2", + "Standard_DS12_2_v2", + "Standard_DS12_1_v2", + "Standard_DS13_4_v2", + "Standard_DS13_2_v2", + "Standard_DS14_8_v2", + "Standard_DS14_4_v2", + "Standard_M416_208s_v2", + "Standard_M416_208ms_v2", + "Standard_E2bs_v5", + "Standard_E4bs_v5", + "Standard_E8bs_v5", + "Standard_E16bs_v5", + "Standard_E32bs_v5", + "Standard_E48bs_v5", + "Standard_E64bs_v5", + "Standard_E2bds_v5", + "Standard_E4bds_v5", + "Standard_E8bds_v5", + "Standard_E16bds_v5", + "Standard_E32bds_v5", + "Standard_E48bds_v5", + "Standard_E64bds_v5" + ], + "x-ms-enum": { + "name": "AzureVmSize", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "BasicA0", + "value": "Basic_A0" + }, + { + "name": "BasicA1", + "value": "Basic_A1" + }, + { + "name": "BasicA2", + "value": "Basic_A2" + }, + { + "name": "BasicA3", + "value": "Basic_A3" + }, + { + "name": "BasicA4", + "value": "Basic_A4" + }, + { + "name": "StandardA0", + "value": "Standard_A0" + }, + { + "name": "StandardA1", + "value": "Standard_A1" + }, + { + "name": "StandardA2", + "value": "Standard_A2" + }, + { + "name": "StandardA3", + "value": "Standard_A3" + }, + { + "name": "StandardA4", + "value": "Standard_A4" + }, + { + "name": "StandardA5", + "value": "Standard_A5" + }, + { + "name": "StandardA6", + "value": "Standard_A6" + }, + { + "name": "StandardA7", + "value": "Standard_A7" + }, + { + "name": "StandardA8", + "value": "Standard_A8" + }, + { + "name": "StandardA9", + "value": "Standard_A9" + }, + { + "name": "StandardA10", + "value": "Standard_A10" + }, + { + "name": "StandardA11", + "value": "Standard_A11" + }, + { + "name": "StandardA1V2", + "value": "Standard_A1_v2" + }, + { + "name": "StandardA2V2", + "value": "Standard_A2_v2" + }, + { + "name": "StandardA4V2", + "value": "Standard_A4_v2" + }, + { + "name": "StandardA8V2", + "value": "Standard_A8_v2" + }, + { + "name": "StandardA2MV2", + "value": "Standard_A2m_v2" + }, + { + "name": "StandardA4MV2", + "value": "Standard_A4m_v2" + }, + { + "name": "StandardA8MV2", + "value": "Standard_A8m_v2" + }, + { + "name": "StandardD1", + "value": "Standard_D1" + }, + { + "name": "StandardD2", + "value": "Standard_D2" + }, + { + "name": "StandardD3", + "value": "Standard_D3" + }, + { + "name": "StandardD4", + "value": "Standard_D4" + }, + { + "name": "StandardD11", + "value": "Standard_D11" + }, + { + "name": "StandardD12", + "value": "Standard_D12" + }, + { + "name": "StandardD13", + "value": "Standard_D13" + }, + { + "name": "StandardD14", + "value": "Standard_D14" + }, + { + "name": "StandardD1V2", + "value": "Standard_D1_v2" + }, + { + "name": "StandardD2V2", + "value": "Standard_D2_v2" + }, + { + "name": "StandardD3V2", + "value": "Standard_D3_v2" + }, + { + "name": "StandardD4V2", + "value": "Standard_D4_v2" + }, + { + "name": "StandardD5V2", + "value": "Standard_D5_v2" + }, + { + "name": "StandardD11V2", + "value": "Standard_D11_v2" + }, + { + "name": "StandardD12V2", + "value": "Standard_D12_v2" + }, + { + "name": "StandardD13V2", + "value": "Standard_D13_v2" + }, + { + "name": "StandardD14V2", + "value": "Standard_D14_v2" + }, + { + "name": "StandardD15V2", + "value": "Standard_D15_v2" + }, + { + "name": "StandardDS1", + "value": "Standard_DS1" + }, + { + "name": "StandardDS2", + "value": "Standard_DS2" + }, + { + "name": "StandardDS3", + "value": "Standard_DS3" + }, + { + "name": "StandardDS4", + "value": "Standard_DS4" + }, + { + "name": "StandardDS11", + "value": "Standard_DS11" + }, + { + "name": "StandardDS12", + "value": "Standard_DS12" + }, + { + "name": "StandardDS13", + "value": "Standard_DS13" + }, + { + "name": "StandardDS14", + "value": "Standard_DS14" + }, + { + "name": "StandardDS1V2", + "value": "Standard_DS1_v2" + }, + { + "name": "StandardDS2V2", + "value": "Standard_DS2_v2" + }, + { + "name": "StandardDS3V2", + "value": "Standard_DS3_v2" + }, + { + "name": "StandardDS4V2", + "value": "Standard_DS4_v2" + }, + { + "name": "StandardDS5V2", + "value": "Standard_DS5_v2" + }, + { + "name": "StandardDS11V2", + "value": "Standard_DS11_v2" + }, + { + "name": "StandardDS12V2", + "value": "Standard_DS12_v2" + }, + { + "name": "StandardDS13V2", + "value": "Standard_DS13_v2" + }, + { + "name": "StandardDS14V2", + "value": "Standard_DS14_v2" + }, + { + "name": "StandardDS15V2", + "value": "Standard_DS15_v2" + }, + { + "name": "StandardF1", + "value": "Standard_F1" + }, + { + "name": "StandardF2", + "value": "Standard_F2" + }, + { + "name": "StandardF4", + "value": "Standard_F4" + }, + { + "name": "StandardF8", + "value": "Standard_F8" + }, + { + "name": "StandardF16", + "value": "Standard_F16" + }, + { + "name": "StandardF1S", + "value": "Standard_F1s" + }, + { + "name": "StandardF2S", + "value": "Standard_F2s" + }, + { + "name": "StandardF4S", + "value": "Standard_F4s" + }, + { + "name": "StandardF8S", + "value": "Standard_F8s" + }, + { + "name": "StandardF16S", + "value": "Standard_F16s" + }, + { + "name": "StandardG1", + "value": "Standard_G1" + }, + { + "name": "StandardG2", + "value": "Standard_G2" + }, + { + "name": "StandardG3", + "value": "Standard_G3" + }, + { + "name": "StandardG4", + "value": "Standard_G4" + }, + { + "name": "StandardG5", + "value": "Standard_G5" + }, + { + "name": "StandardGS1", + "value": "Standard_GS1" + }, + { + "name": "StandardGS2", + "value": "Standard_GS2" + }, + { + "name": "StandardGS3", + "value": "Standard_GS3" + }, + { + "name": "StandardGS4", + "value": "Standard_GS4" + }, + { + "name": "StandardGS5", + "value": "Standard_GS5" + }, + { + "name": "StandardH8", + "value": "Standard_H8" + }, + { + "name": "StandardH16", + "value": "Standard_H16" + }, + { + "name": "StandardH8M", + "value": "Standard_H8m" + }, + { + "name": "StandardH16M", + "value": "Standard_H16m" + }, + { + "name": "StandardH16R", + "value": "Standard_H16r" + }, + { + "name": "StandardH16Mr", + "value": "Standard_H16mr" + }, + { + "name": "StandardL4S", + "value": "Standard_L4s" + }, + { + "name": "StandardL8S", + "value": "Standard_L8s" + }, + { + "name": "StandardL16S", + "value": "Standard_L16s" + }, + { + "name": "StandardL32S", + "value": "Standard_L32s" + }, + { + "name": "StandardD2SV3", + "value": "Standard_D2s_v3" + }, + { + "name": "StandardD4SV3", + "value": "Standard_D4s_v3" + }, + { + "name": "StandardD8SV3", + "value": "Standard_D8s_v3" + }, + { + "name": "StandardD16SV3", + "value": "Standard_D16s_v3" + }, + { + "name": "StandardD32SV3", + "value": "Standard_D32s_v3" + }, + { + "name": "StandardD64SV3", + "value": "Standard_D64s_v3" + }, + { + "name": "StandardD2V3", + "value": "Standard_D2_v3" + }, + { + "name": "StandardD4V3", + "value": "Standard_D4_v3" + }, + { + "name": "StandardD8V3", + "value": "Standard_D8_v3" + }, + { + "name": "StandardD16V3", + "value": "Standard_D16_v3" + }, + { + "name": "StandardD32V3", + "value": "Standard_D32_v3" + }, + { + "name": "StandardD64V3", + "value": "Standard_D64_v3" + }, + { + "name": "StandardF2SV2", + "value": "Standard_F2s_v2" + }, + { + "name": "StandardF4SV2", + "value": "Standard_F4s_v2" + }, + { + "name": "StandardF8SV2", + "value": "Standard_F8s_v2" + }, + { + "name": "StandardF16SV2", + "value": "Standard_F16s_v2" + }, + { + "name": "StandardF32SV2", + "value": "Standard_F32s_v2" + }, + { + "name": "StandardF64SV2", + "value": "Standard_F64s_v2" + }, + { + "name": "StandardF72SV2", + "value": "Standard_F72s_v2" + }, + { + "name": "StandardE2V3", + "value": "Standard_E2_v3" + }, + { + "name": "StandardE4V3", + "value": "Standard_E4_v3" + }, + { + "name": "StandardE8V3", + "value": "Standard_E8_v3" + }, + { + "name": "StandardE16V3", + "value": "Standard_E16_v3" + }, + { + "name": "StandardE32V3", + "value": "Standard_E32_v3" + }, + { + "name": "StandardE64V3", + "value": "Standard_E64_v3" + }, + { + "name": "StandardE2SV3", + "value": "Standard_E2s_v3" + }, + { + "name": "StandardE4SV3", + "value": "Standard_E4s_v3" + }, + { + "name": "StandardE8SV3", + "value": "Standard_E8s_v3" + }, + { + "name": "StandardE16SV3", + "value": "Standard_E16s_v3" + }, + { + "name": "StandardE32SV3", + "value": "Standard_E32s_v3" + }, + { + "name": "StandardE64SV3", + "value": "Standard_E64s_v3" + }, + { + "name": "StandardM64S", + "value": "Standard_M64s" + }, + { + "name": "StandardM64Ms", + "value": "Standard_M64ms" + }, + { + "name": "StandardM128S", + "value": "Standard_M128s" + }, + { + "name": "StandardM128Ms", + "value": "Standard_M128ms" + }, + { + "name": "StandardDC2S", + "value": "Standard_DC2s" + }, + { + "name": "StandardDC4S", + "value": "Standard_DC4s" + }, + { + "name": "StandardE20V3", + "value": "Standard_E20_v3" + }, + { + "name": "StandardE20SV3", + "value": "Standard_E20s_v3" + }, + { + "name": "StandardE64IV3", + "value": "Standard_E64i_v3" + }, + { + "name": "StandardE64IsV3", + "value": "Standard_E64is_v3" + }, + { + "name": "StandardM8Ms", + "value": "Standard_M8ms" + }, + { + "name": "StandardM16Ms", + "value": "Standard_M16ms" + }, + { + "name": "StandardM32Ls", + "value": "Standard_M32ls" + }, + { + "name": "StandardM32Ms", + "value": "Standard_M32ms" + }, + { + "name": "StandardM32Ts", + "value": "Standard_M32ts" + }, + { + "name": "StandardM64", + "value": "Standard_M64" + }, + { + "name": "StandardM64Ls", + "value": "Standard_M64ls" + }, + { + "name": "StandardM64M", + "value": "Standard_M64m" + }, + { + "name": "StandardM128", + "value": "Standard_M128" + }, + { + "name": "StandardM128M", + "value": "Standard_M128m" + }, + { + "name": "StandardL8SV2", + "value": "Standard_L8s_v2" + }, + { + "name": "StandardL16SV2", + "value": "Standard_L16s_v2" + }, + { + "name": "StandardL32SV2", + "value": "Standard_L32s_v2" + }, + { + "name": "StandardL48SV2", + "value": "Standard_L48s_v2" + }, + { + "name": "StandardL64SV2", + "value": "Standard_L64s_v2" + }, + { + "name": "StandardL80SV2", + "value": "Standard_L80s_v2" + }, + { + "name": "StandardD2V4", + "value": "Standard_D2_v4" + }, + { + "name": "StandardD4V4", + "value": "Standard_D4_v4" + }, + { + "name": "StandardD8V4", + "value": "Standard_D8_v4" + }, + { + "name": "StandardD16V4", + "value": "Standard_D16_v4" + }, + { + "name": "StandardD32V4", + "value": "Standard_D32_v4" + }, + { + "name": "StandardD48V4", + "value": "Standard_D48_v4" + }, + { + "name": "StandardD64V4", + "value": "Standard_D64_v4" + }, + { + "name": "StandardD2SV4", + "value": "Standard_D2s_v4" + }, + { + "name": "StandardD4SV4", + "value": "Standard_D4s_v4" + }, + { + "name": "StandardD8SV4", + "value": "Standard_D8s_v4" + }, + { + "name": "StandardD16SV4", + "value": "Standard_D16s_v4" + }, + { + "name": "StandardD32SV4", + "value": "Standard_D32s_v4" + }, + { + "name": "StandardD48SV4", + "value": "Standard_D48s_v4" + }, + { + "name": "StandardD64SV4", + "value": "Standard_D64s_v4" + }, + { + "name": "StandardD2DV4", + "value": "Standard_D2d_v4" + }, + { + "name": "StandardD4DV4", + "value": "Standard_D4d_v4" + }, + { + "name": "StandardD8DV4", + "value": "Standard_D8d_v4" + }, + { + "name": "StandardD16DV4", + "value": "Standard_D16d_v4" + }, + { + "name": "StandardD32DV4", + "value": "Standard_D32d_v4" + }, + { + "name": "StandardD48DV4", + "value": "Standard_D48d_v4" + }, + { + "name": "StandardD64DV4", + "value": "Standard_D64d_v4" + }, + { + "name": "StandardD2DsV4", + "value": "Standard_D2ds_v4" + }, + { + "name": "StandardD4DsV4", + "value": "Standard_D4ds_v4" + }, + { + "name": "StandardD8DsV4", + "value": "Standard_D8ds_v4" + }, + { + "name": "StandardD16DsV4", + "value": "Standard_D16ds_v4" + }, + { + "name": "StandardD32DsV4", + "value": "Standard_D32ds_v4" + }, + { + "name": "StandardD48DsV4", + "value": "Standard_D48ds_v4" + }, + { + "name": "StandardD64DsV4", + "value": "Standard_D64ds_v4" + }, + { + "name": "StandardE2V4", + "value": "Standard_E2_v4" + }, + { + "name": "StandardE4V4", + "value": "Standard_E4_v4" + }, + { + "name": "StandardE8V4", + "value": "Standard_E8_v4" + }, + { + "name": "StandardE16V4", + "value": "Standard_E16_v4" + }, + { + "name": "StandardE20V4", + "value": "Standard_E20_v4" + }, + { + "name": "StandardE32V4", + "value": "Standard_E32_v4" + }, + { + "name": "StandardE48V4", + "value": "Standard_E48_v4" + }, + { + "name": "StandardE64V4", + "value": "Standard_E64_v4" + }, + { + "name": "StandardE2SV4", + "value": "Standard_E2s_v4" + }, + { + "name": "StandardE4SV4", + "value": "Standard_E4s_v4" + }, + { + "name": "StandardE8SV4", + "value": "Standard_E8s_v4" + }, + { + "name": "StandardE16SV4", + "value": "Standard_E16s_v4" + }, + { + "name": "StandardE20SV4", + "value": "Standard_E20s_v4" + }, + { + "name": "StandardE32SV4", + "value": "Standard_E32s_v4" + }, + { + "name": "StandardE48SV4", + "value": "Standard_E48s_v4" + }, + { + "name": "StandardE64SV4", + "value": "Standard_E64s_v4" + }, + { + "name": "StandardE2DV4", + "value": "Standard_E2d_v4" + }, + { + "name": "StandardE4DV4", + "value": "Standard_E4d_v4" + }, + { + "name": "StandardE8DV4", + "value": "Standard_E8d_v4" + }, + { + "name": "StandardE16DV4", + "value": "Standard_E16d_v4" + }, + { + "name": "StandardE20DV4", + "value": "Standard_E20d_v4" + }, + { + "name": "StandardE32DV4", + "value": "Standard_E32d_v4" + }, + { + "name": "StandardE48DV4", + "value": "Standard_E48d_v4" + }, + { + "name": "StandardE64DV4", + "value": "Standard_E64d_v4" + }, + { + "name": "StandardE2DsV4", + "value": "Standard_E2ds_v4" + }, + { + "name": "StandardE4DsV4", + "value": "Standard_E4ds_v4" + }, + { + "name": "StandardE8DsV4", + "value": "Standard_E8ds_v4" + }, + { + "name": "StandardE16DsV4", + "value": "Standard_E16ds_v4" + }, + { + "name": "StandardE20DsV4", + "value": "Standard_E20ds_v4" + }, + { + "name": "StandardE32DsV4", + "value": "Standard_E32ds_v4" + }, + { + "name": "StandardE48DsV4", + "value": "Standard_E48ds_v4" + }, + { + "name": "StandardE64DsV4", + "value": "Standard_E64ds_v4" + }, + { + "name": "StandardE2AsV4", + "value": "Standard_E2as_v4" + }, + { + "name": "StandardE4AsV4", + "value": "Standard_E4as_v4" + }, + { + "name": "StandardE8AsV4", + "value": "Standard_E8as_v4" + }, + { + "name": "StandardE16AsV4", + "value": "Standard_E16as_v4" + }, + { + "name": "StandardE20AsV4", + "value": "Standard_E20as_v4" + }, + { + "name": "StandardE32AsV4", + "value": "Standard_E32as_v4" + }, + { + "name": "StandardE48AsV4", + "value": "Standard_E48as_v4" + }, + { + "name": "StandardE64AsV4", + "value": "Standard_E64as_v4" + }, + { + "name": "StandardE96AsV4", + "value": "Standard_E96as_v4" + }, + { + "name": "StandardD2AsV4", + "value": "Standard_D2as_v4" + }, + { + "name": "StandardD4AsV4", + "value": "Standard_D4as_v4" + }, + { + "name": "StandardD8AsV4", + "value": "Standard_D8as_v4" + }, + { + "name": "StandardD16AsV4", + "value": "Standard_D16as_v4" + }, + { + "name": "StandardD32AsV4", + "value": "Standard_D32as_v4" + }, + { + "name": "StandardD48AsV4", + "value": "Standard_D48as_v4" + }, + { + "name": "StandardD64AsV4", + "value": "Standard_D64as_v4" + }, + { + "name": "StandardD96AsV4", + "value": "Standard_D96as_v4" + }, + { + "name": "StandardM208MsV2", + "value": "Standard_M208ms_v2" + }, + { + "name": "StandardM208SV2", + "value": "Standard_M208s_v2" + }, + { + "name": "StandardM416MsV2", + "value": "Standard_M416ms_v2" + }, + { + "name": "StandardM416SV2", + "value": "Standard_M416s_v2" + }, + { + "name": "StandardF48SV2", + "value": "Standard_F48s_v2" + }, + { + "name": "StandardE48V3", + "value": "Standard_E48_v3" + }, + { + "name": "StandardE48SV3", + "value": "Standard_E48s_v3" + }, + { + "name": "StandardE80IsV4", + "value": "Standard_E80is_v4" + }, + { + "name": "StandardE80IdsV4", + "value": "Standard_E80ids_v4" + }, + { + "name": "StandardE2AV4", + "value": "Standard_E2a_v4" + }, + { + "name": "StandardE4AV4", + "value": "Standard_E4a_v4" + }, + { + "name": "StandardE8AV4", + "value": "Standard_E8a_v4" + }, + { + "name": "StandardE16AV4", + "value": "Standard_E16a_v4" + }, + { + "name": "StandardE20AV4", + "value": "Standard_E20a_v4" + }, + { + "name": "StandardE32AV4", + "value": "Standard_E32a_v4" + }, + { + "name": "StandardE48AV4", + "value": "Standard_E48a_v4" + }, + { + "name": "StandardE64AV4", + "value": "Standard_E64a_v4" + }, + { + "name": "StandardE96AV4", + "value": "Standard_E96a_v4" + }, + { + "name": "StandardD2AV4", + "value": "Standard_D2a_v4" + }, + { + "name": "StandardD4AV4", + "value": "Standard_D4a_v4" + }, + { + "name": "StandardD8AV4", + "value": "Standard_D8a_v4" + }, + { + "name": "StandardD16AV4", + "value": "Standard_D16a_v4" + }, + { + "name": "StandardD32AV4", + "value": "Standard_D32a_v4" + }, + { + "name": "StandardD48AV4", + "value": "Standard_D48a_v4" + }, + { + "name": "StandardD64AV4", + "value": "Standard_D64a_v4" + }, + { + "name": "StandardD96AV4", + "value": "Standard_D96a_v4" + }, + { + "name": "StandardM32MsV2", + "value": "Standard_M32ms_v2" + }, + { + "name": "StandardM64SV2", + "value": "Standard_M64s_v2" + }, + { + "name": "StandardM64MsV2", + "value": "Standard_M64ms_v2" + }, + { + "name": "StandardM128SV2", + "value": "Standard_M128s_v2" + }, + { + "name": "StandardM128MsV2", + "value": "Standard_M128ms_v2" + }, + { + "name": "StandardM192IsV2", + "value": "Standard_M192is_v2" + }, + { + "name": "StandardM192ImsV2", + "value": "Standard_M192ims_v2" + }, + { + "name": "StandardM32DmsV2", + "value": "Standard_M32dms_v2" + }, + { + "name": "StandardM64DsV2", + "value": "Standard_M64ds_v2" + }, + { + "name": "StandardM64DmsV2", + "value": "Standard_M64dms_v2" + }, + { + "name": "StandardM128DsV2", + "value": "Standard_M128ds_v2" + }, + { + "name": "StandardM128DmsV2", + "value": "Standard_M128dms_v2" + }, + { + "name": "StandardM192IdsV2", + "value": "Standard_M192ids_v2" + }, + { + "name": "StandardM192IdmsV2", + "value": "Standard_M192idms_v2" + }, + { + "name": "StandardD2V5", + "value": "Standard_D2_v5" + }, + { + "name": "StandardD4V5", + "value": "Standard_D4_v5" + }, + { + "name": "StandardD8V5", + "value": "Standard_D8_v5" + }, + { + "name": "StandardD16V5", + "value": "Standard_D16_v5" + }, + { + "name": "StandardD32V5", + "value": "Standard_D32_v5" + }, + { + "name": "StandardD48V5", + "value": "Standard_D48_v5" + }, + { + "name": "StandardD64V5", + "value": "Standard_D64_v5" + }, + { + "name": "StandardD96V5", + "value": "Standard_D96_v5" + }, + { + "name": "StandardD2SV5", + "value": "Standard_D2s_v5" + }, + { + "name": "StandardD4SV5", + "value": "Standard_D4s_v5" + }, + { + "name": "StandardD8SV5", + "value": "Standard_D8s_v5" + }, + { + "name": "StandardD16SV5", + "value": "Standard_D16s_v5" + }, + { + "name": "StandardD32SV5", + "value": "Standard_D32s_v5" + }, + { + "name": "StandardD48SV5", + "value": "Standard_D48s_v5" + }, + { + "name": "StandardD64SV5", + "value": "Standard_D64s_v5" + }, + { + "name": "StandardD96SV5", + "value": "Standard_D96s_v5" + }, + { + "name": "StandardD2DV5", + "value": "Standard_D2d_v5" + }, + { + "name": "StandardD4DV5", + "value": "Standard_D4d_v5" + }, + { + "name": "StandardD8DV5", + "value": "Standard_D8d_v5" + }, + { + "name": "StandardD16DV5", + "value": "Standard_D16d_v5" + }, + { + "name": "StandardD32DV5", + "value": "Standard_D32d_v5" + }, + { + "name": "StandardD48DV5", + "value": "Standard_D48d_v5" + }, + { + "name": "StandardD64DV5", + "value": "Standard_D64d_v5" + }, + { + "name": "StandardD96DV5", + "value": "Standard_D96d_v5" + }, + { + "name": "StandardD2DsV5", + "value": "Standard_D2ds_v5" + }, + { + "name": "StandardD4DsV5", + "value": "Standard_D4ds_v5" + }, + { + "name": "StandardD8DsV5", + "value": "Standard_D8ds_v5" + }, + { + "name": "StandardD16DsV5", + "value": "Standard_D16ds_v5" + }, + { + "name": "StandardD32DsV5", + "value": "Standard_D32ds_v5" + }, + { + "name": "StandardD48DsV5", + "value": "Standard_D48ds_v5" + }, + { + "name": "StandardD64DsV5", + "value": "Standard_D64ds_v5" + }, + { + "name": "StandardD96DsV5", + "value": "Standard_D96ds_v5" + }, + { + "name": "StandardD2AsV5", + "value": "Standard_D2as_v5" + }, + { + "name": "StandardD4AsV5", + "value": "Standard_D4as_v5" + }, + { + "name": "StandardD8AsV5", + "value": "Standard_D8as_v5" + }, + { + "name": "StandardD16AsV5", + "value": "Standard_D16as_v5" + }, + { + "name": "StandardD32AsV5", + "value": "Standard_D32as_v5" + }, + { + "name": "StandardD48AsV5", + "value": "Standard_D48as_v5" + }, + { + "name": "StandardD64AsV5", + "value": "Standard_D64as_v5" + }, + { + "name": "StandardD96AsV5", + "value": "Standard_D96as_v5" + }, + { + "name": "StandardD2AdsV5", + "value": "Standard_D2ads_v5" + }, + { + "name": "StandardD4AdsV5", + "value": "Standard_D4ads_v5" + }, + { + "name": "StandardD8AdsV5", + "value": "Standard_D8ads_v5" + }, + { + "name": "StandardD16AdsV5", + "value": "Standard_D16ads_v5" + }, + { + "name": "StandardD32AdsV5", + "value": "Standard_D32ads_v5" + }, + { + "name": "StandardD48AdsV5", + "value": "Standard_D48ads_v5" + }, + { + "name": "StandardD64AdsV5", + "value": "Standard_D64ads_v5" + }, + { + "name": "StandardD96AdsV5", + "value": "Standard_D96ads_v5" + }, + { + "name": "StandardE2V5", + "value": "Standard_E2_v5" + }, + { + "name": "StandardE4V5", + "value": "Standard_E4_v5" + }, + { + "name": "StandardE8V5", + "value": "Standard_E8_v5" + }, + { + "name": "StandardE16V5", + "value": "Standard_E16_v5" + }, + { + "name": "StandardE20V5", + "value": "Standard_E20_v5" + }, + { + "name": "StandardE32V5", + "value": "Standard_E32_v5" + }, + { + "name": "StandardE48V5", + "value": "Standard_E48_v5" + }, + { + "name": "StandardE64V5", + "value": "Standard_E64_v5" + }, + { + "name": "StandardE96V5", + "value": "Standard_E96_v5" + }, + { + "name": "StandardE104IV5", + "value": "Standard_E104i_v5" + }, + { + "name": "StandardE2SV5", + "value": "Standard_E2s_v5" + }, + { + "name": "StandardE4SV5", + "value": "Standard_E4s_v5" + }, + { + "name": "StandardE8SV5", + "value": "Standard_E8s_v5" + }, + { + "name": "StandardE16SV5", + "value": "Standard_E16s_v5" + }, + { + "name": "StandardE20SV5", + "value": "Standard_E20s_v5" + }, + { + "name": "StandardE32SV5", + "value": "Standard_E32s_v5" + }, + { + "name": "StandardE48SV5", + "value": "Standard_E48s_v5" + }, + { + "name": "StandardE64SV5", + "value": "Standard_E64s_v5" + }, + { + "name": "StandardE96SV5", + "value": "Standard_E96s_v5" + }, + { + "name": "StandardE104IsV5", + "value": "Standard_E104is_v5" + }, + { + "name": "StandardE2DV5", + "value": "Standard_E2d_v5" + }, + { + "name": "StandardE4DV5", + "value": "Standard_E4d_v5" + }, + { + "name": "StandardE8DV5", + "value": "Standard_E8d_v5" + }, + { + "name": "StandardE16DV5", + "value": "Standard_E16d_v5" + }, + { + "name": "StandardE20DV5", + "value": "Standard_E20d_v5" + }, + { + "name": "StandardE32DV5", + "value": "Standard_E32d_v5" + }, + { + "name": "StandardE48DV5", + "value": "Standard_E48d_v5" + }, + { + "name": "StandardE64DV5", + "value": "Standard_E64d_v5" + }, + { + "name": "StandardE96DV5", + "value": "Standard_E96d_v5" + }, + { + "name": "StandardE104IdV5", + "value": "Standard_E104id_v5" + }, + { + "name": "StandardE2DsV5", + "value": "Standard_E2ds_v5" + }, + { + "name": "StandardE4DsV5", + "value": "Standard_E4ds_v5" + }, + { + "name": "StandardE8DsV5", + "value": "Standard_E8ds_v5" + }, + { + "name": "StandardE16DsV5", + "value": "Standard_E16ds_v5" + }, + { + "name": "StandardE20DsV5", + "value": "Standard_E20ds_v5" + }, + { + "name": "StandardE32DsV5", + "value": "Standard_E32ds_v5" + }, + { + "name": "StandardE48DsV5", + "value": "Standard_E48ds_v5" + }, + { + "name": "StandardE64DsV5", + "value": "Standard_E64ds_v5" + }, + { + "name": "StandardE96DsV5", + "value": "Standard_E96ds_v5" + }, + { + "name": "StandardE104IdsV5", + "value": "Standard_E104ids_v5" + }, + { + "name": "StandardE2AsV5", + "value": "Standard_E2as_v5" + }, + { + "name": "StandardE4AsV5", + "value": "Standard_E4as_v5" + }, + { + "name": "StandardE8AsV5", + "value": "Standard_E8as_v5" + }, + { + "name": "StandardE16AsV5", + "value": "Standard_E16as_v5" + }, + { + "name": "StandardE20AsV5", + "value": "Standard_E20as_v5" + }, + { + "name": "StandardE32AsV5", + "value": "Standard_E32as_v5" + }, + { + "name": "StandardE48AsV5", + "value": "Standard_E48as_v5" + }, + { + "name": "StandardE64AsV5", + "value": "Standard_E64as_v5" + }, + { + "name": "StandardE96AsV5", + "value": "Standard_E96as_v5" + }, + { + "name": "StandardE2AdsV5", + "value": "Standard_E2ads_v5" + }, + { + "name": "StandardE4AdsV5", + "value": "Standard_E4ads_v5" + }, + { + "name": "StandardE8AdsV5", + "value": "Standard_E8ads_v5" + }, + { + "name": "StandardE16AdsV5", + "value": "Standard_E16ads_v5" + }, + { + "name": "StandardE20AdsV5", + "value": "Standard_E20ads_v5" + }, + { + "name": "StandardE32AdsV5", + "value": "Standard_E32ads_v5" + }, + { + "name": "StandardE48AdsV5", + "value": "Standard_E48ads_v5" + }, + { + "name": "StandardE64AdsV5", + "value": "Standard_E64ads_v5" + }, + { + "name": "StandardE96AdsV5", + "value": "Standard_E96ads_v5" + }, + { + "name": "StandardM82Ms", + "value": "Standard_M8_2ms" + }, + { + "name": "StandardM84Ms", + "value": "Standard_M8_4ms" + }, + { + "name": "StandardM164Ms", + "value": "Standard_M16_4ms" + }, + { + "name": "StandardM168Ms", + "value": "Standard_M16_8ms" + }, + { + "name": "StandardM328Ms", + "value": "Standard_M32_8ms" + }, + { + "name": "StandardM3216Ms", + "value": "Standard_M32_16ms" + }, + { + "name": "StandardM6432Ms", + "value": "Standard_M64_32ms" + }, + { + "name": "StandardM6416Ms", + "value": "Standard_M64_16ms" + }, + { + "name": "StandardM12864Ms", + "value": "Standard_M128_64ms" + }, + { + "name": "StandardM12832Ms", + "value": "Standard_M128_32ms" + }, + { + "name": "StandardE42SV3", + "value": "Standard_E4_2s_v3" + }, + { + "name": "StandardE84SV3", + "value": "Standard_E8_4s_v3" + }, + { + "name": "StandardE82SV3", + "value": "Standard_E8_2s_v3" + }, + { + "name": "StandardE168SV3", + "value": "Standard_E16_8s_v3" + }, + { + "name": "StandardE164SV3", + "value": "Standard_E16_4s_v3" + }, + { + "name": "StandardE3216SV3", + "value": "Standard_E32_16s_v3" + }, + { + "name": "StandardE328SV3", + "value": "Standard_E32_8s_v3" + }, + { + "name": "StandardE6432SV3", + "value": "Standard_E64_32s_v3" + }, + { + "name": "StandardE6416SV3", + "value": "Standard_E64_16s_v3" + }, + { + "name": "StandardE42SV4", + "value": "Standard_E4_2s_v4" + }, + { + "name": "StandardE84SV4", + "value": "Standard_E8_4s_v4" + }, + { + "name": "StandardE82SV4", + "value": "Standard_E8_2s_v4" + }, + { + "name": "StandardE168SV4", + "value": "Standard_E16_8s_v4" + }, + { + "name": "StandardE164SV4", + "value": "Standard_E16_4s_v4" + }, + { + "name": "StandardE3216SV4", + "value": "Standard_E32_16s_v4" + }, + { + "name": "StandardE328SV4", + "value": "Standard_E32_8s_v4" + }, + { + "name": "StandardE6432SV4", + "value": "Standard_E64_32s_v4" + }, + { + "name": "StandardE6416SV4", + "value": "Standard_E64_16s_v4" + }, + { + "name": "StandardE42DsV4", + "value": "Standard_E4_2ds_v4" + }, + { + "name": "StandardE84DsV4", + "value": "Standard_E8_4ds_v4" + }, + { + "name": "StandardE82DsV4", + "value": "Standard_E8_2ds_v4" + }, + { + "name": "StandardE168DsV4", + "value": "Standard_E16_8ds_v4" + }, + { + "name": "StandardE164DsV4", + "value": "Standard_E16_4ds_v4" + }, + { + "name": "StandardE3216DsV4", + "value": "Standard_E32_16ds_v4" + }, + { + "name": "StandardE328DsV4", + "value": "Standard_E32_8ds_v4" + }, + { + "name": "StandardE6432DsV4", + "value": "Standard_E64_32ds_v4" + }, + { + "name": "StandardE6416DsV4", + "value": "Standard_E64_16ds_v4" + }, + { + "name": "StandardE42AsV4", + "value": "Standard_E4_2as_v4" + }, + { + "name": "StandardE84AsV4", + "value": "Standard_E8_4as_v4" + }, + { + "name": "StandardE82AsV4", + "value": "Standard_E8_2as_v4" + }, + { + "name": "StandardE168AsV4", + "value": "Standard_E16_8as_v4" + }, + { + "name": "StandardE164AsV4", + "value": "Standard_E16_4as_v4" + }, + { + "name": "StandardE3216AsV4", + "value": "Standard_E32_16as_v4" + }, + { + "name": "StandardE328AsV4", + "value": "Standard_E32_8as_v4" + }, + { + "name": "StandardE6432AsV4", + "value": "Standard_E64_32as_v4" + }, + { + "name": "StandardE6416AsV4", + "value": "Standard_E64_16as_v4" + }, + { + "name": "StandardE9648AsV4", + "value": "Standard_E96_48as_v4" + }, + { + "name": "StandardE9624AsV4", + "value": "Standard_E96_24as_v4" + }, + { + "name": "StandardE42AdsV5", + "value": "Standard_E4_2ads_v5" + }, + { + "name": "StandardE84AdsV5", + "value": "Standard_E8_4ads_v5" + }, + { + "name": "StandardE82AdsV5", + "value": "Standard_E8_2ads_v5" + }, + { + "name": "StandardE168AdsV5", + "value": "Standard_E16_8ads_v5" + }, + { + "name": "StandardE164AdsV5", + "value": "Standard_E16_4ads_v5" + }, + { + "name": "StandardE3216AdsV5", + "value": "Standard_E32_16ads_v5" + }, + { + "name": "StandardE328AdsV5", + "value": "Standard_E32_8ads_v5" + }, + { + "name": "StandardE6432AdsV5", + "value": "Standard_E64_32ads_v5" + }, + { + "name": "StandardE6416AdsV5", + "value": "Standard_E64_16ads_v5" + }, + { + "name": "StandardE9648AdsV5", + "value": "Standard_E96_48ads_v5" + }, + { + "name": "StandardE9624AdsV5", + "value": "Standard_E96_24ads_v5" + }, + { + "name": "StandardE42SV5", + "value": "Standard_E4_2s_v5" + }, + { + "name": "StandardE84SV5", + "value": "Standard_E8_4s_v5" + }, + { + "name": "StandardE82SV5", + "value": "Standard_E8_2s_v5" + }, + { + "name": "StandardE168SV5", + "value": "Standard_E16_8s_v5" + }, + { + "name": "StandardE164SV5", + "value": "Standard_E16_4s_v5" + }, + { + "name": "StandardE3216SV5", + "value": "Standard_E32_16s_v5" + }, + { + "name": "StandardE328SV5", + "value": "Standard_E32_8s_v5" + }, + { + "name": "StandardE6432SV5", + "value": "Standard_E64_32s_v5" + }, + { + "name": "StandardE6416SV5", + "value": "Standard_E64_16s_v5" + }, + { + "name": "StandardE9648SV5", + "value": "Standard_E96_48s_v5" + }, + { + "name": "StandardE9624SV5", + "value": "Standard_E96_24s_v5" + }, + { + "name": "StandardE42DsV5", + "value": "Standard_E4_2ds_v5" + }, + { + "name": "StandardE84DsV5", + "value": "Standard_E8_4ds_v5" + }, + { + "name": "StandardE82DsV5", + "value": "Standard_E8_2ds_v5" + }, + { + "name": "StandardE168DsV5", + "value": "Standard_E16_8ds_v5" + }, + { + "name": "StandardE164DsV5", + "value": "Standard_E16_4ds_v5" + }, + { + "name": "StandardE3216DsV5", + "value": "Standard_E32_16ds_v5" + }, + { + "name": "StandardE328DsV5", + "value": "Standard_E32_8ds_v5" + }, + { + "name": "StandardE6432DsV5", + "value": "Standard_E64_32ds_v5" + }, + { + "name": "StandardE6416DsV5", + "value": "Standard_E64_16ds_v5" + }, + { + "name": "StandardE9648DsV5", + "value": "Standard_E96_48ds_v5" + }, + { + "name": "StandardE9624DsV5", + "value": "Standard_E96_24ds_v5" + }, + { + "name": "StandardE42AsV5", + "value": "Standard_E4_2as_v5" + }, + { + "name": "StandardE84AsV5", + "value": "Standard_E8_4as_v5" + }, + { + "name": "StandardE82AsV5", + "value": "Standard_E8_2as_v5" + }, + { + "name": "StandardE168AsV5", + "value": "Standard_E16_8as_v5" + }, + { + "name": "StandardE164AsV5", + "value": "Standard_E16_4as_v5" + }, + { + "name": "StandardE3216AsV5", + "value": "Standard_E32_16as_v5" + }, + { + "name": "StandardE328AsV5", + "value": "Standard_E32_8as_v5" + }, + { + "name": "StandardE6432AsV5", + "value": "Standard_E64_32as_v5" + }, + { + "name": "StandardE6416AsV5", + "value": "Standard_E64_16as_v5" + }, + { + "name": "StandardE9648AsV5", + "value": "Standard_E96_48as_v5" + }, + { + "name": "StandardE9624AsV5", + "value": "Standard_E96_24as_v5" + }, + { + "name": "StandardGS48", + "value": "Standard_GS4_8" + }, + { + "name": "StandardGS44", + "value": "Standard_GS4_4" + }, + { + "name": "StandardGS516", + "value": "Standard_GS5_16" + }, + { + "name": "StandardGS58", + "value": "Standard_GS5_8" + }, + { + "name": "StandardDS111V2", + "value": "Standard_DS11_1_v2" + }, + { + "name": "StandardDS122V2", + "value": "Standard_DS12_2_v2" + }, + { + "name": "StandardDS121V2", + "value": "Standard_DS12_1_v2" + }, + { + "name": "StandardDS134V2", + "value": "Standard_DS13_4_v2" + }, + { + "name": "StandardDS132V2", + "value": "Standard_DS13_2_v2" + }, + { + "name": "StandardDS148V2", + "value": "Standard_DS14_8_v2" + }, + { + "name": "StandardDS144V2", + "value": "Standard_DS14_4_v2" + }, + { + "name": "StandardM416208SV2", + "value": "Standard_M416_208s_v2" + }, + { + "name": "StandardM416208MsV2", + "value": "Standard_M416_208ms_v2" + }, + { + "name": "StandardE2BsV5", + "value": "Standard_E2bs_v5" + }, + { + "name": "StandardE4BsV5", + "value": "Standard_E4bs_v5" + }, + { + "name": "StandardE8BsV5", + "value": "Standard_E8bs_v5" + }, + { + "name": "StandardE16BsV5", + "value": "Standard_E16bs_v5" + }, + { + "name": "StandardE32BsV5", + "value": "Standard_E32bs_v5" + }, + { + "name": "StandardE48BsV5", + "value": "Standard_E48bs_v5" + }, + { + "name": "StandardE64BsV5", + "value": "Standard_E64bs_v5" + }, + { + "name": "StandardE2BdsV5", + "value": "Standard_E2bds_v5" + }, + { + "name": "StandardE4BdsV5", + "value": "Standard_E4bds_v5" + }, + { + "name": "StandardE8BdsV5", + "value": "Standard_E8bds_v5" + }, + { + "name": "StandardE16BdsV5", + "value": "Standard_E16bds_v5" + }, + { + "name": "StandardE32BdsV5", + "value": "Standard_E32bds_v5" + }, + { + "name": "StandardE48BdsV5", + "value": "Standard_E48bds_v5" + }, + { + "name": "StandardE64BdsV5", + "value": "Standard_E64bds_v5" + } + ] + } + }, + "AzureVmSuitabilityDetail": { + "type": "string", + "enum": [ + "None", + "RecommendedSizeHasLessNetworkAdapters", + "CannotReportComputeCost", + "CannotReportStorageCost", + "CannotReportBandwidthCosts", + "PercentageOfCoresUtilizedMissing", + "PercentageOfMemoryUtilizedMissing", + "PercentageOfCoresUtilizedOutOfRange", + "PercentageOfMemoryUtilizedOutOfRange" + ], + "x-ms-enum": { + "name": "AzureVmSuitabilityDetail", + "modelAsString": true + } + }, + "AzureVmSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "GuestOperatingSystemArchitectureNotSupported", + "GuestOperatingSystemNotSupported", + "BootTypeNotSupported", + "MoreDisksThanSupported", + "NoSuitableVmSizeFound", + "OneOrMoreDisksNotSuitable", + "OneOrMoreAdaptersNotSuitable", + "InternalErrorOccurredDuringComputeEvaluation", + "InternalErrorOccurredDuringStorageEvaluation", + "InternalErrorOccurredDuringNetworkEvaluation", + "NoVmSizeSupportsStoragePerformance", + "NoVmSizeSupportsNetworkPerformance", + "NoVmSizeForSelectedPricingTier", + "NoVmSizeForSelectedAzureLocation", + "CheckRedHatLinuxVersion", + "CheckOpenSuseLinuxVersion", + "CheckWindowsServer2008R2Version", + "CheckCentOsVersion", + "CheckDebianLinuxVersion", + "CheckSuseLinuxVersion", + "CheckOracleLinuxVersion", + "CheckUbuntuLinuxVersion", + "CheckCoreOsLinuxVersion", + "WindowsServerVersionConditionallySupported", + "NoGuestOperatingSystemConditionallySupported", + "WindowsClientVersionsConditionallySupported", + "BootTypeUnknown", + "GuestOperatingSystemUnknown", + "WindowsServerVersionsSupportedWithCaveat", + "WindowsOSNoLongerUnderMSSupport", + "EndorsedWithConditionsLinuxDistributions", + "UnendorsedLinuxDistributions", + "NoVmSizeForStandardPricingTier", + "NoVmSizeForBasicPricingTier", + "NoVmSizeInSelectedFamilyFound", + "NoEaPriceFoundForVmSize", + "NoVmSizeFoundForOfferCurrencyReservedInstance" + ], + "x-ms-enum": { + "name": "AzureVmSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureWebAppSuitabilityIssueCategory": { + "type": "string", + "enum": [ + "Unknown", + "Issue", + "Info" + ], + "x-ms-enum": { + "name": "AzureWebAppSuitabilityIssueCategory", + "modelAsString": true + } + }, + "AzureWebAppTargetType": { + "type": "string", + "enum": [ + "Unknown", + "AzureAppService", + "AzureAppServiceContainer" + ], + "x-ms-enum": { + "name": "AzureWebAppTargetType", + "modelAsString": true + } + }, + "AzureWebAppTier": { + "type": "string", + "enum": [ + "Unknown", + "Free", + "Premium_V2", + "Premium_V3", + "Isolated" + ], + "x-ms-enum": { + "name": "AzureWebAppTier", + "modelAsString": true + } + }, + "BusinessCase": { + "type": "object", + "description": "Business case resource.", + "properties": { + "properties": { + "$ref": "#/definitions/BusinessCaseProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "BusinessCaseCurrency": { + "type": "string", + "description": "Business case supported currency types.", + "enum": [ + "Unknown", + "USD", + "DKK", + "CAD", + "IDR", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SAR", + "ZAR", + "SEK", + "TRY", + "GBP", + "MXN", + "MYR", + "INR", + "HKD", + "BRL", + "TWD", + "EUR", + "CHF", + "ARS", + "AUD", + "CNY" + ], + "x-ms-enum": { + "name": "BusinessCaseCurrency", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Currency Unknown." + }, + { + "name": "USD", + "value": "USD", + "description": "Currency USD." + }, + { + "name": "DKK", + "value": "DKK", + "description": "Currency DKK." + }, + { + "name": "CAD", + "value": "CAD", + "description": "Currency CAD." + }, + { + "name": "IDR", + "value": "IDR", + "description": "Currency IDR." + }, + { + "name": "JPY", + "value": "JPY", + "description": "Currency JPY." + }, + { + "name": "KRW", + "value": "KRW", + "description": "Currency KRW." + }, + { + "name": "NZD", + "value": "NZD", + "description": "Currency NZD." + }, + { + "name": "NOK", + "value": "NOK", + "description": "Currency NOK." + }, + { + "name": "RUB", + "value": "RUB", + "description": "Currency RUB." + }, + { + "name": "SAR", + "value": "SAR", + "description": "Currency SAR." + }, + { + "name": "ZAR", + "value": "ZAR", + "description": "Currency ZAR." + }, + { + "name": "SEK", + "value": "SEK", + "description": "Currency SEK." + }, + { + "name": "TRY", + "value": "TRY", + "description": "Currency TRY." + }, + { + "name": "GBP", + "value": "GBP", + "description": "Currency GBP." + }, + { + "name": "MXN", + "value": "MXN", + "description": "Currency MXN." + }, + { + "name": "MYR", + "value": "MYR", + "description": "Currency MYR." + }, + { + "name": "INR", + "value": "INR", + "description": "Currency INR." + }, + { + "name": "HKD", + "value": "HKD", + "description": "Currency HKD." + }, + { + "name": "BRL", + "value": "BRL", + "description": "Currency BRL." + }, + { + "name": "TWD", + "value": "TWD", + "description": "Currency TWD." + }, + { + "name": "EUR", + "value": "EUR", + "description": "Currency EUR." + }, + { + "name": "CHF", + "value": "CHF", + "description": "Currency CHF." + }, + { + "name": "ARS", + "value": "ARS", + "description": "Currency ARS." + }, + { + "name": "AUD", + "value": "AUD", + "description": "Currency AUD." + }, + { + "name": "CNY", + "value": "CNY", + "description": "Currency CNY." + } + ] + } + }, + "BusinessCaseListResult": { + "type": "object", + "description": "The response of a BusinessCase list operation.", + "properties": { + "value": { + "type": "array", + "description": "The BusinessCase items on this page", + "items": { + "$ref": "#/definitions/BusinessCase" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "BusinessCaseProperties": { + "type": "object", + "description": "Property bag for an\nMicrosoft.Azure.Migrate.BusinessCaseService.Api.V20220202_preview.Resources.BusinessCase\nresource.", + "properties": { + "settings": { + "$ref": "#/definitions/Settings", + "description": "Business case settings." + }, + "state": { + "$ref": "#/definitions/BusinessCaseState", + "description": "Business case state.", + "readOnly": true + }, + "reportStatusDetails": { + "type": "array", + "description": "Gets the state of business case reports.", + "items": { + "$ref": "#/definitions/ReportDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties2" + } + ] + }, + "BusinessCaseState": { + "type": "string", + "description": "Business case supported state types.", + "enum": [ + "Unknown", + "InProgress", + "Completed", + "OutDated", + "Invalid", + "OutOfSync", + "Failed" + ], + "x-ms-enum": { + "name": "BusinessCaseState", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown State." + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "InProgress State." + }, + { + "name": "Completed", + "value": "Completed", + "description": "Completed State." + }, + { + "name": "OutDated", + "value": "OutDated", + "description": "OutDated State." + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Invalid State." + }, + { + "name": "OutOfSync", + "value": "OutOfSync", + "description": "OutOfSync State." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed State." + } + ] + } + }, + "Check": { + "type": "object", + "description": "Data model of Check or Rule for Suitability Analysis.", + "properties": { + "name": { + "type": "string", + "description": "Gets name.", + "readOnly": true + }, + "behavior": { + "$ref": "#/definitions/CheckResult", + "description": "Gets behavior or check result.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Gets description.", + "readOnly": true + }, + "cause": { + "type": "string", + "description": "Gets cause.", + "readOnly": true + }, + "recommendation": { + "type": "string", + "description": "Gets recommendation.", + "readOnly": true + }, + "moreInfo": { + "$ref": "#/definitions/MoreInfo", + "description": "Gets more information about check or rule.", + "readOnly": true + } + }, + "required": [ + "name", + "behavior", + "description", + "cause", + "recommendation", + "moreInfo" + ] + }, + "CheckResult": { + "type": "string", + "description": "Suitability Check or Rule Result.", + "enum": [ + "Unknown", + "Issue", + "Warn", + "Pass" + ], + "x-ms-enum": { + "name": "CheckResult", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Indicates missing value." + }, + { + "name": "Issue", + "value": "Issue", + "description": "Indicates Migration Issue." + }, + { + "name": "Warn", + "value": "Warn", + "description": "Indicates Migration Warning." + }, + { + "name": "Pass", + "value": "Pass", + "description": "Indicates check is passed." + } + ] + } + }, + "CloudSuitability": { + "type": "string", + "description": "Cloud Suitability for Azure.", + "enum": [ + "Unknown", + "NotSuitable", + "Suitable", + "ConditionallySuitable", + "ReadinessUnknown" + ], + "x-ms-enum": { + "name": "CloudSuitability", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates missing data." + }, + { + "name": "NotSuitable", + "value": "NotSuitable", + "description": "Not Suitable for Azure." + }, + { + "name": "Suitable", + "value": "Suitable", + "description": "Suitable for Azure." + }, + { + "name": "ConditionallySuitable", + "value": "ConditionallySuitable", + "description": "Conditionally Suitable for Azure." + }, + { + "name": "ReadinessUnknown", + "value": "ReadinessUnknown", + "description": "Unknown Readiness for Azure." + } + ] + } + }, + "Cluster": { + "type": "object", + "description": "Data model of Cluster.", + "properties": { + "name": { + "type": "string", + "description": "Gets name.", + "readOnly": true + }, + "nodePools": { + "type": "array", + "description": "Gets list of node pools.", + "items": { + "$ref": "#/definitions/NodePool" + }, + "readOnly": true + }, + "region": { + "type": "string", + "description": "Gets region.", + "readOnly": true + }, + "userNodePoolCount": { + "type": "integer", + "format": "int32", + "description": "Gets user node pool count.", + "readOnly": true + }, + "userNodeCount": { + "type": "integer", + "format": "int32", + "description": "Gets user node count.", + "readOnly": true + }, + "systemNodePoolCount": { + "type": "integer", + "format": "int32", + "description": "Gets system node pool count.", + "readOnly": true + }, + "systemNodeCount": { + "type": "integer", + "format": "int32", + "description": "Gets system node count.", + "readOnly": true + }, + "podCount": { + "type": "integer", + "format": "int32", + "description": "Gets pod count.", + "readOnly": true + }, + "monthlyCost": { + "type": "number", + "format": "float", + "description": "Gets monthly cost.", + "readOnly": true + } + }, + "required": [ + "name", + "nodePools", + "region", + "userNodePoolCount", + "userNodeCount", + "systemNodePoolCount", + "systemNodeCount", + "podCount", + "monthlyCost" + ] + }, + "CollectorAgentPropertiesBase": { + "type": "object", + "description": "Collector agent property class.", + "properties": { + "id": { + "type": "string", + "description": "Gets the collector agent id." + }, + "version": { + "type": "string", + "description": "Gets the collector agent version." + }, + "lastHeartbeatUtc": { + "type": "string", + "format": "date-time", + "description": "Gets the collector last heartbeat time." + }, + "spnDetails": { + "$ref": "#/definitions/CollectorAgentSpnPropertiesBase", + "description": "Gets or sets the SPN details." + } + } + }, + "CollectorAgentSpnPropertiesBase": { + "type": "object", + "description": "Collector agent SPN details class.", + "properties": { + "authority": { + "type": "string", + "description": "Gets the AAD authority endpoint." + }, + "applicationId": { + "type": "string", + "description": "Gets the AAD application id." + }, + "audience": { + "type": "string", + "description": "Gets the AAD audience url." + }, + "objectId": { + "type": "string", + "description": "Gets the object id of the AAD application." + }, + "tenantId": { + "type": "string", + "description": "Gets the tenant id of the AAD application." + } + } + }, + "CollectorPropertiesBase": { + "type": "object", + "description": "Collector properties class.", + "properties": { + "discoverySiteId": { + "type": "string", + "description": "Gets the discovery site id." + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets the Timestamp when collector was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Timestamp when collector was last updated.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "CollectorPropertiesBaseWithAgent": { + "type": "object", + "description": "Collector properties class.", + "properties": { + "agentProperties": { + "$ref": "#/definitions/CollectorAgentPropertiesBase", + "description": "Gets or sets the collector agent properties." + }, + "discoverySiteId": { + "type": "string", + "description": "Gets the discovery site id." + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets the Timestamp when collector was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Timestamp when collector was last updated.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "CompareSummary": { + "type": "object", + "description": "Compare summary class.", + "properties": { + "azurePaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The azure PaaS cost.", + "readOnly": true + }, + "azureIaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The azure IaaS cost.", + "readOnly": true + }, + "azureAvsCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The AVS cost.", + "readOnly": true + }, + "onPremisesPaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "onPremisesIaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises IaaS cost.", + "readOnly": true + }, + "onPremisesAvsCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises AVS cost.", + "readOnly": true + }, + "onPremisesPaasDecommissionedCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS decommissioned cost.", + "readOnly": true + }, + "onPremisesIaasDecommissionedCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises IaaS decommissioned cost.", + "readOnly": true + }, + "onPremisesAvsDecommissionedCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises AVS decommissioned cost.", + "readOnly": true + } + } + }, + "CompatibilityLevel": { + "type": "string", + "enum": [ + "Unknown", + "CompatLevel80", + "CompatLevel90", + "CompatLevel100", + "CompatLevel110", + "CompatLevel120", + "CompatLevel130", + "CompatLevel140", + "CompatLevel150" + ], + "x-ms-enum": { + "name": "CompatibilityLevel", + "modelAsString": true + } + }, + "ComputeResource": { + "type": "object", + "description": "Data model of Cores and Memory Compute Resource.", + "properties": { + "cores": { + "type": "number", + "format": "float", + "description": "Gets cores.", + "readOnly": true + }, + "memory": { + "type": "number", + "format": "float", + "description": "Gets memory.", + "readOnly": true + } + }, + "required": [ + "cores", + "memory" + ] + }, + "ComputeSettings": { + "type": "object", + "description": "Compute settings.", + "properties": { + "hyperthreadCoreToMemoryRatio": { + "type": "number", + "format": "float", + "description": "Hyperthread core to memory ratio." + }, + "price": { + "type": "number", + "format": "float", + "description": "Compute Price." + }, + "sqlServerLicensing": { + "type": "array", + "description": "SQL Server licensing settings.", + "items": { + "$ref": "#/definitions/SqlServerLicensingSettings" + }, + "x-ms-identifiers": [] + }, + "windowsServerLicensing": { + "$ref": "#/definitions/WindowsServerLicensingSettings", + "description": "Windows Server licensing settings." + }, + "rhelLinuxServerLicensing": { + "$ref": "#/definitions/LinuxServerLicensingSettings", + "description": "Linux Rhel Server licensing settings." + }, + "suseLinuxServerLicensing": { + "$ref": "#/definitions/LinuxServerLicensingSettings", + "description": "Linux Suse Server licensing settings." + }, + "virtualizationSoftwareSettings": { + "$ref": "#/definitions/VirtualizationSoftwareSettings", + "description": "Virtualization software settings." + } + }, + "required": [ + "hyperthreadCoreToMemoryRatio", + "price", + "sqlServerLicensing", + "windowsServerLicensing", + "rhelLinuxServerLicensing", + "suseLinuxServerLicensing", + "virtualizationSoftwareSettings" + ] + }, + "ComputeTier": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "Provisioned", + "Serverless" + ], + "x-ms-enum": { + "name": "ComputeTier", + "modelAsString": true + } + }, + "ConsolidationType": { + "type": "string", + "description": "Consolidation Type.", + "enum": [ + "Full", + "AsOnSource" + ], + "x-ms-enum": { + "name": "ConsolidationType", + "modelAsString": true, + "values": [ + { + "name": "Full", + "value": "Full", + "description": "Full Consolidation." + }, + { + "name": "AsOnSource", + "value": "AsOnSource", + "description": "As On Source or On Premises Consolidation." + } + ] + } + }, + "CostByStorageType": { + "type": "object", + "description": "The cost by storage type.", + "properties": { + "storageType": { + "type": "string", + "description": "The storage type.", + "readOnly": true + }, + "cost": { + "type": "number", + "format": "float", + "description": "Cost per storage type.", + "readOnly": true + } + } + }, + "CostComponent": { + "type": "object", + "description": "Class to represent the component of the cost.", + "properties": { + "name": { + "$ref": "#/definitions/CostComponentName", + "description": "Gets the name of the component.", + "readOnly": true + }, + "value": { + "type": "number", + "format": "float", + "description": "The value of the component." + }, + "description": { + "type": "string", + "description": "The textual description of the component." + } + } + }, + "CostComponentName": { + "type": "string", + "description": "Enum to represent component name.", + "enum": [ + "Unknown", + "MonthlyAzureHybridCostSavings", + "MonthlySecurityCost", + "MonthlyPremiumV2StorageCost", + "MonthlyLinuxAzureHybridCostSavings", + "MonthlyAvsNodeCost", + "MonthlyAvsExternalStorageCost", + "MonthlyAvsNetworkCost", + "MonthlyVcfByolCostDifference" + ], + "x-ms-enum": { + "name": "CostComponentName", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Default Cost Component name represented by Unknown." + }, + { + "name": "MonthlyAzureHybridCostSavings", + "value": "MonthlyAzureHybridCostSavings", + "description": "Cost Savings due to Windows Azure Hybrid on monthly basis." + }, + { + "name": "MonthlySecurityCost", + "value": "MonthlySecurityCost", + "description": "Monthly security cost." + }, + { + "name": "MonthlyPremiumV2StorageCost", + "value": "MonthlyPremiumV2StorageCost", + "description": "Monthly PremiumV2 Storage Cost." + }, + { + "name": "MonthlyLinuxAzureHybridCostSavings", + "value": "MonthlyLinuxAzureHybridCostSavings", + "description": "Cost Savings due to Linux Azure Hybrid on monthly basis." + }, + { + "name": "MonthlyAvsNodeCost", + "value": "MonthlyAvsNodeCost", + "description": "Monthly AVS Node cost" + }, + { + "name": "MonthlyAvsExternalStorageCost", + "value": "MonthlyAvsExternalStorageCost", + "description": "Monthly AVS External Storage cost" + }, + { + "name": "MonthlyAvsNetworkCost", + "value": "MonthlyAvsNetworkCost", + "description": "Monthly AVS Network cost" + }, + { + "name": "MonthlyVcfByolCostDifference", + "value": "MonthlyVcfByolCostDifference", + "description": "Monthly compute cost difference between VCF BYOL and non VCF BYOL SKUs" + } + ] + } + }, + "CostDetails": { + "type": "object", + "description": "The on premises PaaS cost.", + "properties": { + "storageCost": { + "type": "number", + "format": "float", + "description": "The storage cost.", + "readOnly": true + }, + "computeCost": { + "type": "number", + "format": "float", + "description": "The compute cost.", + "readOnly": true + }, + "itLaborCost": { + "type": "number", + "format": "float", + "description": "The IT labor cost.", + "readOnly": true + }, + "networkCost": { + "type": "number", + "format": "float", + "description": "The network cost.", + "readOnly": true + }, + "ahubSavings": { + "type": "number", + "format": "float", + "description": "The windows AhubSavings.", + "readOnly": true + }, + "linuxAhubSavings": { + "type": "number", + "format": "float", + "description": "The linux AhubSavings.", + "readOnly": true + }, + "securityCost": { + "type": "number", + "format": "float", + "description": "Security Cost.", + "readOnly": true + }, + "managementCostDetails": { + "$ref": "#/definitions/ManagementCostDetails", + "description": "Management Cost Details.", + "readOnly": true + }, + "esuSavings": { + "type": "number", + "format": "float", + "description": "esu savings.", + "readOnly": true + } + } + }, + "DiscoveredEntitiesSummary": { + "type": "object", + "description": "Discovered entities summary.", + "properties": { + "numberOfServers": { + "type": "integer", + "format": "int32", + "description": "Number of web servers", + "readOnly": true + }, + "numberOfWebApps": { + "type": "integer", + "format": "int32", + "description": "Number of web apps", + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Number of machines", + "readOnly": true + }, + "webServerSummary": { + "type": "object", + "description": "Web server summary data", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "webAppSummary": { + "type": "object", + "description": "Web app summary data", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + } + } + }, + "DiscoveredEntityLightSummary": { + "type": "object", + "description": "Discovered entity light summary.", + "properties": { + "numberOfServers": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of servers." + }, + "numberOfWebApps": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of web apps." + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of machines." + } + }, + "required": [ + "numberOfServers", + "numberOfWebApps", + "numberOfMachines" + ] + }, + "DiscoverySource": { + "type": "string", + "description": "Business case supported Discovery source types.", + "enum": [ + "Unknown", + "Appliance", + "Import" + ], + "x-ms-enum": { + "name": "DiscoverySource", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Discovery Source." + }, + { + "name": "Appliance", + "value": "Appliance", + "description": "Appliance Discovery Source." + }, + { + "name": "Import", + "value": "Import", + "description": "Import Discovery Source." + } + ] + } + }, + "Disk": { + "type": "object", + "description": "A disk discovered on a machine.", + "properties": { + "gigabytesAllocated": { + "type": "number", + "format": "float", + "description": "Gigabytes of storage provisioned for this disk.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "User friendly name of the disk.", + "readOnly": true + } + } + }, + "DistributionByOperatingSystem": { + "type": "object", + "description": "The distribution by operating system.", + "properties": { + "osClassificationType": { + "type": "string", + "description": "The Os classification type.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of machines with the OS type classification.", + "readOnly": true + } + } + }, + "DistributionByType": { + "type": "object", + "description": "Distribution by Type.", + "properties": { + "type": { + "type": "string", + "description": "Distribution Type.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Distribution Count.", + "readOnly": true + } + } + }, + "DistributionByVirtualization": { + "type": "object", + "description": "The distribution by virtualization.", + "properties": { + "virtualizationType": { + "type": "string", + "description": "The Virtualization type.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of machines with the Virtualization type classification.", + "readOnly": true + } + } + }, + "DownloadUrl": { + "type": "object", + "description": "Data model of Download URL for assessment report.", + "properties": { + "assessmentReportUrl": { + "type": "string", + "description": "Hyperlink to download report.", + "readOnly": true + }, + "expirationTime": { + "type": "string", + "format": "date-time", + "description": "Expiry date of download url.", + "readOnly": true + } + }, + "required": [ + "assessmentReportUrl", + "expirationTime" + ] + }, + "EntityUptime": { + "type": "object", + "description": "Entity Uptime.", + "properties": { + "daysPerMonth": { + "type": "integer", + "format": "int32", + "description": "Gets the days per month." + }, + "hoursPerDay": { + "type": "integer", + "format": "int32", + "description": "Gets the hours per day." + } + } + }, + "EnvironmentType": { + "type": "string", + "enum": [ + "Production", + "Test" + ], + "x-ms-enum": { + "name": "EnvironmentType", + "modelAsString": true + } + }, + "Error": { + "type": "object", + "description": "Error web model class.", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "Gets the error ID.", + "readOnly": true + }, + "code": { + "type": "string", + "description": "Gets the error code.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets the Run as account ID.", + "readOnly": true + }, + "applianceName": { + "type": "string", + "description": "Gets the Appliance name.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Gets the error message.", + "readOnly": true + }, + "summaryMessage": { + "type": "string", + "description": "Gets the error summary message.", + "readOnly": true + }, + "agentScenario": { + "type": "string", + "description": "Gets the agent scenario where this error occurred.", + "readOnly": true + }, + "possibleCauses": { + "type": "string", + "description": "Gets the error possible causes.", + "readOnly": true + }, + "recommendedAction": { + "type": "string", + "description": "Gets the recommended action for the error.", + "readOnly": true + }, + "severity": { + "type": "string", + "description": "Gets the error severity.", + "readOnly": true + }, + "messageParameters": { + "type": "object", + "description": "Gets the error message parameters.", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "updatedTimeStamp": { + "type": "string", + "format": "date-time", + "description": "Gets the time stamp when the error was updated.", + "readOnly": true + }, + "impactedAssessmentType": { + "type": "string", + "description": "Gets the type of assessment impacted by this error.", + "readOnly": true + } + } + }, + "ErrorSummary": { + "type": "object", + "description": "Error summary containing affected entities for each type of assessment.", + "properties": { + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Gets the assessment type.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Gets the affected entity count.", + "readOnly": true + } + } + }, + "ErrorDetail": { + "type": "object", + "description": "Error Details", + "properties": { + "code": { + "type": "string", + "description": "Error Code", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Description of the error occurred", + "readOnly": true + } + }, + "required": [ + "code", + "message" + ] + }, + "EstimatedCostByOffer": { + "type": "object", + "description": "The estimated cost by offer.", + "properties": { + "offerName": { + "type": "string", + "description": "The offer name.", + "readOnly": true + }, + "cost": { + "type": "number", + "format": "float", + "description": "Cost for the offer.", + "readOnly": true + } + } + }, + "EstimatedCostByTarget": { + "type": "object", + "description": "Shows the estimated cost by target.", + "properties": { + "azureSqlMiCost": { + "type": "number", + "format": "float", + "description": "Azure SQL MI cost.", + "readOnly": true + }, + "azureSqlDbCost": { + "type": "number", + "format": "float", + "description": "Azure SQL DB cost.", + "readOnly": true + }, + "appServiceCost": { + "type": "number", + "format": "float", + "description": "Azure App Service cost.", + "readOnly": true + }, + "appServiceContainerCost": { + "type": "number", + "format": "float", + "description": "Azure App Service Containers cost.", + "readOnly": true + }, + "azureKubernetesServiceCost": { + "type": "number", + "format": "float", + "description": "Azure Kubernetes Service cost.", + "readOnly": true + } + } + }, + "EstimatedExternalStorage": { + "type": "object", + "description": "Estimated external storage", + "properties": { + "storageType": { + "$ref": "#/definitions/ExternalStorageType", + "description": "External storage type", + "readOnly": true + }, + "totalStorageInGB": { + "type": "number", + "format": "float", + "description": "Total storage allocation in GB", + "readOnly": true + }, + "storageUtilization": { + "type": "number", + "format": "float", + "description": "Percent storage utilization", + "readOnly": true + }, + "totalStorageCost": { + "type": "number", + "format": "float", + "description": "Total storage cost", + "readOnly": true + } + } + }, + "EstimatedNetwork": { + "type": "object", + "description": "Estimated network", + "properties": { + "skuType": { + "$ref": "#/definitions/NetworkSkuType", + "description": "Network SKU type.", + "readOnly": true + }, + "cost": { + "type": "number", + "format": "float", + "description": "Network Sku type cost.", + "readOnly": true + } + } + }, + "EvaluatedAvsMachine": { + "type": "object", + "description": "Evaluated AVS machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/EvaluatedAvsMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "EvaluatedAvsMachineListResult": { + "type": "object", + "description": "The response of a EvaluatedAvsMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EvaluatedAvsMachine items on this page", + "items": { + "$ref": "#/definitions/EvaluatedAvsMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EvaluatedAvsMachineProperties": { + "type": "object", + "description": "Evaluated AVS machine properties class.", + "properties": { + "machineId": { + "type": "string", + "description": "Machine Id.", + "readOnly": true + }, + "serverName": { + "type": "string", + "description": "Server Name.", + "readOnly": true + }, + "virtualizationType": { + "type": "string", + "description": "Virtualization type.", + "readOnly": true + }, + "activityState": { + "type": "string", + "description": "Activity state.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating System (OS) name.", + "readOnly": true + }, + "recommendedAzureTarget": { + "type": "string", + "description": "Recommended Azure target.", + "readOnly": true + }, + "qualifyingOffer": { + "type": "string", + "description": "Qualifying offer.", + "readOnly": true + }, + "readyForMigration": { + "type": "string", + "description": "Is machine ready for migration.", + "readOnly": true + }, + "supportStatus": { + "$ref": "#/definitions/SupportabilityStatus", + "description": "End of Support status.", + "readOnly": true + } + } + }, + "EvaluatedMachine": { + "type": "object", + "description": "Evaluated machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/EvaluatedMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "EvaluatedMachineListResult": { + "type": "object", + "description": "The response of a EvaluatedMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EvaluatedMachine items on this page", + "items": { + "$ref": "#/definitions/EvaluatedMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EvaluatedMachineProperties": { + "type": "object", + "description": "Evaluated machine properties class.", + "properties": { + "machineId": { + "type": "string", + "description": "Machine Id.", + "readOnly": true + }, + "serverName": { + "type": "string", + "description": "Server Name.", + "readOnly": true + }, + "virtualizationType": { + "type": "string", + "description": "Virtualization type.", + "readOnly": true + }, + "activityState": { + "type": "string", + "description": "Activity state.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating System (OS) name.", + "readOnly": true + }, + "recommendedAzureTarget": { + "type": "string", + "description": "Recommended Azure target.", + "readOnly": true + }, + "qualifyingOffer": { + "type": "string", + "description": "Qualifying offer.", + "readOnly": true + }, + "readyForMigration": { + "type": "string", + "description": "Is machine ready for migration.", + "readOnly": true + }, + "supportStatus": { + "$ref": "#/definitions/SupportabilityStatus", + "description": "End of Support status.", + "readOnly": true + } + } + }, + "EvaluatedSqlEntity": { + "type": "object", + "description": "Evaluated sql entity resource.", + "properties": { + "properties": { + "$ref": "#/definitions/EvaluatedSqlEntityProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "EvaluatedSqlEntityListResult": { + "type": "object", + "description": "The response of a EvaluatedSqlEntity list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EvaluatedSqlEntity items on this page", + "items": { + "$ref": "#/definitions/EvaluatedSqlEntity" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EvaluatedSqlEntityProperties": { + "type": "object", + "description": "Evaluated sql entity properties class.", + "properties": { + "serverName": { + "type": "string", + "description": "Server name.", + "readOnly": true + }, + "activityState": { + "type": "string", + "description": "Activity state.", + "readOnly": true + }, + "sqlVersion": { + "type": "string", + "description": "SQL Server version.", + "readOnly": true + }, + "sqlEdition": { + "type": "string", + "description": "SQL Server edition.", + "readOnly": true + }, + "recommendedAzureTarget": { + "type": "string", + "description": "Recommended Azure target.", + "readOnly": true + }, + "qualifyingOffer": { + "type": "string", + "description": "Qualifying offer.", + "readOnly": true + }, + "readyForMigration": { + "type": "string", + "description": "Is SQL Instance ready for migration.", + "readOnly": true + }, + "virtualizationType": { + "type": "string", + "description": "The virtualization type.", + "readOnly": true + }, + "dbCount": { + "type": "integer", + "format": "int32", + "description": "DB count in instance.", + "readOnly": true + }, + "supportStatus": { + "$ref": "#/definitions/SupportabilityStatus", + "description": "End of Support status.", + "readOnly": true + } + } + }, + "EvaluatedWebApp": { + "type": "object", + "description": "Evaluated web app resource.", + "properties": { + "properties": { + "$ref": "#/definitions/EvaluatedWebAppProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "EvaluatedWebAppListResult": { + "type": "object", + "description": "The response of a EvaluatedWebApp list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EvaluatedWebApp items on this page", + "items": { + "$ref": "#/definitions/EvaluatedWebApp" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EvaluatedWebAppProperties": { + "type": "object", + "description": "Evaluated web app properties class.", + "properties": { + "recommendedAzureTarget": { + "type": "string", + "description": "Recommended Azure target." + }, + "recommendedAzureSkuName": { + "type": "string", + "description": "Recommended Azure SKU name." + }, + "recommendedAzureSkuSize": { + "type": "string", + "description": "Recommended Azure SKU size." + }, + "serverName": { + "type": "string", + "description": "The server name." + }, + "workload": { + "type": "string", + "description": "The workload." + }, + "activityState": { + "type": "string", + "description": "The activity state." + }, + "readyForMigration": { + "type": "string", + "description": "Is machine ready for migration." + } + } + }, + "ExternalStorageType": { + "type": "string", + "description": "Different External storage skus.", + "enum": [ + "Unknown", + "None", + "AnfStandard", + "AnfPremium", + "AnfUltra" + ], + "x-ms-enum": { + "name": "ExternalStorageType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Indicates un-supported external storage." + }, + { + "name": "None", + "value": "None", + "description": "Indicates No external storage." + }, + { + "name": "AnfStandard", + "value": "AnfStandard", + "description": "ANF external storage with Standard SKU." + }, + { + "name": "AnfPremium", + "value": "AnfPremium", + "description": "ANF external storage with Premium SKU." + }, + { + "name": "AnfUltra", + "value": "AnfUltra", + "description": "ANF external storage with Ultra SKU." + } + ] + } + }, + "AvsAssessmentScenario": { + "type": "string", + "description": "Scenarios with which Avs Assessments can be created.", + "enum": [ + "Unknown", + "NewAvsSddc", + "AvsSddcExpansion" + ], + "x-ms-enum": { + "name": "AvsAssessmentScenario", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown assessment scenario" + }, + { + "name": "NewAvsSddc", + "value": "NewAvsSddc", + "description": "Create Assessment for new Avs Sddc" + }, + { + "name": "AvsSddcExpansion", + "value": "AvsSddcExpansion", + "description": "Create Assessment for existing Avs Sddc" + } + ] + } + }, + "FacilitySettings": { + "type": "object", + "description": "Facility settings.", + "properties": { + "facilitiesCost": { + "type": "number", + "format": "float", + "description": "The facilities cost." + } + }, + "required": [ + "facilitiesCost" + ] + }, + "FttAndRaidLevel": { + "type": "string", + "description": "FTT and RAID Level.", + "enum": [ + "Unknown", + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt2Raid1", + "Ftt2Raid6", + "Ftt3Raid1" + ], + "x-ms-enum": { + "name": "FttAndRaidLevel", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown FTT and RAID Level." + }, + { + "name": "Ftt1Raid1", + "value": "Ftt1Raid1", + "description": "FTT 1 and RAID Level 1." + }, + { + "name": "Ftt1Raid5", + "value": "Ftt1Raid5", + "description": "FTT 1 and RAID Level 5." + }, + { + "name": "Ftt2Raid1", + "value": "Ftt2Raid1", + "description": "FTT 2 and RAID Level 1." + }, + { + "name": "Ftt2Raid6", + "value": "Ftt2Raid6", + "description": "FTT 2 and RAID Level 6." + }, + { + "name": "Ftt3Raid1", + "value": "Ftt3Raid1", + "description": "FTT 3 and RAID Level 1." + } + ] + } + }, + "Group": { + "type": "object", + "description": "Group resource.", + "properties": { + "properties": { + "$ref": "#/definitions/GroupProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "GroupBodyProperties": { + "type": "object", + "description": "Body properties of group update.", + "properties": { + "operationType": { + "$ref": "#/definitions/GroupUpdateOperation", + "description": "Whether to add or remove the machines." + }, + "machines": { + "type": "array", + "description": "List of machine names that are part of this group.", + "items": { + "type": "string" + } + } + } + }, + "GroupListResult": { + "type": "object", + "description": "The response of a Group list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Group items on this page", + "items": { + "$ref": "#/definitions/Group" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "GroupProperties": { + "type": "object", + "description": "Properties of group resource.", + "properties": { + "groupStatus": { + "$ref": "#/definitions/GroupStatus", + "description": "Whether the group has been created and is valid.", + "readOnly": true + }, + "machineCount": { + "type": "integer", + "format": "int32", + "description": "Number of machines part of this group.", + "readOnly": true + }, + "assessments": { + "type": "array", + "description": "List of References to Assessments created on this group.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "supportedAssessmentTypes": { + "type": "array", + "description": "List of assessment types supported on this group.", + "items": { + "$ref": "#/definitions/AssessmentType" + } + }, + "areAssessmentsRunning": { + "type": "boolean", + "description": "If the assessments are in running state.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when this group was created. Date-Time represented in ISO-8601 format.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when this group was last updated. Date-Time represented in ISO-8601 format.", + "readOnly": true + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "The type of group.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "GroupStatus": { + "type": "string", + "enum": [ + "Created", + "Updated", + "Running", + "Completed", + "Invalid" + ], + "x-ms-enum": { + "name": "GroupStatus", + "modelAsString": true + } + }, + "GroupType": { + "type": "string", + "enum": [ + "Default", + "Import" + ], + "x-ms-enum": { + "name": "GroupType", + "modelAsString": true + } + }, + "GroupUpdateOperation": { + "type": "string", + "enum": [ + "Add", + "Remove" + ], + "x-ms-enum": { + "name": "GroupUpdateOperation", + "modelAsString": true + } + }, + "GuestOperatingSystemArchitecture": { + "type": "string", + "enum": [ + "Unknown", + "X86", + "X64" + ], + "x-ms-enum": { + "name": "GuestOperatingSystemArchitecture", + "modelAsString": true + } + }, + "HardwareGeneration": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "Gen5", + "Fsv2_series", + "M_series", + "DC_series" + ], + "x-ms-enum": { + "name": "HardwareGeneration", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "Automatic", + "value": "Automatic" + }, + { + "name": "Gen5", + "value": "Gen5" + }, + { + "name": "Fsv2Series", + "value": "Fsv2_series" + }, + { + "name": "MSeries", + "value": "M_series" + }, + { + "name": "DCSeries", + "value": "DC_series" + } + ] + } + }, + "HyperVLicenseType": { + "type": "string", + "description": "Business case supported HyperV License types.", + "enum": [ + "Unknown", + "Datacentre", + "Standard" + ], + "x-ms-enum": { + "name": "HyperVLicenseType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown HyperV License." + }, + { + "name": "Datacentre", + "value": "Datacentre", + "description": "Datacentre HyperV License." + }, + { + "name": "Standard", + "value": "Standard", + "description": "Standard HyperV License." + } + ] + } + }, + "HypervCollector": { + "type": "object", + "description": "Hyper-V collector resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBaseWithAgent", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "HypervCollectorListResult": { + "type": "object", + "description": "The response of a HypervCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The HypervCollector items on this page", + "items": { + "$ref": "#/definitions/HypervCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "HypervLicense": { + "type": "object", + "description": "Representation of a licence.", + "properties": { + "licenseCost": { + "type": "number", + "format": "float", + "description": "Cost of a licence." + }, + "licenseType": { + "$ref": "#/definitions/HyperVLicenseType", + "description": "HyperV licence type." + } + }, + "required": [ + "licenseCost", + "licenseType" + ] + }, + "HypervVirtualizationManagementSettings": { + "type": "object", + "description": "HyperV Virtualization Management Settings.", + "properties": { + "numberOfPhysicalCoresPerLicense": { + "type": "integer", + "format": "int32", + "description": "Number of physical cores per licence.", + "minimum": 1 + }, + "softwareAssuranceCost": { + "type": "number", + "format": "float", + "description": "Software Assurance Cost." + }, + "licenseAndSupportList": { + "type": "array", + "description": "Licence and support list.", + "items": { + "$ref": "#/definitions/HypervLicense" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "numberOfPhysicalCoresPerLicense", + "softwareAssuranceCost", + "licenseAndSupportList" + ] + }, + "IaasOsDistribution": { + "type": "object", + "description": "Shows the infrastructure as a service machine OS distribution.", + "properties": { + "windows": { + "type": "integer", + "format": "int32", + "description": "Number of Windows servers.", + "readOnly": true + }, + "linux": { + "type": "integer", + "format": "int32", + "description": "Number of Linux servers.", + "readOnly": true + }, + "other": { + "type": "integer", + "format": "int32", + "description": "Number of servers neither Windows or Linux.", + "readOnly": true + } + } + }, + "IaasOsLicensingDetails": { + "type": "object", + "description": "The Iaas OS licensing details.", + "properties": { + "osType": { + "type": "string", + "description": "The OS type.", + "readOnly": true + }, + "totalCost": { + "type": "number", + "format": "float", + "description": "The total cost.", + "readOnly": true + }, + "decomissionCost": { + "type": "number", + "format": "float", + "description": "The decommission cost.", + "readOnly": true + } + } + }, + "IaasSummary": { + "type": "object", + "description": "Iaas summary REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/IaasSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "IaasSummaryListResult": { + "type": "object", + "description": "The response of a IaasSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IaasSummary items on this page", + "items": { + "$ref": "#/definitions/IaasSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IaasSummaryProperties": { + "type": "object", + "description": "Iaas summary properties class.", + "properties": { + "azureIaasSummary": { + "$ref": "#/definitions/AzureIaasSummary", + "description": "The Azure IaaS summary.", + "readOnly": true + }, + "onPremisesIaasSummary": { + "$ref": "#/definitions/OnPremisesIaasSummary", + "description": "The on premises IaaS summary.", + "readOnly": true + } + } + }, + "ImpactedAssessmentObject": { + "type": "object", + "description": "Class representing the impacted objects.", + "properties": { + "objectName": { + "type": "string", + "description": "Gets the object name.", + "readOnly": true + }, + "objectType": { + "type": "string", + "description": "Gets the object type.", + "readOnly": true + } + } + }, + "ImportCollector": { + "type": "object", + "description": "Import collector resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBase", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ImportCollectorListResult": { + "type": "object", + "description": "The response of a ImportCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ImportCollector items on this page", + "items": { + "$ref": "#/definitions/ImportCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LaborSettings": { + "type": "object", + "description": "Labour settings.", + "properties": { + "physicalServersPerAdmin": { + "type": "integer", + "format": "int32", + "description": "Physical servers per administrator.", + "minimum": 1 + }, + "virtualMachinesPerAdmin": { + "type": "integer", + "format": "int32", + "description": "Virtual machines per administrator.", + "minimum": 1 + }, + "hourlyAdminCost": { + "type": "number", + "format": "float", + "description": "Hourly administrator cost." + } + }, + "required": [ + "physicalServersPerAdmin", + "virtualMachinesPerAdmin", + "hourlyAdminCost" + ] + }, + "LicenseType": { + "type": "string", + "description": "Business case supported VmWare License types.", + "enum": [ + "Unknown", + "VSphereStandard", + "VSphereEnterprisePlus" + ], + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown License." + }, + { + "name": "VSphereStandard", + "value": "VSphereStandard", + "description": "VSphereStandard License." + }, + { + "name": "VSphereEnterprisePlus", + "value": "VSphereEnterprisePlus", + "description": "VSphereEnterprisePlus License." + } + ] + } + }, + "LicensingProgram": { + "type": "string", + "description": "Licensing Program for Azure.", + "enum": [ + "Default", + "EA" + ], + "x-ms-enum": { + "name": "LicensingProgram", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Default value. Indicates Pay As You Go." + }, + { + "name": "EA", + "value": "EA", + "description": "Enterprise Agreement." + } + ] + } + }, + "Machine": { + "type": "object", + "description": "Machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/MachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "MachineAssessmentProperties": { + "type": "object", + "description": "Properties of an assessment.", + "properties": { + "assessmentErrorSummary": { + "type": "object", + "description": "Gets or sets the assessment error summary.\n This is the number of\nmachines affected by each type of error in this assessment.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "monthlyUltraStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate ultra storage cost for all machines in the\nassessment.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Gets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "eaSubscriptionId": { + "type": "string", + "description": "Gets or sets enterprise agreement subscription id." + }, + "azurePricingTier": { + "$ref": "#/definitions/AzurePricingTier", + "description": "Gets or sets Azure Pricing Tier - Free, Basic, etc." + }, + "azureStorageRedundancy": { + "$ref": "#/definitions/AzureStorageRedundancy", + "description": "Gets or sets the Azure Storage Redundancy. Example: Locally Redundant Storage." + }, + "reservedInstance": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Gets or sets the Azure Reserved Instance - 1-Year, 3-Year." + }, + "azureHybridUseBenefit": { + "$ref": "#/definitions/AzureHybridUseBenefit", + "description": "Gets or sets the user configurable setting to display the azure hybrid use\nbenefit." + }, + "linuxAzureHybridUseBenefit": { + "$ref": "#/definitions/AzureHybridUseBenefit", + "description": "Gets or sets the user configurable setting to display the linux azure hybrid use\nbenefit." + }, + "azureDiskTypes": { + "type": "array", + "description": "Gets or sets the azure storage type. Premium, Standard etc.", + "items": { + "$ref": "#/definitions/AzureDiskType" + } + }, + "azureVmFamilies": { + "type": "array", + "description": "Gets or sets the Azure VM families.", + "items": { + "$ref": "#/definitions/AzureVmFamily" + } + }, + "distributionBySupportStatus": { + "type": "object", + "description": "Gets the distribution of sqlInstances by support status.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionByServicePackInsight": { + "type": "object", + "description": "Gets the distribution distribution of sqlInstances by service pack insight.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionByOsName": { + "type": "object", + "description": "Gets the distribution by os name.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate Compute Cost for all machines in the assessment.", + "readOnly": true + }, + "monthlyBandwidthCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate Bandwidth Cost for all machines in the assessment.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate Storage Cost for all machines in the assessment.", + "readOnly": true + }, + "monthlyPremiumStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate premium storage cost for all machines in the\nassessment.", + "readOnly": true + }, + "monthlyStandardSsdStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate standard SSD storage cost for all the machines in\nthe assessment.", + "readOnly": true + }, + "suitabilitySummary": { + "type": "object", + "description": "Gets or sets the Cloud suitability summary for all the machines in the\nassessment.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Number of machines part of the assessment.", + "readOnly": true + }, + "vmUptime": { + "$ref": "#/definitions/VmUptime", + "description": "Gets or sets the duration for which the VMs are up in the on-premises\nenvironment." + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "Gets the group type for the assessment.", + "readOnly": true + }, + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Assessment type of the assessment.", + "readOnly": true + }, + "azureLocation": { + "type": "string", + "description": "Azure Location or Azure region where to which the machines will be migrated." + }, + "azureOfferCode": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Azure Offer Code." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Currency in which prices should be reported." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Percentage of buffer that user wants on performance metrics when recommending\nAzure sizes." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Percentile of the utilization data values to be considered while assessing\nmachines." + }, + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Time Range for which the historic utilization data should be considered for\nassessment." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time to consider performance data for assessment." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time to consider performance data for assessment." + }, + "stage": { + "$ref": "#/definitions/AssessmentStage", + "description": "User configurable setting to display the Stage of Assessment.", + "readOnly": true + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Custom discount percentage." + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion." + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last time when rates were queried.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Whether assessment is in valid state and all machines have been assessed.", + "readOnly": true + }, + "schemaVersion": { + "type": "string", + "description": "Schema version.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "MachineBootType": { + "type": "string", + "enum": [ + "Unknown", + "EFI", + "BIOS", + "NotSpecified" + ], + "x-ms-enum": { + "name": "MachineBootType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "EFI", + "value": "EFI" + }, + { + "name": "Bios", + "value": "BIOS" + }, + { + "name": "NotSpecified", + "value": "NotSpecified" + } + ] + } + }, + "MachineListResult": { + "type": "object", + "description": "The response of a Machine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Machine items on this page", + "items": { + "$ref": "#/definitions/Machine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MachineProperties": { + "type": "object", + "description": "Properties of a machine.", + "properties": { + "workloadSummary": { + "$ref": "#/definitions/WorkloadSummary", + "description": "Gets or sets workload summary.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "List of errors for this machine.", + "items": { + "$ref": "#/definitions/Error" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "hostProcessor": { + "$ref": "#/definitions/ProcessorInfo", + "description": "Gets Processor details of the host.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "discoveryMachineArmId": { + "type": "string", + "description": "Site id of machine discovered in private data center.", + "readOnly": true + }, + "datacenterManagementServerArmId": { + "type": "string", + "description": "The data center management server ARM Id for the machine.", + "readOnly": true + }, + "datacenterManagementServerName": { + "type": "string", + "description": "The data center management server name for the machine.", + "readOnly": true + }, + "bootType": { + "$ref": "#/definitions/MachineBootType", + "description": "Boot type of machine discovered in private data center.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name of the Machine.", + "readOnly": true + }, + "megabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Megabytes of memory found allocated for the machine in private data center.", + "readOnly": true + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores found on the machine.", + "readOnly": true + }, + "operatingSystemType": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemVersion": { + "type": "string", + "description": "Operating system version as reported by datacenter management solution.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description for the machine.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine first created.", + "readOnly": true + }, + "disks": { + "type": "object", + "description": "Disks attached to the machine discovered in private data center.", + "additionalProperties": { + "$ref": "#/definitions/Disk" + }, + "readOnly": true + }, + "groups": { + "type": "array", + "description": "Gets the References to the groups that this machine is member of.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "networkAdapters": { + "type": "object", + "description": "Network adapters attached to the machine discovered in private data center.", + "additionalProperties": { + "$ref": "#/definitions/NetworkAdapter" + }, + "readOnly": true + }, + "sqlInstances": { + "type": "array", + "description": "SQL instances discovered on the machine.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "webApplications": { + "type": "array", + "description": "Web applications discovered on the machine.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine last updated.", + "readOnly": true + } + } + }, + "ManagementCostComponent": { + "type": "object", + "description": "Management Cost Component.", + "properties": { + "name": { + "$ref": "#/definitions/ManagementCostComponentName", + "description": "Name of Management Cost Component." + }, + "value": { + "type": "number", + "format": "float", + "description": "Cost of Management Component." + } + }, + "required": [ + "name" + ] + }, + "ManagementCostComponentName": { + "type": "string", + "description": "Management Cost Component Names.", + "enum": [ + "Unknown", + "SystemCenterLicenseCost", + "VSphereManagementCost", + "ThirdPartyManagementCost", + "OtherMonitoringCost", + "OtherDataProtectionCost", + "OtherPatchingCost", + "AzureMonitoringCost", + "AzurePatchingCost", + "AzureDataProtectionCost" + ], + "x-ms-enum": { + "name": "ManagementCostComponentName", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Management Cost Component." + }, + { + "name": "SystemCenterLicenseCost", + "value": "SystemCenterLicenseCost", + "description": "System Center License Cost." + }, + { + "name": "VSphereManagementCost", + "value": "VSphereManagementCost", + "description": "VSphere eManagement Cost." + }, + { + "name": "ThirdPartyManagementCost", + "value": "ThirdPartyManagementCost", + "description": "Third Party Management Cost." + }, + { + "name": "OtherMonitoringCost", + "value": "OtherMonitoringCost", + "description": "Other Monitoring Cost." + }, + { + "name": "OtherDataProtectionCost", + "value": "OtherDataProtectionCost", + "description": "Other Data Protection Cost." + }, + { + "name": "OtherPatchingCost", + "value": "OtherPatchingCost", + "description": "Other Patching Cost." + }, + { + "name": "AzureMonitoringCost", + "value": "AzureMonitoringCost", + "description": "Azure Monitoring Cost." + }, + { + "name": "AzurePatchingCost", + "value": "AzurePatchingCost", + "description": "Azure Patching Cost." + }, + { + "name": "AzureDataProtectionCost", + "value": "AzureDataProtectionCost", + "description": "Azure Data Protection Cost." + } + ] + } + }, + "ManagementCostDetails": { + "type": "object", + "description": "Management Cost Details.", + "properties": { + "managementCost": { + "type": "number", + "format": "float", + "description": "Management Cost.", + "readOnly": true + }, + "managementCostComponents": { + "type": "array", + "description": "Management Cost Components.", + "items": { + "$ref": "#/definitions/ManagementCostComponent" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "ManagementSettings": { + "type": "object", + "description": "Management settings.", + "properties": { + "hypervVirtualizationManagementSettings": { + "$ref": "#/definitions/HypervVirtualizationManagementSettings", + "description": "HyperV Virtualization Management Settings." + }, + "vsphereManagementSettings": { + "$ref": "#/definitions/VsphereManagementSettings", + "description": "vSphere Management Settings." + }, + "thirdPartyManagementSettings": { + "$ref": "#/definitions/ThirdPartyManagementSettings", + "description": "Third Party Management Settings." + }, + "otherManagementCostsSettings": { + "$ref": "#/definitions/OtherManagementCostsSettings", + "description": "Other Management Costs Settings." + } + }, + "required": [ + "hypervVirtualizationManagementSettings", + "vsphereManagementSettings", + "thirdPartyManagementSettings", + "otherManagementCostsSettings" + ] + }, + "MigrationGuidelineContext": { + "type": "object", + "description": "Migration Guideline Context.", + "properties": { + "contextKey": { + "type": "string", + "description": "Gets the reasoning context key." + }, + "contextValue": { + "type": "string", + "description": "Gets the reasoning context value." + } + } + }, + "MigrationStrategy": { + "type": "string", + "description": "Business case supported migration strategy types.", + "enum": [ + "Unknown", + "OptimizeForCost", + "IaaSOnly", + "OptimizeForPaas", + "AVSOnly" + ], + "x-ms-enum": { + "name": "MigrationStrategy", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Migration Strategy." + }, + { + "name": "OptimizeForCost", + "value": "OptimizeForCost", + "description": "Optimize for cost." + }, + { + "name": "IaaSOnly", + "value": "IaaSOnly", + "description": "IaaS only." + }, + { + "name": "OptimizeForPaas", + "value": "OptimizeForPaas", + "description": "Optimize for PaaS." + }, + { + "name": "AVSOnly", + "value": "AVSOnly", + "description": "Avs only." + } + ] + } + }, + "MoreInfo": { + "type": "object", + "description": "Data model of More information about check or rule.", + "properties": { + "title": { + "type": "string", + "description": "Gets title.", + "readOnly": true + }, + "url": { + "type": "string", + "description": "Gets url.", + "readOnly": true + } + }, + "required": [ + "title", + "url" + ] + }, + "MultiSubnetIntent": { + "type": "string", + "enum": [ + "None", + "HighAvailability", + "DisasterRecovery" + ], + "x-ms-enum": { + "name": "MultiSubnetIntent", + "modelAsString": true + } + }, + "MutableArmResource": { + "type": "object", + "description": "ARM model of Assessment ARM object.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningStatus", + "description": "Gets the provisioning state.", + "readOnly": true + } + } + }, + "NetworkAdapter": { + "type": "object", + "description": "A network adapter discovered on a machine.", + "properties": { + "macAddress": { + "type": "string", + "description": "MAC Address of the network adapter.", + "readOnly": true + }, + "ipAddresses": { + "type": "array", + "description": "List of IP Addresses on the network adapter.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "User friendly name of the network adapter.", + "readOnly": true + } + } + }, + "NetworkSettings": { + "type": "object", + "description": "Network settings.", + "properties": { + "hardwareSoftwareCostPercentage": { + "type": "number", + "format": "float", + "description": "Network hardware and software cost percentage.", + "minimum": 0, + "maximum": 100 + }, + "maintenanceCostPercentage": { + "type": "number", + "format": "float", + "description": "Network maintenance cost percentage.", + "minimum": 0, + "maximum": 100 + } + }, + "required": [ + "hardwareSoftwareCostPercentage", + "maintenanceCostPercentage" + ] + }, + "NetworkSkuType": { + "type": "string", + "description": "Different network skus.", + "enum": [ + "Unknown", + "None", + "ExpressRouteUltra" + ], + "x-ms-enum": { + "name": "NetworkSkuType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Indicates un-supported network SKU." + }, + { + "name": "None", + "value": "None", + "description": "Indicates No network SKU." + }, + { + "name": "ExpressRouteUltra", + "value": "ExpressRouteUltra", + "description": "Express Route network type with Ultra SKU." + } + ] + } + }, + "NodePool": { + "type": "object", + "description": "Data model of Node Pool.", + "properties": { + "id": { + "type": "string", + "description": "Gets id.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Gets name.", + "readOnly": true + }, + "clusterName": { + "type": "string", + "description": "Gets cluster name.", + "readOnly": true + }, + "mode": { + "$ref": "#/definitions/NodePoolMode", + "description": "Gets mode.", + "readOnly": true + }, + "osType": { + "$ref": "#/definitions/OSType", + "description": "Gets os type.", + "readOnly": true + }, + "armSkuName": { + "type": "string", + "description": "Gets arm sku name.", + "readOnly": true + }, + "nodeCount": { + "type": "integer", + "format": "int32", + "description": "Gets node count.", + "readOnly": true + }, + "podCount": { + "type": "integer", + "format": "int32", + "description": "Gets pod count.", + "readOnly": true + }, + "monthlyCost": { + "type": "number", + "format": "float", + "description": "Gets monthly cost.", + "readOnly": true + }, + "podApproxMonthlyCost": { + "type": "number", + "format": "float", + "description": "Gets pod approximate monthly cost.", + "readOnly": true + } + }, + "required": [ + "id", + "name", + "clusterName", + "mode", + "osType", + "armSkuName", + "nodeCount", + "podCount", + "monthlyCost", + "podApproxMonthlyCost" + ] + }, + "NodePoolMode": { + "type": "string", + "description": "Node Pool Mode.", + "enum": [ + "User", + "System" + ], + "x-ms-enum": { + "name": "NodePoolMode", + "modelAsString": true, + "values": [ + { + "name": "User", + "value": "User", + "description": "Indicates User node pool." + }, + { + "name": "System", + "value": "System", + "description": "Indicates System node pool." + } + ] + } + }, + "OSType": { + "type": "string", + "description": "Operating System Type.", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true, + "values": [ + { + "name": "Linux", + "value": "Linux", + "description": "Linux OS Type." + }, + { + "name": "Windows", + "value": "Windows", + "description": "Windows OS Type." + } + ] + } + }, + "OnPremiseSettings": { + "type": "object", + "description": "On-premise settings.", + "properties": { + "computeSettings": { + "$ref": "#/definitions/ComputeSettings", + "description": "Compute settings." + }, + "storageSettings": { + "$ref": "#/definitions/StorageSettings", + "description": "Storage settings." + }, + "networkSettings": { + "$ref": "#/definitions/NetworkSettings", + "description": "Network settings." + }, + "facilitySettings": { + "$ref": "#/definitions/FacilitySettings", + "description": "Facility settings." + }, + "laborSettings": { + "$ref": "#/definitions/LaborSettings", + "description": "Labour settings." + }, + "securitySettings": { + "$ref": "#/definitions/SecuritySettings", + "description": "Security settings." + }, + "managementSettings": { + "$ref": "#/definitions/ManagementSettings", + "description": "Management settings." + } + }, + "required": [ + "computeSettings", + "storageSettings", + "networkSettings", + "facilitySettings", + "laborSettings", + "securitySettings" + ] + }, + "OnPremisesIaasSummary": { + "type": "object", + "description": "The on premises IAAS summary.", + "properties": { + "servers": { + "type": "integer", + "format": "int32", + "description": "The number of servers.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "The number of cores.", + "readOnly": true + }, + "memoryGb": { + "type": "number", + "format": "float", + "description": "Total memory in GB.", + "readOnly": true + }, + "cpuUtilization": { + "type": "number", + "format": "float", + "description": "The CPU utilization.", + "readOnly": true + }, + "memoryUtilization": { + "type": "number", + "format": "float", + "description": "The memory utilization.", + "readOnly": true + }, + "storageUtilization": { + "type": "number", + "format": "float", + "description": "The storage utilization.", + "readOnly": true + }, + "onPremisesIaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "onPremisesIaasCostForDecommissioned": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "osLicensingDetails": { + "type": "array", + "description": "The OS licensing details.", + "items": { + "$ref": "#/definitions/IaasOsLicensingDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByOperatingSystem": { + "type": "array", + "description": "The distribution by operating system.", + "items": { + "$ref": "#/definitions/DistributionByOperatingSystem" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "onPremisesUtilizationData": { + "$ref": "#/definitions/UtilizationData", + "description": "The SQL on premises utilization insights.", + "readOnly": true + }, + "distributionByVirtualization": { + "type": "array", + "description": "The distribution by virtualization.", + "items": { + "$ref": "#/definitions/DistributionByVirtualization" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "iaasOsSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "Iaas OS Support Status Distribution.", + "readOnly": true + }, + "iaasSqlSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "Iaas Sql Support Status Distribution.", + "readOnly": true + }, + "osServicePackInsight": { + "$ref": "#/definitions/ServicePackInsight", + "description": "OS Service Pack Insight.", + "readOnly": true + }, + "sqlServicePackInsight": { + "$ref": "#/definitions/ServicePackInsight", + "description": "Sql Service Pack Insight.", + "readOnly": true + }, + "distributionByOperatingSystemVersion": { + "type": "array", + "description": "Distribution by Operating System Version.", + "items": { + "$ref": "#/definitions/DistributionByType" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySqlVersion": { + "type": "array", + "description": "Distribution by Sql Version.", + "items": { + "$ref": "#/definitions/DistributionByType" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySqlEdition": { + "type": "array", + "description": "Distribution by Sql Edition.", + "items": { + "$ref": "#/definitions/DistributionByType" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "OnPremisesPaasLicensingCost": { + "type": "object", + "description": "The on premises paas licensing cost.", + "properties": { + "version": { + "type": "string", + "description": "The version.", + "readOnly": true + }, + "totalCost": { + "type": "number", + "format": "float", + "description": "The total cost.", + "readOnly": true + }, + "decomissionServerCost": { + "type": "number", + "format": "float", + "description": "The decommissioned server cost.", + "readOnly": true + } + } + }, + "OnPremisesPaasSummary": { + "type": "object", + "description": "Shows platform as a service (PaaS) summary.", + "properties": { + "totalServers": { + "type": "integer", + "format": "int32", + "description": "Total servers.", + "readOnly": true + }, + "cpuUtilization": { + "type": "number", + "format": "float", + "description": "CPU utilization percentage.", + "readOnly": true + }, + "memoryUtilization": { + "type": "number", + "format": "float", + "description": "Memory utilization percentage.", + "readOnly": true + }, + "totalOnPremisesPaasCost": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "onPremisesPaasCostForDecommisioned": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "onPremisesPaasLicensingCost": { + "$ref": "#/definitions/OnPremisesPaasLicensingCost", + "description": "The on premises paas licensing cost.", + "readOnly": true + }, + "onPremisesSqlSummary": { + "$ref": "#/definitions/OnPremisesSqlSummary", + "description": "The on premises SQL summary.", + "readOnly": true + }, + "onPremisesWebAppSummary": { + "$ref": "#/definitions/OnPremisesWebAppSummary", + "description": "The on premises web application summary.", + "readOnly": true + }, + "osSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "OS Support Status Distribution.", + "readOnly": true + }, + "sqlSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "Sql Support Status Distribution.", + "readOnly": true + }, + "osServicePackInsight": { + "$ref": "#/definitions/ServicePackInsight", + "description": "OS Service Pack Insight.", + "readOnly": true + }, + "sqlServicePackInsight": { + "$ref": "#/definitions/ServicePackInsight", + "description": "Sql Service Pack Insight.", + "readOnly": true + } + } + }, + "OnPremisesSqlSummary": { + "type": "object", + "description": "The on premises SQL summary.", + "properties": { + "sqlInstances": { + "type": "integer", + "format": "int32", + "description": "The number of SQL instances.", + "readOnly": true + }, + "sqlDatabases": { + "type": "integer", + "format": "int32", + "description": "The number of SQL databases.", + "readOnly": true + }, + "distributionBySqlVersion": { + "type": "array", + "description": "Distribution by SQL version.", + "items": { + "$ref": "#/definitions/SqlVersionDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sqlOnPremisesUtilizationData": { + "$ref": "#/definitions/UtilizationData", + "description": "The SQL on premises utilization insights.", + "readOnly": true + }, + "distributionBySqlEdition": { + "type": "array", + "description": "Distribution by Sql Edition.", + "items": { + "$ref": "#/definitions/DistributionByType" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "OnPremisesWebAppSummary": { + "type": "object", + "description": "The on premises web application summary.", + "properties": { + "numberOfWebServers": { + "type": "integer", + "format": "int32", + "description": "The number of web servers.", + "readOnly": true + }, + "numberOfWebApplications": { + "type": "integer", + "format": "int32", + "description": "The number of web applications.", + "readOnly": true + }, + "numberOfWebAppsPerType": { + "type": "object", + "description": "The number of web applications per web application type.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + } + } + }, + "OptimizationLogic": { + "type": "string", + "enum": [ + "MinimizeCost", + "ModernizeToPaaS", + "ModernizeToAzureSqlMi", + "ModernizeToAzureSqlDb" + ], + "x-ms-enum": { + "name": "OptimizationLogic", + "modelAsString": true + } + }, + "OptionsArmPropertiesBase": { + "type": "object", + "description": "Base ARM model of ARM properties for assessment options.", + "properties": { + "edges": { + "type": "object", + "description": "Gets the mapping of Assessment Options in graph representation.", + "additionalProperties": { + "$ref": "#/definitions/RecordOfStringArray" + }, + "readOnly": true + } + }, + "required": [ + "edges" + ] + }, + "OsLicense": { + "type": "string", + "enum": [ + "Unknown", + "Yes", + "No" + ], + "x-ms-enum": { + "name": "OsLicense", + "modelAsString": true + } + }, + "OtherManagementCostsSettings": { + "type": "object", + "description": "Other Management Costs Settings.", + "properties": { + "monitoringCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Monitoring Cost Per Server Per Year." + }, + "patchingCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Patching Cost Per Server Per Year." + }, + "dataProtectionCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Data Protection Cost Per Server Per Year." + } + }, + "required": [ + "monitoringCostPerServerPerYear", + "patchingCostPerServerPerYear", + "dataProtectionCostPerServerPerYear" + ] + }, + "OverviewSummary": { + "type": "object", + "description": "Overview summary REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/OverviewSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "OverviewSummaryListResult": { + "type": "object", + "description": "The response of a OverviewSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The OverviewSummary items on this page", + "items": { + "$ref": "#/definitions/OverviewSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "OverviewSummaryProperties": { + "type": "object", + "description": "Overview summary properties class.", + "properties": { + "totalAzureCost": { + "type": "number", + "format": "float", + "description": "The total Azure cost..", + "readOnly": true + }, + "totalAzureIaasCost": { + "type": "number", + "format": "float", + "description": "The total Azure IaaS cost.", + "readOnly": true + }, + "totalAzurePaasCost": { + "type": "number", + "format": "float", + "description": "The total Azure PaaS cost.", + "readOnly": true + }, + "totalAzureAvsCost": { + "type": "number", + "format": "float", + "description": "The total Avs cost.", + "readOnly": true + }, + "windowsAhubSavings": { + "type": "number", + "format": "float", + "description": "The windows ahub saving.", + "readOnly": true + }, + "linuxAhubSavings": { + "type": "number", + "format": "float", + "description": "The linux ahub saving.", + "readOnly": true + }, + "sqlAhubSavings": { + "type": "number", + "format": "float", + "description": "The sql ahub saving.", + "readOnly": true + }, + "totalOnPremisesCost": { + "type": "number", + "format": "float", + "description": "The total on premises cost.", + "readOnly": true + }, + "esuSavingsFor4years": { + "type": "number", + "format": "float", + "description": "ESU Savings 4 Years.", + "readOnly": true + }, + "managementCostSavings": { + "type": "number", + "format": "float", + "description": "The management cost saving.", + "readOnly": true + }, + "securityCostSavings": { + "type": "number", + "format": "float", + "description": "The security cost saving.", + "readOnly": true + }, + "yearOnYearEstimates": { + "$ref": "#/definitions/YearOnYearEstimates", + "description": "Shows the year-on-year cost overall.", + "readOnly": true + }, + "serversDiscovered": { + "$ref": "#/definitions/ServersDiscovered", + "description": "Shows the discovered servers by virtualization platform.", + "readOnly": true + }, + "utilizationData": { + "$ref": "#/definitions/UtilizationData", + "description": "The SQL on premises utilization insights.", + "readOnly": true + }, + "iaasOsDistribution": { + "$ref": "#/definitions/IaasOsDistribution", + "description": "Shows the infrastructure as a service machine OS distribution.", + "readOnly": true + }, + "osSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "OS Support Status Distribution.", + "readOnly": true + }, + "sqlSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "Sql Support Status Distribution.", + "readOnly": true + }, + "paasDistribution": { + "$ref": "#/definitions/PaasDistribution", + "description": "Shows the distribution of platforms.", + "readOnly": true + } + } + }, + "POSAzurePricingTier": { + "type": "string", + "description": "Pricing Tier for Azure.", + "enum": [ + "Unknown", + "Standard" + ], + "x-ms-enum": { + "name": "POSAzurePricingTier", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates missing data." + }, + { + "name": "Standard", + "value": "Standard", + "description": "Standard Pricing Tier." + } + ] + } + }, + "PaasDistribution": { + "type": "object", + "description": "Shows the distribution of platforms.", + "properties": { + "sqlServers": { + "type": "integer", + "format": "int32", + "description": "Number of SQL Server machines.", + "readOnly": true + }, + "iisWebServers": { + "type": "integer", + "format": "int32", + "description": "Number of IIS Web servers.", + "readOnly": true + }, + "webAppDistribution": { + "type": "object", + "description": "Distribution of webapps for each target type.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + } + } + }, + "PaasSummary": { + "type": "object", + "description": "Paas summary REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/PaasSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PaasSummaryListResult": { + "type": "object", + "description": "The response of a PaasSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PaasSummary items on this page", + "items": { + "$ref": "#/definitions/PaasSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PaasSummaryProperties": { + "type": "object", + "description": "Paas summary properties class.", + "properties": { + "azure": { + "$ref": "#/definitions/AzurePaasSummary", + "description": "Shows the PaaS Azure summary.", + "readOnly": true + }, + "onPremises": { + "$ref": "#/definitions/OnPremisesPaasSummary", + "description": "Shows platform as a service (PaaS) summary.", + "readOnly": true + } + } + }, + "Percentile": { + "type": "string", + "description": "Percentile for Performance Data.", + "enum": [ + "Percentile50", + "Percentile90", + "Percentile95", + "Percentile99" + ], + "x-ms-enum": { + "name": "Percentile", + "modelAsString": true, + "values": [ + { + "name": "Percentile50", + "value": "Percentile50", + "description": "Percentile 50." + }, + { + "name": "Percentile90", + "value": "Percentile90", + "description": "Percentile 90." + }, + { + "name": "Percentile95", + "value": "Percentile95", + "description": "Percentile 95." + }, + { + "name": "Percentile99", + "value": "Percentile99", + "description": "Percentile 99." + } + ] + } + }, + "PerfDataSettings": { + "type": "object", + "description": "Data model of Performance Data Settings.", + "properties": { + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Gets perf data time range." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets perf data start time." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets perf data end time." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Gets percentile utilization for performance data." + } + }, + "required": [ + "timeRange", + "percentile" + ] + }, + "PricingTier": { + "type": "string", + "description": "Pricing Tier for Azure.", + "enum": [ + "Standard", + "Free" + ], + "x-ms-enum": { + "name": "PricingTier", + "modelAsString": true, + "values": [ + { + "name": "Standard", + "value": "Standard", + "description": "Standard Pricing Tier." + }, + { + "name": "Free", + "value": "Free", + "description": "Free Pricing Tier." + } + ] + } + }, + "PrivateEndpointConnection": { + "type": "object", + "description": "Private endpoint connection resource.", + "properties": { + "properties": { + "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnectionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "The response of a PrivateEndpointConnection list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateEndpointConnection items on this page", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PrivateLinkResource": { + "type": "object", + "description": "Private link resource.", + "properties": { + "properties": { + "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkResourceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateLinkResourceListResult": { + "type": "object", + "description": "The response of a PrivateLinkResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateLinkResource items on this page", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ProcessorInfo": { + "type": "object", + "description": "Represents a information \\ details of a processor.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name \\ model of a processor." + }, + "numberOfSockets": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of sockets." + }, + "numberOfCoresPerSocket": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of cores in a socket." + } + } + }, + "ProductSupportStatus": { + "type": "object", + "description": "Class to represent the Product Support Status.", + "properties": { + "currentVersion": { + "type": "string", + "description": "Gets or sets current version of ServicePack.", + "readOnly": true + }, + "servicePackStatus": { + "type": "string", + "description": "Gets or sets ServicePack of the product.", + "readOnly": true + }, + "esuStatus": { + "type": "string", + "description": "Gets or sets the Extended Security Update ESU status.", + "readOnly": true + }, + "supportStatus": { + "type": "string", + "description": "Gets or sets the support status of the product.", + "readOnly": true + }, + "eta": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the ETA.", + "readOnly": true + }, + "currentEsuYear": { + "type": "string", + "description": "Gets or sets the current ESU support year.", + "readOnly": true + }, + "mainstreamEndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the main stream end date of the product.", + "readOnly": true + }, + "extendedSupportEndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the extended support end date of the product.", + "readOnly": true + }, + "extendedSecurityUpdateYear1EndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the extended security update year 1 end date of the product.", + "readOnly": true + }, + "extendedSecurityUpdateYear2EndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the extended security update year 2 end date of the product.", + "readOnly": true + }, + "extendedSecurityUpdateYear3EndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the extended security update year 3 end date of the product.", + "readOnly": true + } + } + }, + "ProjectProperties": { + "type": "object", + "description": "Properties of a project.", + "properties": { + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when this project was created. Date-Time represented in ISO-8601 format.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when this project was last updated. Date-Time represented in ISO-8601\nformat.", + "readOnly": true + }, + "serviceEndpoint": { + "type": "string", + "description": "Endpoint at which the collector agent can call agent REST API.", + "readOnly": true + }, + "assessmentSolutionId": { + "type": "string", + "description": "Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects." + }, + "projectStatus": { + "$ref": "#/definitions/ProjectStatus", + "description": "Assessment project status." + }, + "customerWorkspaceId": { + "type": "string", + "description": "The ARM id of service map workspace created by customer." + }, + "customerWorkspaceLocation": { + "type": "string", + "description": "Location of service map workspace created by customer." + }, + "publicNetworkAccess": { + "type": "string", + "description": "This value can be set to 'enabled' to avoid breaking changes on existing\ncustomer resources and templates. If set to 'disabled', traffic over public\ninterface is not allowed, and private endpoint connections would be the\nexclusive access method." + }, + "privateEndpointConnections": { + "type": "array", + "description": "The list of private endpoint connections to the project.", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "customerStorageAccountArmId": { + "type": "string", + "description": "The ARM id of the storage account used for interactions when public access is\ndisabled." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "ProjectStatus": { + "type": "string", + "description": "Project Status.", + "enum": [ + "Active", + "Inactive" + ], + "x-ms-enum": { + "name": "ProjectStatus", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "Active Status." + }, + { + "name": "Inactive", + "value": "Inactive", + "description": "Inactive Status." + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The status of the current operation.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Resource is being Provisioned." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Resource is being Updated." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Resource is being Deleted." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Resource is being Accepted." + } + ] + } + }, + "ProvisioningState2": { + "type": "string", + "description": "The status of the current operation.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState2", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Resource is being Provisioned." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Resource is being Updated." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Resource is being Deleted." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Resource is being Accepted." + } + ] + }, + "readOnly": true + }, + "ProvisioningStatus": { + "type": "string", + "description": "Provisioning Status.", + "enum": [ + "Unknown", + "Succeeded", + "Failed", + "Canceled", + "InProgress" + ], + "x-ms-enum": { + "name": "ProvisioningStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates missing data." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "Provisioning is in Progress." + } + ] + }, + "readOnly": true + }, + "Readiness": { + "type": "string", + "description": "Readiness for Azure.", + "enum": [ + "Unknown", + "NotReady", + "ReadyWithConditions", + "Ready" + ], + "x-ms-enum": { + "name": "Readiness", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Readiness." + }, + { + "name": "NotReady", + "value": "NotReady", + "description": "Not Ready." + }, + { + "name": "ReadyWithConditions", + "value": "ReadyWithConditions", + "description": "Ready with conditions." + }, + { + "name": "Ready", + "value": "Ready", + "description": "Ready for migration." + } + ] + } + }, + "RecommendationResult": { + "type": "object", + "description": "Data model of Recommendation Result.", + "properties": { + "request": { + "$ref": "#/definitions/ComputeResource", + "description": "Gets cores and memory request.", + "readOnly": true + }, + "limit": { + "$ref": "#/definitions/ComputeResource", + "description": "Gets cores and memory limit.", + "readOnly": true + }, + "osType": { + "$ref": "#/definitions/OSType", + "description": "Gets os type.", + "readOnly": true + }, + "clusterName": { + "type": "string", + "description": "Gets cluster name.", + "readOnly": true + }, + "nodePoolId": { + "type": "string", + "description": "Gets node pool id.", + "readOnly": true + }, + "nodePoolName": { + "type": "string", + "description": "Gets node pool name.", + "readOnly": true + }, + "nodePoolArmSkuName": { + "type": "string", + "description": "Gets node pool arm sku name.", + "readOnly": true + }, + "approxMonthlyCost": { + "type": "number", + "format": "float", + "description": "Gets approximate monthly cost.", + "readOnly": true + } + }, + "required": [ + "request", + "limit", + "osType", + "clusterName", + "nodePoolId", + "nodePoolName", + "nodePoolArmSkuName", + "approxMonthlyCost" + ] + }, + "RecommendedAvsNodeTypeSummary": { + "type": "object", + "description": "Azure Avs Node summary.", + "properties": { + "avsNodeType": { + "type": "string", + "description": "AVS node type.", + "readOnly": true + }, + "numberOfNodes": { + "type": "integer", + "format": "int32", + "description": "Number of nodes.", + "readOnly": true + }, + "failuresToTolerateAndRaidLevel": { + "$ref": "#/definitions/FttAndRaidLevel", + "description": "Failures to tolerate and RAID level for the Node.", + "readOnly": true + } + } + }, + "RecommendedSuitability": { + "type": "string", + "enum": [ + "Unknown", + "SuitableForSqlDB", + "SuitableForSqlMI", + "SuitableForVM", + "PotentiallySuitableForVM", + "ReadinessUnknown", + "NotSuitable", + "SuitableForSqlVM", + "ConditionallySuitableForSqlDB", + "ConditionallySuitableForSqlMI", + "ConditionallySuitableForVM", + "ConditionallySuitableForSqlVM" + ], + "x-ms-enum": { + "name": "RecommendedSuitability", + "modelAsString": true + } + }, + "RecommendedVmFamilySummary": { + "type": "object", + "description": "The recommended VM family summary.", + "properties": { + "azureVmFamily": { + "type": "string", + "description": "The Azure VM family.", + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "The number of machines.", + "readOnly": true + } + } + }, + "RecordOfInt": { + "type": "object", + "description": "Data Model for Dictionary.", + "additionalProperties": { + "format": "int32", + "type": "integer" + } + }, + "RecordOfStringArray": { + "type": "object", + "description": "Data Model for Dictionary.", + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "ReportDetails": { + "type": "object", + "description": "Business case report details.", + "properties": { + "reportType": { + "$ref": "#/definitions/ReportType", + "description": "Report type.", + "readOnly": true + }, + "reportStatus": { + "$ref": "#/definitions/ReportStatus", + "description": "Report status.", + "readOnly": true + } + } + }, + "ReportDownloadUrl": { + "type": "object", + "description": "Download URL for assessment report.", + "properties": { + "businessCaseReportUrl": { + "type": "string", + "description": "Hyperlink to download report.", + "readOnly": true + }, + "expirationTime": { + "type": "string", + "format": "date-time", + "description": "Expiry date of download url.", + "readOnly": true + } + } + }, + "ReportStatus": { + "type": "string", + "description": "Business case supported report status types.", + "enum": [ + "Unknown", + "None", + "InProgress", + "Failed", + "Completed" + ], + "x-ms-enum": { + "name": "ReportStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Report Status." + }, + { + "name": "None", + "value": "None", + "description": "None Report Status." + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "InProgress Report Status." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed Report Status." + }, + { + "name": "Completed", + "value": "Completed", + "description": "Completed Report Status." + } + ] + } + }, + "ReportType": { + "type": "string", + "description": "Business case supported report types.", + "enum": [ + "Unknown", + "Excel" + ], + "x-ms-enum": { + "name": "ReportType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Report Type." + }, + { + "name": "Excel", + "value": "Excel", + "description": "Excel Report Type." + } + ] + } + }, + "ResourceId": { + "type": "object", + "description": "ARM id for a resource.", + "properties": { + "id": { + "type": "string", + "description": "Gets the relative URL to get to this REST resource.", + "readOnly": true + } + } + }, + "SavingsOption": { + "type": "string", + "description": "Business case supported Savings Option types.", + "enum": [ + "Unknown", + "RI3Year", + "SavingsPlan3Year" + ], + "x-ms-enum": { + "name": "SavingsOption", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Savings Option." + }, + { + "name": "RI3Year", + "value": "RI3Year", + "description": "Reserved Instance 3 Year." + }, + { + "name": "SavingsPlan3Year", + "value": "SavingsPlan3Year", + "description": "Azure Savings Plan 3 Year." + } + ] + } + }, + "SavingsOptions": { + "type": "string", + "description": "Savings Options for Azure.", + "enum": [ + "None", + "OneYearSavings", + "ThreeYearsSavings", + "OneYearReserved", + "ThreeYearsReserved" + ], + "x-ms-enum": { + "name": "SavingsOptions", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "Savings Options is not applicable." + }, + { + "name": "OneYearSavings", + "value": "OneYearSavings", + "description": "One Year Savings Plan." + }, + { + "name": "ThreeYearsSavings", + "value": "ThreeYearsSavings", + "description": "Three Years Savings Plan." + }, + { + "name": "OneYearReserved", + "value": "OneYearReserved", + "description": "One Year Reserved Instances." + }, + { + "name": "ThreeYearsReserved", + "value": "ThreeYearsReserved", + "description": "Three Years Reserved Instances." + } + ] + } + }, + "SecuritySettings": { + "type": "object", + "description": "Security settings.", + "properties": { + "serverSecurityCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Physical servers per administrator." + }, + "sqlServerSecurityCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Virtual machines per administrator." + } + }, + "required": [ + "serverSecurityCostPerServerPerYear", + "sqlServerSecurityCostPerServerPerYear" + ] + }, + "ServerCollector": { + "type": "object", + "description": "Physical server collector resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBaseWithAgent", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ServerCollectorListResult": { + "type": "object", + "description": "The response of a ServerCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ServerCollector items on this page", + "items": { + "$ref": "#/definitions/ServerCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ServersDiscovered": { + "type": "object", + "description": "Shows the discovered servers by virtualization platform.", + "properties": { + "vmWare": { + "type": "integer", + "format": "int32", + "description": "Number of servers on VMWare.", + "readOnly": true + }, + "hyperV": { + "type": "integer", + "format": "int32", + "description": "Number of servers on HyperV.", + "readOnly": true + }, + "physical": { + "type": "integer", + "format": "int32", + "description": "Number of physical servers.", + "readOnly": true + }, + "notApplicable": { + "type": "integer", + "format": "int32", + "description": "Number of servers whose virtualization is unknown.", + "readOnly": true + } + } + }, + "ServicePackInsight": { + "type": "object", + "description": "Service Pack Insight.", + "properties": { + "unknownServicePack": { + "type": "integer", + "format": "int32", + "description": "Unknown support.", + "readOnly": true + }, + "patched": { + "type": "integer", + "format": "int32", + "description": "Patched Service Pack Insight.", + "readOnly": true + }, + "unpatched": { + "type": "integer", + "format": "int32", + "description": "Unpatched Service Pack Insight.", + "readOnly": true + } + } + }, + "Settings": { + "type": "object", + "description": "Business case settings.", + "properties": { + "azureSettings": { + "$ref": "#/definitions/AzureSettings", + "description": "Azure settings for a business case." + }, + "onPremiseSettings": { + "$ref": "#/definitions/OnPremiseSettings", + "description": "On-premise settings." + } + }, + "required": [ + "azureSettings" + ] + }, + "SharedResourcesDTO": { + "type": "object", + "description": "Shared Resources.", + "properties": { + "sharedDataDisks": { + "type": "array", + "description": "Gets the list of shared data disks.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharedLogDisks": { + "type": "array", + "description": "Gets the list of shared log disks.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharedTempDbDisks": { + "type": "array", + "description": "Gets the list of shared Temporary database disks.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "numberOfMounts": { + "type": "integer", + "format": "int32", + "description": "Gets number of mounts of shared disks.", + "readOnly": true + }, + "quorumWitness": { + "$ref": "#/definitions/AzureQuorumWitnessDTO", + "description": "Gets quorum witness.", + "readOnly": true + } + } + }, + "SkuReplicationMode": { + "type": "string", + "enum": [ + "NotApplicable", + "ActiveGeoReplication", + "FailoverGroupInstance" + ], + "x-ms-enum": { + "name": "SkuReplicationMode", + "modelAsString": true + } + }, + "SqlAssessedNetworkAdapter": { + "type": "object", + "description": "SQL Assessed Network Adapter.", + "properties": { + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability." + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureNetworkAdapterSuitabilityDetail", + "description": "Gets the suitability detail." + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureNetworkAdapterSuitabilityExplanation", + "description": "Gets the suitability explanation." + }, + "monthlyBandwidthCosts": { + "type": "number", + "format": "float", + "description": "Gets the monthly bandwidth costs." + }, + "netGigabytesTransmittedPerMonth": { + "type": "number", + "format": "float", + "description": "Gets the net gigabytes transmitted per month." + }, + "name": { + "type": "string", + "description": "Gets the name." + }, + "displayName": { + "type": "string", + "description": "Gets the display name." + }, + "macAddress": { + "type": "string", + "description": "Gets the mac address." + }, + "ipAddresses": { + "type": "array", + "description": "Gets the ip addresses.", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "megabytesPerSecondReceived": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second received." + }, + "megabytesPerSecondTransmitted": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second transmitted." + } + } + }, + "SqlAssessmentMigrationIssue": { + "type": "object", + "description": "Class representing the SQL migration issues.", + "properties": { + "issueId": { + "type": "string", + "description": "Gets the issue id.", + "readOnly": true + }, + "issueCategory": { + "$ref": "#/definitions/SqlAssessmentMigrationIssueCategory", + "description": "Gets the issue category.", + "readOnly": true + }, + "impactedObjects": { + "type": "array", + "description": "Gets the list of impacted objects.", + "items": { + "$ref": "#/definitions/ImpactedAssessmentObject" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlAssessmentMigrationIssueCategory": { + "type": "string", + "enum": [ + "Issue", + "Warning", + "Internal" + ], + "x-ms-enum": { + "name": "SqlAssessmentMigrationIssueCategory", + "modelAsString": true + } + }, + "SqlAssessmentOptions": { + "type": "object", + "description": "SQL Assessment options web model object.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlAssessmentOptionsProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlAssessmentOptionsListResult": { + "type": "object", + "description": "The response of a SqlAssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlAssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/SqlAssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlAssessmentOptionsProperties": { + "type": "object", + "description": "SQL Assessment options properties Web model object.", + "properties": { + "vmFamilies": { + "type": "array", + "description": "Gets the list of VM families.", + "items": { + "$ref": "#/definitions/VmFamilyOptions" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "reservedInstanceVmFamilies": { + "type": "array", + "description": "Gets the Reserved Instance VM Families list.", + "items": { + "$ref": "#/definitions/AzureVmFamily" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "premiumDiskVmFamilies": { + "type": "array", + "description": "Gets the Premium disk VM Families list.", + "items": { + "$ref": "#/definitions/AzureVmFamily" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "savingsPlanVmFamilies": { + "type": "array", + "description": "Gets or sets the Premium disk VM Families list.", + "items": { + "$ref": "#/definitions/AzureVmFamily" + }, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedLocations": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Saving Plans for IAAS.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedLocationsForPaas": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Saving Plans for PAAS.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedLocationsForIaas": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Reserved Instances for IAAS.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedOffers": { + "type": "array", + "description": "Gets or sets the list of Azure Offers supporting Saving Plans.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + }, + "x-ms-identifiers": [] + }, + "sqlSkus": { + "type": "array", + "description": "Gets or sets the list of SQL target SKU properties for dropdowns.", + "items": { + "$ref": "#/definitions/SqlPaaSTargetOptions" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSqlTargets": { + "type": "array", + "description": "Gets or sets the Reserved Instance SQL target types.", + "items": { + "$ref": "#/definitions/TargetType" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedLocations": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedCurrencies": { + "type": "array", + "description": "Gets or sets the list of currencies supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureCurrency" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedOffers": { + "type": "array", + "description": "Gets or sets the list of offers supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + }, + "x-ms-identifiers": [] + }, + "supportedOffers": { + "type": "array", + "description": "Gets or sets the list of offers supported for SQL assessments.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + }, + "x-ms-identifiers": [] + } + } + }, + "SqlAssessmentV2": { + "type": "object", + "description": "SQL Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlAssessmentV2Properties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlAssessmentV2IaasSuitabilityData": { + "type": "object", + "description": "Class representing Azure SQL IAAS suitability details.", + "properties": { + "azureSqlSku": { + "$ref": "#/definitions/AzureSqlIaasSkuDTO", + "description": "Gets the azure SQL IAAS SKU.", + "readOnly": true + }, + "replicaAzureSqlSku": { + "type": "array", + "description": "Gets the replica azure SQL IAAS SKU.", + "items": { + "$ref": "#/definitions/AzureSqlIaasSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharedResources": { + "$ref": "#/definitions/SharedResourcesDTO", + "description": "Gets the shared resources.", + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly compute cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Gets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "x-ms-identifiers": [] + }, + "securitySuitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability for Microsoft cloud defender.", + "readOnly": true + }, + "shouldProvisionReplicas": { + "type": "boolean", + "description": "Gets a value indicating whether replicas should be provisioned.", + "readOnly": true + }, + "skuReplicationMode": { + "$ref": "#/definitions/SkuReplicationMode", + "description": "Gets the replication mode.", + "readOnly": true + }, + "migrationGuidelines": { + "type": "array", + "description": "Gets the list of migration guidelines applicable to this target.", + "items": { + "$ref": "#/definitions/SqlMigrationGuideline" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendationReasonings": { + "type": "array", + "description": "Gets the list of SQL recommendation Reasoning.", + "items": { + "$ref": "#/definitions/SqlRecommendationReasoning" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "migrationTargetPlatform": { + "$ref": "#/definitions/TargetType", + "description": "Gets the migration target platform.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the azure suitability.", + "readOnly": true + }, + "migrationIssues": { + "type": "array", + "description": "Gets the list of migrations issues.", + "items": { + "$ref": "#/definitions/SqlAssessmentMigrationIssue" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlAssessmentV2ListResult": { + "type": "object", + "description": "The response of a SqlAssessmentV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlAssessmentV2 items on this page", + "items": { + "$ref": "#/definitions/SqlAssessmentV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlAssessmentV2PaasSuitabilityData": { + "type": "object", + "description": "Class representing Azure SQL PAAS suitability details.", + "properties": { + "azureSqlSku": { + "$ref": "#/definitions/AzureSqlPaasSkuDTO", + "description": "Gets the azure SQL PAAS SKU.", + "readOnly": true + }, + "replicaAzureSqlSku": { + "type": "array", + "description": "Gets the replica azure SQL PAAS SKU.", + "items": { + "$ref": "#/definitions/AzureSqlPaasSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharedResources": { + "$ref": "#/definitions/SharedResourcesDTO", + "description": "Gets the shared resources.", + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly compute cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Gets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "x-ms-identifiers": [] + }, + "securitySuitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability for Microsoft cloud defender.", + "readOnly": true + }, + "shouldProvisionReplicas": { + "type": "boolean", + "description": "Gets a value indicating whether replicas should be provisioned.", + "readOnly": true + }, + "skuReplicationMode": { + "$ref": "#/definitions/SkuReplicationMode", + "description": "Gets the replication mode.", + "readOnly": true + }, + "migrationGuidelines": { + "type": "array", + "description": "Gets the list of migration guidelines applicable to this target.", + "items": { + "$ref": "#/definitions/SqlMigrationGuideline" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendationReasonings": { + "type": "array", + "description": "Gets the list of SQL recommendation Reasoning.", + "items": { + "$ref": "#/definitions/SqlRecommendationReasoning" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "migrationTargetPlatform": { + "$ref": "#/definitions/TargetType", + "description": "Gets the migration target platform.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the azure suitability.", + "readOnly": true + }, + "migrationIssues": { + "type": "array", + "description": "Gets the list of migrations issues.", + "items": { + "$ref": "#/definitions/SqlAssessmentMigrationIssue" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlAssessmentV2Properties": { + "type": "object", + "description": "SQL assessment properties class.", + "properties": { + "osLicense": { + "$ref": "#/definitions/OsLicense", + "description": "Gets or sets user configurable setting to display the azure hybrid use benefit." + }, + "environmentType": { + "$ref": "#/definitions/EnvironmentType", + "description": "Gets or sets user configurable setting to display the environment type." + }, + "entityUptime": { + "$ref": "#/definitions/EntityUptime", + "description": "Gets or sets the duration for which the entity (SQL, VMs) are up in the\non-premises environment." + }, + "optimizationLogic": { + "$ref": "#/definitions/OptimizationLogic", + "description": "Gets or sets SQL optimization logic." + }, + "reservedInstanceForVm": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Gets or sets azure reserved instance for VM." + }, + "azureOfferCodeForVm": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Gets or sets Azure Offer Code for VM." + }, + "eaSubscriptionId": { + "type": "string", + "description": "Gets or sets the Enterprise agreement subscription id." + }, + "azureSqlManagedInstanceSettings": { + "$ref": "#/definitions/SqlMiSettings", + "description": "Gets or sets user configurable SQL managed instance settings." + }, + "azureSqlDatabaseSettings": { + "$ref": "#/definitions/SqlDbSettings", + "description": "Gets or sets user configurable SQL database settings." + }, + "azureSqlVmSettings": { + "$ref": "#/definitions/SqlVmSettings", + "description": "Gets or sets user configurable SQL VM settings." + }, + "multiSubnetIntent": { + "$ref": "#/definitions/MultiSubnetIntent", + "description": "Gets or sets user preference indicating intent of multi-subnet configuration." + }, + "asyncCommitModeIntent": { + "$ref": "#/definitions/AsyncCommitModeIntent", + "description": "Gets or sets user preference indicating intent of async commit mode." + }, + "isInternetAccessAvailable": { + "type": "boolean", + "description": "Gets or sets a value indicating whether internet access is available." + }, + "disasterRecoveryLocation": { + "$ref": "#/definitions/AzureLocation", + "description": "Gets or sets the Azure Location or Azure region where to which the machines\nwill be migrated." + }, + "enableHadrAssessment": { + "type": "boolean", + "description": "Gets or sets a value indicating whether HADR assessments needs to be created." + }, + "azureSecurityOfferingType": { + "$ref": "#/definitions/AzureSecurityOfferingType", + "description": "Gets or sets a value indicating azure security offering type." + }, + "reservedInstance": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Reserved instance." + }, + "sqlServerLicense": { + "$ref": "#/definitions/SqlServerLicense", + "description": "SQL server license." + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "Gets the group type for the assessment." + }, + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Assessment type of the assessment." + }, + "azureLocation": { + "type": "string", + "description": "Azure Location or Azure region where to which the machines will be migrated." + }, + "azureOfferCode": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Azure Offer Code." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Currency in which prices should be reported." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Percentage of buffer that user wants on performance metrics when recommending\nAzure sizes." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Percentile of the utilization data values to be considered while assessing\nmachines." + }, + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Time Range for which the historic utilization data should be considered for\nassessment." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time to consider performance data for assessment." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time to consider performance data for assessment." + }, + "stage": { + "$ref": "#/definitions/AssessmentStage", + "description": "User configurable setting to display the Stage of Assessment.", + "readOnly": true + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Custom discount percentage." + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion." + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage." + }, + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last time when rates were queried.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Whether assessment is in valid state and all machines have been assessed.", + "readOnly": true + }, + "schemaVersion": { + "type": "string", + "description": "Schema version.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "SqlAssessmentV2Summary": { + "type": "object", + "description": "SQL Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlAssessmentV2SummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlAssessmentV2SummaryData": { + "type": "object", + "description": "SQL Assessment V2 summary data.", + "properties": { + "suitabilitySummary": { + "type": "object", + "description": "Sql assessment summary data", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Monthly compute cost", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly storage cost", + "readOnly": true + }, + "monthlyLicenseCost": { + "type": "number", + "format": "float", + "description": "Monthly license cost", + "readOnly": true + }, + "confidenceScore": { + "type": "number", + "format": "float", + "description": "Confidence Rating", + "readOnly": true + }, + "monthlySecurityCost": { + "type": "number", + "format": "float", + "description": "Monthly security cost", + "readOnly": true + } + } + }, + "SqlAssessmentV2SummaryListResult": { + "type": "object", + "description": "The response of a SqlAssessmentV2Summary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlAssessmentV2Summary items on this page", + "items": { + "$ref": "#/definitions/SqlAssessmentV2Summary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlAssessmentV2SummaryProperties": { + "type": "object", + "description": "SQL Assessment V2 summary properties.", + "properties": { + "assessmentSummary": { + "type": "object", + "description": "Gets or sets the Assessment summary.", + "additionalProperties": { + "$ref": "#/definitions/SqlAssessmentV2SummaryData" + }, + "readOnly": true + }, + "distributionBySupportStatus": { + "type": "object", + "description": "Gets the distribution of sqlInstances by support status.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionByServicePackInsight": { + "type": "object", + "description": "Gets the distribution distribution of sqlInstances by service pack insight.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionBySqlVersion": { + "type": "object", + "description": "Gets the distribution of sqlInstances by sql version.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionBySqlEdition": { + "type": "object", + "description": "Gets the distribution of sqlInstances by sql edition.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "instanceDistributionBySizingCriterion": { + "type": "object", + "description": "Gets the instance distribution by sizing criterion.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "databaseDistributionBySizingCriterion": { + "type": "object", + "description": "Gets the database distribution by sizing criterion.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Number of machines part of the assessment.", + "readOnly": true + }, + "numberOfSqlInstances": { + "type": "integer", + "format": "int32", + "description": "Number of sql instances part of the assessment.", + "readOnly": true + }, + "numberOfSuccessfullyDiscoveredSqlInstances": { + "type": "integer", + "format": "int32", + "description": "Number of successfully discovered sql instances part of the assessment.", + "readOnly": true + }, + "numberOfSqlDatabases": { + "type": "integer", + "format": "int32", + "description": "Number of sql databases part of the assessment.", + "readOnly": true + }, + "numberOfFciInstances": { + "type": "integer", + "format": "int32", + "description": "Number of sql failover cluster instances part of the assessment.", + "readOnly": true + }, + "numberOfSqlAvailabilityGroups": { + "type": "integer", + "format": "int32", + "description": "Number of sql availability groups part of the assessment.", + "readOnly": true + } + } + }, + "SqlAvailabilityGroupDataOverview": { + "type": "object", + "description": "Assessed Sql Availability Group Data Overview.", + "properties": { + "availabilityGroupId": { + "type": "string", + "description": "Gets the availability group id." + }, + "availabilityGroupName": { + "type": "string", + "description": "Gets the availability group name." + }, + "sqlAvailabilityGroupSdsArmId": { + "type": "string", + "description": "Gets the availability group arm id." + }, + "sqlAvailabilityGroupEntityId": { + "type": "string", + "description": "Gets the availability group entity id." + }, + "sqlAvailabilityReplicaId": { + "type": "string", + "description": "Gets the availability replica id." + } + } + }, + "SqlAvailabilityReplicaSummary": { + "type": "object", + "description": "Assessed Sql Availability Replica Summary.", + "properties": { + "numberOfSynchronousReadReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of synchronous read replicas." + }, + "numberOfSynchronousNonReadReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of synchronous non read replicas." + }, + "numberOfAsynchronousReadReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of asynchronous read replicas." + }, + "numberOfAsynchronousNonReadReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of asynchronous non read replicas." + }, + "numberOfPrimaryReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of primary replicas." + } + } + }, + "SqlCollector": { + "type": "object", + "description": "The SQL collector REST object.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBaseWithAgent", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlCollectorListResult": { + "type": "object", + "description": "The response of a SqlCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlCollector items on this page", + "items": { + "$ref": "#/definitions/SqlCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlDbSettings": { + "type": "object", + "description": "SQL database assessment settings.", + "properties": { + "azureSqlServiceTier": { + "$ref": "#/definitions/AzureSqlServiceTier", + "description": "Gets or sets the azure SQL service tier." + }, + "azureSqlDataBaseType": { + "$ref": "#/definitions/AzureSqlDataBaseType", + "description": "Gets or sets the azure PAAS SQL instance type." + }, + "azureSqlComputeTier": { + "$ref": "#/definitions/ComputeTier", + "description": "Gets or sets the azure SQL compute tier." + }, + "azureSqlPurchaseModel": { + "$ref": "#/definitions/AzureSqlPurchaseModel", + "description": "Gets or sets the azure SQL purchase model." + } + } + }, + "SqlFCIMetadata": { + "type": "object", + "description": "Sql fci meta data.", + "properties": { + "state": { + "$ref": "#/definitions/SqlFCIMetadataState", + "description": "Gets the Sql fci meta data state." + }, + "isMultiSubnet": { + "type": "boolean", + "description": "Gets whether fci is multi subnet." + }, + "fciSharedDiskCount": { + "type": "integer", + "format": "int32", + "description": "Gets the fci shared disk count." + } + } + }, + "SqlFCIMetadataState": { + "type": "string", + "enum": [ + "Unknown", + "Inherited", + "Initializing", + "Online", + "Offline", + "Failed", + "Pending", + "OnlinePending", + "OfflinePending" + ], + "x-ms-enum": { + "name": "SqlFCIMetadataState", + "modelAsString": true + } + }, + "SqlFCIState": { + "type": "string", + "enum": [ + "Unknown", + "Active", + "Passive", + "NotApplicable" + ], + "x-ms-enum": { + "name": "SqlFCIState", + "modelAsString": true + } + }, + "SqlMiSettings": { + "type": "object", + "description": "SQL managed instance assessment settings.", + "properties": { + "azureSqlServiceTier": { + "$ref": "#/definitions/AzureSqlServiceTier", + "description": "Gets or sets the azure SQL service tier." + }, + "azureSqlInstanceType": { + "$ref": "#/definitions/AzureSqlInstanceType", + "description": "Gets or sets the azure PAAS SQL instance type." + } + } + }, + "SqlMigrationGuideline": { + "type": "object", + "description": "Sql Migration Guideline.", + "properties": { + "guidelineId": { + "type": "string", + "description": "Gets the guideline id." + }, + "migrationGuidelineCategory": { + "$ref": "#/definitions/SqlMigrationGuidelineCategory", + "description": "Gets the migration guideline category." + }, + "migrationGuidelineContext": { + "type": "array", + "description": "Gets the migration guideline context.", + "items": { + "$ref": "#/definitions/MigrationGuidelineContext" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlMigrationGuidelineCategory": { + "type": "string", + "enum": [ + "Unknown", + "General", + "FailoverCluterInstanceGuideLine", + "AvailabilityGroupGuideline" + ], + "x-ms-enum": { + "name": "SqlMigrationGuidelineCategory", + "modelAsString": true + } + }, + "SqlPaaSTargetOptions": { + "type": "object", + "description": "SQL target options.", + "properties": { + "computeTier": { + "$ref": "#/definitions/ComputeTier", + "description": "Gets or sets the Azure SQL compute tier." + }, + "hardwareGeneration": { + "$ref": "#/definitions/HardwareGeneration", + "description": "Gets or sets the Azure SQL hardware generation." + }, + "targetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets or sets the Azure SQL target type." + }, + "serviceTier": { + "$ref": "#/definitions/AzureSqlServiceTier", + "description": "Gets or sets the Azure SQL service tier." + }, + "targetLocations": { + "type": "array", + "description": "Gets or sets the target location.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + } + } + }, + "SqlRecommendationReasoning": { + "type": "object", + "description": "Class representing Azure SQL Recommendation Reasoning.", + "properties": { + "reasoningId": { + "type": "string", + "description": "Gets the reasoning id." + }, + "reasoningString": { + "type": "string", + "description": "Gets the reasoning status." + }, + "reasoningCategory": { + "type": "string", + "description": "Gets the reasoning category." + }, + "contextParameters": { + "type": "array", + "description": "Gets the Sql recommended reasoning parameters.", + "items": { + "$ref": "#/definitions/SqlRecommendationReasoningContext" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlRecommendationReasoningContext": { + "type": "object", + "description": "Class representing Azure SQL Recommendation Reasoning Context.", + "properties": { + "contextKey": { + "type": "string", + "description": "Gets the reasoning context key." + }, + "contextValue": { + "type": "string", + "description": "Gets the reasoning context value." + } + } + }, + "SqlServerLicense": { + "type": "string", + "enum": [ + "Unknown", + "Yes", + "No" + ], + "x-ms-enum": { + "name": "SqlServerLicense", + "modelAsString": true + } + }, + "SqlServerLicenseType": { + "type": "string", + "description": "Business case supported SQL Server License types.", + "enum": [ + "Unknown", + "Enterprise", + "Standard" + ], + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Sql Server License." + }, + { + "name": "Enterprise", + "value": "Enterprise", + "description": "Enterprise Sql Server License." + }, + { + "name": "Standard", + "value": "Standard", + "description": "Standard Sql Server License." + } + ] + } + }, + "SqlServerLicensingSettings": { + "type": "object", + "description": "SQL Server licensing settings.", + "properties": { + "version": { + "$ref": "#/definitions/SqlServerLicenseType", + "description": "SQL Server version." + }, + "licenseCost": { + "type": "number", + "format": "float", + "description": "Licence cost." + }, + "softwareAssuranceCost": { + "type": "number", + "format": "float", + "description": "Software assurance (SA) cost." + } + }, + "required": [ + "version", + "licenseCost", + "softwareAssuranceCost" + ] + }, + "SqlServiceTier": { + "type": "object", + "description": "The SQL service tier.", + "properties": { + "serviceTierName": { + "type": "string", + "description": "The service tier name.", + "readOnly": true + }, + "serviceTierNumber": { + "type": "number", + "format": "float", + "description": "The number of sql entities with this tier.", + "readOnly": true + } + } + }, + "SqlVersionDetails": { + "type": "object", + "description": "The SQL version details.", + "properties": { + "sqlVersion": { + "type": "string", + "description": "The SQL version.", + "readOnly": true + }, + "numberOfInstances": { + "type": "integer", + "format": "int32", + "description": "Number of instances with the above SQL version.", + "readOnly": true + } + } + }, + "SqlVmSettings": { + "type": "object", + "description": "SQL VM assessment settings.", + "properties": { + "instanceSeries": { + "type": "array", + "description": "Gets or sets the Azure VM families (calling instance series to keep it\nconsistent with other targets).", + "items": { + "$ref": "#/definitions/AzureVmFamily" + }, + "x-ms-identifiers": [] + } + } + }, + "StorageSettings": { + "type": "object", + "description": "Storage settings.", + "properties": { + "costPerGbPerMonth": { + "type": "number", + "format": "float", + "description": "Cost per gigabyte per month." + }, + "maintainanceCostPercentageToAcquisitionCost": { + "type": "number", + "format": "float", + "description": "Maintenance cost percentage.", + "minimum": 0, + "maximum": 100 + } + }, + "required": [ + "costPerGbPerMonth", + "maintainanceCostPercentageToAcquisitionCost" + ] + }, + "SuggestedMigrationTool": { + "type": "string", + "description": "Suggested Migration Tool for Azure.", + "enum": [ + "None", + "WebAppMigration", + "ServerMigration" + ], + "x-ms-enum": { + "name": "SuggestedMigrationTool", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "No Migration Tool is suggested." + }, + { + "name": "WebAppMigration", + "value": "WebAppMigration", + "description": "Web App Migration." + }, + { + "name": "ServerMigration", + "value": "ServerMigration", + "description": "Server Migration." + } + ] + } + }, + "Suitability": { + "type": "string", + "description": "Suitability for Azure.", + "enum": [ + "NotSuitable", + "Suitable" + ], + "x-ms-enum": { + "name": "Suitability", + "modelAsString": true, + "values": [ + { + "name": "NotSuitable", + "value": "NotSuitable", + "description": "Not Suitable for Azure." + }, + { + "name": "Suitable", + "value": "Suitable", + "description": "Suitable for Azure." + } + ] + } + }, + "SuitabilityResult": { + "type": "object", + "description": "Data model of Suitability Result.", + "properties": { + "readiness": { + "$ref": "#/definitions/Readiness", + "description": "Gets readiness.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/Suitability", + "description": "Gets suitability.", + "readOnly": true + }, + "failedChecks": { + "type": "array", + "description": "Gets list of failed Checks.", + "items": { + "$ref": "#/definitions/Check" + }, + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] + }, + "suggestedMigrationTool": { + "$ref": "#/definitions/SuggestedMigrationTool", + "description": "Gets suggested migration tool.", + "readOnly": true + } + }, + "required": [ + "readiness", + "suitability", + "failedChecks", + "suggestedMigrationTool" + ] + }, + "SummaryDetails": { + "type": "object", + "description": "Data model of Summary Details.", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "Gets count.", + "readOnly": true + }, + "monthlyCost": { + "type": "number", + "format": "float", + "description": "Gets monthly cost.", + "readOnly": true + } + }, + "required": [ + "count", + "monthlyCost" + ] + }, + "SummaryPropertiesBase": { + "type": "object", + "description": "Base ARM model of Assessment Summary ARM properties.", + "properties": { + "assessmentName": { + "type": "string", + "description": "Gets the assessment name.", + "readOnly": true + }, + "summaryName": { + "type": "string", + "description": "Gets the summary name.", + "readOnly": true + }, + "suitabilityPerTarget": { + "type": "object", + "description": "Gets the cloud suitability summary for all entities in the assessment per target.", + "additionalProperties": { + "$ref": "#/definitions/RecordOfInt" + }, + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly compute cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost.", + "readOnly": true + }, + "confidenceScore": { + "type": "number", + "format": "float", + "description": "Gets the confidence score.", + "readOnly": true + } + }, + "required": [ + "assessmentName", + "summaryName", + "suitabilityPerTarget", + "monthlyComputeCost", + "monthlyStorageCost", + "confidenceScore" + ] + }, + "SupportStatusDistribution": { + "type": "object", + "description": "Support Status Distribution.", + "properties": { + "unknownSupport": { + "type": "integer", + "format": "int32", + "description": "Unknown support.", + "readOnly": true + }, + "mainStream": { + "type": "integer", + "format": "int32", + "description": "Mainstream support.", + "readOnly": true + }, + "extended": { + "type": "integer", + "format": "int32", + "description": "Extended support.", + "readOnly": true + }, + "outOfSupport": { + "type": "integer", + "format": "int32", + "description": "Out of support.", + "readOnly": true + } + } + }, + "SupportabilityStatus": { + "type": "string", + "description": "Supportability Status.", + "enum": [ + "Unknown", + "Mainstream", + "Extended", + "OutOfSupport" + ], + "x-ms-enum": { + "name": "SupportabilityStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Supportability Status." + }, + { + "name": "Mainstream", + "value": "Mainstream", + "description": "Mainstream Supportability Status." + }, + { + "name": "Extended", + "value": "Extended", + "description": "Extended Supportability Status." + }, + { + "name": "OutOfSupport", + "value": "OutOfSupport", + "description": "OutOfSupport Supportability Status." + } + ] + } + }, + "TargetSpecificResult": { + "type": "object", + "description": "Target specific result.", + "properties": { + "assessmentResult": { + "$ref": "#/definitions/AssessmentResult", + "description": "Gets or sets the assessment result." + }, + "migrationIssues": { + "type": "array", + "description": "Gets or sets the web app migration issues.", + "items": { + "$ref": "#/definitions/WebAppMigrationIssues" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "assessmentResult", + "migrationIssues" + ] + }, + "TargetSpecificSummary": { + "type": "object", + "description": "Web app target specific summary data.", + "properties": { + "readinessSummary": { + "type": "object", + "description": "Web app readiness summary data", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "recommendationResultSkuDetails": { + "type": "object", + "description": "Web app recommendation sku details data", + "additionalProperties": { + "$ref": "#/definitions/WebAppSkuDetails" + }, + "readOnly": true + } + } + }, + "TargetType": { + "type": "string", + "enum": [ + "Unknown", + "Recommended", + "AzureSqlDatabase", + "AzureSqlManagedInstance", + "AzureSqlVirtualMachine", + "AzureVirtualMachine" + ], + "x-ms-enum": { + "name": "TargetType", + "modelAsString": true + } + }, + "ThirdPartyManagementSettings": { + "type": "object", + "description": "Third Party Management settings.", + "properties": { + "licenseCost": { + "type": "number", + "format": "float", + "description": "License Cost." + }, + "supportCost": { + "type": "number", + "format": "float", + "description": "Support Cost." + } + }, + "required": [ + "licenseCost", + "supportCost" + ] + }, + "TimeRange": { + "type": "string", + "description": "Time Range for Performance Data.", + "enum": [ + "Day", + "Week", + "Month", + "Custom" + ], + "x-ms-enum": { + "name": "TimeRange", + "modelAsString": true, + "values": [ + { + "name": "Day", + "value": "Day", + "description": "Daily." + }, + { + "name": "Week", + "value": "Week", + "description": "Weekly." + }, + { + "name": "Month", + "value": "Month", + "description": "Monthly." + }, + { + "name": "Custom", + "value": "Custom", + "description": "Custom Time Range." + } + ] + } + }, + "UltraDiskAssessmentOptions": { + "type": "object", + "description": "Assessment options for Ultra disk type.", + "properties": { + "familyName": { + "type": "string", + "description": "Family name." + }, + "targetLocations": { + "type": "array", + "description": "List of locations where ultra disk is supported for this VMfamily.", + "items": { + "type": "string" + } + } + } + }, + "UpdateGroupBody": { + "type": "object", + "description": "Properties of group update.", + "properties": { + "eTag": { + "type": "string", + "description": "For optimistic concurrency control." + }, + "properties": { + "$ref": "#/definitions/GroupBodyProperties", + "description": "Properties of the group." + } + } + }, + "UtilizationData": { + "type": "object", + "description": "The SQL on premises utilization insights.", + "properties": { + "numberOfActiveEntities": { + "type": "integer", + "format": "int32", + "description": "The number of active entities.", + "readOnly": true + }, + "numberOfInactiveEntities": { + "type": "integer", + "format": "int32", + "description": "The number of inactive entities.", + "readOnly": true + }, + "numberOfDecommisionEntities": { + "type": "integer", + "format": "int32", + "description": "The number of decommission entities.", + "readOnly": true + }, + "numberOfUnknownEntities": { + "type": "integer", + "format": "int32", + "description": "The number of unknown entities.", + "readOnly": true + } + } + }, + "VirtualizationSoftwareSettings": { + "type": "object", + "description": "Virtualization software settings.", + "properties": { + "numberOfPhysicalCoresPerLicense": { + "type": "integer", + "format": "int32", + "description": "Number of physical cores per licence.", + "minimum": 1 + }, + "softwareAssuranceCost": { + "type": "number", + "format": "float", + "description": "Software Assurance cost." + }, + "licenseAndSupportList": { + "type": "array", + "description": "Licence and support list.", + "items": { + "$ref": "#/definitions/VsphereLicense" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "numberOfPhysicalCoresPerLicense", + "softwareAssuranceCost", + "licenseAndSupportList" + ] + }, + "VmFamilyOptions": { + "type": "object", + "description": "VM family name, the list of targeted azure locations and the category of the\nfamily.", + "properties": { + "familyName": { + "type": "string", + "description": "Name of the VM family.", + "readOnly": true + }, + "targetLocations": { + "type": "array", + "description": "List of Azure regions.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "category": { + "type": "array", + "description": "Category of the VM family.", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "VmUptime": { + "type": "object", + "description": "Details on the total up-time for the VM.", + "properties": { + "daysPerMonth": { + "type": "integer", + "format": "int32", + "description": "Number of days in a month for VM uptime." + }, + "hoursPerDay": { + "type": "integer", + "format": "int32", + "description": "Number of hours per day for VM uptime." + } + } + }, + "VmwareCollector": { + "type": "object", + "description": "VMware collector resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBaseWithAgent", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "VmwareCollectorListResult": { + "type": "object", + "description": "The response of a VmwareCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VmwareCollector items on this page", + "items": { + "$ref": "#/definitions/VmwareCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VsphereLicense": { + "type": "object", + "description": "Representation of a vsphere licence.", + "properties": { + "licenseType": { + "$ref": "#/definitions/LicenseType", + "description": "VSphere licence type." + } + }, + "required": [ + "licenseType" + ], + "allOf": [ + { + "$ref": "#/definitions/VsphereLicenseBase" + } + ] + }, + "VsphereLicenseBase": { + "type": "object", + "description": "Representation of a vsphere licence base.", + "properties": { + "licenseCost": { + "type": "number", + "format": "float", + "description": "Cost of a licence." + }, + "basicSupportCost": { + "type": "number", + "format": "float", + "description": "Basic support cost." + }, + "productionSupportCost": { + "type": "number", + "format": "float", + "description": "Production support cost." + } + }, + "required": [ + "licenseCost", + "basicSupportCost", + "productionSupportCost" + ] + }, + "VsphereManagementLicense": { + "type": "object", + "description": "Representation of a vsphere management licence.", + "properties": { + "licenseType": { + "$ref": "#/definitions/VsphereManagementLicenseType", + "description": "VSphere licence type." + } + }, + "required": [ + "licenseType" + ], + "allOf": [ + { + "$ref": "#/definitions/VsphereLicenseBase" + } + ] + }, + "VsphereManagementLicenseType": { + "type": "string", + "description": "Business case supported Vsphere Management License types.", + "enum": [ + "Unknown", + "VSphereServerStandard" + ], + "x-ms-enum": { + "name": "VsphereManagementLicenseType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown License." + }, + { + "name": "VSphereServerStandard", + "value": "VSphereServerStandard", + "description": "VSphereServerStandard License." + } + ] + } + }, + "VsphereManagementSettings": { + "type": "object", + "description": "Vsphere management settings.", + "properties": { + "licenseAndSupportList": { + "type": "array", + "description": "Licence and support list.", + "items": { + "$ref": "#/definitions/VsphereManagementLicense" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "licenseAndSupportList" + ] + }, + "WebApp": { + "type": "object", + "description": "Data model of Web App.", + "properties": { + "discoveryArmId": { + "type": "string", + "description": "Gets discovery arm id.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets display name.", + "readOnly": true + }, + "webServerArmId": { + "type": "string", + "description": "Gets web server arm id.", + "readOnly": true + }, + "webServerDisplayName": { + "type": "string", + "description": "Gets web server display name.", + "readOnly": true + }, + "machineArmId": { + "type": "string", + "description": "Gets machine arm id.", + "readOnly": true + }, + "machineDisplayName": { + "type": "string", + "description": "Gets machine display name.", + "readOnly": true + }, + "webAppType": { + "$ref": "#/definitions/WebAppType", + "description": "Gets web app type.", + "readOnly": true + } + }, + "required": [ + "discoveryArmId", + "displayName", + "webServerArmId", + "webServerDisplayName", + "machineArmId", + "machineDisplayName", + "webAppType" + ] + }, + "WebAppAssessmentOptions": { + "type": "object", + "description": "Web app Assessment options web model object.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppAssessmentOptionsProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppAssessmentOptionsListResult": { + "type": "object", + "description": "The response of a WebAppAssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppAssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/WebAppAssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppAssessmentOptionsProperties": { + "type": "object", + "description": "Web app Assessment options properties Web model object.", + "properties": { + "webAppSkus": { + "type": "array", + "description": "Gets the list of web app target options.", + "items": { + "$ref": "#/definitions/WebAppTargetOptions" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedLocations": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Saving Plans for IAAS.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedLocations": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedCurrencies": { + "type": "array", + "description": "Gets or sets the list of currencies supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureCurrency" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedOffers": { + "type": "array", + "description": "Gets or sets the list of offers supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedWebAppTiers": { + "type": "array", + "description": "Gets or sets the list of currencies supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureWebAppTier" + }, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedWebAppTiers": { + "type": "array", + "description": "Gets or sets the list of Azure Offers supporting Saving Plans.", + "items": { + "$ref": "#/definitions/AzureWebAppTier" + }, + "x-ms-identifiers": [] + } + } + }, + "WebAppAssessmentV2": { + "type": "object", + "description": "Web app Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppAssessmentV2Properties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppAssessmentV2ListResult": { + "type": "object", + "description": "The response of a WebAppAssessmentV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppAssessmentV2 items on this page", + "items": { + "$ref": "#/definitions/WebAppAssessmentV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppAssessmentV2Properties": { + "type": "object", + "description": "Web app assessment properties class.", + "properties": { + "environmentType": { + "$ref": "#/definitions/EnvironmentType", + "description": "Gets or sets user configurable setting to display the environment type." + }, + "entityUptime": { + "$ref": "#/definitions/EntityUptime", + "description": "Gets or sets the duration for which the entity (Web app, VMs) are up in the\non-premises environment." + }, + "eaSubscriptionId": { + "type": "string", + "description": "Gets or sets the Enterprise agreement subscription id." + }, + "appSvcNativeSettings": { + "$ref": "#/definitions/AppSvcNativeSettings", + "description": "Gets or sets user configurable app service native settings." + }, + "appSvcContainerSettings": { + "$ref": "#/definitions/AppSvcContainerSettings", + "description": "Gets or sets user configurable app service container database settings." + }, + "discoveredEntityLightSummary": { + "$ref": "#/definitions/DiscoveredEntityLightSummary", + "description": "Gets or sets user configurable discovered entity settings." + }, + "azureSecurityOfferingType": { + "$ref": "#/definitions/AzureSecurityOfferingType", + "description": "Gets or sets a value indicating azure security offering type." + }, + "reservedInstance": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Reserved instance." + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "Gets the group type for the assessment." + }, + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Assessment type of the assessment." + }, + "azureLocation": { + "type": "string", + "description": "Azure Location or Azure region where to which the machines will be migrated." + }, + "azureOfferCode": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Azure Offer Code." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Currency in which prices should be reported." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Percentage of buffer that user wants on performance metrics when recommending\nAzure sizes." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Percentile of the utilization data values to be considered while assessing\nmachines." + }, + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Time Range for which the historic utilization data should be considered for\nassessment." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time to consider performance data for assessment." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time to consider performance data for assessment." + }, + "stage": { + "$ref": "#/definitions/AssessmentStage", + "description": "User configurable setting to display the Stage of Assessment.", + "readOnly": true + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Custom discount percentage." + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion." + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage." + }, + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last time when rates were queried.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Whether assessment is in valid state and all machines have been assessed.", + "readOnly": true + }, + "schemaVersion": { + "type": "string", + "description": "Schema version.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties2" + } + ] + }, + "WebAppAssessmentV2Summary": { + "type": "object", + "description": "Web app Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppAssessmentV2SummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppAssessmentV2SummaryListResult": { + "type": "object", + "description": "The response of a WebAppAssessmentV2Summary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppAssessmentV2Summary items on this page", + "items": { + "$ref": "#/definitions/WebAppAssessmentV2Summary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppAssessmentV2SummaryProperties": { + "type": "object", + "description": "Web app Assessment V2 summary properties.", + "properties": { + "assessmentSummary": { + "type": "object", + "description": "Gets or sets the discovered entities summary.", + "additionalProperties": { + "$ref": "#/definitions/DiscoveredEntitiesSummary" + }, + "readOnly": true + }, + "targetSpecificSummary": { + "type": "object", + "description": "Gets the target specific summary.", + "additionalProperties": { + "$ref": "#/definitions/TargetSpecificSummary" + }, + "readOnly": true + } + } + }, + "WebAppCollector": { + "type": "object", + "description": "The web app collector REST object.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppCollectorPropertiesBaseWithAgent", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppCollectorListResult": { + "type": "object", + "description": "The response of a WebAppCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppCollector items on this page", + "items": { + "$ref": "#/definitions/WebAppCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppCollectorPropertiesBaseWithAgent": { + "type": "object", + "description": "Collector properties class.", + "properties": { + "agentProperties": { + "$ref": "#/definitions/CollectorAgentPropertiesBase", + "description": "Gets or sets the collector agent properties." + }, + "discoverySiteId": { + "type": "string", + "description": "Gets the discovery site id." + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets the Timestamp when collector was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Timestamp when collector was last updated.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties2" + } + ] + }, + "WebAppDistribution": { + "type": "object", + "description": "The app type distribution.", + "properties": { + "webAppType": { + "$ref": "#/definitions/WebAppTypes", + "description": "WebApp type.", + "readOnly": true + }, + "numberOfWebApps": { + "type": "number", + "format": "float", + "description": "The cost details.", + "readOnly": true + } + } + }, + "WebAppMigrationIssues": { + "type": "object", + "description": "Web app migration issues.", + "properties": { + "issueId": { + "type": "string", + "description": "Gets or sets the issue Id." + }, + "issueCategory": { + "$ref": "#/definitions/AzureWebAppSuitabilityIssueCategory", + "description": "Gets or sets the issue category." + }, + "issueDescriptionList": { + "type": "array", + "description": "Gets or sets the issue description list.", + "items": { + "type": "string" + } + } + }, + "required": [ + "issueId", + "issueCategory", + "issueDescriptionList" + ] + }, + "WebAppServicePlanV2": { + "type": "object", + "description": "Assessed Web app web model class.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppServicePlanV2Properties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppServicePlanV2ListResult": { + "type": "object", + "description": "The response of a WebAppServicePlanV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppServicePlanV2 items on this page", + "items": { + "$ref": "#/definitions/WebAppServicePlanV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppServicePlanV2Properties": { + "type": "object", + "description": "Assessed Web app database properties web model.", + "properties": { + "webAppType": { + "$ref": "#/definitions/WebAppType", + "description": "Gets or sets the web app type.", + "readOnly": true + }, + "webAppTargetType": { + "$ref": "#/definitions/AzureWebAppTargetType", + "description": "Gets or sets the target specific result.", + "readOnly": true + }, + "webAppServicePlanName": { + "type": "string", + "description": "Gets or sets the app service plan name.", + "readOnly": true + }, + "numberOfWebApps": { + "type": "integer", + "format": "int32", + "description": "Gets the machine name.", + "readOnly": true + }, + "monthlyCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the server ARM Id.", + "readOnly": true + }, + "storage": { + "type": "number", + "format": "double", + "description": "Gets or sets the web server name.", + "readOnly": true + }, + "scaleOutInstances": { + "type": "integer", + "format": "int32", + "description": "Gets or sets web app name.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "Gets the discovered web app ID.", + "readOnly": true + }, + "ram": { + "type": "number", + "format": "double", + "description": "Machine arm id.", + "readOnly": true + }, + "webAppSkuName": { + "type": "string", + "description": "Web app sku name.", + "readOnly": true + }, + "webAppSkuSize": { + "type": "string", + "description": "Web app sku size.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL database first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed Web app database last updated.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + }, + "required": [ + "webAppServicePlanName", + "numberOfWebApps" + ] + }, + "WebAppSkuDetails": { + "type": "object", + "description": "Web app sku details.", + "properties": { + "totalMonthlyCost": { + "type": "number", + "format": "float", + "description": "Total monthly cost", + "readOnly": true + }, + "monthlySecurityCost": { + "type": "number", + "format": "float", + "description": "Monthly security data", + "readOnly": true + }, + "skuName": { + "type": "string", + "description": "Sku name", + "readOnly": true + }, + "skuSize": { + "type": "string", + "description": "Sku size", + "readOnly": true + }, + "appServicePlanCount": { + "type": "integer", + "format": "int32", + "description": "App service plan count", + "readOnly": true + } + }, + "required": [ + "skuName", + "skuSize", + "appServicePlanCount" + ] + }, + "WebAppTargetOptions": { + "type": "object", + "description": "Web app target options.", + "properties": { + "webAppTier": { + "$ref": "#/definitions/AzureWebAppTier", + "description": "Gets or sets the Azure web app tier." + }, + "targetLocations": { + "type": "array", + "description": "Gets or sets the target location.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + } + } + }, + "WebAppTargetSku": { + "type": "object", + "description": "The Webapp target SKU with corresponding cost.", + "properties": { + "skuName": { + "type": "string", + "description": "The SKU name.", + "readOnly": true + }, + "cost": { + "type": "number", + "format": "float", + "description": "The cost details.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of service plans or node pools recommended.", + "readOnly": true + } + } + }, + "WebAppType": { + "type": "string", + "description": "Web App Type.", + "enum": [ + "Unknown", + "IIS", + "Tomcat" + ], + "x-ms-enum": { + "name": "WebAppType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates Missing Data." + }, + { + "name": "IIS", + "value": "IIS", + "description": "ASP.NET Web App." + }, + { + "name": "Tomcat", + "value": "Tomcat", + "description": "Java Web App." + } + ] + } + }, + "WebAppTypes": { + "type": "string", + "description": "Business case supported WebApp types.", + "enum": [ + "Unknown", + "ASPNET", + "Java" + ], + "x-ms-enum": { + "name": "WebAppTypes", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown WebApp Type." + }, + { + "name": "ASPNET", + "value": "ASPNET", + "description": "ASPNET Type." + }, + { + "name": "Java", + "value": "Java", + "description": "Java Tomcat Type." + } + ] + } + }, + "WindowsServerLicensingSettings": { + "type": "object", + "description": "Windows Server licensing settings.", + "properties": { + "licenseCost": { + "type": "number", + "format": "float", + "description": "Licence Cost." + }, + "softwareAssuranceCost": { + "type": "number", + "format": "float", + "description": "Software assurance (SA) cost." + }, + "licensesPerCore": { + "type": "integer", + "format": "int32", + "description": "Licenses per core." + } + }, + "required": [ + "licenseCost", + "softwareAssuranceCost", + "licensesPerCore" + ] + }, + "LinuxServerLicensingSettings": { + "type": "object", + "description": "Linux Server licensing settings.", + "properties": { + "licenseCost": { + "type": "number", + "format": "float", + "description": "Licence Cost." + } + }, + "required": [ + "licenseCost" + ] + }, + "WorkloadSummary": { + "type": "object", + "description": "Workload summary.", + "properties": { + "oracleInstances": { + "type": "integer", + "format": "int32", + "description": "Gets or sets oracle databases." + }, + "springApps": { + "type": "integer", + "format": "int32", + "description": "Gets or sets oracle databases." + } + } + }, + "YearOnYearEstimates": { + "type": "object", + "description": "Shows the year-on-year cost overall.", + "properties": { + "onPremisesCost": { + "type": "object", + "description": "Year-on-Year on-premises cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "azureCost": { + "type": "object", + "description": "Year-on-Year Azure cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "savings": { + "type": "object", + "description": "Year-on-Year savings.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "onPremisesCapexCost": { + "type": "object", + "description": "Year-on-Year on-premises capex cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "onPremisesOpexCost": { + "type": "object", + "description": "Year-on-Year on-premises opex cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "azureCapexCost": { + "type": "object", + "description": "Year-on-Year azure capex cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "azureOpexCost": { + "type": "object", + "description": "Year-on-Year azure opex cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "paybackPeriod": { + "type": "integer", + "format": "int32", + "description": "Payback period.", + "readOnly": true + } + } + } + }, + "parameters": {} +} diff --git a/specification/migrate/resource-manager/readme.md b/specification/migrate/resource-manager/readme.md index c0c31959e15f..54876c5524c4 100644 --- a/specification/migrate/resource-manager/readme.md +++ b/specification/migrate/resource-manager/readme.md @@ -20,6 +20,22 @@ batch: - tag: package-migrateengine-2022-05 ``` +### Tag: package-preview-2023-05 + +These settings apply only when `--tag=package-preview-2023-05` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-05' +input-file: + - Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/migrate.json +suppressions: + - code: AvoidAdditionalProperties + reason: Migrate feature is widely adopted and requires additionalProperties for these swagger properties. + - code: ProvisioningStateMustBeReadOnly + reason: The current swagger version only modifies the resources which do not have Provisioning states as readOnly and not introducing any new Resources, These are incorrectly flagged for previous versions. + - code: UnSupportedPatchProperties + reason: There is no patch operation that is introduced in this swagger version where it is not readOnly. This is incorrectly flagged for previous versions. +``` + ### Tag: package-migrate-2023-04 These settings apply only when `--tag=package-migrate-2023-04` is specified on the command line. @@ -40,6 +56,7 @@ These settings apply only when `--tag=package-preview-2023-10` is specified on t input-file: - Microsoft.OffAzure/preview/2023-10-01-preview/migrate.json ``` + ### Tag: package-2023-06 These settings apply only when `--tag=package-2023-06` is specified on the command line. @@ -202,6 +219,21 @@ These settings apply only when `--tag=package-preview-2023-10` is specified on t input-file: - Microsoft.OffAzure/preview/2023-10-01-preview/migrate.json ``` +### Tag: package-preview-2023-05 + +These settings apply only when `--tag=package-preview-2023-05` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-05' +input-file: + - Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/migrate.json +suppressions: + - code: AvoidAdditionalProperties + reason: Migrate feature is widely adopted and requires additionalProperties for these swagger properties. + - code: ProvisioningStateMustBeReadOnly + reason: The current swagger version only modifies the resources which do not have Provisioning states as readOnly and not introducing any new Resources, These are incorrectly flagged for previous versions. + - code: UnSupportedPatchProperties + reason: There is no patch operation that is introduced in this swagger version where it is not readOnly. This is incorrectly flagged for previous versions. +``` ### Tag: package-migrate-2023-03 diff --git a/specification/migrate/resource-manager/suppressions.yaml b/specification/migrate/resource-manager/suppressions.yaml new file mode 100644 index 000000000000..b421d614e1d1 --- /dev/null +++ b/specification/migrate/resource-manager/suppressions.yaml @@ -0,0 +1,7 @@ +- tool: TypeSpecRequirement + path: Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/**/*.json + reason: Preview version, TypeScript will be added soon + +- tool: TagsAreNotAllowedForProxyResources + path: Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/**/*.json + reason: Adding this supression as this is a false positive alert \ No newline at end of file From e6fde2ac19d0202f0e72217a3e0f9edb63dba273 Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Fri, 27 Sep 2024 14:37:42 +0800 Subject: [PATCH 33/48] remove examples-dir from python tspconfig (#30768) --- specification/ai/DocumentIntelligence/tspconfig.yaml | 1 - specification/ai/Face/tspconfig.yaml | 1 - .../HealthInsights.RadiologyInsights/tspconfig.yaml | 1 - specification/ai/ImageAnalysis/tspconfig.yaml | 1 - specification/apicenter/ApiCenter.DataApi/tspconfig.yaml | 1 - specification/appconfiguration/AppConfiguration/tspconfig.yaml | 1 - .../ApplicationInsights.LiveMetrics/tspconfig.yaml | 1 - specification/azurefleet/AzureFleet.Management/tspconfig.yaml | 1 - specification/batch/Azure.Batch/tspconfig.yaml | 1 - specification/cognitiveservices/ContentSafety/tspconfig.yaml | 1 - .../communication/Communication.JobRouter/tspconfig.yaml | 1 - .../communication/Communication.Messages/tspconfig.yaml | 1 - .../computeschedule/ComputeSchedule.Management/tspconfig.yaml | 1 - .../confidentialledger/Microsoft.CodeTransparency/tspconfig.yaml | 1 - .../contosowidgetmanager/Contoso.Management/tspconfig.yaml | 1 - .../contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml | 1 - specification/devcenter/DevCenter/tspconfig.yaml | 1 - .../Microsoft.DevOpsInfrastructure.Management/tspconfig.yaml | 1 - specification/edgezones/EdgeZones.Management/tspconfig.yaml | 1 - .../Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml | 1 - specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml | 1 - specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml | 1 - .../HealthDataAIServices.DeidServices/tspconfig.yaml | 1 - .../HealthDataAIServices.Management/tspconfig.yaml | 1 - .../iotoperations/IoTOperations.Management/tspconfig.yaml | 1 - .../KubernetesRuntime.Management/tspconfig.yaml | 1 - specification/loadtestservice/LoadTestService/tspconfig.yaml | 1 - .../machinelearning/Azure.AI.ChatProtocol/tspconfig.yaml | 1 - .../machinelearningservices/AzureAI.Assets/tspconfig.yaml | 1 - .../DocumentDB.MongoCluster.Management/tspconfig.yaml | 1 - .../Azure.ProgrammableConnectivity/tspconfig.yaml | 1 - .../purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml | 1 - specification/schemaregistry/SchemaRegistry/tspconfig.yaml | 1 - specification/standbypool/StandbyPool.Management/tspconfig.yaml | 1 - .../translation/Azure.AI.DocumentTranslation/tspconfig.yaml | 1 - .../translation/Azure.AI.TextTranslation/tspconfig.yaml | 1 - specification/trustedsigning/TrustedSigning/tspconfig.yaml | 1 - 37 files changed, 37 deletions(-) diff --git a/specification/ai/DocumentIntelligence/tspconfig.yaml b/specification/ai/DocumentIntelligence/tspconfig.yaml index 42384ac0413f..35640ce9b98c 100644 --- a/specification/ai/DocumentIntelligence/tspconfig.yaml +++ b/specification/ai/DocumentIntelligence/tspconfig.yaml @@ -25,7 +25,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-ai-documentintelligence" namespace: "com.azure.ai.documentintelligence" diff --git a/specification/ai/Face/tspconfig.yaml b/specification/ai/Face/tspconfig.yaml index 69333ed57336..5096759efa37 100644 --- a/specification/ai/Face/tspconfig.yaml +++ b/specification/ai/Face/tspconfig.yaml @@ -21,7 +21,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "Azure.AI.Vision.Face" namespace: "{package-dir}" diff --git a/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/tspconfig.yaml b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/tspconfig.yaml index 8c105bfcd188..ef2b0ce1efdd 100644 --- a/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/tspconfig.yaml +++ b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/tspconfig.yaml @@ -34,7 +34,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-health-insights-radiologyinsights" namespace: com.azure.health.insights.radiologyinsights diff --git a/specification/ai/ImageAnalysis/tspconfig.yaml b/specification/ai/ImageAnalysis/tspconfig.yaml index 968e244f118a..ec72fc3eb5af 100644 --- a/specification/ai/ImageAnalysis/tspconfig.yaml +++ b/specification/ai/ImageAnalysis/tspconfig.yaml @@ -19,7 +19,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "Azure.AI.Vision.ImageAnalysis" namespace: "Azure.AI.Vision.ImageAnalysis" diff --git a/specification/apicenter/ApiCenter.DataApi/tspconfig.yaml b/specification/apicenter/ApiCenter.DataApi/tspconfig.yaml index ed4d3f2e24f2..be755eb76687 100644 --- a/specification/apicenter/ApiCenter.DataApi/tspconfig.yaml +++ b/specification/apicenter/ApiCenter.DataApi/tspconfig.yaml @@ -19,7 +19,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "azure.ApiCenter" namespace: "{package-dir}" diff --git a/specification/appconfiguration/AppConfiguration/tspconfig.yaml b/specification/appconfiguration/AppConfiguration/tspconfig.yaml index 5d2c31b98df7..984363d3eec1 100644 --- a/specification/appconfiguration/AppConfiguration/tspconfig.yaml +++ b/specification/appconfiguration/AppConfiguration/tspconfig.yaml @@ -19,7 +19,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "Azure.Data.AppConfiguration" namespace: "{package-dir}" diff --git a/specification/applicationinsights/ApplicationInsights.LiveMetrics/tspconfig.yaml b/specification/applicationinsights/ApplicationInsights.LiveMetrics/tspconfig.yaml index 1cf18afadc77..0c70abc1f25b 100644 --- a/specification/applicationinsights/ApplicationInsights.LiveMetrics/tspconfig.yaml +++ b/specification/applicationinsights/ApplicationInsights.LiveMetrics/tspconfig.yaml @@ -20,7 +20,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "LiveMetrics" namespace: "{package-dir}" diff --git a/specification/azurefleet/AzureFleet.Management/tspconfig.yaml b/specification/azurefleet/AzureFleet.Management/tspconfig.yaml index 860e37107159..f75c6fb91687 100644 --- a/specification/azurefleet/AzureFleet.Management/tspconfig.yaml +++ b/specification/azurefleet/AzureFleet.Management/tspconfig.yaml @@ -30,7 +30,6 @@ options: package-name: "{package-dir}" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" flavor: "azure" "@azure-tools/typespec-java": package-dir: "azure-resourcemanager-computefleet" diff --git a/specification/batch/Azure.Batch/tspconfig.yaml b/specification/batch/Azure.Batch/tspconfig.yaml index 024a4b79b0dc..1c66dcb9fc9e 100644 --- a/specification/batch/Azure.Batch/tspconfig.yaml +++ b/specification/batch/Azure.Batch/tspconfig.yaml @@ -31,7 +31,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-ts": package-dir: "batch-rest" packageDetails: diff --git a/specification/cognitiveservices/ContentSafety/tspconfig.yaml b/specification/cognitiveservices/ContentSafety/tspconfig.yaml index 565abdc7cc74..e1b159922293 100644 --- a/specification/cognitiveservices/ContentSafety/tspconfig.yaml +++ b/specification/cognitiveservices/ContentSafety/tspconfig.yaml @@ -21,7 +21,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "Azure.AI.ContentSafety" namespace: "{package-dir}" diff --git a/specification/communication/Communication.JobRouter/tspconfig.yaml b/specification/communication/Communication.JobRouter/tspconfig.yaml index 5bbf6cf62172..eaac1149894e 100644 --- a/specification/communication/Communication.JobRouter/tspconfig.yaml +++ b/specification/communication/Communication.JobRouter/tspconfig.yaml @@ -43,7 +43,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": emitter-output-dir: "{java-sdk-folder}/sdk/{service-directory-name}/azure-communication-jobrouter" package-dir: "azure-communication-jobrouter" diff --git a/specification/communication/Communication.Messages/tspconfig.yaml b/specification/communication/Communication.Messages/tspconfig.yaml index efa014db6fba..d6f5bcff1caf 100644 --- a/specification/communication/Communication.Messages/tspconfig.yaml +++ b/specification/communication/Communication.Messages/tspconfig.yaml @@ -44,7 +44,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-communication-messages" namespace: com.azure.communication.messages diff --git a/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml b/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml index c73e44824afb..0c5a91d3e011 100644 --- a/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml +++ b/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml @@ -14,7 +14,6 @@ options: flavor: "azure" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "Azure.ResourceManager.ComputeSchedule" flavor: azure diff --git a/specification/confidentialledger/Microsoft.CodeTransparency/tspconfig.yaml b/specification/confidentialledger/Microsoft.CodeTransparency/tspconfig.yaml index 3f7eb764893a..4b9dc7e146de 100644 --- a/specification/confidentialledger/Microsoft.CodeTransparency/tspconfig.yaml +++ b/specification/confidentialledger/Microsoft.CodeTransparency/tspconfig.yaml @@ -20,7 +20,6 @@ options: models-mode: none generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": flavor: azure package-dir: "Azure.Security.CodeTransparency" diff --git a/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml b/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml index d952a53f56e2..23b54895ca02 100644 --- a/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml +++ b/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml @@ -21,7 +21,6 @@ options: package-name: "{package-dir}" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" flavor: "azure" "@azure-tools/typespec-java": package-dir: "azure-resourcemanager-contoso" diff --git a/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml b/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml index 93dd9d6f2085..2633b3a76f34 100644 --- a/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml +++ b/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml @@ -21,7 +21,6 @@ options: package-name: "{package-dir}" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" flavor: azure "@azure-tools/typespec-csharp": package-dir: "Azure.Template.Contoso" diff --git a/specification/devcenter/DevCenter/tspconfig.yaml b/specification/devcenter/DevCenter/tspconfig.yaml index 476f295d6a7a..49e16784c6ee 100644 --- a/specification/devcenter/DevCenter/tspconfig.yaml +++ b/specification/devcenter/DevCenter/tspconfig.yaml @@ -26,7 +26,6 @@ options: api-version: "2023-04-01" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-ts": title: "Azure Developer DevCenter" package-dir: "developer-devcenter-rest" diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/tspconfig.yaml b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/tspconfig.yaml index a6de4688fc7d..6418c4fbe07c 100644 --- a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/tspconfig.yaml +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/tspconfig.yaml @@ -23,7 +23,6 @@ options: flavor: "azure" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-resourcemanager-devopsinfrastructure" flavor: "azure" diff --git a/specification/edgezones/EdgeZones.Management/tspconfig.yaml b/specification/edgezones/EdgeZones.Management/tspconfig.yaml index 87cf3b8931b1..59af0f9180d3 100644 --- a/specification/edgezones/EdgeZones.Management/tspconfig.yaml +++ b/specification/edgezones/EdgeZones.Management/tspconfig.yaml @@ -20,7 +20,6 @@ options: package-name: "{package-dir}" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" flavor: "azure" "@azure-tools/typespec-java": package-dir: "azure-resourcemanager-edgezones" diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml index 970d52f81e55..89e62a45f20a 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml @@ -24,7 +24,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" # Uncomment this line and add "@azure-tools/typespec-csharp" to your package.json to generate C# code "@azure-tools/typespec-csharp": package-dir: Azure.Messaging.EventGrid.SystemEvents diff --git a/specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml b/specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml index 8477281bc07d..62693d4eb767 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml +++ b/specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml @@ -24,7 +24,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" # Uncomment this line and add "@azure-tools/typespec-csharp" to your package.json to generate C# code "@azure-tools/typespec-csharp": package-dir: Azure.Messaging.EventGridV2 diff --git a/specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml b/specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml index f9653224cf9d..6d8ba54dd4eb 100644 --- a/specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml +++ b/specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml @@ -23,7 +23,6 @@ options: package-name: "{package-dir}" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-ts": azureSdkForJs: true isModularLibrary: true diff --git a/specification/healthdataaiservices/HealthDataAIServices.DeidServices/tspconfig.yaml b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/tspconfig.yaml index 2890f991aec3..d9da9d92e438 100644 --- a/specification/healthdataaiservices/HealthDataAIServices.DeidServices/tspconfig.yaml +++ b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/tspconfig.yaml @@ -19,7 +19,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "Azure.Health.Deidentification" namespace: "{package-dir}" diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/tspconfig.yaml b/specification/healthdataaiservices/HealthDataAIServices.Management/tspconfig.yaml index f45ad94de92c..b007e798dedd 100644 --- a/specification/healthdataaiservices/HealthDataAIServices.Management/tspconfig.yaml +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/tspconfig.yaml @@ -21,7 +21,6 @@ options: package-name: "{package-dir}" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-resourcemanager-healthdataaiservices" flavor: "azure" diff --git a/specification/iotoperations/IoTOperations.Management/tspconfig.yaml b/specification/iotoperations/IoTOperations.Management/tspconfig.yaml index 708bdfee191a..d28a739a8e06 100644 --- a/specification/iotoperations/IoTOperations.Management/tspconfig.yaml +++ b/specification/iotoperations/IoTOperations.Management/tspconfig.yaml @@ -15,7 +15,6 @@ options: flavor: "azure" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/kubernetesruntime/KubernetesRuntime.Management/tspconfig.yaml b/specification/kubernetesruntime/KubernetesRuntime.Management/tspconfig.yaml index bdfdb8ce28c5..8f4556678620 100644 --- a/specification/kubernetesruntime/KubernetesRuntime.Management/tspconfig.yaml +++ b/specification/kubernetesruntime/KubernetesRuntime.Management/tspconfig.yaml @@ -20,7 +20,6 @@ options: flavor: "azure" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" linter: extends: diff --git a/specification/loadtestservice/LoadTestService/tspconfig.yaml b/specification/loadtestservice/LoadTestService/tspconfig.yaml index 9c621ebbaced..bc6f069f006f 100644 --- a/specification/loadtestservice/LoadTestService/tspconfig.yaml +++ b/specification/loadtestservice/LoadTestService/tspconfig.yaml @@ -28,7 +28,6 @@ options: package-name: "{package-dir}" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" # emitter-output-dir: "{python-sdk-folder}/sdk/{service-directory-name}/{package-name}" package-mode: azure-dataplane flavor: azure diff --git a/specification/machinelearning/Azure.AI.ChatProtocol/tspconfig.yaml b/specification/machinelearning/Azure.AI.ChatProtocol/tspconfig.yaml index 04f2db45305a..af95819fba18 100644 --- a/specification/machinelearning/Azure.AI.ChatProtocol/tspconfig.yaml +++ b/specification/machinelearning/Azure.AI.ChatProtocol/tspconfig.yaml @@ -27,7 +27,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-ts": package-dir: "ai-chat-protocol" isModularLibrary: true diff --git a/specification/machinelearningservices/AzureAI.Assets/tspconfig.yaml b/specification/machinelearningservices/AzureAI.Assets/tspconfig.yaml index 64ee3f8728e1..eba014716a1c 100644 --- a/specification/machinelearningservices/AzureAI.Assets/tspconfig.yaml +++ b/specification/machinelearningservices/AzureAI.Assets/tspconfig.yaml @@ -16,7 +16,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" linter: extends: - "@azure-tools/typespec-azure-rulesets/data-plane" diff --git a/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml b/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml index 963bdd54531f..db2c9f14c801 100644 --- a/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml +++ b/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml @@ -15,7 +15,6 @@ options: flavor: "azure" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-resourcemanager-mongocluster" flavor: "azure" diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/tspconfig.yaml b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/tspconfig.yaml index fe41d662bb95..e56bf1a91ef3 100644 --- a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/tspconfig.yaml +++ b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/tspconfig.yaml @@ -25,7 +25,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" linter: extends: - "@azure-tools/typespec-azure-rulesets/data-plane" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml index 3742712d1b88..db2051ab2039 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml +++ b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml @@ -20,7 +20,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "Azure.Analytics.Purview.DataMap" namespace: "{package-dir}" diff --git a/specification/schemaregistry/SchemaRegistry/tspconfig.yaml b/specification/schemaregistry/SchemaRegistry/tspconfig.yaml index 4ecd71e8a0ba..666346bbfdcc 100644 --- a/specification/schemaregistry/SchemaRegistry/tspconfig.yaml +++ b/specification/schemaregistry/SchemaRegistry/tspconfig.yaml @@ -23,7 +23,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-data-schemaregistry" namespace: com.azure.data.schemaregistry diff --git a/specification/standbypool/StandbyPool.Management/tspconfig.yaml b/specification/standbypool/StandbyPool.Management/tspconfig.yaml index 09ee2ea103a3..42e761955bfb 100644 --- a/specification/standbypool/StandbyPool.Management/tspconfig.yaml +++ b/specification/standbypool/StandbyPool.Management/tspconfig.yaml @@ -46,7 +46,6 @@ options: flavor: "azure" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-go": service-dir: "sdk/resourcemanager/standbypool" package-dir: "armstandbypool" diff --git a/specification/translation/Azure.AI.DocumentTranslation/tspconfig.yaml b/specification/translation/Azure.AI.DocumentTranslation/tspconfig.yaml index 5c2fcb0cef11..fbe351d6711b 100644 --- a/specification/translation/Azure.AI.DocumentTranslation/tspconfig.yaml +++ b/specification/translation/Azure.AI.DocumentTranslation/tspconfig.yaml @@ -31,7 +31,6 @@ options: generate-sample-project: false generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-ai-translation-document" namespace: com.azure.ai.translation.document diff --git a/specification/translation/Azure.AI.TextTranslation/tspconfig.yaml b/specification/translation/Azure.AI.TextTranslation/tspconfig.yaml index 8967858b9ba9..e1112abc09d8 100644 --- a/specification/translation/Azure.AI.TextTranslation/tspconfig.yaml +++ b/specification/translation/Azure.AI.TextTranslation/tspconfig.yaml @@ -29,7 +29,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-ai-translation-text" namespace: com.azure.ai.translation.text diff --git a/specification/trustedsigning/TrustedSigning/tspconfig.yaml b/specification/trustedsigning/TrustedSigning/tspconfig.yaml index 25463f0e28f1..9445b6b1401c 100644 --- a/specification/trustedsigning/TrustedSigning/tspconfig.yaml +++ b/specification/trustedsigning/TrustedSigning/tspconfig.yaml @@ -19,7 +19,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": clear-output-folder: true package-dir: "Azure.Developer.TrustedSigning" From 30ec6607bbcbeceb13b634de955667c5aa45766a Mon Sep 17 00:00:00 2001 From: rishavMS <99256759+rishavMS@users.noreply.github.com> Date: Fri, 27 Sep 2024 16:46:39 +0530 Subject: [PATCH 34/48] BilingRP subscrption api swagger update for offerId for 2024-04-01 (#30721) --- .../stable/2024-04-01/billingSubscription.json | 2 +- .../examples/billingSubscriptionsListByBillingProfileEA.json | 1 + .../examples/billingSubscriptionsListByEnrollmentAccount.json | 2 ++ 3 files changed, 4 insertions(+), 1 deletion(-) diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingSubscription.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingSubscription.json index 976b7926e0e9..a0ee06a94b7a 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingSubscription.json +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingSubscription.json @@ -1544,7 +1544,7 @@ "$ref": "#/definitions/NextBillingCycleDetails" }, "offerId": { - "description": "The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts.", + "description": "The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement.", "type": "string", "readOnly": true }, diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileEA.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileEA.json index d84a83a85a99..429e2bb6e50a 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileEA.json +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileEA.json @@ -17,6 +17,7 @@ "displayName": "My Subscription", "enrollmentAccountId": "172988", "enrollmentAccountDisplayName": "billtest332211@outlook.com", + "offerId": "MS-AZR-0017P", "status": "Active", "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3" }, diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByEnrollmentAccount.json index 3c5cab3ccedd..416d3f92d781 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByEnrollmentAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByEnrollmentAccount.json @@ -19,6 +19,7 @@ "enrollmentAccountSubscriptionDetails": { "enrollmentAccountStartDate": "2023-01-04T00:00:00.0000000Z" }, + "offerId": "MS-AZR-0017P", "subscriptionId": "90000000-0000-0000-0000-000000000000" }, "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" @@ -35,6 +36,7 @@ "enrollmentAccountStartDate": "2023-01-04T00:00:00.0000000Z", "subscriptionEnrollmentAccountStatus": "Deleted" }, + "offerId": "MS-AZR-0136P", "subscriptionId": "90000000-0000-0000-0000-000000000001" }, "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" From c43b644ce1f34a83dcf850a73daff5c460cbc524 Mon Sep 17 00:00:00 2001 From: ZiWei Chen <98569699+kazrael2119@users.noreply.github.com> Date: Fri, 27 Sep 2024 19:45:58 +0800 Subject: [PATCH 35/48] add directive for containerservice (#30772) --- .../Microsoft.ContainerService/aks/readme.typescript.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.typescript.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.typescript.md index 288ba334a779..e33bbf8ae14b 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.typescript.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.typescript.md @@ -9,4 +9,10 @@ typescript: package-name: "@azure/arm-containerservice" output-folder: "$(typescript-sdks-folder)/sdk/containerservice/arm-containerservice" generate-metadata: true + +directive: + - from: managedClusters.json + where: $.definitions.MachineIpAddress + transform: > + $.properties.family["x-ms-enum"].name = "IpFamily" ``` From 5c26c3b83ddc9b459d6eece1b3495d2a56bffa5a Mon Sep 17 00:00:00 2001 From: jamesvoongms <104241521+jamesvoongms@users.noreply.github.com> Date: Fri, 27 Sep 2024 09:15:59 -0700 Subject: [PATCH 36/48] DNS Resolver Release 2023-07-01-Preview with new DNS Security Policy feature (#30707) * Add new folder for 2023-07-01-preview with stable 2022-07-01 as the base * Add changes for new DNS security policy feature * Fix linting issues * Add readme changes * Fix autorest issue by changing from v2 to v5 in dnsresolver module --- .../2023-07-01-preview/dnsresolver.json | 2675 +++++++++++++++++ .../2023-07-01-preview/dnsresolverpolicy.json | 1828 +++++++++++ .../examples/DnsForwardingRuleset_Delete.json | 18 + .../examples/DnsForwardingRuleset_Get.json | 40 + ...ForwardingRuleset_ListByResourceGroup.json | 72 + ...sForwardingRuleset_ListBySubscription.json | 71 + ...orwardingRuleset_ListByVirtualNetwork.json | 25 + .../examples/DnsForwardingRuleset_Patch.json | 51 + .../examples/DnsForwardingRuleset_Put.json | 92 + .../DnsResolverDomainList_Delete.json | 17 + .../examples/DnsResolverDomainList_Get.json | 35 + ...esolverDomainList_ListByResourceGroup.json | 62 + ...ResolverDomainList_ListBySubscription.json | 61 + .../examples/DnsResolverDomainList_Patch.json | 51 + .../examples/DnsResolverDomainList_Put.json | 71 + ...solverPolicyVirtualNetworkLink_Delete.json | 18 + ...sResolverPolicyVirtualNetworkLink_Get.json | 35 + ...ResolverPolicyVirtualNetworkLink_List.json | 39 + ...esolverPolicyVirtualNetworkLink_Patch.json | 46 + ...sResolverPolicyVirtualNetworkLink_Put.json | 76 + .../examples/DnsResolverPolicy_Delete.json | 17 + .../examples/DnsResolverPolicy_Get.json | 32 + ...DnsResolverPolicy_ListByResourceGroup.json | 56 + .../DnsResolverPolicy_ListBySubscription.json | 55 + ...nsResolverPolicy_ListByVirtualNetwork.json | 20 + .../examples/DnsResolverPolicy_Patch.json | 43 + .../examples/DnsResolverPolicy_Put.json | 60 + .../examples/DnsResolver_Delete.json | 18 + .../examples/DnsResolver_Get.json | 36 + .../DnsResolver_ListByResourceGroup.json | 64 + .../DnsResolver_ListBySubscription.json | 63 + .../DnsResolver_ListByVirtualNetwork.json | 20 + .../examples/DnsResolver_Patch.json | 47 + .../examples/DnsResolver_Put.json | 73 + .../examples/DnsSecurityRule_Delete.json | 18 + .../examples/DnsSecurityRule_Get.json | 43 + .../examples/DnsSecurityRule_List.json | 77 + .../examples/DnsSecurityRule_Patch.json | 56 + .../examples/DnsSecurityRule_Put.json | 100 + .../examples/ForwardingRule_Delete.json | 13 + .../examples/ForwardingRule_Get.json | 43 + .../examples/ForwardingRule_List.json | 77 + .../examples/ForwardingRule_Patch.json | 51 + .../examples/ForwardingRule_Put.json | 94 + .../examples/InboundEndpoint_Delete.json | 19 + .../examples/InboundEndpoint_Get.json | 42 + .../examples/InboundEndpoint_List.json | 75 + .../examples/InboundEndpoint_Patch.json | 53 + .../examples/InboundEndpoint_Put.json | 95 + .../examples/OutboundEndpoint_Delete.json | 19 + .../examples/OutboundEndpoint_Get.json | 36 + .../examples/OutboundEndpoint_List.json | 63 + .../examples/OutboundEndpoint_Patch.json | 47 + .../examples/OutboundEndpoint_Put.json | 77 + .../examples/VirtualNetworkLink_Delete.json | 19 + .../examples/VirtualNetworkLink_Get.json | 34 + .../examples/VirtualNetworkLink_List.json | 38 + .../examples/VirtualNetworkLink_Patch.json | 47 + .../examples/VirtualNetworkLink_Put.json | 73 + .../dnsresolver/resource-manager/readme.md | 17 +- 60 files changed, 7310 insertions(+), 3 deletions(-) create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dnsresolver.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dnsresolverpolicy.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListByResourceGroup.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListBySubscription.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListByVirtualNetwork.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_ListByResourceGroup.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_ListBySubscription.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_List.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListByResourceGroup.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListBySubscription.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListByVirtualNetwork.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListByResourceGroup.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListBySubscription.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListByVirtualNetwork.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_List.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_List.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_List.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_List.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_List.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Put.json diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dnsresolver.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dnsresolver.json new file mode 100644 index 000000000000..51f0c433eeee --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dnsresolver.json @@ -0,0 +1,2675 @@ +{ + "swagger": "2.0", + "info": { + "title": "DnsResolverManagementClient", + "description": "The DNS Resolver Management Client.", + "version": "2023-07-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}": { + "put": { + "tags": [ + "DnsResolvers" + ], + "operationId": "DnsResolvers_CreateOrUpdate", + "description": "Creates or updates a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsResolver" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The DNS resolver has been created.", + "schema": { + "$ref": "#/definitions/DnsResolver" + } + }, + "200": { + "description": "The DNS resolver has been updated.", + "schema": { + "$ref": "#/definitions/DnsResolver" + } + }, + "202": { + "description": "The operation to upsert DNS resolver has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upsert DNS resolver": { + "$ref": "./examples/DnsResolver_Put.json" + } + } + }, + "patch": { + "tags": [ + "DnsResolvers" + ], + "operationId": "DnsResolvers_Update", + "description": "Updates a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsResolverPatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver has been updated.", + "schema": { + "$ref": "#/definitions/DnsResolver" + } + }, + "202": { + "description": "The operation to update DNS resolver has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update DNS resolver": { + "$ref": "./examples/DnsResolver_Patch.json" + } + } + }, + "delete": { + "tags": [ + "DnsResolvers" + ], + "operationId": "DnsResolvers_Delete", + "description": "Deletes a DNS resolver. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver has been deleted." + }, + "202": { + "description": "The operation to delete DNS resolver has been accepted and will complete asynchronously." + }, + "204": { + "description": "The DNS resolver was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete DNS resolver": { + "$ref": "./examples/DnsResolver_Delete.json" + } + } + }, + "get": { + "tags": [ + "DnsResolvers" + ], + "operationId": "DnsResolvers_Get", + "description": "Gets properties of a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver was found.", + "schema": { + "$ref": "#/definitions/DnsResolver" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Retrieve DNS resolver": { + "$ref": "./examples/DnsResolver_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers": { + "get": { + "tags": [ + "DnsResolvers" + ], + "operationId": "DnsResolvers_ListByResourceGroup", + "description": "Lists DNS resolvers within a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolvers in the resource group.", + "schema": { + "$ref": "#/definitions/DnsResolverListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS resolvers by resource group": { + "$ref": "./examples/DnsResolver_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsResolvers": { + "get": { + "tags": [ + "DnsResolvers" + ], + "operationId": "DnsResolvers_List", + "description": "Lists DNS resolvers in all resource groups of a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolvers in the subscription.", + "schema": { + "$ref": "#/definitions/DnsResolverListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS resolvers by subscription": { + "$ref": "./examples/DnsResolver_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/inboundEndpoints/{inboundEndpointName}": { + "put": { + "tags": [ + "InboundEndpoints" + ], + "operationId": "InboundEndpoints_CreateOrUpdate", + "description": "Creates or updates an inbound endpoint for a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "#/parameters/InboundEndpointNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/InboundEndpoint" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The inbound endpoint for the DNS resolver has been created.", + "schema": { + "$ref": "#/definitions/InboundEndpoint" + } + }, + "200": { + "description": "The inbound endpoint for the DNS resolver has been updated.", + "schema": { + "$ref": "#/definitions/InboundEndpoint" + } + }, + "202": { + "description": "The operation to upsert inbound endpoint for the DNS resolver has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upsert inbound endpoint for DNS resolver": { + "$ref": "./examples/InboundEndpoint_Put.json" + } + } + }, + "patch": { + "tags": [ + "InboundEndpoints" + ], + "operationId": "InboundEndpoints_Update", + "description": "Updates an inbound endpoint for a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "#/parameters/InboundEndpointNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/InboundEndpointPatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The inbound endpoint for the DNS resolver has been updated.", + "schema": { + "$ref": "#/definitions/InboundEndpoint" + } + }, + "202": { + "description": "The operation to update inbound endpoint for the DNS resolver has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update inbound endpoint for DNS resolver": { + "$ref": "./examples/InboundEndpoint_Patch.json" + } + } + }, + "delete": { + "tags": [ + "InboundEndpoints" + ], + "operationId": "InboundEndpoints_Delete", + "description": "Deletes an inbound endpoint for a DNS resolver. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "#/parameters/InboundEndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The inbound endpoint for the DNS resolver has been deleted." + }, + "202": { + "description": "The operation to delete inbound endpoint for the DNS resolver has been accepted and will complete asynchronously." + }, + "204": { + "description": "The inbound endpoint for the DNS resolver was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete inbound endpoint for DNS resolver": { + "$ref": "./examples/InboundEndpoint_Delete.json" + } + } + }, + "get": { + "tags": [ + "InboundEndpoints" + ], + "operationId": "InboundEndpoints_Get", + "description": "Gets properties of an inbound endpoint for a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "#/parameters/InboundEndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The inbound endpoint for the DNS resolver was found.", + "schema": { + "$ref": "#/definitions/InboundEndpoint" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Retrieve inbound endpoint for DNS resolver": { + "$ref": "./examples/InboundEndpoint_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/inboundEndpoints": { + "get": { + "tags": [ + "InboundEndpoints" + ], + "operationId": "InboundEndpoints_List", + "description": "Lists inbound endpoints for a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of inbound endpoints for the DNS resolver.", + "schema": { + "$ref": "#/definitions/InboundEndpointListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List inbound endpoints by DNS resolver": { + "$ref": "./examples/InboundEndpoint_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/outboundEndpoints/{outboundEndpointName}": { + "put": { + "tags": [ + "OutboundEndpoints" + ], + "operationId": "OutboundEndpoints_CreateOrUpdate", + "description": "Creates or updates an outbound endpoint for a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "#/parameters/OutboundEndpointNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OutboundEndpoint" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The outbound endpoint for the DNS resolver has been created.", + "schema": { + "$ref": "#/definitions/OutboundEndpoint" + } + }, + "200": { + "description": "The outbound endpoint for the DNS resolver has been updated.", + "schema": { + "$ref": "#/definitions/OutboundEndpoint" + } + }, + "202": { + "description": "The operation to upsert outbound endpoint for the DNS resolver has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upsert outbound endpoint for DNS resolver": { + "$ref": "./examples/OutboundEndpoint_Put.json" + } + } + }, + "patch": { + "tags": [ + "OutboundEndpoints" + ], + "operationId": "OutboundEndpoints_Update", + "description": "Updates an outbound endpoint for a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "#/parameters/OutboundEndpointNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OutboundEndpointPatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The outbound endpoint for the DNS resolver has been updated.", + "schema": { + "$ref": "#/definitions/OutboundEndpoint" + } + }, + "202": { + "description": "The operation to update outbound endpoint for the DNS resolver has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update outbound endpoint for DNS resolver": { + "$ref": "./examples/OutboundEndpoint_Patch.json" + } + } + }, + "delete": { + "tags": [ + "OutboundEndpoints" + ], + "operationId": "OutboundEndpoints_Delete", + "description": "Deletes an outbound endpoint for a DNS resolver. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "#/parameters/OutboundEndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The outbound endpoint for the DNS resolver has been deleted." + }, + "202": { + "description": "The operation to delete outbound endpoint for the DNS resolver has been accepted and will complete asynchronously." + }, + "204": { + "description": "The outbound endpoint for the DNS resolver was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete outbound endpoint for DNS resolver": { + "$ref": "./examples/OutboundEndpoint_Delete.json" + } + } + }, + "get": { + "tags": [ + "OutboundEndpoints" + ], + "operationId": "OutboundEndpoints_Get", + "description": "Gets properties of an outbound endpoint for a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "#/parameters/OutboundEndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The outbound endpoint for the DNS resolver was found.", + "schema": { + "$ref": "#/definitions/OutboundEndpoint" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Retrieve outbound endpoint for DNS resolver": { + "$ref": "./examples/OutboundEndpoint_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/outboundEndpoints": { + "get": { + "tags": [ + "OutboundEndpoints" + ], + "operationId": "OutboundEndpoints_List", + "description": "Lists outbound endpoints for a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of outbound endpoints for the DNS resolver.", + "schema": { + "$ref": "#/definitions/OutboundEndpointListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List outbound endpoints by DNS resolver": { + "$ref": "./examples/OutboundEndpoint_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}": { + "put": { + "tags": [ + "DnsForwardingRulesets" + ], + "operationId": "DnsForwardingRulesets_CreateOrUpdate", + "description": "Creates or updates a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsForwardingRuleset" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The DNS forwarding ruleset has been created.", + "schema": { + "$ref": "#/definitions/DnsForwardingRuleset" + } + }, + "200": { + "description": "The DNS forwarding ruleset has been updated.", + "schema": { + "$ref": "#/definitions/DnsForwardingRuleset" + } + }, + "202": { + "description": "The operation to upsert DNS forwarding ruleset has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upsert DNS forwarding ruleset": { + "$ref": "./examples/DnsForwardingRuleset_Put.json" + } + } + }, + "patch": { + "tags": [ + "DnsForwardingRulesets" + ], + "operationId": "DnsForwardingRulesets_Update", + "description": "Updates a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsForwardingRulesetPatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The DNS forwarding ruleset has been updated.", + "schema": { + "$ref": "#/definitions/DnsForwardingRuleset" + } + }, + "202": { + "description": "The operation to update DNS forwarding ruleset has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update DNS forwarding ruleset": { + "$ref": "./examples/DnsForwardingRuleset_Patch.json" + } + } + }, + "delete": { + "tags": [ + "DnsForwardingRulesets" + ], + "operationId": "DnsForwardingRulesets_Delete", + "description": "Deletes a DNS forwarding ruleset. WARNING: This operation cannot be undone. All forwarding rules within the ruleset will be deleted.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The DNS forwarding ruleset has been deleted." + }, + "202": { + "description": "The operation to delete DNS forwarding ruleset has been accepted and will complete asynchronously." + }, + "204": { + "description": "The DNS forwarding ruleset was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete DNS forwarding ruleset": { + "$ref": "./examples/DnsForwardingRuleset_Delete.json" + } + } + }, + "get": { + "tags": [ + "DnsForwardingRulesets" + ], + "operationId": "DnsForwardingRulesets_Get", + "description": "Gets a DNS forwarding ruleset properties.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The DNS forwarding ruleset was found.", + "schema": { + "$ref": "#/definitions/DnsForwardingRuleset" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Retrieve DNS forwarding ruleset": { + "$ref": "./examples/DnsForwardingRuleset_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets": { + "get": { + "tags": [ + "DnsForwardingRulesets" + ], + "operationId": "DnsForwardingRulesets_ListByResourceGroup", + "description": "Lists DNS forwarding rulesets within a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS forwarding rulesets in the resource group.", + "schema": { + "$ref": "#/definitions/DnsForwardingRulesetListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS forwarding rulesets by resource group": { + "$ref": "./examples/DnsForwardingRuleset_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsForwardingRulesets": { + "get": { + "tags": [ + "DnsForwardingRulesets" + ], + "operationId": "DnsForwardingRulesets_List", + "description": "Lists DNS forwarding rulesets in all resource groups of a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS forwarding rulesets in the subscription.", + "schema": { + "$ref": "#/definitions/DnsForwardingRulesetListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS forwarding rulesets by subscription": { + "$ref": "./examples/DnsForwardingRuleset_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/forwardingRules/{forwardingRuleName}": { + "put": { + "tags": [ + "ForwardingRules" + ], + "operationId": "ForwardingRules_CreateOrUpdate", + "description": "Creates or updates a forwarding rule in a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "#/parameters/ForwardingRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ForwardingRule" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The forwarding rule has been created.", + "schema": { + "$ref": "#/definitions/ForwardingRule" + } + }, + "200": { + "description": "The forwarding rule has been updated.", + "schema": { + "$ref": "#/definitions/ForwardingRule" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Upsert forwarding rule in a DNS forwarding ruleset": { + "$ref": "./examples/ForwardingRule_Put.json" + } + } + }, + "patch": { + "tags": [ + "ForwardingRules" + ], + "operationId": "ForwardingRules_Update", + "description": "Updates a forwarding rule in a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "#/parameters/ForwardingRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ForwardingRulePatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The forwarding rule has been updated.", + "schema": { + "$ref": "#/definitions/ForwardingRule" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update forwarding rule in a DNS forwarding ruleset": { + "$ref": "./examples/ForwardingRule_Patch.json" + } + } + }, + "delete": { + "tags": [ + "ForwardingRules" + ], + "operationId": "ForwardingRules_Delete", + "description": "Deletes a forwarding rule in a DNS forwarding ruleset. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "#/parameters/ForwardingRuleNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The forwarding rule has been deleted." + }, + "204": { + "description": "The forwarding rule was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete forwarding rule in a DNS forwarding ruleset": { + "$ref": "./examples/ForwardingRule_Delete.json" + } + } + }, + "get": { + "tags": [ + "ForwardingRules" + ], + "operationId": "ForwardingRules_Get", + "description": "Gets properties of a forwarding rule in a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "#/parameters/ForwardingRuleNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The forwarding rule was found.", + "schema": { + "$ref": "#/definitions/ForwardingRule" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Retrieve forwarding rule in a DNS forwarding ruleset": { + "$ref": "./examples/ForwardingRule_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/forwardingRules": { + "get": { + "tags": [ + "ForwardingRules" + ], + "operationId": "ForwardingRules_List", + "description": "Lists forwarding rules in a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of forwarding rules in the DNS forwarding ruleset.", + "schema": { + "$ref": "#/definitions/ForwardingRuleListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List forwarding rules in a DNS forwarding ruleset": { + "$ref": "./examples/ForwardingRule_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/virtualNetworkLinks/{virtualNetworkLinkName}": { + "put": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_CreateOrUpdate", + "description": "Creates or updates a virtual network link to a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkLinkNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The virtual network link to the DNS forwarding ruleset has been created.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + } + }, + "200": { + "description": "The virtual network link to the DNS forwarding ruleset has been updated.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + } + }, + "202": { + "description": "The operation to upsert virtual network link to the DNS forwarding ruleset has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upsert virtual network link to a DNS forwarding ruleset": { + "$ref": "./examples/VirtualNetworkLink_Put.json" + } + } + }, + "patch": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_Update", + "description": "Updates a virtual network link to a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkLinkNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkLinkPatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The virtual network link to the DNS forwarding ruleset has been updated.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + } + }, + "202": { + "description": "The operation to update virtual network link to the DNS forwarding ruleset has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update virtual network link to a DNS forwarding ruleset": { + "$ref": "./examples/VirtualNetworkLink_Patch.json" + } + } + }, + "delete": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_Delete", + "description": "Deletes a virtual network link to a DNS forwarding ruleset. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkLinkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The virtual network link to the DNS forwarding ruleset has been deleted." + }, + "202": { + "description": "The operation to delete virtual network link to the DNS forwarding ruleset has been accepted and will complete asynchronously." + }, + "204": { + "description": "The virtual network link to the DNS forwarding ruleset was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete virtual network link to a DNS forwarding ruleset": { + "$ref": "./examples/VirtualNetworkLink_Delete.json" + } + } + }, + "get": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_Get", + "description": "Gets properties of a virtual network link to a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkLinkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The virtual network link to DNS forwarding ruleset was found.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Retrieve virtual network link to a DNS forwarding ruleset": { + "$ref": "./examples/VirtualNetworkLink_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/virtualNetworkLinks": { + "get": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_List", + "description": "Lists virtual network links to a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of virtual network links to a DNS forwarding ruleset.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLinkListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List virtual network links to a DNS forwarding ruleset": { + "$ref": "./examples/VirtualNetworkLink_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/listDnsResolvers": { + "post": { + "tags": [ + "DnsResolvers" + ], + "operationId": "DnsResolvers_ListByVirtualNetwork", + "description": "Lists DNS resolver resource IDs linked to a virtual network.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolver resource IDs linked to the virtual network.", + "schema": { + "$ref": "#/definitions/SubResourceListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS resolvers by virtual network": { + "$ref": "./examples/DnsResolver_ListByVirtualNetwork.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/listDnsForwardingRulesets": { + "post": { + "tags": [ + "DnsForwardingRulesets" + ], + "operationId": "DnsForwardingRulesets_ListByVirtualNetwork", + "description": "Lists DNS forwarding ruleset resource IDs attached to a virtual network.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS forwarding ruleset resource IDs and virtual network link resource IDs attached to the virtual network.", + "schema": { + "$ref": "#/definitions/VirtualNetworkDnsForwardingRulesetListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS forwarding rulesets by virtual network": { + "$ref": "./examples/DnsForwardingRuleset_ListByVirtualNetwork.json" + } + } + } + } + }, + "definitions": { + "DnsResolverProperties": { + "description": "Represents the properties of a DNS resolver.", + "type": "object", + "required": [ + "virtualNetwork" + ], + "properties": { + "virtualNetwork": { + "description": "The reference to the virtual network. This cannot be changed after creation.", + "x-ms-mutability": [ + "read", + "create" + ], + "$ref": "#/definitions/SubResource" + }, + "dnsResolverState": { + "description": "The current status of the DNS resolver. This is a read-only property and any attempt to set this value will be ignored.", + "type": "string", + "enum": [ + "Connected", + "Disconnected" + ], + "x-ms-enum": { + "name": "DnsResolverState", + "modelAsString": true + }, + "readOnly": true + }, + "provisioningState": { + "description": "The current provisioning state of the DNS resolver. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "resourceGuid": { + "description": "The resourceGuid property of the DNS resolver resource.", + "readOnly": true, + "$ref": "#/definitions/ResourceGuid" + } + } + }, + "DnsResolver": { + "description": "Describes a DNS resolver.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the DNS resolver.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the DNS resolver.", + "$ref": "#/definitions/DnsResolverProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "DnsResolverPatch": { + "description": "Describes a DNS resolver for PATCH operation.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags for DNS Resolver." + } + } + }, + "DnsResolverListResult": { + "description": "The response to an enumeration operation on DNS resolvers.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the DNS resolvers.", + "type": "array", + "items": { + "$ref": "#/definitions/DnsResolver" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "InboundEndpointProperties": { + "description": "Represents the properties of an inbound endpoint for a DNS resolver.", + "type": "object", + "required": [ + "ipConfigurations" + ], + "properties": { + "ipConfigurations": { + "description": "IP configurations for the inbound endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/IpConfiguration" + }, + "x-ms-identifiers": [] + }, + "provisioningState": { + "description": "The current provisioning state of the inbound endpoint. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "resourceGuid": { + "description": "The resourceGuid property of the inbound endpoint resource.", + "readOnly": true, + "$ref": "#/definitions/ResourceGuid" + } + } + }, + "InboundEndpoint": { + "description": "Describes an inbound endpoint for a DNS resolver.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the inbound endpoint.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the inbound endpoint.", + "$ref": "#/definitions/InboundEndpointProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "InboundEndpointPatch": { + "description": "Describes an inbound endpoint for a DNS resolver for PATCH operation.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags for inbound endpoint." + } + } + }, + "InboundEndpointListResult": { + "description": "The response to an enumeration operation on inbound endpoints for a DNS resolver.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the inbound endpoints for a DNS resolver.", + "type": "array", + "items": { + "$ref": "#/definitions/InboundEndpoint" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "OutboundEndpointProperties": { + "description": "Represents the properties of an outbound endpoint for a DNS resolver.", + "type": "object", + "required": [ + "subnet" + ], + "properties": { + "subnet": { + "description": "The reference to the subnet used for the outbound endpoint.", + "$ref": "#/definitions/SubResource" + }, + "provisioningState": { + "description": "The current provisioning state of the outbound endpoint. This is a read-only property and any attempt to set this value will be ignored.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + }, + "resourceGuid": { + "description": "The resourceGuid property of the outbound endpoint resource.", + "readOnly": true, + "$ref": "#/definitions/ResourceGuid" + } + } + }, + "OutboundEndpoint": { + "description": "Describes an outbound endpoint for a DNS resolver.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the outbound endpoint.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the outbound endpoint.", + "$ref": "#/definitions/OutboundEndpointProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "OutboundEndpointPatch": { + "description": "Describes an outbound endpoint for a DNS resolver for PATCH operation.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags for outbound endpoint." + } + } + }, + "OutboundEndpointListResult": { + "description": "The response to an enumeration operation on outbound endpoints for a DNS resolver.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the outbound endpoints for a DNS resolver.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundEndpoint" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "DnsForwardingRulesetProperties": { + "description": "Represents the properties of a DNS forwarding ruleset.", + "type": "object", + "required": [ + "dnsResolverOutboundEndpoints" + ], + "properties": { + "dnsResolverOutboundEndpoints": { + "description": "The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in the ruleset to the target DNS servers.", + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + "provisioningState": { + "description": "The current provisioning state of the DNS forwarding ruleset. This is a read-only property and any attempt to set this value will be ignored.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + }, + "resourceGuid": { + "description": "The resourceGuid for the DNS forwarding ruleset.", + "type": "string", + "readOnly": true + } + } + }, + "DnsForwardingRuleset": { + "description": "Describes a DNS forwarding ruleset.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the DNS forwarding ruleset.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the DNS forwarding ruleset.", + "$ref": "#/definitions/DnsForwardingRulesetProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "DnsForwardingRulesetPatch": { + "description": "Describes a DNS forwarding ruleset PATCH operation.", + "type": "object", + "properties": { + "dnsResolverOutboundEndpoints": { + "description": "The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in the ruleset to the target DNS servers.", + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags for DNS Resolver." + } + } + }, + "DnsForwardingRulesetListResult": { + "description": "The response to an enumeration operation on DNS forwarding rulesets.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the DNS forwarding rulesets.", + "type": "array", + "items": { + "$ref": "#/definitions/DnsForwardingRuleset" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ForwardingRuleProperties": { + "description": "Represents the properties of a forwarding rule within a DNS forwarding ruleset.", + "type": "object", + "required": [ + "domainName", + "targetDnsServers" + ], + "properties": { + "domainName": { + "description": "The domain name for the forwarding rule.", + "type": "string" + }, + "targetDnsServers": { + "description": "DNS servers to forward the DNS query to.", + "type": "array", + "items": { + "$ref": "#/definitions/TargetDnsServer" + }, + "x-ms-identifiers": [] + }, + "metadata": { + "description": "Metadata attached to the forwarding rule.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "forwardingRuleState": { + "type": "string", + "description": "The state of forwarding rule.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ForwardingRuleState", + "modelAsString": true + } + }, + "provisioningState": { + "description": "The current provisioning state of the forwarding rule. This is a read-only property and any attempt to set this value will be ignored.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "ForwardingRule": { + "description": "Describes a forwarding rule within a DNS forwarding ruleset.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the forwarding rule.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the forwarding rule.", + "$ref": "#/definitions/ForwardingRuleProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ForwardingRulePatchProperties": { + "description": "Represents the updatable properties of a forwarding rule within a DNS forwarding ruleset.", + "type": "object", + "properties": { + "targetDnsServers": { + "description": "DNS servers to forward the DNS query to.", + "type": "array", + "items": { + "$ref": "#/definitions/TargetDnsServer" + }, + "x-ms-identifiers": [] + }, + "metadata": { + "description": "Metadata attached to the forwarding rule.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "forwardingRuleState": { + "type": "string", + "description": "The state of forwarding rule.", + "enum": [ + "Enabled", + "Disabled" + ], + "default": "Enabled", + "x-ms-enum": { + "name": "ForwardingRuleState", + "modelAsString": true + } + } + } + }, + "ForwardingRulePatch": { + "description": "Describes a forwarding rule for PATCH operation.", + "type": "object", + "properties": { + "properties": { + "description": "Updatable properties of the forwarding rule.", + "$ref": "#/definitions/ForwardingRulePatchProperties", + "x-ms-client-flatten": true + } + } + }, + "ForwardingRuleListResult": { + "description": "The response to an enumeration operation on forwarding rules within a DNS forwarding ruleset.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the forwarding rules.", + "type": "array", + "items": { + "$ref": "#/definitions/ForwardingRule" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "VirtualNetworkLinkProperties": { + "description": "Represents the properties of a virtual network link.", + "type": "object", + "required": [ + "virtualNetwork" + ], + "properties": { + "virtualNetwork": { + "description": "The reference to the virtual network. This cannot be changed after creation.", + "$ref": "#/definitions/SubResource" + }, + "metadata": { + "description": "Metadata attached to the virtual network link.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "description": "The current provisioning state of the virtual network link. This is a read-only property and any attempt to set this value will be ignored.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "VirtualNetworkLink": { + "description": "Describes a virtual network link.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the virtual network link.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the virtual network link.", + "$ref": "#/definitions/VirtualNetworkLinkProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "VirtualNetworkLinkPatchProperties": { + "description": "Represents the updatable properties of the virtual network link.", + "type": "object", + "properties": { + "metadata": { + "description": "Metadata attached to the virtual network link.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VirtualNetworkLinkPatch": { + "description": "Describes a virtual network link for PATCH operation.", + "type": "object", + "properties": { + "properties": { + "description": "Updatable properties of the virtual network link.", + "$ref": "#/definitions/VirtualNetworkLinkPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "VirtualNetworkLinkListResult": { + "description": "The response to an enumeration operation on virtual network links.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the virtual network links.", + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkLink" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "IpConfiguration": { + "description": "IP configuration.", + "type": "object", + "required": [ + "subnet" + ], + "properties": { + "subnet": { + "description": "The reference to the subnet bound to the IP configuration.", + "$ref": "#/definitions/SubResource" + }, + "privateIpAddress": { + "description": "Private IP address of the IP configuration.", + "type": "string" + }, + "privateIpAllocationMethod": { + "description": "Private IP address allocation method.", + "type": "string", + "enum": [ + "Static", + "Dynamic" + ], + "default": "Dynamic", + "x-ms-enum": { + "name": "IpAllocationMethod", + "modelAsString": true + } + } + } + }, + "TargetDnsServer": { + "description": "Describes a server to forward the DNS queries to.", + "type": "object", + "required": [ + "ipAddress" + ], + "properties": { + "ipAddress": { + "description": "DNS server IP address.", + "type": "string" + }, + "port": { + "description": "DNS server port.", + "type": "integer", + "format": "int32", + "default": 53 + } + } + }, + "ProvisioningState": { + "description": "The current provisioning state of the resource.", + "type": "string", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "ResourceGuid": { + "type": "string", + "description": "The Guid property of the resource." + }, + "SubResourceListResult": { + "description": "The response to an enumeration operation on sub-resources.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the sub-resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SubResource": { + "description": "Reference to another ARM resource.", + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "x-ms-azure-resource": true + }, + "VirtualNetworkDnsForwardingRulesetListResult": { + "description": "The response to an enumeration operation on Virtual Network DNS Forwarding Ruleset.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the Virtual Network DNS Forwarding Ruleset.", + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkDnsForwardingRuleset" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "VirtualNetworkLinkSubResourceProperties": { + "description": "The reference to the virtual network link that associates between the DNS forwarding ruleset and virtual network.", + "type": "object", + "properties": { + "virtualNetworkLink": { + "description": "The reference to the virtual network link.", + "$ref": "#/definitions/SubResource" + } + } + }, + "VirtualNetworkDnsForwardingRuleset": { + "description": "Reference to DNS forwarding ruleset and associated virtual network link.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "DNS Forwarding Ruleset Resource ID." + }, + "properties": { + "description": "Properties of the virtual network link sub-resource reference.", + "$ref": "#/definitions/VirtualNetworkLinkSubResourceProperties", + "x-ms-client-flatten": true + } + } + }, + "CloudError": { + "description": "An error message", + "type": "object", + "properties": { + "error": { + "description": "The error message body", + "$ref": "#/definitions/CloudErrorBody" + } + }, + "x-ms-external": true + }, + "CloudErrorBody": { + "description": "The body of an error message", + "type": "object", + "properties": { + "code": { + "description": "The error code", + "type": "string" + }, + "message": { + "description": "A description of what caused the error", + "type": "string" + }, + "target": { + "description": "The target resource of the error message", + "type": "string" + }, + "details": { + "description": "Extra error information", + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-external": true + } + }, + "parameters": { + "DnsResolverNameParameter": { + "name": "dnsResolverName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DNS resolver.", + "x-ms-parameter-location": "method" + }, + "InboundEndpointNameParameter": { + "name": "inboundEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the inbound endpoint for the DNS resolver.", + "x-ms-parameter-location": "method" + }, + "VirtualNetworkNameParameter": { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network.", + "x-ms-parameter-location": "method" + }, + "OutboundEndpointNameParameter": { + "name": "outboundEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the outbound endpoint for the DNS resolver.", + "x-ms-parameter-location": "method" + }, + "DnsForwardingRulesetNameParameter": { + "name": "dnsForwardingRulesetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DNS forwarding ruleset.", + "x-ms-parameter-location": "method" + }, + "ForwardingRuleNameParameter": { + "name": "forwardingRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the forwarding rule.", + "x-ms-parameter-location": "method" + }, + "VirtualNetworkLinkNameParameter": { + "name": "virtualNetworkLinkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network link.", + "x-ms-parameter-location": "method" + }, + "TopParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of results to return. If not specified, returns up to 100 results.", + "x-ms-parameter-location": "method" + }, + "IfMatchParameter": { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.", + "x-ms-parameter-location": "method" + }, + "IfNoneMatchParameter": { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dnsresolverpolicy.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dnsresolverpolicy.json new file mode 100644 index 000000000000..f0415f04a869 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dnsresolverpolicy.json @@ -0,0 +1,1828 @@ +{ + "swagger": "2.0", + "info": { + "title": "DnsResolverPolicyManagementClient", + "description": "The DNS Resolver Policy Management Client.", + "version": "2023-07-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}": { + "put": { + "tags": [ + "DnsResolverPolicies" + ], + "operationId": "DnsResolverPolicies_CreateOrUpdate", + "description": "Creates or updates a DNS resolver policy.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsResolverPolicy" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The DNS resolver policy has been created.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicy" + } + }, + "200": { + "description": "The DNS resolver policy has been updated.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicy" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upsert DNS resolver policy": { + "$ref": "./examples/DnsResolverPolicy_Put.json" + } + } + }, + "patch": { + "tags": [ + "DnsResolverPolicies" + ], + "operationId": "DnsResolverPolicies_Update", + "description": "Updates a DNS resolver policy.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsResolverPolicyPatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver policy has been updated.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicy" + } + }, + "202": { + "description": "The operation to update DNS resolver policy has been accepted and will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update DNS resolver policy": { + "$ref": "./examples/DnsResolverPolicy_Patch.json" + } + } + }, + "delete": { + "tags": [ + "DnsResolverPolicies" + ], + "operationId": "DnsResolverPolicies_Delete", + "description": "Deletes a DNS resolver policy. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "202": { + "description": "The operation to delete DNS resolver policy has been accepted and will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "The DNS resolver policy was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete DNS resolver policy": { + "$ref": "./examples/DnsResolverPolicy_Delete.json" + } + } + }, + "get": { + "tags": [ + "DnsResolverPolicies" + ], + "operationId": "DnsResolverPolicies_Get", + "description": "Gets properties of a DNS resolver policy.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver policy was found.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicy" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieve DNS resolver policy": { + "$ref": "./examples/DnsResolverPolicy_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies": { + "get": { + "tags": [ + "DnsResolverPolicies" + ], + "operationId": "DnsResolverPolicies_ListByResourceGroup", + "description": "Lists DNS resolver policies within a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolver policies in the resource group.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicyListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS resolver policies by resource group": { + "$ref": "./examples/DnsResolverPolicy_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsResolverPolicies": { + "get": { + "tags": [ + "DnsResolverPolicies" + ], + "operationId": "DnsResolverPolicies_List", + "description": "Lists DNS resolver policies in all resource groups of a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolver policies in the subscription.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicyListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS resolver policies by subscription": { + "$ref": "./examples/DnsResolverPolicy_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/dnsSecurityRules/{dnsSecurityRuleName}": { + "put": { + "tags": [ + "DnsSecurityRules" + ], + "operationId": "DnsSecurityRules_CreateOrUpdate", + "description": "Creates or updates a DNS security rule for a DNS resolver policy.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "#/parameters/DnsSecurityRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsSecurityRule" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The DNS security rule has been created.", + "schema": { + "$ref": "#/definitions/DnsSecurityRule" + } + }, + "200": { + "description": "The DNS security rule has been updated.", + "schema": { + "$ref": "#/definitions/DnsSecurityRule" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upsert DNS security rule": { + "$ref": "./examples/DnsSecurityRule_Put.json" + } + } + }, + "patch": { + "tags": [ + "DnsSecurityRules" + ], + "operationId": "DnsSecurityRules_Update", + "description": "Updates a DNS security rule.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "#/parameters/DnsSecurityRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsSecurityRulePatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The DNS security rule has been updated.", + "schema": { + "$ref": "#/definitions/DnsSecurityRule" + } + }, + "202": { + "description": "The operation to update the DNS security rule has been accepted and will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update DNS security rule for DNS resolver policy": { + "$ref": "./examples/DnsSecurityRule_Patch.json" + } + } + }, + "delete": { + "tags": [ + "DnsSecurityRules" + ], + "operationId": "DnsSecurityRules_Delete", + "description": "Deletes a DNS security rule for a DNS resolver policy. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "#/parameters/DnsSecurityRuleNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "202": { + "description": "The operation to delete the DNS security rule has been accepted and will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "The DNS security rule was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete DNS security rule for DNS resolver policy": { + "$ref": "./examples/DnsSecurityRule_Delete.json" + } + } + }, + "get": { + "tags": [ + "DnsSecurityRules" + ], + "operationId": "DnsSecurityRules_Get", + "description": "Gets properties of a DNS security rule for a DNS resolver policy.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "#/parameters/DnsSecurityRuleNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The DNS security rule was found.", + "schema": { + "$ref": "#/definitions/DnsSecurityRule" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieve DNS security rule for DNS resolver policy": { + "$ref": "./examples/DnsSecurityRule_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/dnsSecurityRules": { + "get": { + "tags": [ + "DnsSecurityRules" + ], + "operationId": "DnsSecurityRules_List", + "description": "Lists DNS security rules for a DNS resolver policy.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS security rules for the DNS resolver policy.", + "schema": { + "$ref": "#/definitions/DnsSecurityRuleListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS security rules by DNS resolver policy": { + "$ref": "./examples/DnsSecurityRule_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/virtualNetworkLinks/{dnsResolverPolicyVirtualNetworkLinkName}": { + "put": { + "tags": [ + "DnsResolverPolicyVirtualNetworkLinks" + ], + "operationId": "DnsResolverPolicyVirtualNetworkLinks_CreateOrUpdate", + "description": "Creates or updates a DNS resolver policy virtual network link.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyVirtualNetworkLinkNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLink" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The DNS resolver policy virtual network link has been created.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLink" + } + }, + "200": { + "description": "The DNS resolver policy virtual network link has been updated.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLink" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upsert DNS resolver policy virtual network link": { + "$ref": "./examples/DnsResolverPolicyVirtualNetworkLink_Put.json" + } + } + }, + "patch": { + "tags": [ + "DnsResolverPolicyVirtualNetworkLinks" + ], + "operationId": "DnsResolverPolicyVirtualNetworkLinks_Update", + "description": "Updates a DNS resolver policy virtual network link.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyVirtualNetworkLinkNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLinkPatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver policy virtual network link has been updated.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLink" + } + }, + "202": { + "description": "The operation to update DNS resolver policy virtual network link has been accepted and will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update DNS resolver policy virtual network link": { + "$ref": "./examples/DnsResolverPolicyVirtualNetworkLink_Patch.json" + } + } + }, + "delete": { + "tags": [ + "DnsResolverPolicyVirtualNetworkLinks" + ], + "operationId": "DnsResolverPolicyVirtualNetworkLinks_Delete", + "description": "Deletes a DNS resolver policy virtual network link. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyVirtualNetworkLinkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "202": { + "description": "The operation to delete the DNS resolver policy virtual network link has been accepted and will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "The DNS resolver policy virtual network link was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete DNS resolver policy virtual network link": { + "$ref": "./examples/DnsResolverPolicyVirtualNetworkLink_Delete.json" + } + } + }, + "get": { + "tags": [ + "DnsResolverPolicyVirtualNetworkLinks" + ], + "operationId": "DnsResolverPolicyVirtualNetworkLinks_Get", + "description": "Gets properties of a DNS resolver policy virtual network link.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyVirtualNetworkLinkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver policy virtual network link was found.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLink" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieve DNS resolver policy virtual network link": { + "$ref": "./examples/DnsResolverPolicyVirtualNetworkLink_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/virtualNetworkLinks": { + "get": { + "tags": [ + "DnsResolverPolicyVirtualNetworkLinks" + ], + "operationId": "DnsResolverPolicyVirtualNetworkLinks_List", + "description": "Lists DNS resolver policy virtual network links.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolver policy virtual network links.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLinkListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS resolver policy virtual network links by DNS resolver policy": { + "$ref": "./examples/DnsResolverPolicyVirtualNetworkLink_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverDomainLists/{dnsResolverDomainListName}": { + "put": { + "tags": [ + "DnsResolverDomainLists" + ], + "operationId": "DnsResolverDomainLists_CreateOrUpdate", + "description": "Creates or updates a DNS resolver domain list.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverDomainListNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsResolverDomainList" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The DNS resolver domain list has been created.", + "schema": { + "$ref": "#/definitions/DnsResolverDomainList" + } + }, + "200": { + "description": "The DNS resolver domain list has been updated.", + "schema": { + "$ref": "#/definitions/DnsResolverDomainList" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upsert DNS resolver domain list": { + "$ref": "./examples/DnsResolverDomainList_Put.json" + } + } + }, + "patch": { + "tags": [ + "DnsResolverDomainLists" + ], + "operationId": "DnsResolverDomainLists_Update", + "description": "Updates a DNS resolver domain list.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverDomainListNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsResolverDomainListPatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver domain list has been updated.", + "schema": { + "$ref": "#/definitions/DnsResolverDomainList" + } + }, + "202": { + "description": "The operation to update DNS resolver domain list has been accepted and will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update DNS resolver domain list": { + "$ref": "./examples/DnsResolverDomainList_Patch.json" + } + } + }, + "delete": { + "tags": [ + "DnsResolverDomainLists" + ], + "operationId": "DnsResolverDomainLists_Delete", + "description": "Deletes a DNS resolver domain list. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverDomainListNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "202": { + "description": "The operation to delete DNS resolver domain list has been accepted and will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "The DNS resolver domain list was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete DNS resolver domain list": { + "$ref": "./examples/DnsResolverDomainList_Delete.json" + } + } + }, + "get": { + "tags": [ + "DnsResolverDomainLists" + ], + "operationId": "DnsResolverDomainLists_Get", + "description": "Gets properties of a DNS resolver domain list.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverDomainListNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver domain list was found.", + "schema": { + "$ref": "#/definitions/DnsResolverDomainList" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieve DNS resolver domain list": { + "$ref": "./examples/DnsResolverDomainList_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverDomainLists": { + "get": { + "tags": [ + "DnsResolverDomainLists" + ], + "operationId": "DnsResolverDomainLists_ListByResourceGroup", + "description": "Lists DNS resolver domain lists within a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolver domain lists in the resource group.", + "schema": { + "$ref": "#/definitions/DnsResolverDomainListListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS resolver domain lists by resource group": { + "$ref": "./examples/DnsResolverDomainList_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsResolverDomainLists": { + "get": { + "tags": [ + "DnsResolverDomainLists" + ], + "operationId": "DnsResolverDomainLists_List", + "description": "Lists DNS resolver domain lists in all resource groups of a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolver domain lists in the subscription.", + "schema": { + "$ref": "#/definitions/DnsResolverDomainListListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS resolver domain lists by subscription": { + "$ref": "./examples/DnsResolverDomainList_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/listDnsResolverPolicies": { + "post": { + "tags": [ + "DnsResolverPolicies" + ], + "operationId": "DnsResolverPolicies_ListByVirtualNetwork", + "description": "Lists DNS resolver policy resource IDs linked to a virtual network.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolver policy resource IDs linked to the virtual network.", + "schema": { + "$ref": "#/definitions/SubResourceListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS resolver policies by virtual network": { + "$ref": "./examples/DnsResolverPolicy_ListByVirtualNetwork.json" + } + } + } + } + }, + "definitions": { + "DnsResolverPolicyProperties": { + "description": "Represents the properties of a DNS resolver policy.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The current provisioning state of the DNS resolver policy. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "resourceGuid": { + "description": "The resourceGuid property of the DNS resolver policy resource.", + "readOnly": true, + "$ref": "#/definitions/ResourceGuid" + } + } + }, + "DnsResolverPolicy": { + "description": "Describes a DNS resolver policy.", + "type": "object", + "properties": { + "etag": { + "description": "ETag of the DNS resolver policy.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the DNS resolver policy.", + "$ref": "#/definitions/DnsResolverPolicyProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "DnsResolverPolicyPatch": { + "description": "Describes a DNS resolver policy for PATCH operation.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags for DNS resolver policy." + } + } + }, + "DnsResolverPolicyListResult": { + "description": "The response to an enumeration operation on DNS resolver policies.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the DNS resolver policies.", + "type": "array", + "items": { + "$ref": "#/definitions/DnsResolverPolicy" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "DnsSecurityRuleProperties": { + "description": "Represents the properties of a DNS security rule.", + "type": "object", + "required": [ + "priority", + "action", + "dnsResolverDomainLists" + ], + "properties": { + "priority": { + "description": "The priority of the DNS security rule.", + "type": "integer", + "format": "int32", + "x-ms-mutability": [ + "read", + "create", + "update" + ] + }, + "action": { + "description": "The action to take on DNS requests that match the DNS security rule.", + "$ref": "#/definitions/DnsSecurityRuleAction" + }, + "dnsResolverDomainLists": { + "description": "DNS resolver policy domains lists that the DNS security rule applies to.", + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "x-ms-identifiers": [] + }, + "dnsSecurityRuleState": { + "type": "string", + "description": "The state of DNS security rule.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "DnsSecurityRuleState", + "modelAsString": true + } + }, + "provisioningState": { + "description": "The current provisioning state of the DNS security rule. This is a read-only property and any attempt to set this value will be ignored.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "DnsSecurityRule": { + "description": "Describes a DNS security rule.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the DNS security rule.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the DNS security rule.", + "$ref": "#/definitions/DnsSecurityRuleProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "DnsSecurityRulePatchProperties": { + "description": "Represents the updatable properties of a DNS security rule.", + "type": "object", + "properties": { + "action": { + "description": "The action to take on DNS requests that match the DNS security rule.", + "$ref": "#/definitions/DnsSecurityRuleAction" + }, + "dnsResolverDomainLists": { + "description": "DNS resolver policy domains lists that the DNS security rule applies to.", + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "x-ms-identifiers": [] + }, + "dnsSecurityRuleState": { + "type": "string", + "description": "The state of DNS security rule.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "DnsSecurityRuleState", + "modelAsString": true + } + }, + "priority": { + "description": "The priority of the DNS security rule.", + "type": "integer", + "format": "int32", + "x-ms-mutability": [ + "read", + "create", + "update" + ] + } + } + }, + "DnsSecurityRulePatch": { + "description": "Describes a DNS security rule for PATCH operation.", + "type": "object", + "properties": { + "properties": { + "description": "Updatable properties of the DNS security rule.", + "$ref": "#/definitions/DnsSecurityRulePatchProperties", + "x-ms-client-flatten": true + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags for DNS security rule." + } + } + }, + "DnsSecurityRuleListResult": { + "description": "The response to an enumeration operation on DNS security rules within a DNS resolver policy.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the DNS security rules.", + "type": "array", + "items": { + "$ref": "#/definitions/DnsSecurityRule" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "DnsSecurityRuleAction": { + "description": "The action to take on DNS requests that match the DNS security rule.", + "type": "object", + "properties": { + "actionType": { + "type": "string", + "description": "The type of action to take.", + "enum": [ + "Allow", + "Alert", + "Block" + ], + "x-ms-enum": { + "name": "actionType", + "modelAsString": true + } + }, + "blockResponseCode": { + "type": "string", + "description": "The response code for block actions.", + "enum": [ + "SERVFAIL" + ], + "x-ms-enum": { + "name": "BlockResponseCode", + "modelAsString": true + } + } + } + }, + "DnsResolverPolicyVirtualNetworkLinkProperties": { + "description": "Represents the properties of a DNS resolver policy virtual network link.", + "type": "object", + "required": [ + "virtualNetwork" + ], + "properties": { + "virtualNetwork": { + "description": "The reference to the virtual network. This cannot be changed after creation.", + "x-ms-mutability": [ + "read", + "create" + ], + "$ref": "#/definitions/SubResource" + }, + "provisioningState": { + "description": "The current provisioning state of the DNS resolver policy virtual network link. This is a read-only property and any attempt to set this value will be ignored.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "DnsResolverPolicyVirtualNetworkLink": { + "description": "Describes a DNS resolver policy virtual network link.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the DNS resolver policy virtual network link.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the DNS resolver policy virtual network link.", + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLinkProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "DnsResolverPolicyVirtualNetworkLinkPatch": { + "description": "Describes a DNS resolver policy virtual network link for PATCH operation.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags for the DNS resolver policy virtual network link." + } + } + }, + "DnsResolverPolicyVirtualNetworkLinkListResult": { + "description": "The response to an enumeration operation on DNS resolver policy virtual network links.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the DNS resolver policy virtual network links.", + "type": "array", + "items": { + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLink" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "DnsResolverDomainListProperties": { + "description": "Represents the properties of a DNS resolver domain list.", + "type": "object", + "required": [ + "domains" + ], + "properties": { + "domains": { + "description": "The domains in the domain list.", + "type": "array", + "items": { + "type": "string" + } + }, + "provisioningState": { + "description": "The current provisioning state of the DNS resolver domain list. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "resourceGuid": { + "description": "The resourceGuid property of the DNS resolver domain list resource.", + "readOnly": true, + "$ref": "#/definitions/ResourceGuid" + } + } + }, + "DnsResolverDomainList": { + "description": "Describes a DNS resolver domain list.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the DNS resolver domain list.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the DNS resolver domain list.", + "$ref": "#/definitions/DnsResolverDomainListProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "DnsResolverDomainListPatchProperties": { + "description": "Represents the updatable properties of a DNS resolver domain list.", + "type": "object", + "properties": { + "domains": { + "description": "The domains in the domain list.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DnsResolverDomainListPatch": { + "description": "Describes a DNS resolver domain list for PATCH operation.", + "type": "object", + "properties": { + "properties": { + "description": "Updatable properties of the DNS resolver policy virtual network link.", + "$ref": "#/definitions/DnsResolverDomainListPatchProperties", + "x-ms-client-flatten": true + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags for DNS resolver domain list." + } + } + }, + "DnsResolverDomainListListResult": { + "description": "The response to an enumeration operation on DNS resolver domain lists.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the DNS resolver domain lists.", + "type": "array", + "items": { + "$ref": "#/definitions/DnsResolverDomainList" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ProvisioningState": { + "description": "The current provisioning state of the resource.", + "type": "string", + "readOnly": true, + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "ResourceGuid": { + "type": "string", + "description": "The Guid property of the resource." + }, + "SubResourceListResult": { + "description": "The response to an enumeration operation on sub-resources.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the sub-resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SubResource": { + "description": "Reference to another ARM resource.", + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "DnsResolverPolicyNameParameter": { + "name": "dnsResolverPolicyName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9_\\-]*[a-zA-Z0-9])?$", + "minLength": 1, + "maxLength": 80, + "description": "The name of the DNS resolver policy.", + "x-ms-parameter-location": "method" + }, + "DnsSecurityRuleNameParameter": { + "name": "dnsSecurityRuleName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9_\\-]*[a-zA-Z0-9])?$", + "minLength": 1, + "maxLength": 80, + "description": "The name of the DNS security rule.", + "x-ms-parameter-location": "method" + }, + "DnsResolverPolicyVirtualNetworkLinkNameParameter": { + "name": "dnsResolverPolicyVirtualNetworkLinkName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9_\\-]*[a-zA-Z0-9])?$", + "minLength": 1, + "maxLength": 80, + "description": "The name of the DNS resolver policy virtual network link for the DNS resolver policy.", + "x-ms-parameter-location": "method" + }, + "DnsResolverDomainListNameParameter": { + "name": "dnsResolverDomainListName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9_\\-]*[a-zA-Z0-9])?$", + "minLength": 1, + "maxLength": 80, + "description": "The name of the DNS resolver domain list.", + "x-ms-parameter-location": "method" + }, + "VirtualNetworkNameParameter": { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^.+$", + "minLength": 1, + "description": "The name of the virtual network.", + "x-ms-parameter-location": "method" + }, + "TopParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of results to return. If not specified, returns up to 100 results.", + "x-ms-parameter-location": "method" + }, + "IfMatchParameter": { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.", + "x-ms-parameter-location": "method" + }, + "IfNoneMatchParameter": { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Delete.json new file mode 100644 index 000000000000..7107b1f637dd --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "samplednsForwardingRulesetName", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Get.json new file mode 100644 index 000000000000..94c2a7a063cf --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset", + "name": "sampleDnsForwardingRuleset", + "type": "Microsoft.Network/dnsForwardingRulesets", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint0" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint1" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListByResourceGroup.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListByResourceGroup.json new file mode 100644 index 000000000000..1f05389ae97c --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListByResourceGroup.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset", + "name": "sampleDnsForwardingRuleset", + "type": "Microsoft.Network/dnsForwardingRulesets", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint0" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint1" + } + ], + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset1", + "name": "sampleDnsForwardingRuleset", + "type": "Microsoft.Network/dnsForwardingRulesets", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-04T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-05T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint2" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint3" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "c2aed17a-708d-48d1-89c3-d6a9b648d222" + } + } + ], + "nextLink": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListBySubscription.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListBySubscription.json new file mode 100644 index 000000000000..456dc7d6fb19 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListBySubscription.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset", + "name": "sampleDnsForwardingRuleset", + "type": "Microsoft.Network/dnsForwardingRulesets", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint0" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint1" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset1", + "name": "sampleDnsForwardingRuleset", + "type": "Microsoft.Network/dnsForwardingRulesets", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-04T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-05T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint2" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint3" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8" + } + } + ], + "nextLink": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/providers/Microsoft.Network/dnsForwardingRulesets?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListByVirtualNetwork.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListByVirtualNetwork.json new file mode 100644 index 000000000000..e525fd69f74c --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListByVirtualNetwork.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "virtualNetworkName": "sampleVirtualNetwork", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset", + "properties": { + "virtualNetworkLink": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRuleset/sampleDnsForwardingRuleset/virtualNetworkLinks/sampleVirtualNetworkLink" + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Patch.json new file mode 100644 index 000000000000..1b9900f9de3c --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Patch.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "api-version": "2023-07-01-preview", + "parameters": { + "tags": { + "key1": "value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset", + "name": "sampleDnsForwardingRuleset", + "type": "Microsoft.Network/dnsForwardingRulesets", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint0" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint1" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Put.json new file mode 100644 index 000000000000..80d0d41b1f0b --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Put.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "samplednsForwardingRuleset", + "api-version": "2023-07-01-preview", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "westus2", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint0" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint1" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset", + "name": "sampleDnsForwardingRuleset", + "type": "Microsoft.Network/dnsForwardingRulesets", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint0" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint1" + } + ], + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8", + "provisioningState": "Succeeded" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset", + "name": "sampleDnsForwardingRuleset", + "type": "Microsoft.Network/dnsForwardingRulesets", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint0" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint1" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Delete.json new file mode 100644 index 000000000000..34061d8643e9 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverDomainListName": "sampleDnsResolverDomainList", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Get.json new file mode 100644 index 000000000000..e8b62627ad8d --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverDomainListName": "sampleDnsResolverDomainList", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList", + "name": "sampleDnsResolverDomainList", + "type": "Microsoft.Network/dnsResolverDomainLists", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ], + "provisioningState": "Succeeded", + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_ListByResourceGroup.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_ListByResourceGroup.json new file mode 100644 index 000000000000..711a46672b21 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_ListByResourceGroup.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList1", + "name": "sampleDnsResolverDomainList1", + "type": "Microsoft.Network/dnsResolverDomainLists", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ], + "provisioningState": "Succeeded", + "resourceGuid": "ad9c8da4-3bb2-4821-a878-c2cb07b01fb6" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList2", + "name": "sampleDnsResolverDomainList2", + "type": "Microsoft.Network/dnsResolverDomainLists", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ], + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_ListBySubscription.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_ListBySubscription.json new file mode 100644 index 000000000000..3243f2b0f3c2 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_ListBySubscription.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList1", + "name": "sampleDnsResolverDomainList1", + "type": "Microsoft.Network/dnsResolverDomainLists", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ], + "provisioningState": "Succeeded", + "resourceGuid": "ad9c8da4-3bb2-4821-a878-c2cb07b01fb6" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList2", + "name": "sampleDnsResolverDomainList2", + "type": "Microsoft.Network/dnsResolverDomainLists", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ], + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/providers/Microsoft.Network/dnsResolverDomainLists?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Patch.json new file mode 100644 index 000000000000..d307656d2f7d --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Patch.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverDomainListName": "sampleDnsResolverDomainList", + "api-version": "2023-07-01-preview", + "parameters": { + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList", + "name": "sampleDnsResolverDomainList", + "type": "Microsoft.Network/dnsResolverDomainLists", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ], + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Put.json new file mode 100644 index 000000000000..b8f9bf2ddb5c --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Put.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverDomainListName": "sampleDnsResolverDomainList", + "api-version": "2023-07-01-preview", + "parameters": { + "location": "westus2", + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ] + } + } + }, + "responses": { + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + }, + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList", + "name": "sampleDnsResolverDomainList", + "type": "Microsoft.Network/dnsResolverDomainLists", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ], + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + }, + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + }, + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList", + "name": "sampleDnsResolverDomainList", + "type": "Microsoft.Network/dnsResolverDomainLists", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ], + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Delete.json new file mode 100644 index 000000000000..a1e86cff9cc2 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "dnsResolverPolicyVirtualNetworkLinkName": "sampleVirtualNetworkLink", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Get.json new file mode 100644 index 000000000000..348e02fd2b7d --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "dnsResolverPolicyVirtualNetworkLinkName": "sampleVirtualNetworkLink", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsResolverPolicies/virtualNetworkLinks", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_List.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_List.json new file mode 100644 index 000000000000..4a8f966a8a93 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_List.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsResolverPolicies/virtualNetworkLinks", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "provisioningState": "Succeeded" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Patch.json new file mode 100644 index 000000000000..8c89c19d29dd --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Patch.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "dnsResolverPolicyVirtualNetworkLinkName": "sampleVirtualNetworkLink", + "parameters": { + "tags": { + "key1": "value1" + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsResolverPolicies/virtualNetworkLinks", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Put.json new file mode 100644 index 000000000000..909d98942841 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Put.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "dnsResolverPolicyVirtualNetworkLinkName": "sampleVirtualNetworkLink", + "parameters": { + "location": "westus2", + "tags": { + "key1": "value1" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + } + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + }, + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicy/sampleDnsResolverPolicy/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsResolverPolicies/virtualNetworkLinks", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "provisioningState": "Succeeded" + } + } + }, + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + }, + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicy/sampleDnsResolverPolicy/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsResolverPolicies/virtualNetworkLinks", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Delete.json new file mode 100644 index 000000000000..7166c3551217 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Get.json new file mode 100644 index 000000000000..9a39f19360e0 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy", + "name": "sampleDnsResolverPolicy", + "type": "Microsoft.Network/dnsResolverPolicies", + "location": "westus2", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2023-07-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2023-07-04T02:03:01.1974346Z" + }, + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListByResourceGroup.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListByResourceGroup.json new file mode 100644 index 000000000000..32c0a6a472e1 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListByResourceGroup.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy1", + "name": "sampleDnsResolverPolicy1", + "type": "Microsoft.Network/dnsResolverPolicies", + "location": "westus2", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "ad9c8da4-3bb2-4821-a878-c2cb07b01fb6" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy2", + "name": "sampleDnsResolverPolicy2", + "type": "Microsoft.Network/dnsResolverPolicies", + "location": "westus2", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListBySubscription.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListBySubscription.json new file mode 100644 index 000000000000..9b8fedadb3e2 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListBySubscription.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy1", + "name": "sampleDnsResolverPolicy1", + "type": "Microsoft.Network/dnsResolverPolicies", + "location": "westus2", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "ad9c8da4-3bb2-4821-a878-c2cb07b01fb6" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy2", + "name": "sampleDnsResolverPolicy2", + "type": "Microsoft.Network/dnsResolverPolicies", + "location": "westus2", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/providers/Microsoft.Network/dnsResolverPolicies?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListByVirtualNetwork.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListByVirtualNetwork.json new file mode 100644 index 000000000000..34220c360186 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListByVirtualNetwork.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "virtualNetworkName": "sampleVirtualNetwork", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy1" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Patch.json new file mode 100644 index 000000000000..9539b679c7c4 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Patch.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "api-version": "2023-07-01-preview", + "parameters": { + "tags": { + "key1": "value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy", + "name": "sampleDnsResolverPolicy", + "type": "Microsoft.Network/dnsResolverPolicies", + "location": "westus2", + "tags": { + "key1": "value1" + }, + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Put.json new file mode 100644 index 000000000000..e6fb7d148f45 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Put.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "api-version": "2023-07-01-preview", + "parameters": { + "location": "westus2", + "tags": { + "key1": "value1" + } + } + }, + "responses": { + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + }, + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy", + "name": "sampleDnsResolverPolicy", + "type": "Microsoft.Network/dnsResolverPolicies", + "location": "westus2", + "tags": { + "key1": "value1" + }, + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + }, + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + }, + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy", + "name": "sampleDnsResolverPolicy", + "type": "Microsoft.Network/dnsResolverPolicies", + "location": "westus2", + "tags": { + "key1": "value1" + }, + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Delete.json new file mode 100644 index 000000000000..ff36658d7bcb --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Get.json new file mode 100644 index 000000000000..a7e6b4c97012 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver", + "name": "sampleDnsResolver", + "type": "Microsoft.Network/dnsResolvers", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "dnsResolverState": "Connected", + "provisioningState": "Succeeded", + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListByResourceGroup.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListByResourceGroup.json new file mode 100644 index 000000000000..83152bce7a58 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListByResourceGroup.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver1", + "name": "sampleDnsResolver1", + "type": "Microsoft.Network/dnsResolvers", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork1" + }, + "dnsResolverState": "Connected", + "provisioningState": "Succeeded", + "resourceGuid": "ad9c8da4-3bb2-4821-a878-c2cb07b01fb6" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver2", + "name": "sampleDnsResolver2", + "type": "Microsoft.Network/dnsResolvers", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork2" + }, + "dnsResolverState": "Connected", + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + ], + "nextLink": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListBySubscription.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListBySubscription.json new file mode 100644 index 000000000000..fdd09c22f0da --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListBySubscription.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver1", + "name": "sampleDnsResolver1", + "type": "Microsoft.Network/dnsResolvers", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork1" + }, + "dnsResolverState": "Connected", + "provisioningState": "Succeeded", + "resourceGuid": "ad9c8da4-3bb2-4821-a878-c2cb07b01fb6" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver2", + "name": "sampleDnsResolver2", + "type": "Microsoft.Network/dnsResolvers", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork2" + }, + "dnsResolverState": "Connected", + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + ], + "nextLink": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/providers/Microsoft.Network/dnsResolvers?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListByVirtualNetwork.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListByVirtualNetwork.json new file mode 100644 index 000000000000..9a2771152b70 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListByVirtualNetwork.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "virtualNetworkName": "sampleVirtualNetwork", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver1" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Patch.json new file mode 100644 index 000000000000..819a87624dbf --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Patch.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "api-version": "2023-07-01-preview", + "parameters": { + "tags": { + "key1": "value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver", + "name": "sampleDnsResolver", + "type": "Microsoft.Network/dnsResolvers", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "dnsResolverState": "Connected", + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Put.json new file mode 100644 index 000000000000..20abcb40c39c --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Put.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "api-version": "2023-07-01-preview", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "westus2", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver", + "name": "sampleDnsResolver", + "type": "Microsoft.Network/dnsResolvers", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "dnsResolverState": "Connected", + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver", + "name": "sampleDnsResolver", + "type": "Microsoft.Network/dnsResolvers", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "dnsResolverState": "Connected", + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Delete.json new file mode 100644 index 000000000000..3734714233b6 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsDnsResolverPolicy", + "dnsSecurityRuleName": "sampleDnsSecurityRule", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Get.json new file mode 100644 index 000000000000..7e9cd2ffa48c --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "dnsSecurityRuleName": "sampleDnsSecurityRule", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/dnsSecurityRules/sampleDnsSecurityRule", + "name": "sampleDnsSecurityRule", + "type": "Microsoft.Network/dnsResolverPolicies/dnsSecurityRules", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "priority": 100, + "action": { + "actionType": "Block", + "blockResponseCode": "SERVFAIL" + }, + "dnsResolverDomainLists": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList" + } + ], + "dnsSecurityRuleState": "Enabled", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_List.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_List.json new file mode 100644 index 000000000000..448035790b96 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_List.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/dnsSecurityRules/sampleDnsSecurityRule", + "name": "sampleDnsSecurityRule", + "type": "Microsoft.Network/dnsResolverPolicies/dnsSecurityRules", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "priority": 100, + "action": { + "actionType": "Block", + "blockResponseCode": "SERVFAIL" + }, + "dnsResolverDomainLists": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList" + } + ], + "dnsSecurityRuleState": "Enabled", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/dnsSecurityRules/sampleDnsSecurityRule1", + "name": "sampleDnsSecurityRule1", + "type": "Microsoft.Network/dnsResolverPolicies/dnsSecurityRules", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "priority": 101, + "action": { + "actionType": "Block", + "blockResponseCode": "SERVFAIL" + }, + "dnsResolverDomainLists": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList1" + } + ], + "dnsSecurityRuleState": "Enabled", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsSecurityRules?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Patch.json new file mode 100644 index 000000000000..4b1acec7f6ca --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Patch.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "dnsSecurityRuleName": "sampleDnsSecurityRule", + "parameters": { + "properties": { + "dnsSecurityRuleState": "Disabled" + }, + "tags": { + "key1": "value1" + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/dnsSecurityRules/sampleDnsSecurityRule", + "name": "sampleDnsSecurityRule", + "type": "Microsoft.Network/dnsResolverPolicies/dnsSecurityRules", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "priority": 100, + "action": { + "actionType": "Allow" + }, + "dnsResolverDomainLists": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList2" + } + ], + "dnsSecurityRuleState": "Disabled", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Put.json new file mode 100644 index 000000000000..afa3dc4c5de8 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Put.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "dnsSecurityRuleName": "sampleDnsSecurityRule", + "parameters": { + "location": "westus2", + "tags": { + "key1": "value1" + }, + "properties": { + "priority": 100, + "action": { + "actionType": "Block", + "blockResponseCode": "SERVFAIL" + }, + "dnsResolverDomainLists": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList" + } + ], + "dnsSecurityRuleState": "Enabled" + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + }, + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/dnsSecurityRules/sampleDnsSecurityRule", + "name": "sampleDnsSecurityRule", + "type": "Microsoft.Network/dnsResolverPolicies/dnsSecurityRules", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "priority": 100, + "action": { + "actionType": "Block", + "blockResponseCode": "SERVFAIL" + }, + "dnsResolverDomainLists": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList" + } + ], + "dnsSecurityRuleState": "Enabled", + "provisioningState": "Succeeded" + } + } + }, + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + }, + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/dnsSecurityRules/sampleDnsSecurityRule", + "name": "sampleDnsSecurityRule", + "type": "Microsoft.Network/dnsResolverPolicies/dnsSecurityRules", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "priority": 100, + "action": { + "actionType": "Block", + "blockResponseCode": "SERVFAIL" + }, + "dnsResolverDomainLists": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList" + } + ], + "dnsSecurityRuleState": "Enabled", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Delete.json new file mode 100644 index 000000000000..9d00277a78eb --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "forwardingRuleName": "sampleForwardingRule", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Get.json new file mode 100644 index 000000000000..475971f47cae --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "forwardingRuleName": "sampleForwardingRule", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset/forwardingRules/sampleForwardingRule", + "name": "sampleForwardingRule", + "type": "Microsoft.Network/dnsForwardingRulesets/forwardingRules", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "domainName": "contoso.com.", + "targetDnsServers": [ + { + "ipAddress": "10.0.0.1", + "port": 53 + }, + { + "ipAddress": "10.0.0.2", + "port": 53 + } + ], + "metadata": { + "additionalProp1": "value1" + }, + "forwardingRuleState": "Enabled", + "provisioningState": "Succecced" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_List.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_List.json new file mode 100644 index 000000000000..18d7ad15ec3e --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_List.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset/forwardingRules/sampleForwardingRule", + "name": "sampleForwardingRule", + "type": "Microsoft.Network/dnsForwardingRulesets/forwardingRules", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "domainName": "contoso.com.", + "targetDnsServers": [ + { + "ipAddress": "10.0.0.1", + "port": 53 + }, + { + "ipAddress": "10.0.0.2", + "port": 53 + } + ], + "metadata": { + "additionalProp1": "value1" + }, + "forwardingRuleState": "Enabled", + "provisioningState": "Succecced" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset/forwardingRules/sampleForwardingRule1", + "name": "sampleForwardingRule1", + "type": "Microsoft.Network/dnsForwardingRulesets/forwardingRules", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "domainName": "foobar.com.", + "targetDnsServers": [ + { + "ipAddress": "10.0.0.3", + "port": 53 + }, + { + "ipAddress": "10.0.0.4", + "port": 53 + } + ], + "metadata": { + "additionalProp1": "value1" + }, + "forwardingRuleState": "Enabled", + "provisioningState": "Succecced" + } + } + ], + "nextLink": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/forwardingRules?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Patch.json new file mode 100644 index 000000000000..26a2bc01e5fb --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Patch.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "forwardingRuleName": "sampleForwardingRule", + "parameters": { + "properties": { + "forwardingRuleState": "Disabled", + "metadata": { + "additionalProp2": "value2" + } + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset/forwardingRules/sampleForwardingRule", + "name": "sampleForwardingRule", + "type": "Microsoft.Network/dnsForwardingRulesets/forwardingRules", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "domainName": "contoso.com.", + "targetDnsServers": [ + { + "ipAddress": "10.0.0.1", + "port": 53 + }, + { + "ipAddress": "10.0.0.2", + "port": 53 + } + ], + "metadata": { + "additionalProp2": "value2" + }, + "forwardingRuleState": "Disabled", + "provisioningState": "Succecced" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Put.json new file mode 100644 index 000000000000..e3872ac7093d --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Put.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "forwardingRuleName": "sampleForwardingRule", + "parameters": { + "properties": { + "domainName": "contoso.com.", + "targetDnsServers": [ + { + "ipAddress": "10.0.0.1", + "port": 53 + }, + { + "ipAddress": "10.0.0.2", + "port": 53 + } + ], + "forwardingRuleState": "Enabled", + "metadata": { + "additionalProp1": "value1" + } + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset/forwardingRules/sampleForwardingRule", + "name": "sampleForwardingRule", + "type": "Microsoft.Network/dnsForwardingRulesets/forwardingRules", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "domainName": "contoso.com.", + "targetDnsServers": [ + { + "ipAddress": "10.0.0.1", + "port": 53 + }, + { + "ipAddress": "10.0.0.2", + "port": 53 + } + ], + "metadata": { + "additionalProp1": "value1" + }, + "forwardingRuleState": "Enabled", + "provisioningState": "Succecced" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset/forwardingRules/sampleForwardingRule", + "name": "sampleForwardingRule", + "type": "Microsoft.Network/dnsForwardingRulesets/forwardingRules", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "domainName": "contoso.com.", + "targetDnsServers": [ + { + "ipAddress": "10.0.0.1", + "port": 53 + }, + { + "ipAddress": "10.0.0.2", + "port": 53 + } + ], + "metadata": { + "additionalProp1": "value1" + }, + "forwardingRuleState": "Enabled", + "provisioningState": "Succecced" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Delete.json new file mode 100644 index 000000000000..ce839e23f78d --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "inboundEndpointName": "sampleInboundEndpoint", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Get.json new file mode 100644 index 000000000000..e5e6970c510b --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "inboundEndpointName": "sampleInboundEndpoint", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/inboundEndpoints/sampleInboundEndpoint", + "name": "sampleInboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/inboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "ipConfigurations": [ + { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "privateIpAddress": "255.255.255.255", + "privateIpAllocationMethod": "Dynamic" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_List.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_List.json new file mode 100644 index 000000000000..24a014617a36 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_List.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/inboundEndpoints/sampleInboundEndpoint1", + "name": "sampleInboundEndpoint1", + "type": "Microsoft.Network/dnsResolvers/inboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "ipConfigurations": [ + { + "subnet": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet1" + }, + "privateIpAddress": "255.1.255.1", + "privateIpAllocationMethod": "Dynamic" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/inboundEndpoints/sampleInboundEndpoint2", + "name": "sampleInboundEndpoint2", + "type": "Microsoft.Network/dnsResolvers/inboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-02T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-03T02:03:01.1974346Z" + }, + "properties": { + "ipConfigurations": [ + { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet1" + }, + "privateIpAddress": "1.1.255.1", + "privateIpAllocationMethod": "Dynamic" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "87b3e20a-5833-4c40-8ad7-c5160bb1c5bd" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Patch.json new file mode 100644 index 000000000000..11cf34e59b76 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Patch.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "inboundEndpointName": "sampleInboundEndpoint", + "parameters": { + "tags": { + "key1": "value1" + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/inboundEndpoints/sampleInboundEndpoint", + "name": "sampleInboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/inboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "ipConfigurations": [ + { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "privateIpAddress": "255.255.255.255", + "privateIpAllocationMethod": "Dynamic" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "87b3e20a-5833-4c40-8ad7-c5160bb1c5bd" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Put.json new file mode 100644 index 000000000000..8ca756400a75 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Put.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "inboundEndpointName": "sampleInboundEndpoint", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "westus2", + "properties": { + "ipConfigurations": [ + { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "privateIpAllocationMethod": "Dynamic" + } + ] + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/inboundEndpoints/sampleInboundEndpoint", + "name": "sampleInboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/inboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "ipConfigurations": [ + { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "privateIpAddress": "255.255.255.255", + "privateIpAllocationMethod": "Dynamic" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/inboundEndpoints/sampleInboundEndpoint", + "name": "sampleInboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/inboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "ipConfigurations": [ + { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "privateIpAddress": "255.255.255.255", + "privateIpAllocationMethod": "Dynamic" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "87b3e20a-5833-4c40-8ad7-c5160bb1c5bd" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Delete.json new file mode 100644 index 000000000000..fa4e867cc925 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "outboundEndpointName": "sampleOutboundEndpoint", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Get.json new file mode 100644 index 000000000000..7378b3bfd102 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "outboundEndpointName": "sampleOutboundEndpoint", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/outboundEndpoints/sampleOutboundEndpoint", + "name": "sampleOutboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/outboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "provisioningState": "Succecced", + "resourceGuid": "b4d35f41-0c70-4ec7-bb3e-0cd9f8b7e4be" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_List.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_List.json new file mode 100644 index 000000000000..8af4a68dee0e --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_List.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/outboundEndpoints/sampleOutboundEndpoint", + "name": "sampleOutboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/outboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "provisioningState": "Succeeded", + "resourceGuid": "b4d35f41-0c70-4ec7-bb3e-0cd9f8b7e4be" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/outboundEndpoints/sampleOutboundEndpoint1", + "name": "sampleOutboundEndpoint1", + "type": "Microsoft.Network/dnsResolvers/outboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet1" + }, + "provisioningState": "Succecced", + "resourceGuid": "b4d35f41-0c70-4ec7-bb3e-0cd9f8b7e4be" + } + } + ], + "nextLink": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/outboundEndpoints?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Patch.json new file mode 100644 index 000000000000..0d0f9a015690 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Patch.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "outboundEndpointName": "sampleOutboundEndpoint", + "parameters": { + "tags": { + "key1": "value1" + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/outboundEndpoints/sampleOutboundEndpoint", + "name": "sampleOutboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/outboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "provisioningState": "Succecced", + "resourceGuid": "b4d35f41-0c70-4ec7-bb3e-0cd9f8b7e4be" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Put.json new file mode 100644 index 000000000000..a5c3ac17745e --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Put.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "outboundEndpointName": "sampleOutboundEndpoint", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "westus2", + "properties": { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + } + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/outboundEndpoints/sampleOutboundEndpoint", + "name": "sampleOutboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/outboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "provisioningState": "Succeeded" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/outboundEndpoints/sampleOutboundEndpoint", + "name": "sampleOutboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/outboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "provisioningState": "Succeeded", + "resourceGuid": "87b3e20a-5833-4c40-8ad7-c5160bb1c5bd" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Delete.json new file mode 100644 index 000000000000..d9db418ffa06 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "virtualNetworkLinkName": "sampleVirtualNetworkLink", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Get.json new file mode 100644 index 000000000000..96c759001524 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "virtualNetworkLinkName": "sampleVirtualNetworkLink", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRuleset/sampleDnsForwardingRuleset/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "metadata": { + "additionalProp1": "value1" + }, + "provisioningState": "Succecced" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_List.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_List.json new file mode 100644 index 000000000000..0a4a10302b09 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_List.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRuleset/sampleDnsForwardingRuleset/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "metadata": { + "additionalProp1": "value1" + }, + "provisioningState": "Succecced" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Patch.json new file mode 100644 index 000000000000..88473b3dbd0d --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Patch.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "virtualNetworkLinkName": "sampleVirtualNetworkLink", + "parameters": { + "properties": { + "metadata": { + "additionalProp1": "value1" + } + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRuleset/sampleDnsForwardingRuleset/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "metadata": { + "additionalProp1": "value1" + }, + "provisioningState": "Succecced" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Put.json new file mode 100644 index 000000000000..369f23d834ed --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Put.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "virtualNetworkLinkName": "sampleVirtualNetworkLink", + "parameters": { + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "metadata": { + "additionalProp1": "value1" + } + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRuleset/sampleDnsForwardingRuleset/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "metadata": { + "additionalProp1": "value1" + }, + "provisioningState": "Succecced" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRuleset/sampleDnsForwardingRuleset/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "metadata": { + "additionalProp1": "value1" + }, + "provisioningState": "Succecced" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/readme.md b/specification/dnsresolver/resource-manager/readme.md index 1143e778efef..b31bbb537eb1 100644 --- a/specification/dnsresolver/resource-manager/readme.md +++ b/specification/dnsresolver/resource-manager/readme.md @@ -25,8 +25,20 @@ To see additional help and options, run: These are the global settings for the DNS resolver API. ``` yaml +title: DnsResolverManagementClient +description: DNS Resolver Client openapi-type: arm -tag: package-2022-07 +tag: package-preview-2023-07 +``` + +### Tag: package-preview-2023-07 + +These settings apply only when `--tag=package-preview-2023-07` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-07' +input-file: + - Microsoft.Network/preview/2023-07-01-preview/dnsresolver.json + - Microsoft.Network/preview/2023-07-01-preview/dnsresolverpolicy.json ``` ### Tag: package-2022-07 @@ -57,7 +69,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net-track2 - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-go - repo: azure-powershell ``` @@ -129,4 +141,3 @@ uncomment the `exclude-file` section below and add the file paths. #exclude-file: # - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json ``` - From 157802f3c23879acabd2cba9384679de59fe6e10 Mon Sep 17 00:00:00 2001 From: gubalasu <59630928+gubalasu@users.noreply.github.com> Date: Fri, 27 Sep 2024 10:17:56 -0700 Subject: [PATCH 37/48] Add new API version 2024-09-01 for Microsoft.Cdn (#30309) * Copy 2024-02-01 version to create 2024-09-01 version * Update readme.md * Changes for the new api version * Update readme.md * Fix api versions in examples * Update description * Update cdn.json Attempting to address lintdiff * Update cdn.json * Update cdn.json * Fix validation * Update cdn.json * Update sdk-suppressions.yaml * Update sdk-suppressions.yaml * Update readme.md * Update readme.md * Update specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdn.json Co-authored-by: Chenjie Shi * Update specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdn.json Co-authored-by: Chenjie Shi --------- Co-authored-by: Yuchao Yan Co-authored-by: Chenglong Liu <48578056+ChenglongLiu@users.noreply.github.com> Co-authored-by: Chenjie Shi --- .../Microsoft.Cdn/stable/2024-09-01/afdx.json | 6310 ++++++++++++++ .../Microsoft.Cdn/stable/2024-09-01/cdn.json | 7466 +++++++++++++++++ .../2024-09-01/cdnwebapplicationfirewall.json | 977 +++ .../examples/AFDCustomDomains_Create.json | 119 + .../examples/AFDCustomDomains_Delete.json | 18 + .../examples/AFDCustomDomains_Get.json | 42 + .../AFDCustomDomains_ListByProfile.json | 45 + ...DCustomDomains_RefreshValidationToken.json | 17 + .../examples/AFDCustomDomains_Update.json | 87 + .../examples/AFDEndpoints_Create.json | 70 + .../examples/AFDEndpoints_Delete.json | 18 + .../2024-09-01/examples/AFDEndpoints_Get.json | 27 + .../examples/AFDEndpoints_ListByProfile.json | 30 + .../AFDEndpoints_ListResourceUsage.json | 27 + .../examples/AFDEndpoints_PurgeContent.json | 25 + .../examples/AFDEndpoints_Update.json | 52 + .../AFDEndpoints_ValidateCustomDomain.json | 21 + .../examples/AFDOriginGroups_Create.json | 99 + .../examples/AFDOriginGroups_Delete.json | 18 + .../examples/AFDOriginGroups_Get.json | 34 + .../AFDOriginGroups_ListByProfile.json | 37 + .../AFDOriginGroups_ListResourceUsage.json | 27 + .../examples/AFDOriginGroups_Update.json | 76 + .../examples/AFDOrigins_Create.json | 87 + .../examples/AFDOrigins_Delete.json | 19 + .../2024-09-01/examples/AFDOrigins_Get.json | 33 + .../AFDOrigins_ListByOriginGroup.json | 36 + .../examples/AFDOrigins_Update.json | 65 + ...rofiles_CheckEndpointNameAvailability.json | 23 + ...AFDProfiles_CheckHostNameAvailability.json | 20 + .../AFDProfiles_ListResourceUsage.json | 26 + .../examples/AFDProfiles_Upgrade.json | 63 + .../examples/AFDProfiles_ValidateSecret.json | 22 + .../examples/CdnProfiles_CanMigrate.json | 26 + .../examples/CdnProfiles_Migrate.json | 31 + .../CheckEndpointNameAvailability.json | 22 + .../examples/CheckNameAvailability.json | 18 + ...CheckNameAvailabilityWithSubscription.json | 19 + .../examples/CustomDomains_Create.json | 65 + .../examples/CustomDomains_Delete.json | 32 + .../CustomDomains_DisableCustomHttps.json | 45 + ...tomDomains_EnableCustomHttpsUsingBYOC.json | 60 + ...CustomHttpsUsingCDNManagedCertificate.json | 54 + .../examples/CustomDomains_Get.json | 27 + .../CustomDomains_ListByEndpoint.json | 30 + .../2024-09-01/examples/EdgeNodes_List.json | 107 + .../2024-09-01/examples/Endpoints_Create.json | 546 ++ .../2024-09-01/examples/Endpoints_Delete.json | 18 + .../2024-09-01/examples/Endpoints_Get.json | 79 + .../examples/Endpoints_ListByProfile.json | 86 + .../examples/Endpoints_ListResourceUsage.json | 29 + .../examples/Endpoints_LoadContent.json | 22 + .../examples/Endpoints_PurgeContent.json | 22 + .../2024-09-01/examples/Endpoints_Start.json | 86 + .../2024-09-01/examples/Endpoints_Stop.json | 86 + .../2024-09-01/examples/Endpoints_Update.json | 141 + .../Endpoints_ValidateCustomDomain.json | 21 + ...LogAnalytics_GetLogAnalyticsLocations.json | 60 + .../LogAnalytics_GetLogAnalyticsMetrics.json | 71 + .../LogAnalytics_GetLogAnalyticsRankings.json | 82 + ...LogAnalytics_GetLogAnalyticsResources.json | 55 + ...ogAnalytics_GetWafLogAnalyticsMetrics.json | 132 + ...gAnalytics_GetWafLogAnalyticsRankings.json | 42 + .../2024-09-01/examples/Operations_List.json | 93 + .../examples/OriginGroups_Create.json | 112 + .../examples/OriginGroups_Delete.json | 19 + .../2024-09-01/examples/OriginGroups_Get.json | 44 + .../examples/OriginGroups_ListByEndpoint.json | 41 + .../examples/OriginGroups_Update.json | 74 + .../2024-09-01/examples/Origins_Create.json | 95 + .../2024-09-01/examples/Origins_Delete.json | 19 + .../2024-09-01/examples/Origins_Get.json | 33 + .../examples/Origins_ListByEndpoint.json | 36 + .../2024-09-01/examples/Origins_Update.json | 68 + .../examples/Profiles_CanMigrate.json | 31 + .../2024-09-01/examples/Profiles_Create.json | 98 + .../2024-09-01/examples/Profiles_Delete.json | 17 + .../examples/Profiles_GenerateSsoUri.json | 15 + .../2024-09-01/examples/Profiles_Get.json | 33 + .../2024-09-01/examples/Profiles_List.json | 56 + .../Profiles_ListByResourceGroup.json | 57 + .../examples/Profiles_ListResourceUsage.json | 22 + ...ofiles_ListSupportedOptimizationTypes.json | 18 + .../2024-09-01/examples/Profiles_Migrate.json | 43 + .../examples/Profiles_MigrationAbort.json | 15 + .../examples/Profiles_MigrationCommit.json | 16 + .../2024-09-01/examples/Profiles_Update.json | 68 + .../examples/ResourceUsage_List.json | 20 + .../2024-09-01/examples/Routes_Create.json | 196 + .../2024-09-01/examples/Routes_Delete.json | 19 + .../2024-09-01/examples/Routes_Get.json | 59 + .../examples/Routes_ListByEndpoint.json | 62 + .../2024-09-01/examples/Routes_Update.json | 148 + .../2024-09-01/examples/RuleSets_Create.json | 33 + .../2024-09-01/examples/RuleSets_Delete.json | 18 + .../2024-09-01/examples/RuleSets_Get.json | 22 + .../examples/RuleSets_ListByProfile.json | 25 + .../examples/RuleSets_ListResourceUsage.json | 27 + .../2024-09-01/examples/Rules_Create.json | 158 + .../2024-09-01/examples/Rules_Delete.json | 19 + .../stable/2024-09-01/examples/Rules_Get.json | 50 + .../examples/Rules_ListByRuleSet.json | 53 + .../2024-09-01/examples/Rules_Update.json | 107 + .../2024-09-01/examples/Secrets_Create.json | 107 + .../2024-09-01/examples/Secrets_Delete.json | 18 + .../2024-09-01/examples/Secrets_Get.json | 38 + .../examples/Secrets_ListByProfile.json | 55 + .../examples/SecurityPolicies_Create.json | 135 + .../examples/SecurityPolicies_Delete.json | 18 + .../examples/SecurityPolicies_Get.json | 43 + .../SecurityPolicies_ListByProfile.json | 46 + .../examples/SecurityPolicies_Patch.json | 103 + .../2024-09-01/examples/ValidateProbe.json | 18 + .../examples/WafListManagedRuleSets.json | 53 + .../2024-09-01/examples/WafListPolicies.json | 265 + .../2024-09-01/examples/WafPatchPolicy.json | 275 + .../examples/WafPolicyCreateOrUpdate.json | 508 ++ .../2024-09-01/examples/WafPolicyDelete.json | 12 + .../2024-09-01/examples/WafPolicyGet.json | 139 + .../AFDProfiles_Upgrade_WithoutWaf.yaml | 28 + specification/cdn/resource-manager/readme.md | 16 +- .../resource-manager/sdk-suppressions.yaml | 37 + 122 files changed, 22202 insertions(+), 1 deletion(-) create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/afdx.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdn.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdnwebapplicationfirewall.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_RefreshValidationToken.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ListResourceUsage.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_PurgeContent.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ValidateCustomDomain.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_ListResourceUsage.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_ListByOriginGroup.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_CheckEndpointNameAvailability.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_CheckHostNameAvailability.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_ListResourceUsage.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_Upgrade.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_ValidateSecret.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CdnProfiles_CanMigrate.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CdnProfiles_Migrate.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckEndpointNameAvailability.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckNameAvailability.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckNameAvailabilityWithSubscription.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_DisableCustomHttps.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_ListByEndpoint.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/EdgeNodes_List.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ListResourceUsage.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_LoadContent.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_PurgeContent.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Start.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Stop.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ValidateCustomDomain.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsLocations.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsMetrics.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsRankings.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsResources.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetWafLogAnalyticsMetrics.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetWafLogAnalyticsRankings.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Operations_List.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_ListByEndpoint.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_ListByEndpoint.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_CanMigrate.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_GenerateSsoUri.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_List.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListByResourceGroup.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListResourceUsage.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListSupportedOptimizationTypes.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Migrate.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_MigrationAbort.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_MigrationCommit.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/ResourceUsage_List.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_ListByEndpoint.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_ListResourceUsage.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_ListByRuleSet.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Patch.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/ValidateProbe.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafListManagedRuleSets.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafListPolicies.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPatchPolicy.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyCreateOrUpdate.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyDelete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyGet.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/scenarios/AFDProfiles_Upgrade_WithoutWaf.yaml diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/afdx.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/afdx.json new file mode 100644 index 000000000000..0d5a749bea04 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/afdx.json @@ -0,0 +1,6310 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-01", + "title": "CdnManagementClient", + "description": "Use these APIs to manage Azure Front Door resources through the Azure Resource Manager. You must make sure that requests made to these resources are secure." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/checkEndpointNameAvailability": { + "post": { + "tags": [ + "CheckEndpointNameAvailability" + ], + "description": "Check the availability of a resource name. This is needed for resources where name is globally unique, such as a afdx endpoint.", + "operationId": "CheckEndpointNameAvailability", + "x-ms-examples": { + "CheckEndpointNameAvailability": { + "$ref": "./examples/CheckEndpointNameAvailability.json" + } + }, + "parameters": [ + { + "name": "checkEndpointNameAvailabilityInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckEndpointNameAvailabilityInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckEndpointNameAvailabilityOutput" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/checkEndpointNameAvailability": { + "post": { + "tags": [ + "AFDProfiles" + ], + "description": "Check the availability of an afdx endpoint name, and return the globally unique endpoint host name.", + "operationId": "AFDProfiles_CheckEndpointNameAvailability", + "x-ms-examples": { + "CheckEndpointNameAvailability": { + "$ref": "./examples/AFDProfiles_CheckEndpointNameAvailability.json" + } + }, + "parameters": [ + { + "name": "checkEndpointNameAvailabilityInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckEndpointNameAvailabilityInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckEndpointNameAvailabilityOutput" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/usages": { + "post": { + "tags": [ + "AFDProfiles" + ], + "description": "Checks the quota and actual usage of endpoints under the given Azure Front Door profile.", + "operationId": "AFDProfiles_ListResourceUsage", + "x-ms-examples": { + "AFDProfiles_ListResourceUsage": { + "$ref": "./examples/AFDProfiles_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/checkHostNameAvailability": { + "post": { + "tags": [ + "AFDProfiles" + ], + "description": "Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS.", + "operationId": "AFDProfiles_CheckHostNameAvailability", + "x-ms-examples": { + "AFDProfiles_CheckHostNameAvailability": { + "$ref": "./examples/AFDProfiles_CheckHostNameAvailability.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "checkHostNameAvailabilityInput", + "in": "body", + "description": "Custom domain to be validated.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckHostNameAvailabilityInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "./cdn.json#/definitions/CheckNameAvailabilityOutput" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/validateSecret": { + "post": { + "tags": [ + "AFDProfiles" + ], + "description": "Validate a Secret in the profile.", + "operationId": "AFDProfiles_ValidateSecret", + "x-ms-examples": { + "Validate_Secret": { + "$ref": "./examples/AFDProfiles_ValidateSecret.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "name": "validateSecretInput", + "in": "body", + "description": "The Secret source.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateSecretInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ValidateSecretOutput" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/upgrade": { + "post": { + "tags": [ + "AFDProfiles" + ], + "description": "Upgrade a profile from Standard_AzureFrontDoor to Premium_AzureFrontDoor.", + "operationId": "AFDProfiles_Upgrade", + "x-ms-examples": { + "AFDProfiles_Upgrade": { + "$ref": "./examples/AFDProfiles_Upgrade.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "name": "profileUpgradeParameters", + "in": "body", + "description": "Profile upgrade input parameter.", + "required": true, + "schema": { + "$ref": "#/definitions/ProfileUpgradeParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "./cdn.json#/definitions/Profile" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "./cdn.json#/definitions/Profile" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains": { + "get": { + "tags": [ + "AFDCustomDomains" + ], + "description": "Lists existing AzureFrontDoor domains.", + "operationId": "AFDCustomDomains_ListByProfile", + "x-ms-examples": { + "AFDCustomDomains_ListByProfile": { + "$ref": "./examples/AFDCustomDomains_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDDomainListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}": { + "get": { + "tags": [ + "AFDCustomDomains" + ], + "description": "Gets an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.", + "operationId": "AFDCustomDomains_Get", + "x-ms-examples": { + "AFDCustomDomains_Get": { + "$ref": "./examples/AFDCustomDomains_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the domain under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AFDCustomDomains" + ], + "description": "Creates a new domain within the specified profile.", + "operationId": "AFDCustomDomains_Create", + "x-ms-examples": { + "AFDCustomDomains_Create": { + "$ref": "./examples/AFDCustomDomains_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the domain under the profile which is unique globally", + "required": true, + "type": "string" + }, + { + "name": "customDomain", + "in": "body", + "description": "Domain properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new domain has been created.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "AFDCustomDomains" + ], + "description": "Updates an existing domain within a profile.", + "operationId": "AFDCustomDomains_Update", + "x-ms-examples": { + "AFDCustomDomains_Update": { + "$ref": "./examples/AFDCustomDomains_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the domain under the profile which is unique globally", + "required": true, + "type": "string" + }, + { + "name": "customDomainUpdateProperties", + "in": "body", + "description": "Domain properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDDomainUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "AFDCustomDomains" + ], + "description": "Deletes an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.", + "operationId": "AFDCustomDomains_Delete", + "x-ms-examples": { + "AFDCustomDomains_Delete": { + "$ref": "./examples/AFDCustomDomains_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the domain under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the domain was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}/refreshValidationToken": { + "post": { + "tags": [ + "AFDCustomDomains" + ], + "description": "Updates the domain validation token.", + "operationId": "AFDCustomDomains_RefreshValidationToken", + "x-ms-examples": { + "AFDCustomDomains_Delete": { + "$ref": "./examples/AFDCustomDomains_RefreshValidationToken.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the domain under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. Please poll the targeted custom domain and check the 'validationProperties' field for the new validation token values.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints": { + "get": { + "tags": [ + "AFDEndpoints" + ], + "description": "Lists existing AzureFrontDoor endpoints.", + "operationId": "AFDEndpoints_ListByProfile", + "x-ms-examples": { + "AFDEndpoints_ListByProfile": { + "$ref": "./examples/AFDEndpoints_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDEndpointListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}": { + "get": { + "tags": [ + "AFDEndpoints" + ], + "description": "Gets an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "AFDEndpoints_Get", + "x-ms-examples": { + "AFDEndpoints_Get": { + "$ref": "./examples/AFDEndpoints_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AFDEndpoints" + ], + "description": "Creates a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "AFDEndpoints_Create", + "x-ms-examples": { + "AFDEndpoints_Create": { + "$ref": "./examples/AFDEndpoints_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "endpoint", + "in": "body", + "description": "Endpoint properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new endpoint has been created.", + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "AFDEndpoints" + ], + "description": "Updates an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update domains, use the Update Custom Domain operation.", + "operationId": "AFDEndpoints_Update", + "x-ms-examples": { + "AFDEndpoints_Update": { + "$ref": "./examples/AFDEndpoints_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "endpointUpdateProperties", + "in": "body", + "description": "Endpoint update properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDEndpointUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "AFDEndpoints" + ], + "description": "Deletes an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "AFDEndpoints_Delete", + "x-ms-examples": { + "AFDEndpoints_Delete": { + "$ref": "./examples/AFDEndpoints_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/purge": { + "post": { + "tags": [ + "AFDEndpoints" + ], + "description": "Removes a content from AzureFrontDoor.", + "operationId": "AFDEndpoints_PurgeContent", + "x-ms-examples": { + "AFDEndpoints_PurgeContent": { + "$ref": "./examples/AFDEndpoints_PurgeContent.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "contents", + "in": "body", + "description": "The list of paths to the content and the list of linked domains to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory.", + "required": true, + "schema": { + "$ref": "#/definitions/AfdPurgeParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/usages": { + "post": { + "tags": [ + "AFDEndpoints" + ], + "description": "Checks the quota and actual usage of endpoints under the given Azure Front Door profile.", + "operationId": "AFDEndpoints_ListResourceUsage", + "x-ms-examples": { + "AFDEndpoints_ListResourceUsage": { + "$ref": "./examples/AFDEndpoints_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/validateCustomDomain": { + "post": { + "tags": [ + "AFDEndpoints" + ], + "description": "Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS.", + "operationId": "AFDEndpoints_ValidateCustomDomain", + "x-ms-examples": { + "Endpoints_ValidateCustomDomain": { + "$ref": "./examples/AFDEndpoints_ValidateCustomDomain.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainProperties", + "in": "body", + "description": "Custom domain to be validated.", + "required": true, + "schema": { + "$ref": "./cdn.json#/definitions/ValidateCustomDomainInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "./cdn.json#/definitions/ValidateCustomDomainOutput" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups": { + "get": { + "tags": [ + "AFDOriginGroups" + ], + "description": "Lists all of the existing origin groups within a profile.", + "operationId": "AFDOriginGroups_ListByProfile", + "x-ms-examples": { + "AFDOriginGroups_ListByProfile": { + "$ref": "./examples/AFDOriginGroups_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOriginGroupListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}": { + "get": { + "tags": [ + "AFDOriginGroups" + ], + "description": "Gets an existing origin group within a profile.", + "operationId": "AFDOriginGroups_Get", + "x-ms-examples": { + "AFDOriginGroups_Get": { + "$ref": "./examples/AFDOriginGroups_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AFDOriginGroups" + ], + "description": "Creates a new origin group within the specified profile.", + "operationId": "AFDOriginGroups_Create", + "x-ms-examples": { + "AFDOriginGroups_Create": { + "$ref": "./examples/AFDOriginGroups_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "originGroup", + "in": "body", + "description": "Origin group properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new origin group has been created.", + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "AFDOriginGroups" + ], + "description": "Updates an existing origin group within a profile.", + "operationId": "AFDOriginGroups_Update", + "x-ms-examples": { + "AFDOriginGroups_Update": { + "$ref": "./examples/AFDOriginGroups_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "originGroupUpdateProperties", + "in": "body", + "description": "Origin group properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDOriginGroupUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "AFDOriginGroups" + ], + "description": "Deletes an existing origin group within a profile.", + "operationId": "AFDOriginGroups_Delete", + "x-ms-examples": { + "AFDOriginGroups_Delete": { + "$ref": "./examples/AFDOriginGroups_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the origin group was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/usages": { + "post": { + "tags": [ + "AFDOriginGroups" + ], + "description": "Checks the quota and actual usage of endpoints under the given Azure Front Door profile..", + "operationId": "AFDOriginGroups_ListResourceUsage", + "x-ms-examples": { + "AFDOriginGroups_ListResourceUsage": { + "$ref": "./examples/AFDOriginGroups_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins": { + "get": { + "tags": [ + "AFDOrigins" + ], + "description": "Lists all of the existing origins within an origin group.", + "operationId": "AFDOrigins_ListByOriginGroup", + "x-ms-examples": { + "AFDOrigins_ListByOriginGroup": { + "$ref": "./examples/AFDOrigins_ListByOriginGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOriginListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins/{originName}": { + "get": { + "tags": [ + "AFDOrigins" + ], + "description": "Gets an existing origin within an origin group.", + "operationId": "AFDOrigins_Get", + "x-ms-examples": { + "AFDOrigins_Get": { + "$ref": "./examples/AFDOrigins_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AFDOrigins" + ], + "description": "Creates a new origin within the specified origin group.", + "operationId": "AFDOrigins_Create", + "x-ms-examples": { + "AFDOrigins_Create": { + "$ref": "./examples/AFDOrigins_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin that is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "origin", + "in": "body", + "description": "Origin properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new origin has been created.", + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "AFDOrigins" + ], + "description": "Updates an existing origin within an origin group.", + "operationId": "AFDOrigins_Update", + "x-ms-examples": { + "AFDOrigins_Update": { + "$ref": "./examples/AFDOrigins_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "originUpdateProperties", + "in": "body", + "description": "Origin properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDOriginUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "AFDOrigins" + ], + "description": "Deletes an existing origin within an origin group.", + "operationId": "AFDOrigins_Delete", + "x-ms-examples": { + "AFDOrigins_Delete": { + "$ref": "./examples/AFDOrigins_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the origin was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes": { + "get": { + "tags": [ + "Routes" + ], + "description": "Lists all of the existing origins within a profile.", + "operationId": "Routes_ListByEndpoint", + "x-ms-examples": { + "Routes_ListByEndpoint": { + "$ref": "./examples/Routes_ListByEndpoint.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RouteListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}": { + "get": { + "tags": [ + "Routes" + ], + "description": "Gets an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.", + "operationId": "Routes_Get", + "x-ms-examples": { + "Routes_Get": { + "$ref": "./examples/Routes_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "routeName", + "in": "path", + "description": "Name of the routing rule.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Routes" + ], + "description": "Creates a new route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.", + "operationId": "Routes_Create", + "x-ms-examples": { + "Routes_Create": { + "$ref": "./examples/Routes_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "routeName", + "in": "path", + "description": "Name of the routing rule.", + "required": true, + "type": "string" + }, + { + "name": "route", + "in": "body", + "description": "Route properties", + "required": true, + "schema": { + "$ref": "#/definitions/Route" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new endpoint has been created.", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Route" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "Routes" + ], + "description": "Updates an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.", + "operationId": "Routes_Update", + "x-ms-examples": { + "Routes_Update": { + "$ref": "./examples/Routes_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "routeName", + "in": "path", + "description": "Name of the routing rule.", + "required": true, + "type": "string" + }, + { + "name": "routeUpdateProperties", + "in": "body", + "description": "Route update properties", + "required": true, + "schema": { + "$ref": "#/definitions/RouteUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Route" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Routes" + ], + "description": "Deletes an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.", + "operationId": "Routes_Delete", + "x-ms-examples": { + "Routes_Delete": { + "$ref": "./examples/Routes_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "routeName", + "in": "path", + "description": "Name of the routing rule.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets": { + "get": { + "tags": [ + "RuleSets" + ], + "description": "Lists existing AzureFrontDoor rule sets within a profile.", + "operationId": "RuleSets_ListByProfile", + "x-ms-examples": { + "RuleSets_ListByProfile": { + "$ref": "./examples/RuleSets_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RuleSetListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}": { + "get": { + "tags": [ + "RuleSets" + ], + "description": "Gets an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.", + "operationId": "RuleSets_Get", + "x-ms-examples": { + "RuleSets_Get": { + "$ref": "./examples/RuleSets_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RuleSet" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "RuleSets" + ], + "description": "Creates a new rule set within the specified profile.", + "operationId": "RuleSets_Create", + "x-ms-examples": { + "RuleSets_Create": { + "$ref": "./examples/RuleSets_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile which is unique globally", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RuleSet" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new rule set has been created.", + "schema": { + "$ref": "#/definitions/RuleSet" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "RuleSets" + ], + "description": "Deletes an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.", + "operationId": "RuleSets_Delete", + "x-ms-examples": { + "RuleSets_Delete": { + "$ref": "./examples/RuleSets_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the rule set was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/usages": { + "post": { + "tags": [ + "RuleSets" + ], + "description": "Checks the quota and actual usage of endpoints under the given Azure Front Door profile..", + "operationId": "RuleSets_ListResourceUsage", + "x-ms-examples": { + "RuleSets_ListResourceUsage": { + "$ref": "./examples/RuleSets_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules": { + "get": { + "tags": [ + "Rules" + ], + "description": "Lists all of the existing delivery rules within a rule set.", + "operationId": "Rules_ListByRuleSet", + "x-ms-examples": { + "Rules_ListByRuleSet": { + "$ref": "./examples/Rules_ListByRuleSet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RuleListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}": { + "get": { + "tags": [ + "Rules" + ], + "description": "Gets an existing delivery rule within a rule set.", + "operationId": "Rules_Get", + "x-ms-examples": { + "Rules_Get": { + "$ref": "./examples/Rules_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile.", + "required": true, + "type": "string" + }, + { + "name": "ruleName", + "in": "path", + "description": "Name of the delivery rule which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Rules" + ], + "description": "Creates a new delivery rule within the specified rule set.", + "operationId": "Rules_Create", + "x-ms-examples": { + "Rules_Create": { + "$ref": "./examples/Rules_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile.", + "required": true, + "type": "string" + }, + { + "name": "ruleName", + "in": "path", + "description": "Name of the delivery rule which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "rule", + "in": "body", + "description": "The delivery rule properties.", + "required": true, + "schema": { + "$ref": "#/definitions/Rule" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new delivery rule has been created.", + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "Rules" + ], + "description": "Updates an existing delivery rule within a rule set.", + "operationId": "Rules_Update", + "x-ms-examples": { + "Rules_Update": { + "$ref": "./examples/Rules_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile.", + "required": true, + "type": "string" + }, + { + "name": "ruleName", + "in": "path", + "description": "Name of the delivery rule which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "ruleUpdateProperties", + "in": "body", + "description": "Delivery rule properties", + "required": true, + "schema": { + "$ref": "#/definitions/RuleUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Rules" + ], + "description": "Deletes an existing delivery rule within a rule set.", + "operationId": "Rules_Delete", + "x-ms-examples": { + "Rules_Delete": { + "$ref": "./examples/Rules_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile.", + "required": true, + "type": "string" + }, + { + "name": "ruleName", + "in": "path", + "description": "Name of the delivery rule which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the origin was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies": { + "get": { + "tags": [ + "SecurityPolicies" + ], + "description": "Lists security policies associated with the profile", + "operationId": "SecurityPolicies_ListByProfile", + "x-ms-examples": { + "SecurityPolicies_ListByProfile": { + "$ref": "./examples/SecurityPolicies_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityPolicyListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies/{securityPolicyName}": { + "get": { + "tags": [ + "SecurityPolicies" + ], + "description": "Gets an existing security policy within a profile.", + "operationId": "SecurityPolicies_Get", + "x-ms-examples": { + "SecurityPolicies_Get": { + "$ref": "./examples/SecurityPolicies_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "securityPolicyName", + "in": "path", + "description": "Name of the security policy under the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "SecurityPolicies" + ], + "description": "Creates a new security policy within the specified profile.", + "operationId": "SecurityPolicies_Create", + "x-ms-examples": { + "SecurityPolicies_Create": { + "$ref": "./examples/SecurityPolicies_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "securityPolicyName", + "in": "path", + "description": "Name of the security policy under the profile.", + "required": true, + "type": "string" + }, + { + "name": "securityPolicy", + "in": "body", + "description": "The security policy properties.", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new delivery rule has been created.", + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "SecurityPolicies" + ], + "description": "Updates an existing security policy within a profile.", + "operationId": "SecurityPolicies_Patch", + "x-ms-examples": { + "SecurityPolicies_Patch": { + "$ref": "./examples/SecurityPolicies_Patch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "securityPolicyName", + "in": "path", + "description": "Name of the security policy under the profile.", + "required": true, + "type": "string" + }, + { + "name": "securityPolicyUpdateProperties", + "in": "body", + "description": "Security policy update properties", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityPolicyUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "SecurityPolicies" + ], + "description": "Deletes an existing security policy within profile.", + "operationId": "SecurityPolicies_Delete", + "x-ms-examples": { + "SecurityPolicies_Delete": { + "$ref": "./examples/SecurityPolicies_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "securityPolicyName", + "in": "path", + "description": "Name of the security policy under the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets": { + "get": { + "tags": [ + "Secrets" + ], + "description": "Lists existing AzureFrontDoor secrets.", + "operationId": "Secrets_ListByProfile", + "x-ms-examples": { + "Secrets_ListByProfile": { + "$ref": "./examples/Secrets_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}": { + "get": { + "tags": [ + "Secrets" + ], + "description": "Gets an existing Secret within a profile.", + "operationId": "Secrets_Get", + "x-ms-examples": { + "Secrets_Get": { + "$ref": "./examples/Secrets_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "secretName", + "in": "path", + "description": "Name of the Secret under the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Secrets" + ], + "description": "Creates a new Secret within the specified profile.", + "operationId": "Secrets_Create", + "x-ms-examples": { + "Secrets_Create": { + "$ref": "./examples/Secrets_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "secretName", + "in": "path", + "description": "Name of the Secret under the profile.", + "required": true, + "type": "string" + }, + { + "name": "secret", + "in": "body", + "description": "The Secret properties.", + "required": true, + "schema": { + "$ref": "#/definitions/Secret" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new delivery rule has been created.", + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Secrets" + ], + "description": "Deletes an existing Secret within profile.", + "operationId": "Secrets_Delete", + "x-ms-examples": { + "Secrets_Delete": { + "$ref": "./examples/Secrets_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "secretName", + "in": "path", + "description": "Name of the Secret under the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the origin was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsMetrics": { + "get": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_GetLogAnalyticsMetrics", + "x-ms-examples": { + "LogAnalytics_GetLogAnalyticsMetrics": { + "$ref": "./examples/LogAnalytics_GetLogAnalyticsMetrics.json" + } + }, + "description": "Get log report for AFD profile", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "metrics", + "type": "array", + "required": true, + "collectionFormat": "multi", + "in": "query", + "items": { + "type": "string", + "enum": [ + "clientRequestCount", + "clientRequestTraffic", + "clientRequestBandwidth", + "originRequestTraffic", + "originRequestBandwidth", + "totalLatency" + ], + "x-ms-enum": { + "name": "LogMetric", + "modelAsString": true + } + } + }, + { + "name": "dateTimeBegin", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "dateTimeEnd", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "granularity", + "type": "string", + "in": "query", + "required": true, + "enum": [ + "PT5M", + "PT1H", + "P1D" + ], + "x-ms-enum": { + "name": "LogMetricsGranularity", + "modelAsString": true + } + }, + { + "name": "groupBy", + "in": "query", + "type": "array", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "httpStatusCode", + "protocol", + "cacheStatus", + "countryOrRegion", + "customDomain" + ], + "x-ms-enum": { + "name": "LogMetricsGroupBy", + "modelAsString": true + } + } + }, + { + "name": "continents", + "type": "array", + "in": "query", + "collectionFormat": "multi", + "required": false, + "items": { + "type": "string" + } + }, + { + "name": "countryOrRegions", + "type": "array", + "in": "query", + "collectionFormat": "multi", + "required": false, + "items": { + "type": "string" + } + }, + { + "name": "customDomains", + "type": "array", + "required": true, + "collectionFormat": "multi", + "in": "query", + "items": { + "type": "string" + } + }, + { + "name": "protocols", + "type": "array", + "required": true, + "collectionFormat": "multi", + "in": "query", + "items": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/MetricsResponse" + } + }, + "default": { + "description": "Azure Front Door Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsRankings": { + "get": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_GetLogAnalyticsRankings", + "x-ms-examples": { + "LogAnalytics_GetLogAnalyticsRankings": { + "$ref": "./examples/LogAnalytics_GetLogAnalyticsRankings.json" + } + }, + "description": "Get log analytics ranking report for AFD profile", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "rankings", + "type": "array", + "in": "query", + "required": true, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "url", + "referrer", + "browser", + "userAgent", + "countryOrRegion" + ], + "x-ms-enum": { + "name": "LogRanking", + "modelAsString": true + } + } + }, + { + "name": "metrics", + "type": "array", + "in": "query", + "required": true, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "clientRequestCount", + "clientRequestTraffic", + "hitCount", + "missCount", + "userErrorCount", + "errorCount" + ], + "x-ms-enum": { + "name": "LogRankingMetric", + "modelAsString": true + } + } + }, + { + "name": "maxRanking", + "in": "query", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "name": "dateTimeBegin", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "dateTimeEnd", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "customDomains", + "type": "array", + "in": "query", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/RankingsResponse" + } + }, + "default": { + "description": "Azure Front Door Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsLocations": { + "get": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_GetLogAnalyticsLocations", + "x-ms-examples": { + "LogAnalytics_GetLogAnalyticsLocations": { + "$ref": "./examples/LogAnalytics_GetLogAnalyticsLocations.json" + } + }, + "description": "Get all available location names for AFD log analytics report.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/ContinentsResponse" + } + }, + "default": { + "description": "Azure Front Door Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsResources": { + "get": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_GetLogAnalyticsResources", + "x-ms-examples": { + "LogAnalytics_GetLogAnalyticsResources": { + "$ref": "./examples/LogAnalytics_GetLogAnalyticsResources.json" + } + }, + "description": "Get all endpoints and custom domains available for AFD log report", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/ResourcesResponse" + } + }, + "default": { + "description": "Azure Front Door Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getWafLogAnalyticsMetrics": { + "get": { + "tags": [ + "WafLogAnalytics" + ], + "operationId": "LogAnalytics_GetWafLogAnalyticsMetrics", + "x-ms-examples": { + "LogAnalytics_GetWafLogAnalyticsMetrics": { + "$ref": "./examples/LogAnalytics_GetWafLogAnalyticsMetrics.json" + } + }, + "description": "Get Waf related log analytics report for AFD profile.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "metrics", + "type": "array", + "in": "query", + "required": true, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "clientRequestCount" + ], + "x-ms-enum": { + "name": "WafMetric", + "modelAsString": true + } + } + }, + { + "name": "dateTimeBegin", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "dateTimeEnd", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "granularity", + "type": "string", + "in": "query", + "required": true, + "enum": [ + "PT5M", + "PT1H", + "P1D" + ], + "x-ms-enum": { + "name": "WafGranularity", + "modelAsString": true + } + }, + { + "name": "actions", + "type": "array", + "in": "query", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "allow", + "block", + "log", + "redirect" + ], + "x-ms-enum": { + "name": "WafAction", + "modelAsString": true + } + } + }, + { + "name": "groupBy", + "in": "query", + "type": "array", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "httpStatusCode", + "customDomain" + ], + "x-ms-enum": { + "name": "WafRankingGroupBy", + "modelAsString": true + } + } + }, + { + "name": "ruleTypes", + "type": "array", + "in": "query", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "managed", + "custom", + "bot" + ], + "x-ms-enum": { + "name": "WafRuleType", + "modelAsString": true + } + } + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/WafMetricsResponse" + } + }, + "default": { + "description": "Azure Front Door Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getWafLogAnalyticsRankings": { + "get": { + "tags": [ + "WafLogAnalytics" + ], + "operationId": "LogAnalytics_GetWafLogAnalyticsRankings", + "x-ms-examples": { + "LogAnalytics_GetWafLogAnalyticsRankings": { + "$ref": "./examples/LogAnalytics_GetWafLogAnalyticsRankings.json" + } + }, + "description": "Get WAF log analytics charts for AFD profile", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "metrics", + "type": "array", + "in": "query", + "required": true, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "clientRequestCount" + ], + "x-ms-enum": { + "name": "WafMetric", + "modelAsString": true + } + } + }, + { + "name": "dateTimeBegin", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "dateTimeEnd", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "maxRanking", + "in": "query", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "name": "rankings", + "type": "array", + "in": "query", + "required": true, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "action", + "ruleGroup", + "ruleId", + "userAgent", + "clientIp", + "url", + "countryOrRegion", + "ruleType" + ], + "x-ms-enum": { + "name": "WafRankingType", + "modelAsString": true + } + } + }, + { + "name": "actions", + "type": "array", + "in": "query", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "allow", + "block", + "log", + "redirect" + ], + "x-ms-enum": { + "name": "WafAction", + "modelAsString": true + } + } + }, + { + "name": "ruleTypes", + "type": "array", + "in": "query", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "managed", + "custom", + "bot" + ], + "x-ms-enum": { + "name": "WafRuleType", + "modelAsString": true + } + } + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/WafRankingsResponse" + } + }, + "default": { + "description": "Azure Front Door Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ProfileChangeSkuWafMapping": { + "type": "object", + "description": "Parameters required for profile upgrade.", + "required": [ + "securityPolicyName", + "changeToWafPolicy" + ], + "properties": { + "securityPolicyName": { + "description": "The security policy name.", + "type": "string" + }, + "changeToWafPolicy": { + "description": "The new waf resource for the security policy to use.", + "$ref": "./cdn.json#/definitions/ResourceReference" + } + } + }, + "ProfileUpgradeParameters": { + "type": "object", + "description": "Parameters required for profile upgrade.", + "required": [ + "wafMappingList" + ], + "properties": { + "wafMappingList": { + "description": "Web Application Firewall (WAF) and security policy mapping for the profile upgrade", + "type": "array", + "items": { + "description": "List of waf mappings", + "$ref": "#/definitions/ProfileChangeSkuWafMapping" + }, + "x-ms-identifiers": [] + } + } + }, + "AfdPurgeParameters": { + "type": "object", + "description": "Parameters required for content purge.", + "required": [ + "contentPaths" + ], + "properties": { + "contentPaths": { + "description": "The path to the content to be purged. Can describe a file path or a wild card directory.", + "type": "array", + "items": { + "type": "string" + } + }, + "domains": { + "description": "List of domains.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Certificate": { + "description": "Certificate used for https", + "properties": { + "type": { + "$ref": "#/definitions/SecretType" + }, + "subject": { + "description": "Subject name in the certificate.", + "type": "string", + "readOnly": true + }, + "expirationDate": { + "description": "Certificate expiration date.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedCertificate": { + "description": "Managed Certificate used for https", + "allOf": [ + { + "$ref": "#/definitions/Certificate" + } + ] + }, + "CustomerCertificate": { + "description": "Customer Certificate used for https", + "allOf": [ + { + "$ref": "#/definitions/Certificate" + } + ], + "properties": { + "secretSource": { + "description": "Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{certificateName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "secretVersion": { + "description": "Certificate version.", + "type": "string" + }, + "certificateAuthority": { + "description": "Certificate issuing authority.", + "type": "string", + "readOnly": true + }, + "useLatestVersion": { + "description": "Whether to use the latest version for the certificate", + "type": "boolean" + }, + "subjectAlternativeNames": { + "description": "The list of SANs.", + "type": "array", + "items": { + "type": "string", + "readOnly": true + } + }, + "thumbprint": { + "description": "Certificate thumbprint.", + "type": "string", + "readOnly": true + } + } + }, + "AzureFirstPartyManagedCertificate": { + "description": "Azure FirstParty Managed Certificate provided by other first party resource providers to enable HTTPS.", + "allOf": [ + { + "$ref": "#/definitions/Certificate" + } + ] + }, + "ValidateSecretInput": { + "description": "Input of the secret to be validated.", + "type": "object", + "required": [ + "secretSource", + "secretType" + ], + "properties": { + "secretType": { + "description": "The secret type.", + "$ref": "#/definitions/SecretType" + }, + "secretSource": { + "description": "Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{secretName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "secretVersion": { + "description": "Secret version, if customer is using a specific version.", + "type": "string" + } + } + }, + "ValidateSecretOutput": { + "description": "Output of the validated secret.", + "type": "object", + "properties": { + "status": { + "description": "The validation status.", + "enum": [ + "Valid", + "Invalid", + "AccessDenied", + "CertificateExpired" + ], + "type": "string", + "x-ms-enum": { + "name": "status", + "modelAsString": true + } + }, + "message": { + "description": "Detailed error message", + "type": "string" + } + } + }, + "AFDDomainListResult": { + "description": "Result of the request to list domains. It contains a list of domain objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AFDDomain" + }, + "description": "List of AzureFrontDoor domains within a profile." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of domain objects if there are any." + } + } + }, + "AFDDomain": { + "description": "Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDDomainProperties" + } + } + }, + "AFDDomainProperties": { + "description": "The JSON object that contains the properties of the domain to create.", + "required": [ + "hostName" + ], + "allOf": [ + { + "$ref": "#/definitions/AFDDomainUpdatePropertiesParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ], + "properties": { + "domainValidationState": { + "description": "Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation.", + "readOnly": true, + "enum": [ + "Unknown", + "Submitting", + "Pending", + "Rejected", + "TimedOut", + "PendingRevalidation", + "Approved", + "RefreshingValidationToken", + "InternalError" + ], + "type": "string", + "x-ms-enum": { + "name": "DomainValidationState", + "modelAsString": true + } + }, + "hostName": { + "description": "The host name of the domain. Must be a domain name.", + "type": "string" + }, + "extendedProperties": { + "description": "Key-Value pair representing migration properties for domains.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "validationProperties": { + "description": "Values the customer needs to validate domain ownership", + "readOnly": true, + "type": "object", + "$ref": "#/definitions/DomainValidationProperties" + } + } + }, + "AFDDomainUpdateParameters": { + "description": "The domain JSON object required for domain creation or update.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDDomainUpdatePropertiesParameters" + } + } + }, + "AFDDomainUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the domain to create.", + "properties": { + "profileName": { + "description": "The name of the profile which holds the domain.", + "type": "string", + "readOnly": true + }, + "tlsSettings": { + "description": "The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user's own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default.", + "type": "object", + "$ref": "#/definitions/AFDDomainHttpsParameters" + }, + "azureDnsZone": { + "description": "Resource reference to the Azure DNS zone", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "preValidatedCustomDomainResourceId": { + "description": "Resource reference to the Azure resource where custom domain ownership was prevalidated", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + } + } + }, + "DomainValidationProperties": { + "description": "The JSON object that contains the properties to validate a domain.", + "properties": { + "validationToken": { + "description": "Challenge used for DNS TXT record or file based validation", + "readOnly": true, + "type": "string" + }, + "expirationDate": { + "description": "The date time that the token expires", + "readOnly": true, + "type": "string" + } + } + }, + "AFDDomainHttpsParameters": { + "description": "The JSON object that contains the properties to secure a domain.", + "required": [ + "certificateType" + ], + "properties": { + "certificateType": { + "description": "Defines the source of the SSL certificate.", + "enum": [ + "CustomerCertificate", + "ManagedCertificate", + "AzureFirstPartyManagedCertificate" + ], + "type": "string", + "x-ms-enum": { + "name": "AfdCertificateType", + "modelAsString": true + } + }, + "minimumTlsVersion": { + "description": "TLS protocol version that will be used for Https", + "enum": [ + "TLS10", + "TLS12" + ], + "type": "string", + "x-ms-enum": { + "name": "AfdMinimumTlsVersion", + "modelAsString": false + } + }, + "secret": { + "description": "Resource reference to the secret. ie. subs/rg/profile/secret", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + } + } + }, + "SecurityPolicy": { + "description": "SecurityPolicy association for AzureFrontDoor profile", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecurityPolicyProperties" + } + } + }, + "SecurityPolicyProperties": { + "description": "The json object that contains properties required to create a security policy", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AFDStateProperties" + } + ], + "properties": { + "profileName": { + "description": "The name of the profile which holds the security policy.", + "type": "string", + "readOnly": true + }, + "parameters": { + "description": "object which contains security policy parameters", + "$ref": "#/definitions/SecurityPolicyPropertiesParameters" + } + } + }, + "SecurityPolicyUpdateParameters": { + "description": "The JSON object containing security policy update parameters.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecurityPolicyUpdateProperties" + } + } + }, + "SecurityPolicyUpdateProperties": { + "description": "The json object that contains properties required to update a security policy", + "type": "object", + "properties": { + "parameters": { + "description": "object which contains security policy parameters", + "$ref": "#/definitions/SecurityPolicyPropertiesParameters" + } + } + }, + "SecurityPolicyPropertiesParameters": { + "description": "The json object containing security policy parameters", + "discriminator": "type", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "description": "The type of the Security policy to create.", + "enum": [ + "WebApplicationFirewall" + ], + "type": "string", + "x-ms-enum": { + "name": "SecurityPolicyType", + "modelAsString": true + } + } + } + }, + "SecurityPolicyWebApplicationFirewallParameters": { + "description": "The json object containing security policy waf parameters", + "x-ms-discriminator-value": "WebApplicationFirewall", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecurityPolicyPropertiesParameters" + } + ], + "properties": { + "wafPolicy": { + "type": "object", + "description": "Resource ID.", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "associations": { + "description": "Waf associations", + "type": "array", + "items": { + "$ref": "#/definitions/SecurityPolicyWebApplicationFirewallAssociation" + }, + "x-ms-identifiers": [] + } + } + }, + "SecurityPolicyWebApplicationFirewallAssociation": { + "description": "settings for security policy patterns to match", + "type": "object", + "properties": { + "domains": { + "description": "List of domains.", + "type": "array", + "items": { + "$ref": "#/definitions/ActivatedResourceReference" + } + }, + "patternsToMatch": { + "description": "List of paths", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SecurityPolicyListResult": { + "description": "Result of the request to list security policies. It contains a list of security policy objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SecurityPolicy" + }, + "description": "List of Security policies within a profile" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of security policy objects if there is any." + } + } + }, + "AutoGeneratedDomainNameLabelScope": { + "description": "Indicates the endpoint name reuse scope. The default value is TenantReuse.", + "enum": [ + "TenantReuse", + "SubscriptionReuse", + "ResourceGroupReuse", + "NoReuse" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoGeneratedDomainNameLabelScope", + "modelAsString": true + } + }, + "AFDEndpoint": { + "description": "Azure Front Door endpoint is the entity within a Azure Front Door profile containing configuration information such as origin, protocol, content caching and delivery behavior. The AzureFrontDoor endpoint uses the URL format .azureedge.net.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDEndpointProperties" + } + } + }, + "AFDEndpointProperties": { + "description": "The JSON object that contains the properties required to create an endpoint.", + "allOf": [ + { + "$ref": "#/definitions/AFDEndpointPropertiesUpdateParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ], + "properties": { + "hostName": { + "description": "The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net", + "type": "string", + "readOnly": true + }, + "autoGeneratedDomainNameLabelScope": { + "description": "Indicates the endpoint name reuse scope. The default value is TenantReuse.", + "$ref": "#/definitions/AutoGeneratedDomainNameLabelScope" + } + } + }, + "AFDEndpointListResult": { + "description": "Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AFDEndpoint" + }, + "description": "List of AzureFrontDoor endpoints within a profile" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of endpoint objects if there is any." + } + } + }, + "AFDEndpointUpdateParameters": { + "type": "object", + "description": "Properties required to create or update an endpoint.", + "properties": { + "tags": { + "description": "Endpoint tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDEndpointPropertiesUpdateParameters" + } + }, + "x-ms-azure-resource": true + }, + "AFDEndpointPropertiesUpdateParameters": { + "description": "The JSON object containing endpoint update parameters.", + "properties": { + "profileName": { + "description": "The name of the profile which holds the endpoint.", + "type": "string", + "readOnly": true + }, + "enabledState": { + "description": "Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EnabledState", + "modelAsString": true + } + } + } + }, + "CompressionSettings": { + "description": "settings for compression.", + "type": "object", + "properties": { + "contentTypesToCompress": { + "description": "List of content types on which compression applies. The value should be a valid MIME type.", + "type": "array", + "items": { + "type": "string" + } + }, + "isCompressionEnabled": { + "description": "Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.", + "type": "boolean" + } + } + }, + "AFDEndpointProtocols": { + "description": "Supported protocols for the customer's endpoint.", + "enum": [ + "Http", + "Https" + ], + "type": "string", + "x-ms-enum": { + "name": "AFDEndpointProtocols", + "modelAsString": true + } + }, + "SecretListResult": { + "description": "Result of the request to list secrets. It contains a list of Secret objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Secret" + }, + "description": "List of AzureFrontDoor secrets within a profile." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of Secret objects if there are any." + } + } + }, + "Secret": { + "description": "Friendly Secret name mapping to the any Secret or secret related information.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecretProperties" + } + } + }, + "SecretProperties": { + "description": "The JSON object that contains the properties of the Secret to create.", + "allOf": [ + { + "$ref": "#/definitions/AFDStateProperties" + } + ], + "properties": { + "profileName": { + "description": "The name of the profile which holds the secret.", + "type": "string", + "readOnly": true + }, + "parameters": { + "description": "object which contains secret parameters", + "$ref": "#/definitions/SecretParameters" + } + } + }, + "SecretParameters": { + "description": "The json object containing secret parameters", + "discriminator": "type", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/SecretType" + } + } + }, + "SecretType": { + "description": "The type of the secret resource.", + "enum": [ + "UrlSigningKey", + "CustomerCertificate", + "ManagedCertificate", + "AzureFirstPartyManagedCertificate" + ], + "type": "string", + "x-ms-enum": { + "name": "SecretType", + "modelAsString": true + } + }, + "UrlSigningKeyParameters": { + "description": "Url signing key parameters", + "x-ms-discriminator-value": "UrlSigningKey", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretParameters" + } + ], + "required": [ + "keyId", + "secretSource" + ], + "properties": { + "keyId": { + "description": "Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash.", + "type": "string" + }, + "secretSource": { + "description": "Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{secretName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "secretVersion": { + "description": "Version of the secret to be used", + "type": "string" + } + } + }, + "ManagedCertificateParameters": { + "description": "Managed Certificate used for https", + "x-ms-discriminator-value": "ManagedCertificate", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretParameters" + } + ], + "properties": { + "subject": { + "description": "Subject name in the certificate.", + "type": "string", + "readOnly": true + }, + "expirationDate": { + "description": "Certificate expiration date.", + "type": "string", + "readOnly": true + } + } + }, + "CustomerCertificateParameters": { + "description": "Customer Certificate used for https", + "x-ms-discriminator-value": "CustomerCertificate", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretParameters" + } + ], + "required": [ + "secretSource" + ], + "properties": { + "secretSource": { + "description": "Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{certificateName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "secretVersion": { + "description": "Version of the secret to be used", + "type": "string" + }, + "useLatestVersion": { + "description": "Whether to use the latest version for the certificate", + "type": "boolean" + }, + "subject": { + "description": "Subject name in the certificate.", + "type": "string", + "readOnly": true + }, + "expirationDate": { + "description": "Certificate expiration date.", + "type": "string", + "readOnly": true + }, + "certificateAuthority": { + "description": "Certificate issuing authority.", + "type": "string", + "readOnly": true + }, + "subjectAlternativeNames": { + "description": "The list of SANs.", + "type": "array", + "items": { + "type": "string", + "readOnly": true + } + }, + "thumbprint": { + "description": "Certificate thumbprint.", + "type": "string", + "readOnly": true + } + } + }, + "AzureFirstPartyManagedCertificateParameters": { + "description": "Azure FirstParty Managed Certificate provided by other first party resource providers to enable HTTPS.", + "x-ms-discriminator-value": "AzureFirstPartyManagedCertificate", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretParameters" + } + ], + "properties": { + "secretSource": { + "description": "Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{certificateName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference", + "readOnly": true + }, + "subject": { + "description": "Subject name in the certificate.", + "type": "string", + "readOnly": true + }, + "expirationDate": { + "description": "Certificate expiration date.", + "type": "string", + "readOnly": true + }, + "certificateAuthority": { + "description": "Certificate issuing authority.", + "type": "string", + "readOnly": true + }, + "subjectAlternativeNames": { + "description": "The list of SANs.", + "type": "array", + "items": { + "type": "string", + "readOnly": true + } + }, + "thumbprint": { + "description": "Certificate thumbprint.", + "type": "string", + "readOnly": true + } + } + }, + "RuleSetListResult": { + "description": "Result of the request to list rule sets. It contains a list of rule set objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RuleSet" + }, + "description": "List of AzureFrontDoor rule sets within a profile." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of rule set objects if there are any." + } + } + }, + "RuleSet": { + "description": "Friendly RuleSet name mapping to the any RuleSet or secret related information.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RuleSetProperties" + } + } + }, + "RuleSetProperties": { + "description": "The JSON object that contains the properties of the Rule Set to create.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AFDStateProperties" + } + ], + "properties": { + "profileName": { + "description": "The name of the profile which holds the rule set.", + "type": "string", + "readOnly": true + } + } + }, + "AFDOrigin": { + "description": "Azure Front Door origin is the source of the content being delivered via Azure Front Door. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDOriginProperties" + } + } + }, + "AFDOriginProperties": { + "description": "The JSON object that contains the properties of the origin.", + "required": [ + "hostName" + ], + "allOf": [ + { + "$ref": "#/definitions/AFDOriginUpdatePropertiesParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ] + }, + "AFDOriginUpdateParameters": { + "type": "object", + "description": "AFDOrigin properties needed for origin update.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDOriginUpdatePropertiesParameters" + } + }, + "x-ms-azure-resource": true + }, + "AFDOriginUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the origin.", + "properties": { + "originGroupName": { + "description": "The name of the origin group which contains this origin.", + "type": "string", + "readOnly": true + }, + "azureOrigin": { + "description": "Resource reference to the Azure origin resource.", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "hostName": { + "description": "The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.", + "type": "string" + }, + "httpPort": { + "description": "The value of the HTTP port. Must be between 1 and 65535.", + "type": "integer", + "format": "int32", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false, + "default": 80 + }, + "httpsPort": { + "description": "The value of the HTTPS port. Must be between 1 and 65535.", + "type": "integer", + "maximum": 65535, + "format": "int32", + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false, + "default": 443 + }, + "originHostHeader": { + "description": "The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure Front Door origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint", + "type": "string" + }, + "priority": { + "description": "Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5", + "type": "integer", + "format": "int32", + "maximum": 5, + "minimum": 1 + }, + "weight": { + "description": "Weight of the origin in given origin group for load balancing. Must be between 1 and 1000", + "type": "integer", + "format": "int32", + "maximum": 1000, + "minimum": 1 + }, + "sharedPrivateLinkResource": { + "description": "The properties of the private link resource for private origin.", + "type": "object", + "$ref": "#/definitions/SharedPrivateLinkResourceProperties" + }, + "enabledState": { + "description": "Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnabledState", + "modelAsString": true + } + }, + "enforceCertificateNameCheck": { + "description": "Whether to enable certificate name check at origin level", + "type": "boolean", + "default": true + } + } + }, + "SharedPrivateLinkResourceProperties": { + "properties": { + "privateLink": { + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference", + "description": "The resource id of the resource the shared private link resource is for." + }, + "privateLinkLocation": { + "type": "string", + "description": "The location of the shared private link resource" + }, + "groupId": { + "type": "string", + "description": "The group id from the provider of resource the shared private link resource is for." + }, + "requestMessage": { + "type": "string", + "description": "The request message for requesting approval of the shared private link resource." + }, + "status": { + "type": "string", + "description": "Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected", + "Timeout" + ], + "x-ms-enum": { + "name": "SharedPrivateLinkResourceStatus", + "modelAsString": false + } + } + }, + "description": "Describes the properties of an existing Shared Private Link Resource to use when connecting to a private origin." + }, + "AFDOriginListResult": { + "description": "Result of the request to list origins. It contains a list of origin objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AFDOrigin" + }, + "description": "List of Azure Front Door origins within an Azure Front Door endpoint" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of origin objects if there are any." + } + } + }, + "AFDOriginGroup": { + "description": "AFDOrigin group comprising of origins is used for load balancing to origins when the content cannot be served from Azure Front Door.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDOriginGroupProperties" + } + } + }, + "AFDOriginGroupProperties": { + "description": "The JSON object that contains the properties of the origin group.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AFDOriginGroupUpdatePropertiesParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ] + }, + "AFDOriginGroupUpdateParameters": { + "type": "object", + "description": "AFDOrigin group properties needed for origin group creation or update.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDOriginGroupUpdatePropertiesParameters" + } + }, + "x-ms-azure-resource": true + }, + "AFDOriginGroupUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the origin group.", + "properties": { + "profileName": { + "description": "The name of the profile which holds the origin group.", + "type": "string", + "readOnly": true + }, + "loadBalancingSettings": { + "description": "Load balancing settings for a backend pool", + "$ref": "#/definitions/LoadBalancingSettingsParameters" + }, + "healthProbeSettings": { + "description": "Health probe settings to the origin that is used to determine the health of the origin.", + "type": "object", + "$ref": "./cdn.json#/definitions/HealthProbeParameters" + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": { + "description": "Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.", + "type": "integer", + "format": "int32", + "maximum": 50, + "minimum": 0 + }, + "sessionAffinityState": { + "description": "Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EnabledState", + "modelAsString": true + } + } + } + }, + "LoadBalancingSettingsParameters": { + "description": "Round-Robin load balancing settings for a backend pool", + "type": "object", + "properties": { + "sampleSize": { + "description": "The number of samples to consider for load balancing decisions", + "type": "integer", + "format": "int32" + }, + "successfulSamplesRequired": { + "description": "The number of samples within the sample period that must succeed", + "type": "integer", + "format": "int32" + }, + "additionalLatencyInMilliseconds": { + "description": "The additional latency in milliseconds for probes to fall into the lowest latency bucket", + "type": "integer", + "format": "int32" + } + } + }, + "AFDOriginGroupListResult": { + "description": "Result of the request to list origin groups. It contains a list of origin groups objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AFDOriginGroup" + }, + "description": "List of Azure Front Door origin groups within an Azure Front Door endpoint" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of origin objects if there are any." + } + } + }, + "RouteListResult": { + "description": "Result of the request to list routes. It contains a list of route objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Route" + }, + "description": "List of AzureFrontDoor routes within a profile." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of route objects if there are any." + } + } + }, + "Route": { + "description": "Friendly Routes name mapping to the any Routes or secret related information.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteProperties" + } + } + }, + "RouteProperties": { + "description": "The JSON object that contains the properties of the Routes to create.", + "allOf": [ + { + "$ref": "#/definitions/RouteUpdatePropertiesParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ], + "required": [ + "originGroup" + ] + }, + "RouteUpdateParameters": { + "description": "The domain JSON object required for domain creation or update.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteUpdatePropertiesParameters" + } + } + }, + "RouteUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the domain to create.", + "properties": { + "endpointName": { + "description": "The name of the endpoint which holds the route.", + "type": "string", + "readOnly": true + }, + "customDomains": { + "description": "Domains referenced by this endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/ActivatedResourceReference" + } + }, + "originGroup": { + "description": "A reference to the origin group.", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "originPath": { + "description": "A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.", + "type": "string" + }, + "ruleSets": { + "description": "rule sets referenced by this endpoint.", + "type": "array", + "items": { + "$ref": "./cdn.json#/definitions/ResourceReference" + } + }, + "supportedProtocols": { + "description": "List of supported protocols for this route.", + "type": "array", + "items": { + "$ref": "#/definitions/AFDEndpointProtocols" + }, + "default": [ + "Http", + "Https" + ] + }, + "patternsToMatch": { + "description": "The route patterns of the rule.", + "type": "array", + "items": { + "type": "string", + "description": "A route pattern of the rule. Must not have any * except possibly after the final / at the end of the path." + } + }, + "cacheConfiguration": { + "description": "The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.", + "type": "object", + "$ref": "#/definitions/AfdRouteCacheConfiguration" + }, + "forwardingProtocol": { + "description": "Protocol this rule will use when forwarding traffic to backends.", + "type": "string", + "enum": [ + "HttpOnly", + "HttpsOnly", + "MatchRequest" + ], + "x-ms-enum": { + "name": "ForwardingProtocol", + "modelAsString": true + }, + "default": "MatchRequest" + }, + "linkToDefaultDomain": { + "description": "whether this route will be linked to the default endpoint domain.", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "LinkToDefaultDomain", + "modelAsString": true + }, + "default": "Disabled" + }, + "httpsRedirect": { + "description": "Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "httpsRedirect", + "modelAsString": true + }, + "default": "Disabled" + }, + "enabledState": { + "description": "Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EnabledState", + "modelAsString": true + } + } + } + }, + "AfdRouteCacheConfiguration": { + "description": "Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.", + "type": "object", + "properties": { + "queryStringCachingBehavior": { + "description": "Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.", + "enum": [ + "IgnoreQueryString", + "UseQueryString", + "IgnoreSpecifiedQueryStrings", + "IncludeSpecifiedQueryStrings" + ], + "type": "string", + "x-ms-enum": { + "name": "afdQueryStringCachingBehavior", + "modelAsString": true + } + }, + "queryParameters": { + "description": "query parameters to include or exclude (comma separated).", + "type": "string" + }, + "compressionSettings": { + "description": "compression settings.", + "type": "object", + "$ref": "#/definitions/CompressionSettings" + } + } + }, + "RuleListResult": { + "description": "Result of the request to list rules. It contains a list of rule objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Rule" + }, + "description": "List of AzureFrontDoor rules within a rule set." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of rule objects if there are any." + } + } + }, + "Rule": { + "description": "Friendly Rules name mapping to the any Rules or secret related information.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RuleProperties" + } + } + }, + "RuleProperties": { + "description": "The JSON object that contains the properties of the Rules to create.", + "type": "object", + "required": [ + "order", + "actions" + ], + "allOf": [ + { + "$ref": "#/definitions/RuleUpdatePropertiesParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ] + }, + "RuleUpdateParameters": { + "description": "The domain JSON object required for domain creation or update.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RuleUpdatePropertiesParameters" + } + } + }, + "RuleUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the rule to update.", + "properties": { + "ruleSetName": { + "description": "The name of the rule set containing the rule.", + "type": "string", + "readOnly": true + }, + "order": { + "description": "The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.", + "type": "integer", + "format": "int32" + }, + "conditions": { + "description": "A list of conditions that must be matched for the actions to be executed", + "type": "array", + "items": { + "$ref": "./cdn.json#/definitions/DeliveryRuleCondition" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "actions": { + "description": "A list of actions that are executed when all the conditions of a rule are satisfied.", + "type": "array", + "items": { + "$ref": "./cdn.json#/definitions/DeliveryRuleAction" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "matchProcessingBehavior": { + "description": "If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.", + "type": "string", + "enum": [ + "Continue", + "Stop" + ], + "x-ms-enum": { + "name": "MatchProcessingBehavior", + "modelAsString": true + }, + "default": "Continue" + } + } + }, + "CheckEndpointNameAvailabilityInput": { + "description": "Input of CheckNameAvailability API.", + "type": "object", + "required": [ + "name", + "type" + ], + "properties": { + "name": { + "description": "The resource name to validate.", + "type": "string" + }, + "type": { + "description": "The type of the resource whose name is to be validated.", + "$ref": "./cdn.json#/definitions/ResourceType" + }, + "autoGeneratedDomainNameLabelScope": { + "description": "Indicates the endpoint name reuse scope. The default value is TenantReuse.", + "$ref": "#/definitions/AutoGeneratedDomainNameLabelScope" + } + } + }, + "CheckEndpointNameAvailabilityOutput": { + "description": "Output of check name availability API.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates whether the name is available.", + "readOnly": true, + "type": "boolean" + }, + "availableHostname": { + "description": "Returns the available hostname generated based on the AutoGeneratedDomainNameLabelScope when the name is available, otherwise it returns empty string", + "readOnly": true, + "type": "string" + }, + "reason": { + "description": "The reason why the name is not available.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "The detailed error message describing why the name is not available.", + "readOnly": true, + "type": "string" + } + } + }, + "CheckHostNameAvailabilityInput": { + "description": "Input of CheckHostNameAvailability API.", + "type": "object", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name to validate.", + "type": "string" + } + } + }, + "ValidationToken": { + "description": "The validation token.", + "type": "object", + "properties": { + "token": { + "readOnly": true, + "type": "string" + } + } + }, + "AFDStateProperties": { + "description": "The tracking states for afd resources.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "description": "Provisioning status", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Updating", + "Deleting", + "Creating" + ], + "x-ms-enum": { + "name": "AfdProvisioningState", + "modelAsString": true + } + }, + "deploymentStatus": { + "enum": [ + "NotStarted", + "InProgress", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DeploymentStatus", + "modelAsString": true + } + } + } + }, + "AfdErrorResponse": { + "title": "Error response", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "properties": { + "error": { + "description": "The error object.", + "$ref": "./cdn.json#/definitions/ErrorDetail" + } + } + }, + "MetricsResponse": { + "description": "Metrics Response", + "properties": { + "dateTimeBegin": { + "type": "string", + "format": "date-time" + }, + "dateTimeEnd": { + "type": "string", + "format": "date-time" + }, + "granularity": { + "type": "string", + "enum": [ + "PT5M", + "PT1H", + "P1D" + ], + "x-ms-enum": { + "name": "MetricsGranularity", + "modelAsString": true + } + }, + "series": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metric": { + "type": "string" + }, + "unit": { + "type": "string", + "enum": [ + "count", + "bytes", + "bitsPerSecond", + "milliSeconds" + ], + "x-ms-enum": { + "name": "MetricsSeriesUnit", + "modelAsString": true + } + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "x-ms-identifiers": [ + "name" + ] + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dateTime": { + "type": "string", + "format": "date-time" + }, + "value": { + "type": "number" + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "RankingsResponse": { + "description": "Rankings Response", + "properties": { + "dateTimeBegin": { + "type": "string", + "format": "date-time" + }, + "dateTimeEnd": { + "type": "string", + "format": "date-time" + }, + "tables": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ranking": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "metrics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metric": { + "type": "string" + }, + "value": { + "type": "integer", + "format": "int64" + }, + "percentage": { + "type": "number" + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "ContinentsResponse": { + "description": "Continents Response", + "properties": { + "continents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + } + } + }, + "countryOrRegions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "continentId": { + "type": "string" + } + } + } + } + } + }, + "ResourcesResponse": { + "description": "Resources Response", + "properties": { + "endpoints": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "history": { + "type": "boolean" + }, + "customDomains": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "endpointId": { + "type": "string" + }, + "history": { + "type": "boolean" + } + } + } + } + } + } + }, + "customDomains": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "endpointId": { + "type": "string" + }, + "history": { + "type": "boolean" + } + } + } + } + } + }, + "WafMetricsResponse": { + "description": "Waf Metrics Response", + "properties": { + "dateTimeBegin": { + "type": "string", + "format": "date-time" + }, + "dateTimeEnd": { + "type": "string", + "format": "date-time" + }, + "granularity": { + "type": "string", + "enum": [ + "PT5M", + "PT1H", + "P1D" + ], + "x-ms-enum": { + "name": "WafMetricsGranularity", + "modelAsString": true + } + }, + "series": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metric": { + "type": "string" + }, + "unit": { + "type": "string", + "enum": [ + "count" + ], + "x-ms-enum": { + "name": "WafMetricsSeriesUnit", + "modelAsString": true + } + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "x-ms-identifiers": [ + "name" + ] + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dateTime": { + "type": "string", + "format": "date-time" + }, + "value": { + "type": "number" + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "WafRankingsResponse": { + "description": "Waf Rankings Response", + "properties": { + "dateTimeBegin": { + "type": "string", + "format": "date-time" + }, + "dateTimeEnd": { + "type": "string", + "format": "date-time" + }, + "groups": { + "type": "array", + "items": { + "type": "string" + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupValues": { + "type": "array", + "items": { + "type": "string" + } + }, + "metrics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metric": { + "type": "string" + }, + "value": { + "type": "integer", + "format": "int64" + }, + "percentage": { + "type": "number", + "format": "double" + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "UsageName": { + "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": "Describes resource usage." + }, + "UsagesListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list of resource usages." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "The list usages operation response." + }, + "ActivatedResourceReference": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + }, + "isActive": { + "readOnly": true, + "type": "boolean", + "description": "Whether the resource is active or inactive" + } + }, + "description": "Reference to another resource along with its state.", + "type": "object", + "x-ms-azure-resource": true + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. Current version is 2024-09-01." + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "Name of the Resource group within the Azure subscription." + }, + "profileNameParameter": { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group." + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdn.json new file mode 100644 index 000000000000..8a76359927c1 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdn.json @@ -0,0 +1,7466 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-01", + "title": "CdnManagementClient", + "description": "Use these APIs to manage Azure CDN resources through the Azure Resource Manager. You must make sure that requests made to these resources are secure." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/profiles": { + "get": { + "tags": [ + "Profiles" + ], + "description": "Lists all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within an Azure subscription.", + "operationId": "Profiles_List", + "x-ms-examples": { + "Profiles_List": { + "$ref": "./examples/Profiles_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProfileListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles": { + "get": { + "tags": [ + "Profiles" + ], + "description": "Lists all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within a resource group.", + "operationId": "Profiles_ListByResourceGroup", + "x-ms-examples": { + "Profiles_ListByResourceGroup": { + "$ref": "./examples/Profiles_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProfileListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}": { + "get": { + "tags": [ + "Profiles" + ], + "description": "Gets an Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group.", + "operationId": "Profiles_Get", + "x-ms-examples": { + "Profiles_Get": { + "$ref": "./examples/Profiles_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Profiles" + ], + "description": "Creates a new Azure Front Door Standard or Azure Front Door Premium or CDN profile with a profile name under the specified subscription and resource group.", + "operationId": "Profiles_Create", + "x-ms-examples": { + "Profiles_Create": { + "$ref": "./examples/Profiles_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "description": "Profile properties needed to create a new profile.", + "in": "body", + "name": "profile", + "required": true, + "schema": { + "$ref": "#/definitions/Profile" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new profile has been created.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Profiles" + ], + "description": "Updates an existing Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group.", + "operationId": "Profiles_Update", + "x-ms-examples": { + "Profiles_Update": { + "$ref": "./examples/Profiles_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "profileUpdateParameters", + "in": "body", + "description": "Profile properties needed to update an existing profile.", + "required": true, + "schema": { + "$ref": "#/definitions/ProfileUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Profiles" + ], + "description": "Deletes an existing Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified parameters. Deleting a profile will result in the deletion of all of the sub-resources including endpoints, origins and custom domains.", + "operationId": "Profiles_Delete", + "x-ms-examples": { + "Profiles_Delete": { + "$ref": "./examples/Profiles_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the profile was not found." + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/canMigrate": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Checks if CDN profile can be migrated to Azure Frontdoor(Standard/Premium) profile.", + "operationId": "Profiles_CanMigrate", + "x-ms-examples": { + "Profiles_CanMigrate": { + "$ref": "./examples/Profiles_CanMigrate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "description": "Properties needed to check if cdn profile or classic frontdoor can be migrated.", + "in": "body", + "name": "canMigrateParameters", + "required": true, + "schema": { + "$ref": "#/definitions/CanMigrateParameters" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CanMigrateResult" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/migrate": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile. The change need to be committed after this.", + "operationId": "Profiles_Migrate", + "x-ms-examples": { + "Profiles_Migrate": { + "$ref": "./examples/Profiles_Migrate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "description": "Properties needed to migrate the profile.", + "in": "body", + "name": "migrationParameters", + "required": true, + "schema": { + "$ref": "#/definitions/MigrationParameters" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/MigrateResult" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/MigrateResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/migrationCommit": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Commit the migrated Azure Frontdoor(Standard/Premium) profile.", + "operationId": "Profiles_MigrationCommit", + "x-ms-examples": { + "Profiles_MigrationCommit": { + "$ref": "./examples/Profiles_MigrationCommit.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/generateSsoUri": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Generates a dynamic SSO URI used to sign in to the CDN supplemental portal. Supplemental portal is used to configure advanced feature capabilities that are not yet available in the Azure portal, such as core reports in a standard profile; rules engine, advanced HTTP reports, and real-time stats and alerts in a premium profile. The SSO URI changes approximately every 10 minutes.", + "operationId": "Profiles_GenerateSsoUri", + "x-ms-examples": { + "Profiles_GenerateSsoUri": { + "$ref": "./examples/Profiles_GenerateSsoUri.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/SsoUri" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getSupportedOptimizationTypes": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Gets the supported optimization types for the current profile. A user can create an endpoint with an optimization type from the listed values.", + "operationId": "Profiles_ListSupportedOptimizationTypes", + "x-ms-examples": { + "Profiles_ListSupportedOptimizationTypes": { + "$ref": "./examples/Profiles_ListSupportedOptimizationTypes.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/SupportedOptimizationTypesListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/checkResourceUsage": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Checks the quota and actual usage of endpoints under the given Azure Front Door Standard or Azure Front Door Premium or CDN profile.", + "operationId": "Profiles_ListResourceUsage", + "x-ms-examples": { + "Profiles_ListResourceUsage": { + "$ref": "./examples/Profiles_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ResourceUsageListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints": { + "get": { + "tags": [ + "Endpoints" + ], + "description": "Lists existing CDN endpoints.", + "operationId": "Endpoints_ListByProfile", + "x-ms-examples": { + "Endpoints_ListByProfile": { + "$ref": "./examples/Endpoints_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EndpointListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}": { + "get": { + "tags": [ + "Endpoints" + ], + "description": "Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "Endpoints_Get", + "x-ms-examples": { + "Endpoints_Get": { + "$ref": "./examples/Endpoints_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Endpoints" + ], + "description": "Creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "Endpoints_Create", + "x-ms-examples": { + "Endpoints_Create": { + "$ref": "./examples/Endpoints_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "endpoint", + "in": "body", + "description": "Endpoint properties", + "required": true, + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new endpoint has been created.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Endpoints" + ], + "description": "Updates an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update custom domains, use the Update Custom Domain operation.", + "operationId": "Endpoints_Update", + "x-ms-examples": { + "Endpoints_Update": { + "$ref": "./examples/Endpoints_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "endpointUpdateProperties", + "in": "body", + "description": "Endpoint update properties", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Endpoints" + ], + "description": "Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "Endpoints_Delete", + "x-ms-examples": { + "Endpoints_Delete": { + "$ref": "./examples/Endpoints_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the endpoint was not found." + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/start": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Starts an existing CDN endpoint that is on a stopped state.", + "operationId": "Endpoints_Start", + "x-ms-examples": { + "Endpoints_Start": { + "$ref": "./examples/Endpoints_Start.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/stop": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Stops an existing running CDN endpoint.", + "operationId": "Endpoints_Stop", + "x-ms-examples": { + "Endpoints_Stop": { + "$ref": "./examples/Endpoints_Stop.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/purge": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Removes a content from CDN.", + "operationId": "Endpoints_PurgeContent", + "x-ms-examples": { + "Endpoints_PurgeContent": { + "$ref": "./examples/Endpoints_PurgeContent.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "contentFilePaths", + "in": "body", + "description": "The path to the content to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory.", + "required": true, + "schema": { + "$ref": "#/definitions/PurgeParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/load": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Pre-loads a content to CDN. Available for Verizon Profiles.", + "operationId": "Endpoints_LoadContent", + "x-ms-examples": { + "Endpoints_LoadContent": { + "$ref": "./examples/Endpoints_LoadContent.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "contentFilePaths", + "in": "body", + "description": "The path to the content to be loaded. Path should be a full URL, e.g. ‘/pictures/city.png' which loads a single file ", + "required": true, + "schema": { + "$ref": "#/definitions/LoadParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/validateCustomDomain": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.", + "operationId": "Endpoints_ValidateCustomDomain", + "x-ms-examples": { + "Endpoints_ValidateCustomDomain": { + "$ref": "./examples/Endpoints_ValidateCustomDomain.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainProperties", + "in": "body", + "description": "Custom domain to be validated.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateCustomDomainInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ValidateCustomDomainOutput" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/checkResourceUsage": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Checks the quota and usage of geo filters and custom domains under the given endpoint.", + "operationId": "Endpoints_ListResourceUsage", + "x-ms-examples": { + "Endpoints_ListResourceUsage": { + "$ref": "./examples/Endpoints_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ResourceUsageListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins": { + "get": { + "tags": [ + "Origins" + ], + "description": "Lists all of the existing origins within an endpoint.", + "operationId": "Origins_ListByEndpoint", + "x-ms-examples": { + "Origins_ListByEndpoint": { + "$ref": "./examples/Origins_ListByEndpoint.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}": { + "get": { + "tags": [ + "Origins" + ], + "description": "Gets an existing origin within an endpoint.", + "operationId": "Origins_Get", + "x-ms-examples": { + "Origins_Get": { + "$ref": "./examples/Origins_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Origins" + ], + "description": "Creates a new origin within the specified endpoint.", + "operationId": "Origins_Create", + "x-ms-examples": { + "Origins_Create": { + "$ref": "./examples/Origins_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin that is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "origin", + "in": "body", + "description": "Origin properties", + "required": true, + "schema": { + "$ref": "#/definitions/Origin" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new origin has been created.", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Origins" + ], + "description": "Updates an existing origin within an endpoint.", + "operationId": "Origins_Update", + "x-ms-examples": { + "Origins_Update": { + "$ref": "./examples/Origins_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "originUpdateProperties", + "in": "body", + "description": "Origin properties", + "required": true, + "schema": { + "$ref": "#/definitions/OriginUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Origins" + ], + "description": "Deletes an existing origin within an endpoint.", + "operationId": "Origins_Delete", + "x-ms-examples": { + "Origins_Delete": { + "$ref": "./examples/Origins_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the origin was not found." + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups": { + "get": { + "tags": [ + "OriginGroups" + ], + "description": "Lists all of the existing origin groups within an endpoint.", + "operationId": "OriginGroups_ListByEndpoint", + "x-ms-examples": { + "OriginsGroups_ListByEndpoint": { + "$ref": "./examples/OriginGroups_ListByEndpoint.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginGroupListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups/{originGroupName}": { + "get": { + "tags": [ + "OriginGroups" + ], + "description": "Gets an existing origin group within an endpoint.", + "operationId": "OriginGroups_Get", + "x-ms-examples": { + "OriginGroups_Get": { + "$ref": "./examples/OriginGroups_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "OriginGroups" + ], + "description": "Creates a new origin group within the specified endpoint.", + "operationId": "OriginGroups_Create", + "x-ms-examples": { + "OriginGroups_Create": { + "$ref": "./examples/OriginGroups_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "originGroup", + "in": "body", + "description": "Origin group properties", + "required": true, + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new origin group has been created.", + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "OriginGroups" + ], + "description": "Updates an existing origin group within an endpoint.", + "operationId": "OriginGroups_Update", + "x-ms-examples": { + "OriginGroups_Update": { + "$ref": "./examples/OriginGroups_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "originGroupUpdateProperties", + "in": "body", + "description": "Origin group properties", + "required": true, + "schema": { + "$ref": "#/definitions/OriginGroupUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "OriginGroups" + ], + "description": "Deletes an existing origin group within an endpoint.", + "operationId": "OriginGroups_Delete", + "x-ms-examples": { + "OriginGroups_Delete": { + "$ref": "./examples/OriginGroups_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the origin was not found." + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains": { + "get": { + "tags": [ + "CustomDomains" + ], + "description": "Lists all of the existing custom domains within an endpoint.", + "operationId": "CustomDomains_ListByEndpoint", + "x-ms-examples": { + "CustomDomains_ListByEndpoint": { + "$ref": "./examples/CustomDomains_ListByEndpoint.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomDomainListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}": { + "get": { + "tags": [ + "CustomDomains" + ], + "description": "Gets an existing custom domain within an endpoint.", + "operationId": "CustomDomains_Get", + "x-ms-examples": { + "CustomDomains_Get": { + "$ref": "./examples/CustomDomains_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "CustomDomains" + ], + "description": "Creates a new custom domain within an endpoint.", + "operationId": "CustomDomains_Create", + "x-ms-examples": { + "CustomDomains_Create": { + "$ref": "./examples/CustomDomains_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "name": "customDomainProperties", + "in": "body", + "description": "Properties required to create a new custom domain.", + "required": true, + "schema": { + "$ref": "#/definitions/CustomDomainParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new custom domain has been created.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "CustomDomains" + ], + "description": "Deletes an existing custom domain within an endpoint.", + "operationId": "CustomDomains_Delete", + "x-ms-examples": { + "CustomDomains_Delete": { + "$ref": "./examples/CustomDomains_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "204": { + "description": "No Content. The request has been accepted but the custom domain was not found" + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/disableCustomHttps": { + "post": { + "tags": [ + "CustomDomains" + ], + "description": "Disable https delivery of the custom domain.", + "operationId": "CustomDomains_DisableCustomHttps", + "x-ms-examples": { + "CustomDomains_DisableCustomHttps": { + "$ref": "./examples/CustomDomains_DisableCustomHttps.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/enableCustomHttps": { + "post": { + "tags": [ + "CustomDomains" + ], + "description": "Enable https delivery of the custom domain.", + "operationId": "CustomDomains_EnableCustomHttps", + "x-ms-examples": { + "CustomDomains_EnableCustomHttpsUsingYourOwnCertificate": { + "$ref": "./examples/CustomDomains_EnableCustomHttpsUsingBYOC.json" + }, + "CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate": { + "$ref": "./examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "name": "customDomainHttpsParameters", + "in": "body", + "description": "The configuration specifying how to enable HTTPS for the custom domain - using CDN managed certificate or user's own certificate. If not specified, enabling ssl uses CDN managed certificate by default.", + "required": false, + "schema": { + "$ref": "#/definitions/CustomDomainHttpsParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.Cdn/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailability" + ], + "description": "Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.", + "operationId": "CheckNameAvailability", + "x-ms-examples": { + "CheckNameAvailability": { + "$ref": "./examples/CheckNameAvailability.json" + } + }, + "parameters": [ + { + "name": "checkNameAvailabilityInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityInput" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityOutput" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailabilityWithSubscription" + ], + "description": "Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.", + "operationId": "CheckNameAvailabilityWithSubscription", + "x-ms-examples": { + "CheckNameAvailabilityWithSubscription": { + "$ref": "./examples/CheckNameAvailabilityWithSubscription.json" + } + }, + "parameters": [ + { + "name": "checkNameAvailabilityInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityOutput" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/validateProbe": { + "post": { + "tags": [ + "ValidateProbe" + ], + "description": "Check if the probe path is a valid path and the file can be accessed. Probe path is the path to a file hosted on the origin server to help accelerate the delivery of dynamic content via the CDN endpoint. This path is relative to the origin path specified in the endpoint configuration.", + "operationId": "ValidateProbe", + "x-ms-examples": { + "ValidateProbe": { + "$ref": "./examples/ValidateProbe.json" + } + }, + "parameters": [ + { + "name": "validateProbeInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateProbeInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ValidateProbeOutput" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/checkResourceUsage": { + "post": { + "tags": [ + "CheckResourceUsage" + ], + "description": "Check the quota and actual usage of the CDN profiles under the given subscription.", + "operationId": "ResourceUsage_List", + "x-ms-examples": { + "ResourceUsage_List": { + "$ref": "./examples/ResourceUsage_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ResourceUsageListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Cdn/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available CDN REST API operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationsListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Cdn/edgenodes": { + "get": { + "tags": [ + "Edgenodes" + ], + "description": "Edgenodes are the global Point of Presence (POP) locations used to deliver CDN content to end users.", + "operationId": "EdgeNodes_List", + "x-ms-examples": { + "EdgeNodes_List": { + "$ref": "./examples/EdgeNodes_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EdgenodeResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/cdnCanMigrateToAfd": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Checks if CDN profile can be migrated to Azure Frontdoor(Standard/Premium) profile.", + "operationId": "Profiles_CdnCanMigrateToAfd", + "x-ms-examples": { + "Profiles_CdnCanMigrate": { + "$ref": "./examples/CdnProfiles_CanMigrate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CanMigrateResult" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/cdnMigrateToAfd": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile. This step prepares the profile for migration and will be followed by Commit to finalize the migration.", + "operationId": "Profiles_CdnMigrateToAfd", + "x-ms-examples": { + "Profiles_CdnMigrate": { + "$ref": "./examples/CdnProfiles_Migrate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "description": "Properties needed to migrate the profile.", + "in": "body", + "name": "migrationParameters", + "required": true, + "schema": { + "$ref": "#/definitions/CdnMigrationToAfdParameters" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/MigrateResult" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/migrationAbort": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Abort the migration to Azure Frontdoor Premium/Standard.", + "operationId": "Profiles_MigrationAbort", + "x-ms-examples": { + "Profiles_CdnMigrationCommit": { + "$ref": "./examples/Profiles_MigrationAbort.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "Profile": { + "description": "A profile is a logical grouping of endpoints that share the same settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "description": "The pricing tier (defines Azure Front Door Standard or Premium or a CDN provider, feature list and rate) of the profile.", + "$ref": "#/definitions/Sku" + }, + "kind": { + "readOnly": true, + "type": "string", + "description": "Kind of the profile. Used by portal to differentiate traditional CDN profile and new AFD profile." + }, + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities).", + "type": "object", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProfileProperties" + } + }, + "required": [ + "sku" + ] + }, + "ProfileProperties": { + "description": "The JSON object that contains the properties required to create a profile.", + "properties": { + "resourceState": { + "description": "Resource status of the profile.", + "readOnly": true, + "enum": [ + "Creating", + "Active", + "Deleting", + "Disabled", + "Migrating", + "Migrated", + "PendingMigrationCommit", + "CommittingMigration", + "AbortingMigration" + ], + "type": "string", + "x-ms-enum": { + "name": "ProfileResourceState", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "description": "Provisioning status of the profile.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Updating", + "Deleting", + "Creating" + ], + "x-ms-enum": { + "name": "ProfileProvisioningState", + "modelAsString": true + } + }, + "extendedProperties": { + "description": "Key-Value pair representing additional properties for profiles.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "frontDoorId": { + "readOnly": true, + "type": "string", + "description": "The Id of the frontdoor." + }, + "originResponseTimeoutSeconds": { + "description": "Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns.", + "type": "integer", + "format": "int32", + "minimum": 16, + "exclusiveMinimum": false + }, + "logScrubbing": { + "description": "Defines rules that scrub sensitive fields in the Azure Front Door profile logs.", + "$ref": "#/definitions/ProfileLogScrubbing" + } + } + }, + "ProfileLogScrubbing": { + "description": "Defines rules that scrub sensitive fields in the Azure Front Door profile logs.", + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "State of the log scrubbing config. Default value is Enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ProfileScrubbingState", + "modelAsString": true + } + }, + "scrubbingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/ProfileScrubbingRules" + }, + "x-ms-identifiers": [], + "description": "List of log scrubbing rules applied to the Azure Front Door profile logs." + } + } + }, + "ProfileListResult": { + "description": "Result of the request to list profiles. It contains a list of profile objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Profile" + }, + "description": "List of CDN profiles within a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of profile objects if there are any." + } + } + }, + "ProfileUpdateParameters": { + "type": "object", + "description": "Properties required to update a profile.", + "properties": { + "tags": { + "description": "Profile tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities).", + "type": "object", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProfilePropertiesUpdateParameters" + } + }, + "x-ms-azure-resource": true + }, + "ProfilePropertiesUpdateParameters": { + "type": "object", + "description": "The JSON object containing profile update parameters.", + "properties": { + "originResponseTimeoutSeconds": { + "description": "Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns.", + "type": "integer", + "format": "int32", + "minimum": 16, + "exclusiveMinimum": false + }, + "logScrubbing": { + "description": "Defines rules to scrub sensitive fields in logs", + "$ref": "#/definitions/ProfileLogScrubbing" + } + } + }, + "ProfileScrubbingRules": { + "description": "Defines the contents of the log scrubbing rules.", + "type": "object", + "required": [ + "matchVariable", + "selectorMatchOperator" + ], + "properties": { + "matchVariable": { + "type": "string", + "enum": [ + "RequestIPAddress", + "RequestUri", + "QueryStringArgNames" + ], + "description": "The variable to be scrubbed from the logs.", + "x-ms-enum": { + "name": "scrubbingRuleEntryMatchVariable", + "modelAsString": true + } + }, + "selectorMatchOperator": { + "type": "string", + "enum": [ + "EqualsAny" + ], + "description": "When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to.", + "x-ms-enum": { + "name": " scrubbingRuleEntryMatchOperator", + "modelAsString": true + } + }, + "selector": { + "type": "string", + "description": "When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to." + }, + "state": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "description": "Defines the state of a log scrubbing rule. Default value is enabled.", + "x-ms-enum": { + "name": " scrubbingRuleEntryState", + "modelAsString": true + } + } + } + }, + "CanMigrateResult": { + "type": "object", + "description": "Result for canMigrate operation.", + "properties": { + "id": { + "description": "Resource ID.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Resource type.", + "readOnly": true, + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CanMigrateProperties" + } + }, + "x-ms-azure-resource": true + }, + "CanMigrateProperties": { + "type": "object", + "properties": { + "canMigrate": { + "readOnly": true, + "description": "Flag that says if the profile can be migrated", + "type": "boolean" + }, + "defaultSku": { + "readOnly": true, + "description": "Recommended sku for the migration", + "type": "string", + "enum": [ + "Standard_AzureFrontDoor", + "Premium_AzureFrontDoor" + ], + "x-ms-enum": { + "name": "CanMigrateDefaultSku", + "modelAsString": true + } + }, + "errors": { + "items": { + "description": "List of migration errors", + "$ref": "#/definitions/MigrationErrorType" + }, + "type": "array", + "x-ms-identifiers": [] + } + } + }, + "MigrationErrorType": { + "description": "Error response indicates CDN service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "readOnly": true, + "type": "string" + }, + "resourceName": { + "description": "Resource which has the problem.", + "readOnly": true, + "type": "string" + }, + "errorMessage": { + "description": "Error message indicating why the operation failed.", + "readOnly": true, + "type": "string" + }, + "nextSteps": { + "description": "Describes what needs to be done to fix the problem", + "readOnly": true, + "type": "string" + } + } + }, + "CanMigrateParameters": { + "type": "object", + "description": "Request body for CanMigrate operation.", + "required": [ + "classicResourceReference" + ], + "properties": { + "classicResourceReference": { + "description": "Resource reference of the classic cdn profile or classic frontdoor that need to be migrated.", + "$ref": "#/definitions/ResourceReference" + } + }, + "x-ms-azure-resource": true + }, + "MigrationParameters": { + "type": "object", + "description": "Request body for Migrate operation.", + "required": [ + "classicResourceReference", + "sku", + "profileName" + ], + "properties": { + "sku": { + "description": "Sku for the migration", + "$ref": "#/definitions/Sku" + }, + "classicResourceReference": { + "description": "Resource reference of the classic cdn profile or classic frontdoor that need to be migrated.", + "$ref": "#/definitions/ResourceReference" + }, + "profileName": { + "description": "Name of the new profile that need to be created.", + "type": "string" + }, + "migrationWebApplicationFirewallMappings": { + "description": "Waf mapping for the migrated profile", + "type": "array", + "items": { + "description": "List of waf mappings", + "$ref": "#/definitions/MigrationWebApplicationFirewallMapping" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-azure-resource": true + }, + "MigrationWebApplicationFirewallMapping": { + "description": "Web Application Firewall Mapping ", + "type": "object", + "properties": { + "migratedFrom": { + "description": "Migration From Waf policy", + "$ref": "#/definitions/ResourceReference" + }, + "migratedTo": { + "description": "Migration to Waf policy", + "$ref": "#/definitions/ResourceReference" + } + } + }, + "MigrateResult": { + "type": "object", + "description": "Result for migrate operation.", + "properties": { + "id": { + "description": "Resource ID.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Resource type.", + "readOnly": true, + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/MigrateResultProperties" + } + }, + "x-ms-azure-resource": true + }, + "MigrateResultProperties": { + "type": "object", + "properties": { + "migratedProfileResourceId": { + "readOnly": true, + "description": "Arm resource id of the migrated profile", + "$ref": "#/definitions/ResourceReference" + } + } + }, + "SsoUri": { + "description": "The URI required to login to the supplemental portal from the Azure portal.", + "type": "object", + "properties": { + "ssoUriValue": { + "description": "The URI used to login to the supplemental portal.", + "readOnly": true, + "type": "string" + } + } + }, + "SupportedOptimizationTypesListResult": { + "description": "The result of the GetSupportedOptimizationTypes API", + "type": "object", + "properties": { + "supportedOptimizationTypes": { + "description": "Supported optimization types for a profile.", + "readOnly": true, + "items": { + "$ref": "#/definitions/OptimizationType" + }, + "type": "array" + } + } + }, + "DeliveryRuleConditionParameters": { + "description": "Defines the parameters for delivery rule match conditions", + "type": "object", + "discriminator": "typeName", + "required": [ + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleRemoteAddressConditionParameters", + "DeliveryRuleRequestMethodConditionParameters", + "DeliveryRuleQueryStringConditionParameters", + "DeliveryRulePostArgsConditionParameters", + "DeliveryRuleRequestUriConditionParameters", + "DeliveryRuleRequestHeaderConditionParameters", + "DeliveryRuleRequestBodyConditionParameters", + "DeliveryRuleRequestSchemeConditionParameters", + "DeliveryRuleUrlPathMatchConditionParameters", + "DeliveryRuleUrlFileExtensionMatchConditionParameters", + "DeliveryRuleUrlFilenameConditionParameters", + "DeliveryRuleHttpVersionConditionParameters", + "DeliveryRuleCookiesConditionParameters", + "DeliveryRuleIsDeviceConditionParameters", + "DeliveryRuleSocketAddrConditionParameters", + "DeliveryRuleClientPortConditionParameters", + "DeliveryRuleServerPortConditionParameters", + "DeliveryRuleHostNameConditionParameters", + "DeliveryRuleSslProtocolConditionParameters" + ], + "x-ms-enum": { + "name": "DeliveryRuleConditionParametersType", + "modelAsString": true + } + } + } + }, + "DeliveryRuleActionParameters": { + "description": "Defines the parameters for delivery rule actions", + "type": "object", + "discriminator": "typeName", + "required": [ + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleUrlRedirectActionParameters", + "DeliveryRuleUrlSigningActionParameters", + "DeliveryRuleOriginGroupOverrideActionParameters", + "DeliveryRuleUrlRewriteActionParameters", + "DeliveryRuleHeaderActionParameters", + "DeliveryRuleCacheExpirationActionParameters", + "DeliveryRuleCacheKeyQueryStringBehaviorActionParameters", + "DeliveryRuleRouteConfigurationOverrideActionParameters" + ], + "x-ms-enum": { + "name": "DeliveryRuleActionParametersType", + "modelAsString": true + } + } + } + }, + "CertificateSourceParameters": { + "description": "Defines the parameters for certificate source", + "type": "object", + "discriminator": "typeName", + "required": [ + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "CdnCertificateSourceParameters", + "KeyVaultCertificateSourceParameters" + ], + "x-ms-enum": { + "name": "CertificateSourceParametersType", + "modelAsString": true + } + } + } + }, + "Endpoint": { + "description": "CDN endpoint is the entity within a CDN profile containing configuration information such as origin, protocol, content caching and delivery behavior. The CDN endpoint uses the URL format .azureedge.net.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EndpointProperties" + } + } + }, + "EndpointProperties": { + "description": "The JSON object that contains the properties required to create an endpoint.", + "required": [ + "origins" + ], + "allOf": [ + { + "$ref": "#/definitions/EndpointPropertiesUpdateParameters" + } + ], + "properties": { + "hostName": { + "description": "The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net", + "type": "string", + "readOnly": true + }, + "origins": { + "description": "The source of the content being delivered via CDN.", + "type": "array", + "items": { + "$ref": "#/definitions/DeepCreatedOrigin" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "originGroups": { + "description": "The origin groups comprising of origins that are used for load balancing the traffic based on availability.", + "type": "array", + "items": { + "$ref": "#/definitions/DeepCreatedOriginGroup" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "customDomains": { + "description": "The custom domains under the endpoint.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/DeepCreatedCustomDomain" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "resourceState": { + "description": "Resource status of the endpoint.", + "readOnly": true, + "enum": [ + "Creating", + "Deleting", + "Running", + "Starting", + "Stopped", + "Stopping" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointResourceState", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "description": "Provisioning status of the endpoint.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Updating", + "Deleting", + "Creating" + ], + "x-ms-enum": { + "name": "EndpointProvisioningState", + "modelAsString": true + } + } + } + }, + "EndpointListResult": { + "description": "Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Endpoint" + }, + "description": "List of CDN endpoints within a profile" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of endpoint objects if there is any." + } + } + }, + "EndpointUpdateParameters": { + "type": "object", + "description": "Properties required to create or update an endpoint.", + "properties": { + "tags": { + "description": "Endpoint tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EndpointPropertiesUpdateParameters" + } + }, + "x-ms-azure-resource": true + }, + "EndpointPropertiesUpdateParameters": { + "description": "The JSON object containing endpoint update parameters.", + "properties": { + "originPath": { + "description": "A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.", + "type": "string" + }, + "contentTypesToCompress": { + "description": "List of content types on which compression applies. The value should be a valid MIME type.", + "type": "array", + "items": { + "type": "string" + } + }, + "originHostHeader": { + "description": "The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.", + "type": "string" + }, + "isCompressionEnabled": { + "description": "Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.", + "type": "boolean" + }, + "isHttpAllowed": { + "description": "Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.", + "type": "boolean", + "default": true + }, + "isHttpsAllowed": { + "description": "Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.", + "type": "boolean", + "default": true + }, + "queryStringCachingBehavior": { + "description": "Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.", + "$ref": "#/definitions/QueryStringCachingBehavior", + "default": "NotSet" + }, + "optimizationType": { + "description": "Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization.", + "$ref": "#/definitions/OptimizationType" + }, + "probePath": { + "description": "Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin.", + "type": "string" + }, + "geoFilters": { + "description": "List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/", + "type": "array", + "items": { + "$ref": "#/definitions/GeoFilter" + }, + "x-ms-identifiers": [] + }, + "defaultOriginGroup": { + "description": "A reference to the origin group.", + "type": "object", + "$ref": "#/definitions/ResourceReference" + }, + "urlSigningKeys": { + "description": "List of keys used to validate the signed URL hashes.", + "type": "array", + "items": { + "$ref": "#/definitions/UrlSigningKey" + }, + "x-ms-identifiers": [ + "keyId" + ] + }, + "deliveryPolicy": { + "description": "A policy that specifies the delivery rules to be used for an endpoint.", + "type": "object", + "required": [ + "rules" + ], + "properties": { + "description": { + "description": "User-friendly description of the policy.", + "type": "string" + }, + "rules": { + "description": "A list of the delivery rules.", + "type": "array", + "items": { + "$ref": "#/definitions/DeliveryRule" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "webApplicationFirewallPolicyLink": { + "description": "Defines the Web Application Firewall policy for the endpoint (if applicable)", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + } + } + } + }, + "DeliveryRule": { + "description": "A rule that specifies a set of actions and conditions", + "type": "object", + "required": [ + "order", + "actions" + ], + "properties": { + "name": { + "description": "Name of the rule", + "type": "string" + }, + "order": { + "description": "The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.", + "type": "integer", + "format": "int32" + }, + "conditions": { + "description": "A list of conditions that must be matched for the actions to be executed", + "type": "array", + "items": { + "$ref": "#/definitions/DeliveryRuleCondition" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "actions": { + "description": "A list of actions that are executed when all the conditions of a rule are satisfied.", + "type": "array", + "items": { + "$ref": "#/definitions/DeliveryRuleAction" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "DeliveryRuleCondition": { + "description": "A condition for the delivery rule.", + "discriminator": "name", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "The name of the condition for the delivery rule.", + "type": "string", + "enum": [ + "RemoteAddress", + "RequestMethod", + "QueryString", + "PostArgs", + "RequestUri", + "RequestHeader", + "RequestBody", + "RequestScheme", + "UrlPath", + "UrlFileExtension", + "UrlFileName", + "HttpVersion", + "Cookies", + "IsDevice", + "SocketAddr", + "ClientPort", + "ServerPort", + "HostName", + "SslProtocol" + ], + "x-ms-enum": { + "name": "MatchVariable", + "modelAsString": true + } + } + } + }, + "DeliveryRuleRemoteAddressCondition": { + "description": "Defines the RemoteAddress condition for the delivery rule.", + "x-ms-discriminator-value": "RemoteAddress", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RemoteAddressMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestMethodCondition": { + "description": "Defines the RequestMethod condition for the delivery rule.", + "x-ms-discriminator-value": "RequestMethod", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestMethodMatchConditionParameters" + } + } + }, + "DeliveryRuleQueryStringCondition": { + "description": "Defines the QueryString condition for the delivery rule.", + "x-ms-discriminator-value": "QueryString", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/QueryStringMatchConditionParameters" + } + } + }, + "DeliveryRulePostArgsCondition": { + "description": "Defines the PostArgs condition for the delivery rule.", + "x-ms-discriminator-value": "PostArgs", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/PostArgsMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestUriCondition": { + "description": "Defines the RequestUri condition for the delivery rule.", + "x-ms-discriminator-value": "RequestUri", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestUriMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestHeaderCondition": { + "description": "Defines the RequestHeader condition for the delivery rule.", + "x-ms-discriminator-value": "RequestHeader", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestHeaderMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestBodyCondition": { + "description": "Defines the RequestBody condition for the delivery rule.", + "x-ms-discriminator-value": "RequestBody", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestBodyMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestSchemeCondition": { + "description": "Defines the RequestScheme condition for the delivery rule.", + "x-ms-discriminator-value": "RequestScheme", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestSchemeMatchConditionParameters" + } + } + }, + "DeliveryRuleUrlPathCondition": { + "description": "Defines the UrlPath condition for the delivery rule.", + "x-ms-discriminator-value": "UrlPath", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/UrlPathMatchConditionParameters" + } + } + }, + "DeliveryRuleUrlFileExtensionCondition": { + "description": "Defines the UrlFileExtension condition for the delivery rule.", + "x-ms-discriminator-value": "UrlFileExtension", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/UrlFileExtensionMatchConditionParameters" + } + } + }, + "DeliveryRuleUrlFileNameCondition": { + "description": "Defines the UrlFileName condition for the delivery rule.", + "x-ms-discriminator-value": "UrlFileName", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/UrlFileNameMatchConditionParameters" + } + } + }, + "DeliveryRuleHttpVersionCondition": { + "description": "Defines the HttpVersion condition for the delivery rule.", + "x-ms-discriminator-value": "HttpVersion", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/HttpVersionMatchConditionParameters" + } + } + }, + "DeliveryRuleCookiesCondition": { + "description": "Defines the Cookies condition for the delivery rule.", + "x-ms-discriminator-value": "Cookies", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/CookiesMatchConditionParameters" + } + } + }, + "DeliveryRuleIsDeviceCondition": { + "description": "Defines the IsDevice condition for the delivery rule.", + "x-ms-discriminator-value": "IsDevice", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/IsDeviceMatchConditionParameters" + } + } + }, + "DeliveryRuleSocketAddrCondition": { + "description": "Defines the SocketAddress condition for the delivery rule.", + "type": "object", + "x-ms-discriminator-value": "SocketAddr", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/SocketAddrMatchConditionParameters" + } + } + }, + "DeliveryRuleClientPortCondition": { + "description": "Defines the ClientPort condition for the delivery rule.", + "type": "object", + "x-ms-discriminator-value": "ClientPort", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/ClientPortMatchConditionParameters" + } + } + }, + "DeliveryRuleServerPortCondition": { + "description": "Defines the ServerPort condition for the delivery rule.", + "type": "object", + "x-ms-discriminator-value": "ServerPort", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/ServerPortMatchConditionParameters" + } + } + }, + "DeliveryRuleHostNameCondition": { + "description": "Defines the HostName condition for the delivery rule.", + "type": "object", + "x-ms-discriminator-value": "HostName", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/HostNameMatchConditionParameters" + } + } + }, + "DeliveryRuleSslProtocolCondition": { + "description": "Defines the SslProtocol condition for the delivery rule.", + "type": "object", + "x-ms-discriminator-value": "SslProtocol", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/SslProtocolMatchConditionParameters" + } + } + }, + "RemoteAddressMatchConditionParameters": { + "description": "Defines the parameters for RemoteAddress match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleRemoteAddressConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "IPMatch", + "GeoMatch" + ], + "x-ms-enum": { + "name": "RemoteAddressOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match.", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestMethodMatchConditionParameters": { + "description": "Defines the parameters for RequestMethod match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleRequestMethodConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Equal" + ], + "x-ms-enum": { + "name": "RequestMethodOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string", + "enum": [ + "GET", + "HEAD", + "POST", + "PUT", + "DELETE", + "OPTIONS", + "TRACE" + ], + "x-ms-enum": { + "name": "RequestMethodMatchValue", + "modelAsString": true + } + } + } + } + }, + "QueryStringMatchConditionParameters": { + "description": "Defines the parameters for QueryString match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleQueryStringConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "QueryStringOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "PostArgsMatchConditionParameters": { + "description": "Defines the parameters for PostArgs match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRulePostArgsConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "selector": { + "description": "Name of PostArg to be matched", + "type": "string" + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "PostArgsOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestUriMatchConditionParameters": { + "description": "Defines the parameters for RequestUri match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleRequestUriConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "RequestUriOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestHeaderMatchConditionParameters": { + "description": "Defines the parameters for RequestHeader match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleRequestHeaderConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "selector": { + "description": "Name of Header to be matched", + "type": "string" + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "RequestHeaderOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestBodyMatchConditionParameters": { + "description": "Defines the parameters for RequestBody match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleRequestBodyConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "RequestBodyOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestSchemeMatchConditionParameters": { + "description": "Defines the parameters for RequestScheme match conditions ", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleRequestSchemeConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Equal" + ] + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string", + "enum": [ + "HTTP", + "HTTPS" + ], + "x-ms-enum": { + "name": "RequestSchemeMatchValue", + "modelAsString": true + } + } + } + } + }, + "UrlPathMatchConditionParameters": { + "description": "Defines the parameters for UrlPath match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleUrlPathMatchConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "Wildcard", + "RegEx" + ], + "x-ms-enum": { + "name": "UrlPathOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "UrlFileExtensionMatchConditionParameters": { + "description": "Defines the parameters for UrlFileExtension match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleUrlFileExtensionMatchConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "UrlFileExtensionOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "UrlFileNameMatchConditionParameters": { + "description": "Defines the parameters for UrlFilename match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleUrlFilenameConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "UrlFileNameOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "HttpVersionMatchConditionParameters": { + "description": "Defines the parameters for HttpVersion match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleHttpVersionConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Equal" + ], + "x-ms-enum": { + "name": "HttpVersionOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "CookiesMatchConditionParameters": { + "description": "Defines the parameters for Cookies match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleCookiesConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "selector": { + "description": "Name of Cookies to be matched", + "type": "string" + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "CookiesOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "IsDeviceMatchConditionParameters": { + "description": "Defines the parameters for IsDevice match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleIsDeviceConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Equal" + ], + "x-ms-enum": { + "name": "IsDeviceOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string", + "enum": [ + "Mobile", + "Desktop" + ], + "x-ms-enum": { + "name": "IsDeviceMatchValue", + "modelAsString": true + } + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "SocketAddrMatchConditionParameters": { + "description": "Defines the parameters for SocketAddress match conditions", + "type": "object", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleSocketAddrConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "IPMatch" + ], + "x-ms-enum": { + "name": "SocketAddrOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "ClientPortMatchConditionParameters": { + "description": "Defines the parameters for ClientPort match conditions", + "type": "object", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleClientPortConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "ClientPortOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "ServerPortMatchConditionParameters": { + "description": "Defines the parameters for ServerPort match conditions", + "type": "object", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleServerPortConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "ServerPortOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "HostNameMatchConditionParameters": { + "description": "Defines the parameters for HostName match conditions", + "type": "object", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleHostNameConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "HostNameOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "SslProtocolMatchConditionParameters": { + "description": "Defines the parameters for SslProtocol match conditions", + "type": "object", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleSslProtocolConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Equal" + ], + "x-ms-enum": { + "name": "SslProtocolOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "$ref": "#/definitions/SslProtocol" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "DeliveryRuleAction": { + "description": "An action for the delivery rule.", + "discriminator": "name", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "The name of the action for the delivery rule.", + "type": "string", + "enum": [ + "CacheExpiration", + "CacheKeyQueryString", + "ModifyRequestHeader", + "ModifyResponseHeader", + "UrlRedirect", + "UrlRewrite", + "UrlSigning", + "OriginGroupOverride", + "RouteConfigurationOverride" + ], + "x-ms-enum": { + "name": "DeliveryRuleActionName", + "modelAsString": true + } + } + } + }, + "UrlRedirectAction": { + "description": "Defines the url redirect action for the delivery rule.", + "x-ms-discriminator-value": "UrlRedirect", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/UrlRedirectActionParameters" + } + } + }, + "UrlRedirectActionParameters": { + "description": "Defines the parameters for the url redirect action.", + "required": [ + "redirectType" + ], + "x-ms-discriminator-value": "DeliveryRuleUrlRedirectActionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleActionParameters" + } + ], + "properties": { + "redirectType": { + "description": "The redirect type the rule will use when redirecting traffic.", + "type": "string", + "enum": [ + "Moved", + "Found", + "TemporaryRedirect", + "PermanentRedirect" + ], + "x-ms-enum": { + "name": "RedirectType", + "modelAsString": true + } + }, + "destinationProtocol": { + "description": "Protocol to use for the redirect. The default value is MatchRequest", + "type": "string", + "enum": [ + "MatchRequest", + "Http", + "Https" + ], + "x-ms-enum": { + "name": "DestinationProtocol", + "modelAsString": true + } + }, + "customPath": { + "description": "The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.", + "type": "string" + }, + "customHostname": { + "description": "Host to redirect. Leave empty to use the incoming host as the destination host.", + "type": "string" + }, + "customQueryString": { + "description": "The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in = format. ? and & will be added automatically so do not include them.", + "type": "string" + }, + "customFragment": { + "type": "string", + "description": "Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #." + } + } + }, + "UrlSigningAction": { + "description": "Defines the url signing action for the delivery rule.", + "x-ms-discriminator-value": "UrlSigning", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/UrlSigningActionParameters" + } + } + }, + "UrlSigningActionParameters": { + "description": "Defines the parameters for the Url Signing action.", + "x-ms-discriminator-value": "DeliveryRuleUrlSigningActionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleActionParameters" + } + ], + "properties": { + "algorithm": { + "description": "Algorithm to use for URL signing", + "type": "string", + "enum": [ + "SHA256" + ], + "x-ms-enum": { + "name": "algorithm", + "modelAsString": true + } + }, + "parameterNameOverride": { + "description": "Defines which query string parameters in the url to be considered for expires, key id etc. ", + "type": "array", + "items": { + "$ref": "#/definitions/UrlSigningParamIdentifier" + }, + "x-ms-identifiers": [ + "paramName" + ] + } + } + }, + "UrlSigningParamIdentifier": { + "description": "Defines how to identify a parameter for a specific purpose e.g. expires", + "required": [ + "paramIndicator", + "paramName" + ], + "properties": { + "paramIndicator": { + "description": "Indicates the purpose of the parameter", + "type": "string", + "enum": [ + "Expires", + "KeyId", + "Signature" + ], + "x-ms-enum": { + "name": "paramIndicator", + "modelAsString": true + } + }, + "paramName": { + "description": "Parameter name", + "type": "string" + } + } + }, + "OriginGroupOverrideAction": { + "description": "Defines the origin group override action for the delivery rule.", + "x-ms-discriminator-value": "OriginGroupOverride", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/OriginGroupOverrideActionParameters" + } + } + }, + "OriginGroupOverrideActionParameters": { + "description": "Defines the parameters for the origin group override action.", + "required": [ + "originGroup" + ], + "x-ms-discriminator-value": "DeliveryRuleOriginGroupOverrideActionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleActionParameters" + } + ], + "properties": { + "originGroup": { + "description": "defines the OriginGroup that would override the DefaultOriginGroup.", + "type": "object", + "$ref": "#/definitions/ResourceReference" + } + } + }, + "UrlRewriteAction": { + "description": "Defines the url rewrite action for the delivery rule.", + "x-ms-discriminator-value": "UrlRewrite", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/UrlRewriteActionParameters" + } + } + }, + "UrlRewriteActionParameters": { + "description": "Defines the parameters for the url rewrite action.", + "required": [ + "sourcePattern", + "destination" + ], + "x-ms-discriminator-value": "DeliveryRuleUrlRewriteActionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleActionParameters" + } + ], + "properties": { + "sourcePattern": { + "description": "define a request URI pattern that identifies the type of requests that may be rewritten. If value is blank, all strings are matched.", + "type": "string" + }, + "destination": { + "description": "Define the relative URL to which the above requests will be rewritten by.", + "type": "string" + }, + "preserveUnmatchedPath": { + "description": "Whether to preserve unmatched path. Default value is true.", + "type": "boolean" + } + } + }, + "DeliveryRuleRequestHeaderAction": { + "description": "Defines the request header action for the delivery rule.", + "x-ms-discriminator-value": "ModifyRequestHeader", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/HeaderActionParameters" + } + } + }, + "DeliveryRuleResponseHeaderAction": { + "description": "Defines the response header action for the delivery rule.", + "x-ms-discriminator-value": "ModifyResponseHeader", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/HeaderActionParameters" + } + } + }, + "HeaderActionParameters": { + "description": "Defines the parameters for the request header action.", + "required": [ + "headerAction", + "headerName" + ], + "x-ms-discriminator-value": "DeliveryRuleHeaderActionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleActionParameters" + } + ], + "properties": { + "headerAction": { + "description": "Action to perform", + "type": "string", + "enum": [ + "Append", + "Overwrite", + "Delete" + ], + "x-ms-enum": { + "name": "HeaderAction", + "modelAsString": true + } + }, + "headerName": { + "description": "Name of the header to modify", + "type": "string" + }, + "value": { + "description": "Value for the specified action", + "type": "string" + } + } + }, + "DeliveryRuleCacheExpirationAction": { + "description": "Defines the cache expiration action for the delivery rule.", + "x-ms-discriminator-value": "CacheExpiration", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/CacheExpirationActionParameters" + } + } + }, + "CacheExpirationActionParameters": { + "description": "Defines the parameters for the cache expiration action.", + "required": [ + "cacheBehavior", + "cacheType" + ], + "x-ms-discriminator-value": "DeliveryRuleCacheExpirationActionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleActionParameters" + } + ], + "properties": { + "cacheBehavior": { + "description": "Caching behavior for the requests", + "type": "string", + "enum": [ + "BypassCache", + "Override", + "SetIfMissing" + ], + "x-ms-enum": { + "name": "cacheBehavior", + "modelAsString": true + } + }, + "cacheType": { + "description": "The level at which the content needs to be cached.", + "type": "string", + "enum": [ + "All" + ], + "x-ms-enum": { + "name": "CacheType", + "modelAsString": true + } + }, + "cacheDuration": { + "description": "The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss", + "type": "string", + "x-nullable": true + } + } + }, + "DeliveryRuleCacheKeyQueryStringAction": { + "description": "Defines the cache-key query string action for the delivery rule.", + "x-ms-discriminator-value": "CacheKeyQueryString", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/CacheKeyQueryStringActionParameters" + } + } + }, + "CacheKeyQueryStringActionParameters": { + "description": "Defines the parameters for the cache-key query string action.", + "required": [ + "queryStringBehavior" + ], + "x-ms-discriminator-value": "DeliveryRuleCacheKeyQueryStringBehaviorActionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleActionParameters" + } + ], + "properties": { + "queryStringBehavior": { + "description": "Caching behavior for the requests", + "type": "string", + "enum": [ + "Include", + "IncludeAll", + "Exclude", + "ExcludeAll" + ], + "x-ms-enum": { + "name": "queryStringBehavior", + "modelAsString": true + } + }, + "queryParameters": { + "description": "query parameters to include or exclude (comma separated).", + "type": "string", + "x-nullable": true + } + } + }, + "DeliveryRuleRouteConfigurationOverrideAction": { + "description": "Defines the route configuration override action for the delivery rule. Only applicable to Frontdoor Standard/Premium Profiles.", + "type": "object", + "x-ms-discriminator-value": "RouteConfigurationOverride", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/RouteConfigurationOverrideActionParameters" + } + } + }, + "RouteConfigurationOverrideActionParameters": { + "description": "Defines the parameters for the route configuration override action.", + "type": "object", + "x-ms-discriminator-value": "DeliveryRuleRouteConfigurationOverrideActionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleActionParameters" + } + ], + "properties": { + "originGroupOverride": { + "description": "A reference to the origin group override configuration. Leave empty to use the default origin group on route.", + "type": "object", + "$ref": "#/definitions/OriginGroupOverride" + }, + "cacheConfiguration": { + "description": "The caching configuration associated with this rule. To disable caching, do not provide a cacheConfiguration object.", + "type": "object", + "$ref": "#/definitions/CacheConfiguration" + } + } + }, + "OriginGroupOverride": { + "description": "Defines the parameters for the origin group override configuration.", + "type": "object", + "properties": { + "originGroup": { + "description": "defines the OriginGroup that would override the DefaultOriginGroup on route.", + "type": "object", + "$ref": "#/definitions/ResourceReference" + }, + "forwardingProtocol": { + "description": "Protocol this rule will use when forwarding traffic to backends.", + "type": "string", + "enum": [ + "HttpOnly", + "HttpsOnly", + "MatchRequest" + ], + "x-ms-enum": { + "name": "ForwardingProtocol", + "modelAsString": true + } + } + } + }, + "CacheConfiguration": { + "description": "Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.", + "type": "object", + "properties": { + "queryStringCachingBehavior": { + "description": "Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.", + "enum": [ + "IgnoreQueryString", + "UseQueryString", + "IgnoreSpecifiedQueryStrings", + "IncludeSpecifiedQueryStrings" + ], + "type": "string", + "x-ms-enum": { + "name": "ruleQueryStringCachingBehavior", + "modelAsString": true + } + }, + "queryParameters": { + "description": "query parameters to include or exclude (comma separated).", + "type": "string" + }, + "isCompressionEnabled": { + "description": "Indicates whether content compression is enabled. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ruleIsCompressionEnabled", + "modelAsString": true + } + }, + "cacheBehavior": { + "description": "Caching behavior for the requests", + "type": "string", + "enum": [ + "HonorOrigin", + "OverrideAlways", + "OverrideIfOriginMissing" + ], + "x-ms-enum": { + "name": "ruleCacheBehavior", + "modelAsString": true + } + }, + "cacheDuration": { + "description": "The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss", + "type": "string" + } + } + }, + "transform": { + "description": "Describes what transforms are applied before matching", + "type": "string", + "enum": [ + "Lowercase", + "Uppercase", + "Trim", + "UrlDecode", + "UrlEncode", + "RemoveNulls" + ], + "x-ms-enum": { + "name": "transform", + "modelAsString": true + } + }, + "SslProtocol": { + "description": "The protocol of an established TLS connection.", + "type": "string", + "enum": [ + "TLSv1", + "TLSv1.1", + "TLSv1.2" + ], + "x-ms-enum": { + "name": "SslProtocol", + "modelAsString": true + } + }, + "DeepCreatedOrigin": { + "description": "The main origin of CDN content which is added when creating a CDN endpoint.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "Origin name which must be unique within the endpoint. ", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DeepCreatedOriginProperties" + } + }, + "x-ms-azure-resource": true + }, + "DeepCreatedOriginProperties": { + "description": "Properties of the origin created on the CDN endpoint.", + "type": "object", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint.", + "type": "string" + }, + "httpPort": { + "description": "The value of the HTTP port. Must be between 1 and 65535.", + "type": "integer", + "format": "int32", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false + }, + "httpsPort": { + "description": "The value of the HTTPS port. Must be between 1 and 65535.", + "type": "integer", + "format": "int32", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false + }, + "originHostHeader": { + "description": "The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.", + "type": "string" + }, + "priority": { + "description": "Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.", + "type": "integer", + "format": "int32", + "maximum": 5, + "minimum": 1 + }, + "weight": { + "description": "Weight of the origin in given origin group for load balancing. Must be between 1 and 1000", + "type": "integer", + "format": "int32", + "maximum": 1000, + "minimum": 1 + }, + "enabled": { + "description": "Origin is enabled for load balancing or not. By default, origin is always enabled.", + "type": "boolean" + }, + "privateLinkAlias": { + "description": "The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'", + "type": "string" + }, + "privateLinkResourceId": { + "description": "The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'", + "type": "string" + }, + "privateLinkLocation": { + "description": "The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated", + "type": "string" + }, + "privateLinkApprovalMessage": { + "description": "A custom message to be included in the approval request to connect to the Private Link.", + "type": "string" + }, + "privateEndpointStatus": { + "description": "The approval status for the connection to the Private Link", + "$ref": "#/definitions/PrivateEndpointStatus", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "DeepCreatedOriginGroup": { + "description": "The origin group for CDN content which is added when creating a CDN endpoint. Traffic is sent to the origins within the origin group based on origin health.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "Origin group name which must be unique within the endpoint.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DeepCreatedOriginGroupProperties" + } + }, + "x-ms-azure-resource": true + }, + "DeepCreatedOriginGroupProperties": { + "description": "Properties of the origin group created on the CDN endpoint.", + "type": "object", + "required": [ + "origins" + ], + "properties": { + "healthProbeSettings": { + "description": "Health probe settings to the origin that is used to determine the health of the origin.", + "type": "object", + "$ref": "#/definitions/HealthProbeParameters" + }, + "origins": { + "description": "The source of the content being delivered via CDN within given origin group.", + "type": "array", + "items": { + "description": "A reference to a origin.", + "$ref": "#/definitions/ResourceReference" + } + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": { + "description": "Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.", + "type": "integer", + "format": "int32", + "maximum": 50, + "minimum": 0 + }, + "responseBasedOriginErrorDetectionSettings": { + "description": "The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported.", + "type": "object", + "$ref": "#/definitions/ResponseBasedOriginErrorDetectionParameters" + } + }, + "x-ms-azure-resource": true + }, + "ResourceReference": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "description": "Reference to another resource.", + "x-ms-azure-resource": true + }, + "GeoFilter": { + "description": "Rules defining user's geo access within a CDN endpoint.", + "type": "object", + "required": [ + "relativePath", + "action", + "countryCodes" + ], + "properties": { + "relativePath": { + "description": "Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.)", + "type": "string" + }, + "action": { + "description": "Action of the geo filter, i.e. allow or block access.", + "enum": [ + "Block", + "Allow" + ], + "type": "string", + "x-ms-enum": { + "name": "GeoFilterActions", + "modelAsString": false + } + }, + "countryCodes": { + "description": "Two letter country or region codes defining user country or region access in a geo filter, e.g. AU, MX, US.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PurgeParameters": { + "type": "object", + "description": "Parameters required for content purge.", + "required": [ + "contentPaths" + ], + "properties": { + "contentPaths": { + "description": "The path to the content to be purged. Can describe a file path or a wild card directory.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "UrlSigningKey": { + "description": "Url signing key", + "required": [ + "keyId", + "keySourceParameters" + ], + "properties": { + "keyId": { + "description": "Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash.", + "type": "string" + }, + "keySourceParameters": { + "description": "Defines the parameters for using customer key vault for Url Signing Key.", + "$ref": "#/definitions/KeyVaultSigningKeyParameters" + } + } + }, + "KeyVaultSigningKeyParameters": { + "description": "Describes the parameters for using a user's KeyVault for URL Signing Key.", + "required": [ + "typeName", + "subscriptionId", + "resourceGroupName", + "vaultName", + "secretName", + "secretVersion" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "KeyVaultSigningKeyParameters" + ], + "x-ms-enum": { + "name": "KeyVaultSigningKeyParametersType", + "modelAsString": true + } + }, + "subscriptionId": { + "description": "Subscription Id of the user's Key Vault containing the secret", + "type": "string" + }, + "resourceGroupName": { + "description": "Resource group of the user's Key Vault containing the secret", + "type": "string" + }, + "vaultName": { + "description": "The name of the user's Key Vault containing the secret", + "type": "string" + }, + "secretName": { + "description": "The name of secret in Key Vault.", + "type": "string" + }, + "secretVersion": { + "description": "The version(GUID) of secret in Key Vault.", + "type": "string" + } + } + }, + "LoadParameters": { + "type": "object", + "description": "Parameters required for content load.", + "required": [ + "contentPaths" + ], + "properties": { + "contentPaths": { + "description": "The path to the content to be loaded. Path should be a relative file URL of the origin.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Origin": { + "description": "CDN origin is the source of the content being delivered via CDN. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OriginProperties" + } + } + }, + "OriginProperties": { + "description": "The JSON object that contains the properties of the origin.", + "required": [ + "hostName" + ], + "allOf": [ + { + "$ref": "#/definitions/OriginUpdatePropertiesParameters" + } + ], + "properties": { + "resourceState": { + "description": "Resource status of the origin.", + "readOnly": true, + "enum": [ + "Creating", + "Active", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "OriginResourceState", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "description": "Provisioning status of the origin.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Updating", + "Deleting", + "Creating" + ], + "x-ms-enum": { + "name": "OriginProvisioningState", + "modelAsString": true + } + }, + "privateEndpointStatus": { + "description": "The approval status for the connection to the Private Link", + "$ref": "#/definitions/PrivateEndpointStatus", + "type": "string", + "readOnly": true + } + } + }, + "OriginUpdateParameters": { + "type": "object", + "description": "Origin properties needed for origin update.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OriginUpdatePropertiesParameters" + } + }, + "x-ms-azure-resource": true + }, + "OriginUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the origin.", + "properties": { + "hostName": { + "description": "The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.", + "type": "string" + }, + "httpPort": { + "description": "The value of the HTTP port. Must be between 1 and 65535.", + "type": "integer", + "format": "int32", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false + }, + "httpsPort": { + "description": "The value of the HTTPS port. Must be between 1 and 65535.", + "type": "integer", + "format": "int32", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false + }, + "originHostHeader": { + "description": "The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint", + "type": "string" + }, + "priority": { + "description": "Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5", + "type": "integer", + "format": "int32", + "maximum": 5, + "minimum": 1 + }, + "weight": { + "description": "Weight of the origin in given origin group for load balancing. Must be between 1 and 1000", + "type": "integer", + "format": "int32", + "maximum": 1000, + "minimum": 1 + }, + "enabled": { + "description": "Origin is enabled for load balancing or not", + "type": "boolean" + }, + "privateLinkAlias": { + "description": "The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'", + "type": "string" + }, + "privateLinkResourceId": { + "description": "The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'", + "type": "string" + }, + "privateLinkLocation": { + "description": "The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated", + "type": "string" + }, + "privateLinkApprovalMessage": { + "description": "A custom message to be included in the approval request to connect to the Private Link.", + "type": "string" + } + } + }, + "OriginListResult": { + "description": "Result of the request to list origins. It contains a list of origin objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Origin" + }, + "description": "List of CDN origins within an endpoint" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of origin objects if there are any." + } + } + }, + "OriginGroup": { + "description": "Origin group comprising of origins is used for load balancing to origins when the content cannot be served from CDN.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OriginGroupProperties" + } + } + }, + "OriginGroupProperties": { + "description": "The JSON object that contains the properties of the origin group.", + "type": "object", + "required": [ + "origins" + ], + "allOf": [ + { + "$ref": "#/definitions/OriginGroupUpdatePropertiesParameters" + } + ], + "properties": { + "resourceState": { + "description": "Resource status of the origin group.", + "readOnly": true, + "enum": [ + "Creating", + "Active", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "OriginGroupResourceState", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "description": "Provisioning status of the origin group.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Updating", + "Deleting", + "Creating" + ], + "x-ms-enum": { + "name": "OriginGroupProvisioningState", + "modelAsString": true + } + } + } + }, + "OriginGroupUpdateParameters": { + "type": "object", + "description": "Origin group properties needed for origin group creation or update.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OriginGroupUpdatePropertiesParameters" + } + }, + "x-ms-azure-resource": true + }, + "OriginGroupUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the origin group.", + "properties": { + "healthProbeSettings": { + "description": "Health probe settings to the origin that is used to determine the health of the origin.", + "type": "object", + "$ref": "#/definitions/HealthProbeParameters" + }, + "origins": { + "description": "The source of the content being delivered via CDN within given origin group.", + "type": "array", + "items": { + "description": "A reference to a origin.", + "$ref": "#/definitions/ResourceReference" + } + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": { + "description": "Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.", + "type": "integer", + "format": "int32", + "maximum": 50, + "minimum": 0 + }, + "responseBasedOriginErrorDetectionSettings": { + "description": "The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.", + "type": "object", + "$ref": "#/definitions/ResponseBasedOriginErrorDetectionParameters" + } + } + }, + "HealthProbeParameters": { + "description": "The JSON object that contains the properties to send health probes to origin.", + "properties": { + "probePath": { + "description": "The path relative to the origin that is used to determine the health of the origin.", + "type": "string" + }, + "probeRequestType": { + "description": "The type of health probe request that is made.", + "enum": [ + "NotSet", + "GET", + "HEAD" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthProbeRequestType", + "modelAsString": false + } + }, + "probeProtocol": { + "description": "Protocol to use for health probe.", + "type": "string", + "enum": [ + "NotSet", + "Http", + "Https" + ], + "x-ms-enum": { + "name": "ProbeProtocol", + "modelAsString": false + } + }, + "probeIntervalInSeconds": { + "description": "The number of seconds between health probes.Default is 240sec.", + "type": "integer", + "format": "int32", + "maximum": 255, + "minimum": 1 + } + } + }, + "ResponseBasedOriginErrorDetectionParameters": { + "description": "The JSON object that contains the properties to determine origin health using real requests/responses.", + "properties": { + "responseBasedDetectedErrorTypes": { + "description": "Type of response errors for real user requests for which origin will be deemed unhealthy", + "type": "string", + "enum": [ + "None", + "TcpErrorsOnly", + "TcpAndHttpErrors" + ], + "x-ms-enum": { + "name": "ResponseBasedDetectedErrorTypes", + "modelAsString": false + } + }, + "responseBasedFailoverThresholdPercentage": { + "description": "The percentage of failed requests in the sample where failover should trigger.", + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 0 + }, + "httpErrorRanges": { + "description": "The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.", + "type": "array", + "items": { + "$ref": "#/definitions/HttpErrorRangeParameters" + }, + "x-ms-identifiers": [] + } + } + }, + "HttpErrorRangeParameters": { + "description": "The JSON object that represents the range for http status codes", + "properties": { + "begin": { + "description": "The inclusive start of the http status code range.", + "type": "integer", + "format": "int32", + "maximum": 999, + "minimum": 100 + }, + "end": { + "description": "The inclusive end of the http status code range.", + "type": "integer", + "format": "int32", + "maximum": 999, + "minimum": 100 + } + } + }, + "OriginGroupListResult": { + "description": "Result of the request to list origin groups. It contains a list of origin groups objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OriginGroup" + }, + "description": "List of CDN origin groups within an endpoint" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of origin objects if there are any." + } + } + }, + "DeepCreatedCustomDomain": { + "description": "Custom domains created on the CDN endpoint.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "Custom domain name.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DeepCreatedCustomDomainProperties" + } + } + }, + "DeepCreatedCustomDomainProperties": { + "description": "Properties of the custom domain created on the CDN endpoint.", + "type": "object", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the custom domain. Must be a domain name.", + "type": "string" + }, + "validationData": { + "description": "Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.", + "type": "string" + } + } + }, + "CustomDomain": { + "description": "Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomDomainProperties" + } + } + }, + "CustomDomainProperties": { + "description": "The JSON object that contains the properties of the custom domain to create.", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the custom domain. Must be a domain name.", + "type": "string" + }, + "resourceState": { + "description": "Resource status of the custom domain.", + "readOnly": true, + "enum": [ + "Creating", + "Active", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomDomainResourceState", + "modelAsString": true + } + }, + "customHttpsProvisioningState": { + "description": "Provisioning status of the custom domain.", + "readOnly": true, + "enum": [ + "Enabling", + "Enabled", + "Disabling", + "Disabled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomHttpsProvisioningState", + "modelAsString": true + } + }, + "customHttpsProvisioningSubstate": { + "description": "Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.", + "readOnly": true, + "enum": [ + "SubmittingDomainControlValidationRequest", + "PendingDomainControlValidationREquestApproval", + "DomainControlValidationRequestApproved", + "DomainControlValidationRequestRejected", + "DomainControlValidationRequestTimedOut", + "IssuingCertificate", + "DeployingCertificate", + "CertificateDeployed", + "DeletingCertificate", + "CertificateDeleted" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomHttpsProvisioningSubstate", + "modelAsString": true + } + }, + "customHttpsParameters": { + "description": "Certificate parameters for securing custom HTTPS", + "$ref": "#/definitions/CustomDomainHttpsParameters" + }, + "validationData": { + "description": "Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.", + "type": "string" + }, + "provisioningState": { + "description": "Provisioning status of Custom Https of the custom domain.", + "readOnly": true, + "enum": [ + "Enabling", + "Enabled", + "Disabling", + "Disabled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomHttpsProvisioningState", + "modelAsString": true + } + } + } + }, + "CustomDomainParameters": { + "description": "The customDomain JSON object required for custom domain creation or update.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomDomainPropertiesParameters" + } + } + }, + "CustomDomainPropertiesParameters": { + "description": "The JSON object that contains the properties of the custom domain to create.", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the custom domain. Must be a domain name.", + "type": "string" + } + } + }, + "CustomDomainHttpsParameters": { + "description": "The JSON object that contains the properties to secure a custom domain.", + "discriminator": "certificateSource", + "required": [ + "certificateSource", + "protocolType" + ], + "properties": { + "certificateSource": { + "description": "Defines the source of the SSL certificate.", + "enum": [ + "AzureKeyVault", + "Cdn" + ], + "type": "string", + "x-ms-enum": { + "name": "CertificateSource", + "modelAsString": true + } + }, + "protocolType": { + "description": "Defines the TLS extension protocol that is used for secure delivery.", + "enum": [ + "ServerNameIndication", + "IPBased" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtocolType", + "modelAsString": true + } + }, + "minimumTlsVersion": { + "description": "TLS protocol version that will be used for Https", + "enum": [ + "None", + "TLS10", + "TLS12" + ], + "type": "string", + "x-ms-enum": { + "name": "MinimumTlsVersion", + "modelAsString": false + } + } + } + }, + "CdnManagedHttpsParameters": { + "description": "Defines the certificate source parameters using CDN managed certificate for enabling SSL.", + "x-ms-discriminator-value": "Cdn", + "allOf": [ + { + "$ref": "#/definitions/CustomDomainHttpsParameters" + } + ], + "required": [ + "certificateSourceParameters" + ], + "properties": { + "certificateSourceParameters": { + "description": "Defines the certificate source parameters using CDN managed certificate for enabling SSL.", + "$ref": "#/definitions/CdnCertificateSourceParameters" + } + } + }, + "CdnCertificateSourceParameters": { + "description": "Defines the parameters for using CDN managed certificate for securing custom domain.", + "required": [ + "certificateType" + ], + "x-ms-discriminator-value": "CdnCertificateSourceParameters", + "allOf": [ + { + "$ref": "#/definitions/CertificateSourceParameters" + } + ], + "properties": { + "certificateType": { + "description": "Type of certificate used", + "enum": [ + "Shared", + "Dedicated" + ], + "type": "string", + "x-ms-enum": { + "name": "CertificateType", + "modelAsString": true + } + } + } + }, + "UserManagedHttpsParameters": { + "description": "Defines the certificate source parameters using user's keyvault certificate for enabling SSL.", + "x-ms-discriminator-value": "AzureKeyVault", + "allOf": [ + { + "$ref": "#/definitions/CustomDomainHttpsParameters" + } + ], + "required": [ + "certificateSourceParameters" + ], + "properties": { + "certificateSourceParameters": { + "description": "Defines the certificate source parameters using user's keyvault certificate for enabling SSL.", + "$ref": "#/definitions/KeyVaultCertificateSourceParameters" + } + } + }, + "KeyVaultCertificateSourceParameters": { + "description": "Describes the parameters for using a user's KeyVault certificate for securing custom domain.", + "required": [ + "subscriptionId", + "resourceGroupName", + "vaultName", + "secretName", + "updateRule", + "deleteRule" + ], + "x-ms-discriminator-value": "KeyVaultCertificateSourceParameters", + "allOf": [ + { + "$ref": "#/definitions/CertificateSourceParameters" + } + ], + "properties": { + "subscriptionId": { + "description": "Subscription Id of the user's Key Vault containing the SSL certificate", + "type": "string" + }, + "resourceGroupName": { + "description": "Resource group of the user's Key Vault containing the SSL certificate", + "type": "string" + }, + "vaultName": { + "description": "The name of the user's Key Vault containing the SSL certificate", + "type": "string" + }, + "secretName": { + "description": "The name of Key Vault Secret (representing the full certificate PFX) in Key Vault.", + "type": "string" + }, + "secretVersion": { + "description": "The version(GUID) of Key Vault Secret in Key Vault.", + "type": "string" + }, + "updateRule": { + "description": "Describes the action that shall be taken when the certificate is updated in Key Vault.", + "type": "string", + "enum": [ + "NoAction" + ], + "x-ms-enum": { + "name": "UpdateRule", + "modelAsString": true + } + }, + "deleteRule": { + "description": "Describes the action that shall be taken when the certificate is removed from Key Vault.", + "type": "string", + "enum": [ + "NoAction" + ], + "x-ms-enum": { + "name": "DeleteRule", + "modelAsString": true + } + } + } + }, + "CustomDomainListResult": { + "description": "Result of the request to list custom domains. It contains a list of custom domain objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CustomDomain" + }, + "description": "List of CDN CustomDomains within an endpoint." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of custom domain objects if there are any." + } + } + }, + "ValidateCustomDomainInput": { + "description": "Input of the custom domain to be validated for DNS mapping.", + "type": "object", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the custom domain. Must be a domain name.", + "type": "string" + } + } + }, + "ValidateCustomDomainOutput": { + "description": "Output of custom domain validation.", + "type": "object", + "properties": { + "customDomainValidated": { + "description": "Indicates whether the custom domain is valid or not.", + "readOnly": true, + "type": "boolean" + }, + "reason": { + "description": "The reason why the custom domain is not valid.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "Error message describing why the custom domain is not valid.", + "readOnly": true, + "type": "string" + } + } + }, + "CheckNameAvailabilityInput": { + "description": "Input of CheckNameAvailability API.", + "type": "object", + "required": [ + "name", + "type" + ], + "properties": { + "name": { + "description": "The resource name to validate.", + "type": "string" + }, + "type": { + "description": "The type of the resource whose name is to be validated.", + "$ref": "#/definitions/ResourceType" + } + } + }, + "CheckNameAvailabilityOutput": { + "description": "Output of check name availability API.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates whether the name is available.", + "readOnly": true, + "type": "boolean" + }, + "reason": { + "description": "The reason why the name is not available.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "The detailed error message describing why the name is not available.", + "readOnly": true, + "type": "string" + } + } + }, + "ValidateProbeInput": { + "description": "Input of the validate probe API.", + "properties": { + "probeURL": { + "description": "The probe URL to validate.", + "type": "string" + } + }, + "required": [ + "probeURL" + ], + "type": "object" + }, + "ValidateProbeOutput": { + "description": "Output of the validate probe API.", + "properties": { + "isValid": { + "description": "Indicates whether the probe URL is accepted or not.", + "readOnly": true, + "type": "boolean" + }, + "errorCode": { + "description": "Specifies the error code when the probe url is not accepted.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "The detailed error message describing why the probe URL is not accepted.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ResourceUsageListResult": { + "description": "Output of check resource usage API.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ResourceUsage" + }, + "x-ms-identifiers": [ + "resourceType" + ], + "description": "List of resource usages." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of custom domain objects if there are any." + } + } + }, + "ResourceUsage": { + "description": "Output of check resource usage API.", + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "readOnly": true, + "description": "Resource type for which the usage is provided." + }, + "unit": { + "type": "string", + "readOnly": true, + "description": "Unit of the usage. e.g. count.", + "enum": [ + "count" + ], + "x-ms-enum": { + "name": "ResourceUsageUnit", + "modelAsString": true + } + }, + "currentValue": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Actual value of usage on the specified resource type." + }, + "limit": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Quota of the specified resource type." + } + } + }, + "ResourceType": { + "description": "Type of CDN resource used in CheckNameAvailability.", + "enum": [ + "Microsoft.Cdn/Profiles/Endpoints", + "Microsoft.Cdn/Profiles/AfdEndpoints" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceType", + "modelAsString": true + } + }, + "OperationsListResult": { + "description": "Result of the request to list CDN operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of CDN operations supported by the CDN resource provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "CDN REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "readOnly": true, + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft.Cdn", + "readOnly": true, + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed: Profile, endpoint, etc.", + "readOnly": true, + "type": "string" + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of operation.", + "readOnly": true, + "type": "string" + } + } + }, + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of operations." + }, + "properties": { + "description": "Properties of operation, include metric specifications.", + "x-ms-client-flatten": true, + "x-ms-client-name": "OperationProperties", + "$ref": "#/definitions/OperationProperties" + } + } + }, + "OperationProperties": { + "description": "Properties of operation, include metric specifications.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "One property of operation, include metric specifications." + } + } + }, + "ServiceSpecification": { + "description": "One property of operation, include log specifications.", + "type": "object", + "properties": { + "logSpecifications": { + "description": "Log specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "metricSpecifications": { + "description": "Metric specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "LogSpecification": { + "description": "Log specification of operation.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of log specification." + }, + "displayName": { + "type": "string", + "description": "Display name of log specification." + }, + "blobDuration": { + "type": "string", + "description": "Blob duration of specification." + }, + "logFilterPattern": { + "type": "string", + "description": "Pattern to filter based on name" + } + } + }, + "MetricSpecification": { + "description": "Metric specification of operation.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of metric specification." + }, + "displayName": { + "type": "string", + "description": "Display name of metric specification." + }, + "displayDescription": { + "type": "string", + "description": "Display description of metric specification." + }, + "unit": { + "type": "string", + "description": "The metric unit. Possible values include: 'Bytes', 'Count', 'Milliseconds'." + }, + "aggregationType": { + "type": "string", + "description": "The metric aggregation type. Possible values include: 'Average', 'Count', 'Total'." + }, + "availabilities": { + "description": "Retention policies of a resource metric.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricAvailability" + }, + "x-ms-identifiers": [] + }, + "supportedTimeGrainTypes": { + "type": "array", + "description": "The supported time grain types for the metrics.", + "items": { + "type": "string" + } + }, + "dimensions": { + "type": "array", + "description": "The dimensions of metric", + "items": { + "$ref": "#/definitions/DimensionProperties" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "fillGapWithZero": { + "type": "boolean", + "description": "Property to specify whether to fill gap with zero." + }, + "metricFilterPattern": { + "type": "string", + "description": "Pattern to filter based on name" + }, + "isInternal": { + "type": "boolean", + "description": "Property to specify metric is internal or not." + } + } + }, + "DimensionProperties": { + "description": "Type of operation: get, read, delete, etc.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of dimension." + }, + "displayName": { + "type": "string", + "description": "Display name of dimension." + }, + "internalName": { + "type": "string", + "description": "Internal name of dimension." + } + } + }, + "MetricAvailability": { + "description": "Retention policy of a resource metric.", + "type": "object", + "properties": { + "timeGrain": { + "type": "string" + }, + "blobDuration": { + "type": "string" + } + } + }, + "EdgenodeResult": { + "description": "Result of the request to list CDN edgenodes. It contains a list of ip address group and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/EdgeNode" + }, + "description": "Edge node of CDN service." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of edgenode list results if there are any." + } + } + }, + "EdgeNode": { + "description": "Edgenode is a global Point of Presence (POP) location used to deliver CDN content to end users.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EdgeNodeProperties" + } + } + }, + "EdgeNodeProperties": { + "description": "The JSON object that contains the properties required to create an edgenode.", + "required": [ + "ipAddressGroups" + ], + "properties": { + "ipAddressGroups": { + "description": "List of ip address groups.", + "type": "array", + "items": { + "$ref": "#/definitions/IpAddressGroup" + }, + "x-ms-identifiers": [ + "deliveryRegion" + ] + } + } + }, + "IpAddressGroup": { + "description": "CDN Ip address group", + "type": "object", + "properties": { + "deliveryRegion": { + "description": "The delivery region of the ip address group", + "type": "string" + }, + "ipv4Addresses": { + "description": "The list of ip v4 addresses.", + "type": "array", + "items": { + "$ref": "#/definitions/cidrIpAddress" + }, + "x-ms-identifiers": [ + "baseIpAddress" + ] + }, + "ipv6Addresses": { + "description": "The list of ip v6 addresses.", + "type": "array", + "items": { + "$ref": "#/definitions/cidrIpAddress" + }, + "x-ms-identifiers": [ + "baseIpAddress" + ] + } + } + }, + "cidrIpAddress": { + "description": "CIDR Ip address", + "type": "object", + "properties": { + "baseIpAddress": { + "description": "Ip address itself.", + "type": "string" + }, + "prefixLength": { + "description": "The length of the prefix of the ip address.", + "type": "integer", + "format": "int32" + } + } + }, + "Resource": { + "description": "The core properties of ARM resources", + "properties": { + "id": { + "description": "Resource ID.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Resource name.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Resource type.", + "readOnly": true, + "type": "string" + }, + "systemData": { + "$ref": "#/definitions/SystemData", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "SystemData": { + "description": "Read only system data", + "readOnly": true, + "type": "object", + "properties": { + "createdBy": { + "type": "string", + "description": "An identifier for the identity that created the resource" + }, + "createdByType": { + "$ref": "#/definitions/IdentityType", + "description": "The type of identity that created the resource" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)" + }, + "lastModifiedBy": { + "type": "string", + "description": "An identifier for the identity that last modified the resource" + }, + "lastModifiedByType": { + "$ref": "#/definitions/IdentityType", + "description": "The type of identity that last modified the resource" + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)" + } + } + }, + "IdentityType": { + "description": "The type of identity that creates/modifies resources", + "type": "string", + "enum": [ + "user", + "application", + "managedIdentity", + "key" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": true + } + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + }, + "required": [ + "location" + ] + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": {} + }, + "QueryStringCachingBehavior": { + "description": "Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.", + "enum": [ + "IgnoreQueryString", + "BypassCaching", + "UseQueryString", + "NotSet" + ], + "type": "string", + "x-ms-enum": { + "name": "QueryStringCachingBehavior", + "modelAsString": false + } + }, + "PrivateEndpointStatus": { + "description": "The approval status for the connection to the Private Link", + "type": "string", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected", + "Timeout" + ], + "x-ms-enum": { + "name": "PrivateEndpointStatus", + "modelAsString": true + } + }, + "Sku": { + "description": "Standard_Verizon = The SKU name for a Standard Verizon CDN profile.\nPremium_Verizon = The SKU name for a Premium Verizon CDN profile.\nCustom_Verizon = The SKU name for a Custom Verizon CDN profile.\nStandard_Akamai = The SKU name for an Akamai CDN profile.\nStandard_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using GB based billing model.\nStandard_Microsoft = The SKU name for a Standard Microsoft CDN profile.\nStandard_AzureFrontDoor = The SKU name for an Azure Front Door Standard profile.\nPremium_AzureFrontDoor = The SKU name for an Azure Front Door Premium profile.\nStandard_955BandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using 95-5 peak bandwidth billing model.\nStandard_AvgBandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using monthly average peak bandwidth billing model.\nStandardPlus_ChinaCdn = The SKU name for a China CDN profile for live-streaming using GB based billing model.\nStandardPlus_955BandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using 95-5 peak bandwidth billing model.\nStandardPlus_AvgBandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using monthly average peak bandwidth billing model.\n", + "properties": { + "name": { + "description": "Name of the pricing tier.", + "enum": [ + "Standard_Verizon", + "Premium_Verizon", + "Custom_Verizon", + "Standard_Akamai", + "Standard_ChinaCdn", + "Standard_Microsoft", + "Standard_AzureFrontDoor", + "Premium_AzureFrontDoor", + "Standard_955BandWidth_ChinaCdn", + "Standard_AvgBandWidth_ChinaCdn", + "StandardPlus_ChinaCdn", + "StandardPlus_955BandWidth_ChinaCdn", + "StandardPlus_AvgBandWidth_ChinaCdn" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + } + }, + "type": "object" + }, + "OptimizationType": { + "description": "Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization.", + "enum": [ + "GeneralWebDelivery", + "GeneralMediaStreaming", + "VideoOnDemandMediaStreaming", + "LargeFileDownload", + "DynamicSiteAcceleration" + ], + "type": "string", + "x-ms-enum": { + "name": "OptimizationType", + "modelAsString": true + } + }, + "ErrorResponse": { + "title": "Error response", + "description": "Error response indicates Azure Front Door Standard or Azure Front Door Premium or CDN service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "error": { + "description": "The error object.", + "$ref": "#/definitions/ErrorDetail" + } + } + }, + "ErrorDetail": { + "description": "The error detail.", + "type": "object", + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "The error code." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "The error message." + }, + "target": { + "readOnly": true, + "type": "string", + "description": "The error target." + }, + "details": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-identifiers": [ + "message", + "target" + ], + "description": "The error details." + }, + "additionalInfo": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ErrorAdditionalInfo" + }, + "x-ms-identifiers": [], + "description": "The error additional info." + } + } + }, + "ErrorAdditionalInfo": { + "type": "object", + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "The additional info type." + }, + "info": { + "readOnly": true, + "type": "object", + "description": "The additional info." + } + }, + "description": "The resource management error additional info." + }, + "CdnMigrationToAfdParameters": { + "type": "object", + "description": "Request body for Migrate operation.", + "required": [ + "sku" + ], + "properties": { + "sku": { + "description": "Sku for the migration", + "$ref": "#/definitions/Sku" + }, + "migrationEndpointMappings": { + "description": "A name map between classic CDN endpoints and AFD Premium/Standard endpoints.", + "type": "array", + "items": { + "description": "List of endpoint mappings", + "$ref": "#/definitions/MigrationEndpointMapping" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-azure-resource": true + }, + "MigrationEndpointMapping": { + "description": "CDN Endpoint Mapping.", + "type": "object", + "properties": { + "migratedFrom": { + "description": "Name of the classic CDN profile endpoint.", + "type": "string" + }, + "migratedTo": { + "description": "Name of the newly created migrated Azure Frontdoor Standard/Premium profile endpoint. This name will replace the name of the classic CDN endpoint resource.", + "type": "string" + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. Current version is 2024-09-01." + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "Name of the Resource group within the Azure subscription." + }, + "profileNameParameter": { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group." + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdnwebapplicationfirewall.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdnwebapplicationfirewall.json new file mode 100644 index 000000000000..ad37d1ab36ed --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdnwebapplicationfirewall.json @@ -0,0 +1,977 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-01", + "title": "Azure CDN WebApplicationFirewallManagement", + "description": "APIs to manage web application firewall rules for Azure CDN" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/cdnWebApplicationFirewallPolicies": { + "get": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Lists all of the protection policies within a resource group.", + "operationId": "Policies_List", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicyList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cdn.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Policies in a Resource Group": { + "$ref": "./examples/WafListPolicies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/cdnWebApplicationFirewallPolicies/{policyName}": { + "get": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Retrieve protection policy with specified name within a resource group.", + "operationId": "Policies_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PolicyNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cdn.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Policy": { + "$ref": "./examples/WafPolicyGet.json" + } + } + }, + "put": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Create or update policy with specified rule set name within a resource group.", + "operationId": "Policies_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PolicyNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "description": "Policy to be created.", + "in": "body", + "name": "cdnWebApplicationFirewallPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new protection policy has been created.", + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cdn.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creates specific policy": { + "$ref": "./examples/WafPolicyCreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Update an existing CdnWebApplicationFirewallPolicy with the specified policy name under the specified subscription and resource group", + "operationId": "Policies_Update", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PolicyNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "description": "CdnWebApplicationFirewallPolicy parameters to be patched.", + "in": "body", + "name": "cdnWebApplicationFirewallPolicyPatchParameters", + "required": true, + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicyPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cdn.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creates specific policy": { + "$ref": "./examples/WafPatchPolicy.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Deletes Policy", + "operationId": "Policies_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PolicyNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "204": { + "description": "No Content. The request has been accepted but the policy was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cdn.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete protection policy": { + "$ref": "./examples/WafPolicyDelete.json" + } + }, + "x-ms-long-running-operation": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/cdnWebApplicationFirewallManagedRuleSets": { + "get": { + "tags": [ + "WebApplicationFirewallManagedRuleSets" + ], + "description": "Lists all available managed rule sets.", + "operationId": "ManagedRuleSets_List", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of all available web application firewall managed rule sets.", + "schema": { + "$ref": "#/definitions/ManagedRuleSetDefinitionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cdn.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Policies in a Resource Group": { + "$ref": "./examples/WafListManagedRuleSets.json" + } + } + } + } + }, + "definitions": { + "CdnWebApplicationFirewallPolicyList": { + "description": "Defines a list of WebApplicationFirewallPolicies for Azure CDN. It contains a list of WebApplicationFirewallPolicy objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + }, + "description": "List of Azure CDN WebApplicationFirewallPolicies within a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of WebApplicationFirewallPolicy objects if there are any." + } + } + }, + "CdnWebApplicationFirewallPolicy": { + "description": "Defines web application firewall policy for Azure CDN.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of the web application firewall policy.", + "$ref": "#/definitions/CdnWebApplicationFirewallPolicyProperties" + }, + "etag": { + "type": "string", + "description": "Gets a unique read-only string that changes whenever the resource is updated." + }, + "sku": { + "description": "The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy.", + "$ref": "./cdn.json#/definitions/Sku" + } + }, + "required": [ + "sku" + ], + "allOf": [ + { + "$ref": "./cdn.json#/definitions/TrackedResource" + } + ] + }, + "CdnWebApplicationFirewallPolicyPatchParameters": { + "type": "object", + "description": "Properties required to update a CdnWebApplicationFirewallPolicy.", + "properties": { + "tags": { + "description": "CdnWebApplicationFirewallPolicy tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-azure-resource": true + }, + "CdnWebApplicationFirewallPolicyProperties": { + "description": "Defines CDN web application firewall policy properties.", + "properties": { + "policySettings": { + "description": "Describes policySettings for policy", + "$ref": "#/definitions/policySettings" + }, + "rateLimitRules": { + "description": "Describes rate limit rules inside the policy.", + "$ref": "#/definitions/RateLimitRuleList" + }, + "customRules": { + "description": "Describes custom rules inside the policy.", + "$ref": "#/definitions/CustomRuleList" + }, + "managedRules": { + "description": "Describes managed rules inside the policy.", + "$ref": "#/definitions/ManagedRuleSetList" + }, + "endpointLinks": { + "description": "Describes Azure CDN endpoints associated with this Web Application Firewall policy.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CdnEndpoint" + } + }, + "extendedProperties": { + "description": "Key-Value pair representing additional properties for Web Application Firewall policy.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the WebApplicationFirewallPolicy.", + "enum": [ + "Creating", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "resourceState": { + "title": "Resource status of the policy.", + "readOnly": true, + "enum": [ + "Creating", + "Enabling", + "Enabled", + "Disabling", + "Disabled", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "PolicyResourceState", + "modelAsString": true + } + } + } + }, + "policySettings": { + "description": "Defines contents of a web application firewall global configuration", + "properties": { + "enabledState": { + "description": "describes if the policy is in enabled state or disabled state", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "PolicyEnabledState", + "modelAsString": true + } + }, + "mode": { + "description": "Describes if it is in detection mode or prevention mode at policy level.", + "type": "string", + "enum": [ + "Prevention", + "Detection" + ], + "x-ms-enum": { + "name": "PolicyMode", + "modelAsString": true + } + }, + "defaultRedirectUrl": { + "description": "If action type is redirect, this field represents the default redirect URL for the client.", + "type": "string" + }, + "defaultCustomBlockResponseStatusCode": { + "description": "If the action type is block, this field defines the default customer overridable http response status code.", + "type": "integer", + "format": "int32", + "enum": [ + 200, + 403, + 405, + 406, + 429 + ] + }, + "defaultCustomBlockResponseBody": { + "description": "If the action type is block, customer can override the response body. The body must be specified in base64 encoding.", + "type": "string", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + } + } + }, + "CdnEndpoint": { + "description": "Defines the ARM Resource ID for the linked endpoints", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "ARM Resource ID string." + } + } + }, + "CustomRuleList": { + "description": "Defines contents of custom rules", + "properties": { + "rules": { + "description": "List of rules", + "type": "array", + "items": { + "$ref": "#/definitions/CustomRule" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "CustomRule": { + "description": "Defines the common attributes for a custom rule that can be included in a waf policy", + "type": "object", + "required": [ + "name", + "priority", + "matchConditions", + "action" + ], + "properties": { + "name": { + "description": "Defines the name of the custom rule", + "type": "string" + }, + "enabledState": { + "description": "Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "CustomRuleEnabledState", + "modelAsString": true + } + }, + "priority": { + "description": "Defines in what order this rule be evaluated in the overall list of custom rules", + "type": "integer", + "format": "int32", + "maximum": 1000, + "exclusiveMaximum": false, + "minimum": 0, + "exclusiveMinimum": false + }, + "matchConditions": { + "description": "List of match conditions.", + "type": "array", + "items": { + "$ref": "#/definitions/MatchCondition" + }, + "x-ms-identifiers": [] + }, + "action": { + "description": "Describes what action to be applied when rule matches", + "$ref": "#/definitions/ActionType" + } + } + }, + "RateLimitRuleList": { + "description": "Defines contents of rate limit rules", + "properties": { + "rules": { + "description": "List of rules", + "type": "array", + "items": { + "$ref": "#/definitions/RateLimitRule" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "RateLimitRule": { + "description": "Defines a rate limiting rule that can be included in a waf policy", + "type": "object", + "required": [ + "rateLimitThreshold", + "rateLimitDurationInMinutes" + ], + "properties": { + "rateLimitThreshold": { + "description": "Defines rate limit threshold.", + "type": "integer", + "format": "int32", + "minimum": 0, + "exclusiveMinimum": false + }, + "rateLimitDurationInMinutes": { + "description": "Defines rate limit duration. Default is 1 minute.", + "type": "integer", + "format": "int32", + "maximum": 60, + "exclusiveMaximum": false, + "minimum": 0, + "exclusiveMinimum": false + } + }, + "allOf": [ + { + "$ref": "#/definitions/CustomRule" + } + ] + }, + "MatchCondition": { + "description": "Define match conditions", + "required": [ + "matchVariable", + "operator", + "matchValue" + ], + "properties": { + "matchVariable": { + "description": "Match variable to compare against.", + "type": "string", + "enum": [ + "RemoteAddr", + "SocketAddr", + "RequestMethod", + "RequestHeader", + "RequestUri", + "QueryString", + "RequestBody", + "Cookies", + "PostArgs" + ], + "x-ms-enum": { + "name": "WafMatchVariable", + "modelAsString": true + } + }, + "selector": { + "description": "Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs.", + "type": "string" + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "IPMatch", + "GeoMatch", + "Equal", + "Contains", + "LessThan", + "GreaterThan", + "LessThanOrEqual", + "GreaterThanOrEqual", + "BeginsWith", + "EndsWith", + "RegEx" + ], + "x-ms-enum": { + "name": "operator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if the result of this condition should be negated.", + "type": "boolean" + }, + "matchValue": { + "description": "List of possible match values.", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms.", + "type": "array", + "items": { + "$ref": "#/definitions/TransformType" + } + } + } + }, + "TransformType": { + "description": "Describes what transforms were applied before matching.", + "type": "string", + "enum": [ + "Lowercase", + "Uppercase", + "Trim", + "UrlDecode", + "UrlEncode", + "RemoveNulls" + ], + "x-ms-enum": { + "name": "TransformType", + "modelAsString": true + } + }, + "ManagedRuleSetList": { + "description": "Defines the list of managed rule sets for the policy.", + "properties": { + "managedRuleSets": { + "description": "List of rule sets.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleSet" + }, + "x-ms-identifiers": [ + "ruleSetType", + "ruleSetVersion" + ] + } + } + }, + "ManagedRuleSet": { + "type": "object", + "description": "Defines a managed rule set.", + "required": [ + "ruleSetType", + "ruleSetVersion" + ], + "properties": { + "ruleSetType": { + "description": "Defines the rule set type to use.", + "type": "string" + }, + "ruleSetVersion": { + "description": "Defines the version of the rule set to use.", + "type": "string" + }, + "anomalyScore": { + "description": "Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests.", + "type": "integer", + "format": "int32", + "maximum": 20, + "exclusiveMaximum": false, + "minimum": 0, + "exclusiveMinimum": false + }, + "ruleGroupOverrides": { + "description": "Defines the rule overrides to apply to the rule set.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleGroupOverride" + }, + "x-ms-identifiers": [ + "ruleGroupName" + ] + } + } + }, + "ManagedRuleGroupOverride": { + "description": "Defines a managed rule group override setting.", + "required": [ + "ruleGroupName" + ], + "properties": { + "ruleGroupName": { + "description": "Describes the managed rule group within the rule set to override", + "type": "string" + }, + "rules": { + "description": "List of rules that will be enabled. If none specified, all rules in the group will be disabled.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleOverride" + }, + "x-ms-identifiers": [ + "ruleId" + ] + } + } + }, + "ManagedRuleOverride": { + "description": "Defines a managed rule group override setting.", + "required": [ + "ruleId" + ], + "properties": { + "ruleId": { + "description": "Identifier for the managed rule.", + "type": "string" + }, + "enabledState": { + "description": "Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ManagedRuleEnabledState", + "modelAsString": true + } + }, + "action": { + "description": "Describes the override action to be applied when rule matches.", + "$ref": "#/definitions/ActionType" + } + } + }, + "ManagedRuleSetDefinitionList": { + "description": "List of managed rule set definitions available for use in a policy.", + "properties": { + "value": { + "description": "List of managed rule set definitions.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleSetDefinition" + } + }, + "nextLink": { + "type": "string", + "description": "URL to retrieve next set of managed rule set definitions." + } + } + }, + "ManagedRuleSetDefinition": { + "description": "Describes a managed rule set definition.", + "properties": { + "properties": { + "description": "Describes managed rule set definition properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagedRuleSetDefinitionProperties" + }, + "sku": { + "description": "The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy.", + "$ref": "./cdn.json#/definitions/Sku" + } + }, + "allOf": [ + { + "$ref": "./cdn.json#/definitions/Resource" + } + ] + }, + "ManagedRuleSetDefinitionProperties": { + "description": "Properties for a managed rule set definition.", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Provisioning state of the managed rule set." + }, + "ruleSetType": { + "type": "string", + "readOnly": true, + "description": "Type of the managed rule set." + }, + "ruleSetVersion": { + "type": "string", + "readOnly": true, + "description": "Version of the managed rule set type." + }, + "ruleGroups": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ManagedRuleGroupDefinition" + }, + "x-ms-identifiers": [ + "ruleGroupName" + ], + "description": "Rule groups of the managed rule set." + } + } + }, + "ManagedRuleGroupDefinition": { + "description": "Describes a managed rule group.", + "properties": { + "ruleGroupName": { + "type": "string", + "readOnly": true, + "description": "Name of the managed rule group." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Description of the managed rule group." + }, + "rules": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ManagedRuleDefinition" + }, + "x-ms-identifiers": [ + "ruleId" + ], + "description": "List of rules within the managed rule group." + } + } + }, + "ManagedRuleDefinition": { + "description": "Describes a managed rule definition.", + "properties": { + "ruleId": { + "description": "Identifier for the managed rule.", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Describes the functionality of the managed rule.", + "readOnly": true, + "type": "string" + } + } + }, + "ActionType": { + "description": "Defines the action to take on rule match.", + "type": "string", + "enum": [ + "Allow", + "Block", + "Log", + "Redirect" + ], + "x-ms-enum": { + "name": "ActionType", + "modelAsString": true + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. Current version is 2024-09-01." + }, + "PolicyNameParameter": { + "name": "policyName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 128, + "x-ms-parameter-location": "method", + "description": "The name of the CdnWebApplicationFirewallPolicy." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_\\-\\(\\)\\.]*[^\\.]$", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method", + "description": "Name of the Resource group within the Azure subscription." + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Create.json new file mode 100644 index 000000000000..82f832ab5329 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Create.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "customDomainName": "domain1", + "customDomain": { + "properties": { + "hostName": "www.someDomain.net", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12" + }, + "azureDnsZone": { + "id": "" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "" + } + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "", + "expirationDate": "" + }, + "domainValidationState": "Submitting", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "" + } + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "", + "expirationDate": "" + }, + "domainValidationState": "Submitting", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "" + } + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "", + "expirationDate": "" + }, + "domainValidationState": "Submitting", + "provisioningState": "Creating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Delete.json new file mode 100644 index 000000000000..742bcc835345 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "customDomainName": "domain1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Get.json new file mode 100644 index 000000000000..a9346d866f3d --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "customDomainName": "domain1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "" + } + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "8c9912db-c615-4eeb-8465", + "expirationDate": "2009-06-15T13:45:43.0000000Z" + }, + "domainValidationState": "Pending", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_ListByProfile.json new file mode 100644 index 000000000000..cd9790671b50 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_ListByProfile.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "" + } + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "8c9912db-c615-4eeb-8465", + "expirationDate": "2009-06-15T13:45:43.0000000Z" + }, + "domainValidationState": "Pending", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_RefreshValidationToken.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_RefreshValidationToken.json new file mode 100644 index 000000000000..307091c09977 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_RefreshValidationToken.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "customDomainName": "domain1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Update.json new file mode 100644 index 000000000000..1ba8fae48008 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Update.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "customDomainName": "domain1", + "customDomainUpdateProperties": { + "properties": { + "tlsSettings": { + "certificateType": "CustomerCertificate", + "minimumTlsVersion": "TLS12" + }, + "azureDnsZone": { + "id": "" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/mysecert" + } + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "8c9912db-c615-4eeb-8465", + "expirationDate": "2009-06-15T13:45:43.0000000Z" + }, + "domainValidationState": "Approved", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/mysecert" + } + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "8c9912db-c615-4eeb-8465", + "expirationDate": "2009-06-15T13:45:43.0000000Z" + }, + "domainValidationState": "Approved", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Create.json new file mode 100644 index 000000000000..66c04169a74d --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Create.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "endpoint": { + "tags": {}, + "location": "global", + "properties": { + "enabledState": "Enabled", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + }, + "responses": { + "200": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + }, + "201": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net", + "enabledState": "Enabled", + "provisioningState": "Creating", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Delete.json new file mode 100644 index 000000000000..28895b584392 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Get.json new file mode 100644 index 000000000000..42b5693fc898 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ListByProfile.json new file mode 100644 index 000000000000..3f257645f15f --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ListByProfile.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ListResourceUsage.json new file mode 100644 index 000000000000..849c34cc902f --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ListResourceUsage.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 0, + "limit": 25, + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "name": { + "value": "route", + "localizedValue": "route" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_PurgeContent.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_PurgeContent.json new file mode 100644 index 000000000000..aa17f1fc7e06 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_PurgeContent.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "contents": { + "contentPaths": [ + "/folder1" + ], + "domains": [ + "endpoint1-abcdefghijklmnop.z01.azurefd.net" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Update.json new file mode 100644 index 000000000000..230fd0ec4084 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Update.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "endpointUpdateProperties": { + "tags": {}, + "properties": { + "enabledState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-ezh7ddcmguaeajfu.z01.azureedge.net", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net", + "enabledState": "Enabled", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ValidateCustomDomain.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ValidateCustomDomain.json new file mode 100644 index 000000000000..4f3257ee5e53 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ValidateCustomDomain.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainProperties": { + "hostName": "www.someDomain.com" + } + }, + "responses": { + "200": { + "body": { + "customDomainValidated": true, + "message": null, + "reason": null + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Create.json new file mode 100644 index 000000000000..b9251255260e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Create.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1", + "originGroup": { + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path2", + "probeRequestType": "NotSet", + "probeProtocol": "NotSet", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Creating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Delete.json new file mode 100644 index 000000000000..0e80603e9db1 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Get.json new file mode 100644 index 000000000000..70388c913207 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_ListByProfile.json new file mode 100644 index 000000000000..d3c44b339b6b --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_ListByProfile.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_ListResourceUsage.json new file mode 100644 index 000000000000..238bc2a5b6cf --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_ListResourceUsage.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 0, + "limit": 25, + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "name": { + "value": "origin", + "localizedValue": "origin" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Update.json new file mode 100644 index 000000000000..89ceff41d61b --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Update.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1", + "originGroupUpdateProperties": { + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path2", + "probeRequestType": "NotSet", + "probeProtocol": "NotSet", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Create.json new file mode 100644 index 000000000000..ec6e73455717 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Create.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1", + "originName": "origin1", + "origin": { + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "enabledState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Creating", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Delete.json new file mode 100644 index 000000000000..867defe0fc66 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1", + "originName": "origin1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Get.json new file mode 100644 index 000000000000..a5aa5e870ca2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1", + "originName": "origin1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_ListByOriginGroup.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_ListByOriginGroup.json new file mode 100644 index 000000000000..3ebb1f0b0c22 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_ListByOriginGroup.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Update.json new file mode 100644 index 000000000000..d422643c50cd --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Update.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1", + "originName": "origin1", + "originUpdateProperties": { + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "enabledState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_CheckEndpointNameAvailability.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_CheckEndpointNameAvailability.json new file mode 100644 index 000000000000..aea9ba6c4f6e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_CheckEndpointNameAvailability.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "myResourceGroup", + "profileName": "profile1", + "checkEndpointNameAvailabilityInput": { + "name": "sampleName", + "type": "Microsoft.Cdn/Profiles/AfdEndpoints", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "Name is already in use", + "message": "Name not available", + "availableHostname": "" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_CheckHostNameAvailability.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_CheckHostNameAvailability.json new file mode 100644 index 000000000000..6805739e79bd --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_CheckHostNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "checkHostNameAvailabilityInput": { + "hostName": "www.someDomain.net" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "Conflict", + "message": "The hostname 'www.someDomain.net' is already owned by another profile." + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_ListResourceUsage.json new file mode 100644 index 000000000000..8dcbcc84af69 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_ListResourceUsage.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 0, + "limit": 25, + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "name": { + "value": "afdendpoint", + "localizedValue": "afdendpoint" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_Upgrade.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_Upgrade.json new file mode 100644 index 000000000000..b3abe705d2e2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_Upgrade.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "profileUpgradeParameters": { + "wafMappingList": [ + { + "securityPolicyName": "securityPolicy1", + "changeToWafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/waf2" + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "name": "profile1", + "location": "Global", + "kind": "frontdoor", + "tags": {}, + "sku": { + "name": "Standard_AzureFrontDoor" + }, + "properties": { + "extendedProperties": {}, + "frontDoorId": "id", + "originResponseTimeoutSeconds": 60, + "provisioningState": "Succeeded", + "resourceState": "Enabled" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "name": "profile1", + "location": "Global", + "kind": "frontdoor", + "tags": {}, + "sku": { + "name": "Standard_AzureFrontDoor" + }, + "properties": { + "originResponseTimeoutSeconds": 60, + "frontDoorId": "id", + "extendedProperties": {}, + "resourceState": "Upgrading", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_ValidateSecret.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_ValidateSecret.json new file mode 100644 index 000000000000..e6a4beb9ead4 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_ValidateSecret.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "validateSecretInput": { + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/certificate/certName" + }, + "secretType": "CustomerCertificate" + } + }, + "responses": { + "200": { + "body": { + "status": "Valid", + "message": null + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CdnProfiles_CanMigrate.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CdnProfiles_CanMigrate.json new file mode 100644 index 000000000000..17cead852987 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CdnProfiles_CanMigrate.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationid/profileresults/profile1/canmigrateresults/profile1", + "type": "Microsoft.Cdn/profiles/canmigrate", + "properties": { + "canMigrate": true, + "defaultSku": "Standard_AzureFrontDoor", + "errors": null + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CdnProfiles_Migrate.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CdnProfiles_Migrate.json new file mode 100644 index 000000000000..b4373821c45d --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CdnProfiles_Migrate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "RG", + "profileName": "profile1", + "migrationParameters": { + "sku": { + "name": "Standard_AzureFrontDoor" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/operationresults/operationid/profileresults/profile1/migrateresults/profile1", + "type": "Microsoft.Cdn/profiles/migrate", + "properties": { + "migratedProfileResourceId": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1" + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckEndpointNameAvailability.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckEndpointNameAvailability.json new file mode 100644 index 000000000000..0180d609966a --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckEndpointNameAvailability.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "myResourceGroup", + "checkEndpointNameAvailabilityInput": { + "name": "sampleName", + "type": "Microsoft.Cdn/Profiles/AfdEndpoints", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "Name is already in use", + "message": "Name not available", + "availableHostname": "" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckNameAvailability.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..12f321bebb66 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckNameAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "checkNameAvailabilityInput": { + "name": "sampleName", + "type": "Microsoft.Cdn/Profiles/Endpoints" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "Name is already in use", + "message": "Name not available" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckNameAvailabilityWithSubscription.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckNameAvailabilityWithSubscription.json new file mode 100644 index 000000000000..48e658ba4073 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckNameAvailabilityWithSubscription.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "checkNameAvailabilityInput": { + "name": "sampleName", + "type": "Microsoft.Cdn/Profiles/Endpoints" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "Name is already in use", + "message": "Name not available" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Create.json new file mode 100644 index 000000000000..b86710e2eedd --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Create.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net", + "customDomainProperties": { + "properties": { + "hostName": "www.someDomain.net" + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + }, + "201": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Delete.json new file mode 100644 index 000000000000..6e3aab25e3c8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Delete.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_DisableCustomHttps.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_DisableCustomHttps.json new file mode 100644 index 000000000000..9a712dfeb7bc --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_DisableCustomHttps.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net" + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Disabled", + "customHttpsProvisioningSubstate": "CertificateDeleted", + "validationData": null + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json new file mode 100644 index 000000000000..0ade08219414 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net", + "customHttpsParameters": { + "MinimumTLSVersion": "TLS12", + "certificateSource": "AzureKeyVault", + "protocolType": "ServerNameIndication", + "certificateSourceParameters": { + "typeName": "KeyVaultCertificateSourceParameters", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "vaultName": "kv", + "secretName": "secret1", + "secretVersion": "00000000-0000-0000-0000-000000000000", + "updateRule": "NoAction", + "deleteRule": "NoAction" + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabled", + "customHttpsProvisioningSubstate": "CertificateDeployed", + "validationData": "validationdata" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": "validationdata" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json new file mode 100644 index 000000000000..a6271e38a778 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net", + "customHttpsParameters": { + "MinimumTLSVersion": "TLS12", + "certificateSource": "Cdn", + "protocolType": "ServerNameIndication", + "certificateSourceParameters": { + "typeName": "CdnCertificateSourceParameters", + "certificateType": "Shared" + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabled", + "customHttpsProvisioningSubstate": "CertificateDeployed", + "validationData": "validationdata" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": "validationdata" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Get.json new file mode 100644 index 000000000000..d4ce4ba35412 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net" + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Disabled", + "customHttpsProvisioningSubstate": "None", + "validationData": null + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_ListByEndpoint.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_ListByEndpoint.json new file mode 100644 index 000000000000..818b57bff626 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_ListByEndpoint.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Disabled", + "customHttpsProvisioningSubstate": "None", + "validationData": null + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/EdgeNodes_List.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/EdgeNodes_List.json new file mode 100644 index 000000000000..267a380d29d1 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/EdgeNodes_List.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard_Verizon", + "id": "/providers/Microsoft.Cdn/edgenodes/Standard_Verizon", + "type": "Microsoft.Cdn/edgenodes", + "properties": { + "ipAddressGroups": [ + { + "deliveryRegion": "All", + "ipv4Addresses": [ + { + "baseIpAddress": "192.229.176.0", + "prefixLength": 24 + }, + { + "baseIpAddress": "180.240.184.128", + "prefixLength": 25 + }, + { + "baseIpAddress": "152.195.27.0", + "prefixLength": 24 + } + ], + "ipv6Addresses": [ + { + "baseIpAddress": "2606:2800:60f2::", + "prefixLength": 48 + }, + { + "baseIpAddress": "2606:2800:700c::", + "prefixLength": 48 + } + ] + } + ] + } + }, + { + "name": "Premium_Verizon", + "id": "/providers/Microsoft.Cdn/edgenodes/Premium_Verizon", + "type": "Microsoft.Cdn/edgenodes", + "properties": { + "ipAddressGroups": [ + { + "deliveryRegion": "All", + "ipv4Addresses": [ + { + "baseIpAddress": "192.229.176.0", + "prefixLength": 24 + }, + { + "baseIpAddress": "152.195.27.0", + "prefixLength": 24 + } + ], + "ipv6Addresses": [ + { + "baseIpAddress": "2606:2800:60f2::", + "prefixLength": 48 + }, + { + "baseIpAddress": "2606:2800:700c::", + "prefixLength": 48 + } + ] + } + ] + } + }, + { + "name": "Custom_Verizon", + "id": "/providers/Microsoft.Cdn/edgenodes/Custom_Verizon", + "type": "Microsoft.Cdn/edgenodes", + "properties": { + "ipAddressGroups": [ + { + "deliveryRegion": "All", + "ipv4Addresses": [ + { + "baseIpAddress": "192.229.176.0", + "prefixLength": 24 + }, + { + "baseIpAddress": "2606:2800:420b::", + "prefixLength": 48 + }, + { + "baseIpAddress": "2606:2800:700c::", + "prefixLength": 48 + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Create.json new file mode 100644 index 000000000000..d8ece8311e03 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Create.json @@ -0,0 +1,546 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "endpoint": { + "location": "WestUs", + "tags": { + "key1": "value1" + }, + "properties": { + "originHostHeader": "www.bing.com", + "originPath": "/photos", + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true, + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "BypassCaching", + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "deliveryPolicy": { + "description": "Test description for a policy.", + "rules": [ + { + "name": "rule1", + "order": 1, + "conditions": [ + { + "name": "RemoteAddress", + "parameters": { + "operator": "IPMatch", + "negateCondition": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "typeName": "DeliveryRuleRemoteAddressConditionParameters" + } + } + ], + "actions": [ + { + "name": "CacheExpiration", + "parameters": { + "cacheBehavior": "Override", + "cacheDuration": "10:10:09", + "typeName": "DeliveryRuleCacheExpirationActionParameters", + "cacheType": "All" + } + }, + { + "name": "ModifyResponseHeader", + "parameters": { + "headerAction": "Overwrite", + "headerName": "Access-Control-Allow-Origin", + "value": "*", + "typeName": "DeliveryRuleHeaderActionParameters" + } + }, + { + "name": "ModifyRequestHeader", + "parameters": { + "headerAction": "Overwrite", + "headerName": "Accept-Encoding", + "value": "gzip", + "typeName": "DeliveryRuleHeaderActionParameters" + } + } + ] + } + ] + }, + "origins": [ + { + "name": "origin1", + "properties": { + "hostName": "www.someDomain1.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain1.net", + "priority": 1, + "weight": 50, + "enabled": true + } + }, + { + "name": "origin2", + "properties": { + "hostName": "www.someDomain2.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + }, + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint4899.azureedge-test.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "BypassCaching", + "originPath": "/photos", + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "origins": [ + { + "name": "origin1", + "properties": { + "hostName": "www.someDomain1.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain1.net", + "priority": 1, + "weight": 50, + "enabled": true + } + }, + { + "name": "origin2", + "properties": { + "hostName": "www.someDomain2.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + }, + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ], + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true, + "optimizationType": null, + "probePath": null, + "geoFilters": [], + "deliveryPolicy": { + "description": "Test description for a policy.", + "rules": [ + { + "name": "rule1", + "order": 1, + "conditions": [ + { + "name": "RemoteAddress", + "parameters": { + "typeName": "DeliveryRuleRemoteAddressConditionParameters", + "operator": "IPMatch", + "negateCondition": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + } + ], + "actions": [ + { + "name": "CacheExpiration", + "parameters": { + "typeName": "DeliveryRuleCacheExpirationActionParameters", + "cacheBehavior": "Override", + "cacheDuration": "10:10:09", + "cacheType": "All" + } + }, + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Access-Control-Allow-Origin", + "value": "*" + } + }, + { + "name": "ModifyRequestHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Accept-Encoding", + "value": "gzip" + } + } + ] + } + ] + } + } + } + }, + "201": { + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint4899.azureedge-test.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "BypassCaching", + "originPath": "/photos", + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "origins": [ + { + "name": "origin1", + "properties": { + "hostName": "www.someDomain1.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain1.net", + "priority": 1, + "weight": 50, + "enabled": true + } + }, + { + "name": "origin2", + "properties": { + "hostName": "www.someDomain2.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + }, + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ], + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true, + "optimizationType": null, + "probePath": null, + "geoFilters": [], + "deliveryPolicy": { + "description": "Test description for a policy.", + "rules": [ + { + "name": "rule1", + "order": 1, + "conditions": [ + { + "name": "RemoteAddress", + "parameters": { + "typeName": "DeliveryRuleRemoteAddressConditionParameters", + "operator": "IPMatch", + "negateCondition": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + } + ], + "actions": [ + { + "name": "CacheExpiration", + "parameters": { + "typeName": "DeliveryRuleCacheExpirationActionParameters", + "cacheBehavior": "Override", + "cacheDuration": "10:10:09", + "cacheType": "All" + } + }, + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Access-Control-Allow-Origin", + "value": "*" + } + }, + { + "name": "ModifyRequestHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Accept-Encoding", + "value": "gzip" + } + } + ] + } + ] + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint4899.azureedge-test.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "BypassCaching", + "originPath": "/photos", + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "origins": [ + { + "name": "origin1", + "properties": { + "hostName": "www.someDomain1.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain1.net", + "priority": 1, + "weight": 50, + "enabled": true + } + }, + { + "name": "origin2", + "properties": { + "hostName": "www.someDomain2.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + }, + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ], + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true, + "optimizationType": null, + "probePath": null, + "geoFilters": [], + "deliveryPolicy": { + "description": "Test description for a policy.", + "rules": [ + { + "name": "rule1", + "order": 1, + "conditions": [ + { + "name": "RemoteAddress", + "parameters": { + "typeName": "DeliveryRuleRemoteAddressConditionParameters", + "operator": "IPMatch", + "negateCondition": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + } + ], + "actions": [ + { + "name": "CacheExpiration", + "parameters": { + "typeName": "DeliveryRuleCacheExpirationActionParameters", + "cacheBehavior": "Override", + "cacheDuration": "10:10:09", + "cacheType": "All" + } + }, + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Access-Control-Allow-Origin", + "value": "*" + } + }, + { + "name": "ModifyRequestHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Accept-Encoding", + "value": "gzip" + } + } + ] + } + ] + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Delete.json new file mode 100644 index 000000000000..28895b584392 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Get.json new file mode 100644 index 000000000000..7fd7c0fc03a3 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Get.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": {}, + "location": "CentralUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Running", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com" + } + ] + } + } + ], + "customDomains": [ + { + "name": "www-someDomain-net", + "properties": { + "hostName": "www.someDomain.Net", + "validationData": null + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [], + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ListByProfile.json new file mode 100644 index 000000000000..b8c6ccf7b7ec --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ListByProfile.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": {}, + "location": "CentralUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Running", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ], + "customDomains": [ + { + "name": "www-someDomain-net", + "properties": { + "hostName": "www.someDomain.Net", + "validationData": null + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [], + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + } + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ListResourceUsage.json new file mode 100644 index 000000000000..2c7150ddb144 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ListResourceUsage.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "customdomain", + "unit": "count", + "currentValue": 1, + "limit": 20 + }, + { + "resourceType": "geofilter", + "unit": "count", + "currentValue": 0, + "limit": 25 + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_LoadContent.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_LoadContent.json new file mode 100644 index 000000000000..90165c79b110 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_LoadContent.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "contentFilePaths": { + "contentPaths": [ + "/folder1" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_PurgeContent.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_PurgeContent.json new file mode 100644 index 000000000000..90165c79b110 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_PurgeContent.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "contentFilePaths": { + "contentPaths": [ + "/folder1" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Start.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Start.json new file mode 100644 index 000000000000..8502040cc9b2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Start.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Starting", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443 + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [] + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Starting", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443 + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Stop.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Stop.json new file mode 100644 index 000000000000..d29029942ae8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Stop.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Stopping", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443 + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [] + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Stopping", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443 + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Update.json new file mode 100644 index 000000000000..ebc284fb3f56 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Update.json @@ -0,0 +1,141 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "endpointUpdateProperties": { + "tags": { + "additionalProperties": "Tag1" + } + } + }, + "responses": { + "200": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "additionalProperties": "Tag1" + }, + "location": "WestCentralUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": null, + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "IgnoreQueryString", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com" + } + ] + } + } + ], + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": null, + "probePath": null, + "geoFilters": [] + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "additionalProperties": "Tag1" + }, + "location": "WestCentralUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": null, + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "IgnoreQueryString", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com" + } + ] + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": null, + "probePath": null, + "geoFilters": [], + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ValidateCustomDomain.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ValidateCustomDomain.json new file mode 100644 index 000000000000..4f3257ee5e53 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ValidateCustomDomain.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainProperties": { + "hostName": "www.someDomain.com" + } + }, + "responses": { + "200": { + "body": { + "customDomainValidated": true, + "message": null, + "reason": null + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsLocations.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsLocations.json new file mode 100644 index 000000000000..eb045204ff85 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsLocations.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "metrics": "clientRequestCount", + "granularity": "PT5M", + "groupBy": "httpStatusCode", + "dateTimeBegin": "2020-11-04T05:00:00.000Z", + "dateTimeEnd": "2020-11-04T06:00:00.000Z" + }, + "responses": { + "200": { + "body": { + "continents": [ + { + "id": "africa" + }, + { + "id": "antarctica" + }, + { + "id": "asia" + }, + { + "id": "europe" + }, + { + "id": "northAmerica" + }, + { + "id": "oceania" + }, + { + "id": "southAmerica" + } + ], + "countryOrRegions": [ + { + "id": "dz", + "continentId": "africa" + }, + { + "id": "ao", + "continentId": "africa" + }, + { + "id": "bw", + "continentId": "africa" + }, + { + "id": "bi", + "continentId": "africa" + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsMetrics.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsMetrics.json new file mode 100644 index 000000000000..c01c624bf25e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsMetrics.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "metrics": [ + "clientRequestCount" + ], + "granularity": "PT5M", + "groupBy": [ + "protocol" + ], + "dateTimeBegin": "2020-11-04T04:30:00.000Z", + "dateTimeEnd": "2020-11-04T05:00:00.000Z", + "customDomains": [ + "customdomain1.azurecdn.net", + "customdomain2.azurecdn.net" + ], + "protocols": [ + "https" + ] + }, + "responses": { + "200": { + "body": { + "dateTimeBegin": "2020-11-04T12:30:27.554+08:00", + "dateTimeEnd": "2020-11-04T13:00:27.554+08:00", + "granularity": "PT5M", + "series": [ + { + "metric": "clientRequestCount", + "unit": "count", + "groups": [ + { + "name": "protocol", + "value": "https" + } + ], + "data": [ + { + "dateTime": "2020-11-04T04:35:00+00:00", + "value": 4250 + }, + { + "dateTime": "2020-11-04T04:40:00+00:00", + "value": 3120 + }, + { + "dateTime": "2020-11-04T04:45:00+00:00", + "value": 2221 + }, + { + "dateTime": "2020-11-04T04:50:00+00:00", + "value": 2466 + }, + { + "dateTime": "2020-11-04T04:55:00+00:00", + "value": 2654 + }, + { + "dateTime": "2020-11-04T05:00:00+00:00", + "value": 3565 + } + ] + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsRankings.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsRankings.json new file mode 100644 index 000000000000..e6971f7109cb --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsRankings.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "rankings": [ + "url" + ], + "metrics": [ + "clientRequestCount" + ], + "maxRanking": "5", + "dateTimeBegin": "2020-11-04T06:49:27.554Z", + "dateTimeEnd": "2020-11-04T09:49:27.554Z" + }, + "responses": { + "200": { + "body": { + "dateTimeBegin": "2020-11-04T14:49:27.554+08:00", + "dateTimeEnd": "2020-11-04T17:49:27.554+08:00", + "tables": [ + { + "ranking": "url", + "data": [ + { + "name": "https://testdomain.com/favicon.png", + "metrics": [ + { + "metric": "clientRequestCount", + "value": 2336, + "percentage": 8.28133862733976 + } + ] + }, + { + "name": "https://testdomain.com/js/app.js", + "metrics": [ + { + "metric": "clientRequestCount", + "value": 2140, + "percentage": 7.586500283607488 + } + ] + }, + { + "name": "https://testdomain.com/js/lang/en.js", + "metrics": [ + { + "metric": "clientRequestCount", + "value": 1536, + "percentage": 5.445263754963131 + } + ] + }, + { + "name": "https://testdomain.com/js/lib.js", + "metrics": [ + { + "metric": "clientRequestCount", + "value": 1480, + "percentage": 5.246738513896767 + } + ] + }, + { + "name": "https://cdn.exam.net/css/lib.css", + "metrics": [ + { + "metric": "clientRequestCount", + "value": 1452, + "percentage": 5.147475893363584 + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsResources.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsResources.json new file mode 100644 index 000000000000..b6c2d332d7b3 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsResources.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "endpoints": [ + { + "id": "endpoint1", + "name": "endpoint1.azureedge.net", + "history": false, + "customDomains": [ + { + "id": "customdomain1.azurecdn.net", + "name": "customdomain1.azurecdn.net", + "endpointId": "enbdpiont1", + "history": true + }, + { + "id": "customdomain2.azurecdn.net", + "name": "customdomain2.azurecdn.net", + "endpointId": null, + "history": true + } + ] + } + ], + "customDomains": [ + { + "id": "customdomain1.azurecdn.net", + "name": "customdomain1.azurecdn.net", + "endpointId": null, + "history": true + }, + { + "id": "customdomain2.azurecdn.net", + "name": "customdomain2.azurecdn.net", + "endpointId": null, + "history": true + }, + { + "id": "customdomain3.azurecdn.net", + "name": "customdomain3.azurecdn.net", + "endpointId": null, + "history": true + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetWafLogAnalyticsMetrics.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetWafLogAnalyticsMetrics.json new file mode 100644 index 000000000000..7c0009aa9554 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetWafLogAnalyticsMetrics.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "metrics": [ + "clientRequestCount" + ], + "dateTimeBegin": "2020-11-04T06:49:27.554Z", + "dateTimeEnd": "2020-11-04T09:49:27.554Z", + "actions": [ + "block", + "log" + ], + "granularity": "PT5M" + }, + "responses": { + "200": { + "body": { + "dateTimeBegin": "2020-11-04T14:30:27.554+08:00", + "dateTimeEnd": "2020-11-04T17:00:27.554+08:00", + "granularity": "PT5M", + "series": [ + { + "metric": "clientRequestCount", + "unit": "count", + "groups": [], + "data": [ + { + "dateTime": "2020-11-04T07:05:00+00:00", + "value": 2 + }, + { + "dateTime": "2020-11-04T07:10:00+00:00", + "value": 32 + }, + { + "dateTime": "2020-11-04T07:15:00+00:00", + "value": 31 + }, + { + "dateTime": "2020-11-04T07:20:00+00:00", + "value": 63 + }, + { + "dateTime": "2020-11-04T07:25:00+00:00", + "value": 50 + }, + { + "dateTime": "2020-11-04T07:30:00+00:00", + "value": 12 + }, + { + "dateTime": "2020-11-04T07:35:00+00:00", + "value": 8 + }, + { + "dateTime": "2020-11-04T07:40:00+00:00", + "value": 21 + }, + { + "dateTime": "2020-11-04T07:45:00+00:00", + "value": 30 + }, + { + "dateTime": "2020-11-04T07:50:00+00:00", + "value": 18 + }, + { + "dateTime": "2020-11-04T07:55:00+00:00", + "value": 28 + }, + { + "dateTime": "2020-11-04T08:00:00+00:00", + "value": 3 + }, + { + "dateTime": "2020-11-04T08:05:00+00:00", + "value": 58 + }, + { + "dateTime": "2020-11-04T08:10:00+00:00", + "value": 42 + }, + { + "dateTime": "2020-11-04T08:15:00+00:00", + "value": 17 + }, + { + "dateTime": "2020-11-04T08:20:00+00:00", + "value": 21 + }, + { + "dateTime": "2020-11-04T08:25:00+00:00", + "value": 41 + }, + { + "dateTime": "2020-11-04T08:30:00+00:00", + "value": 8 + }, + { + "dateTime": "2020-11-04T08:35:00+00:00", + "value": 15 + }, + { + "dateTime": "2020-11-04T08:40:00+00:00", + "value": 25 + }, + { + "dateTime": "2020-11-04T08:45:00+00:00", + "value": 13 + }, + { + "dateTime": "2020-11-04T08:50:00+00:00", + "value": 17 + }, + { + "dateTime": "2020-11-04T08:55:00+00:00", + "value": 29 + }, + { + "dateTime": "2020-11-04T09:00:00+00:00", + "value": 17 + } + ] + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetWafLogAnalyticsRankings.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetWafLogAnalyticsRankings.json new file mode 100644 index 000000000000..d2639a42f3b2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetWafLogAnalyticsRankings.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "rankings": [ + "ruleId" + ], + "metrics": [ + "clientRequestCount" + ], + "maxRanking": "5", + "dateTimeBegin": "2020-11-04T06:49:27.554Z", + "dateTimeEnd": "2020-11-04T09:49:27.554Z" + }, + "responses": { + "200": { + "body": { + "dateTimeBegin": "2020-11-04T14:49:27.554+08:00", + "dateTimeEnd": "2020-11-04T17:49:27.554+08:00", + "groups": [ + "ruleId" + ], + "data": [ + { + "groupValues": [ + "BlockRateLimit" + ], + "metrics": [ + { + "metric": "clientRequestCount", + "value": 1268, + "percentage": 0 + } + ] + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Operations_List.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Operations_List.json new file mode 100644 index 000000000000..5b6d6e7baa0e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Operations_List.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Cdn/register/action", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Microsoft.Cdn Resource Provider", + "operation": "Registers the Microsoft.Cdn Resource Provider" + } + }, + { + "name": "Microsoft.Cdn/edgenodes/read", + "display": { + "provider": "Microsoft.Cdn", + "resource": "EdgeNode", + "operation": "read" + } + }, + { + "name": "Microsoft.Cdn/edgenodes/write", + "display": { + "provider": "Microsoft.Cdn", + "resource": "EdgeNode", + "operation": "write" + } + }, + { + "name": "Microsoft.Cdn/edgenodes/delete", + "display": { + "provider": "Microsoft.Cdn", + "resource": "EdgeNode", + "operation": "delete" + } + }, + { + "name": "Microsoft.Cdn/profiles/read", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "read" + } + }, + { + "name": "Microsoft.Cdn/profiles/write", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "write" + } + }, + { + "name": "Microsoft.Cdn/operationresults/profileresults/write", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "write" + } + }, + { + "name": "Microsoft.Cdn/operationresults/profileresults/delete", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "delete" + } + }, + { + "name": "Microsoft.Cdn/operationresults/profileresults/CheckResourceUsage/action", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "CheckResourceUsage" + } + }, + { + "name": "Microsoft.Cdn/operationresults/profileresults/GenerateSsoUri/action", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "GenerateSsoUri" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Create.json new file mode 100644 index 000000000000..e7e9180589da --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Create.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originGroupName": "origingroup1", + "originGroup": { + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "origingroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + }, + "201": { + "body": { + "name": "origingroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "originGroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Delete.json new file mode 100644 index 000000000000..ea894397bde8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originGroupName": "originGroup1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Get.json new file mode 100644 index 000000000000..1e8dc056db4a --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originGroupName": "originGroup1" + }, + "responses": { + "200": { + "body": { + "name": "origingroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpAndHttpErrors", + "responseBasedFailoverThresholdPercentage": 10, + "httpErrorRanges": [ + { + "begin": 500, + "end": 505 + } + ] + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_ListByEndpoint.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_ListByEndpoint.json new file mode 100644 index 000000000000..068d939278fe --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_ListByEndpoint.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "origingroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Update.json new file mode 100644 index 000000000000..3fde7708c5e1 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Update.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originGroupName": "originGroup1", + "originGroupUpdateProperties": { + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ] + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Create.json new file mode 100644 index 000000000000..c1bfc3f8bbce --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Create.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originName": "www-someDomain-net", + "origin": { + "properties": { + "hostName": "www.someDomain.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1", + "privateLinkLocation": "eastus", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link" + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1", + "privateLinkLocation": "eastus", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link" + } + } + }, + "201": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "", + "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1", + "privateLinkLocation": "eastus" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "", + "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1", + "privateLinkLocation": "eastus" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Delete.json new file mode 100644 index 000000000000..7ad9a804522e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originName": "origin1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Get.json new file mode 100644 index 000000000000..76fe7295bec6 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originName": "www-someDomain-net" + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": null, + "httpsPort": null, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link", + "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_ListByEndpoint.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_ListByEndpoint.json new file mode 100644 index 000000000000..1d55129f21e5 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_ListByEndpoint.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": null, + "httpsPort": null, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link", + "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Update.json new file mode 100644 index 000000000000..46f6f4ba9525 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Update.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originName": "www-someDomain-net", + "originUpdateProperties": { + "properties": { + "httpPort": 42, + "httpsPort": 43, + "originHostHeader": "www.someDomain2.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice" + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 42, + "httpsPort": 43, + "originHostHeader": "www.someDomain2.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link", + "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 42, + "httpsPort": 43, + "originHostHeader": "www.someDomain2.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link", + "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_CanMigrate.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_CanMigrate.json new file mode 100644 index 000000000000..e990fcf0799c --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_CanMigrate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "canMigrateParameters": { + "classicResourceReference": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoors/frontdoorname" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/yaoshitest/providers/Microsoft.Cdn/operationresults/operationid/profileresults/DummyProfile/canmigrateresults/DummyProfile", + "type": "Microsoft.Cdn/canmigrate", + "properties": { + "canMigrate": true, + "defaultSku": "Standard_AzureFrontDoor", + "errors": null + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Create.json new file mode 100644 index 000000000000..5d71afbe2c2e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Create.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "profile": { + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + } + } + }, + "responses": { + "200": { + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + }, + "201": { + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [ + { + "matchVariable": "RequestIPAddress", + "selectorMatchOperator": "EqualsAny", + "selector": null, + "state": "Enabled" + } + ] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [ + { + "matchVariable": "RequestIPAddress", + "selectorMatchOperator": "EqualsAny", + "selector": null, + "state": "Enabled" + } + ] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Creating", + "resourceState": "Creating" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Delete.json new file mode 100644 index 000000000000..0916458730c6 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_GenerateSsoUri.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_GenerateSsoUri.json new file mode 100644 index 000000000000..6b8bd50baefa --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_GenerateSsoUri.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "ssoUriValue": "https://someuri.com" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Get.json new file mode 100644 index 000000000000..a82a4dfd3e04 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_List.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_List.json new file mode 100644 index 000000000000..c590a49088af --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_List.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG1/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + }, + { + "name": "profile2", + "id": "/subscriptions/subid/resourcegroups/RG1/providers/Microsoft.Cdn/profiles/profile2", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListByResourceGroup.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListByResourceGroup.json new file mode 100644 index 000000000000..e2f448df16bb --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListByResourceGroup.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + }, + { + "name": "profile2", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile2", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListResourceUsage.json new file mode 100644 index 000000000000..8697e399d591 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListResourceUsage.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "endpoint", + "unit": "count", + "currentValue": 0, + "limit": 25 + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListSupportedOptimizationTypes.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListSupportedOptimizationTypes.json new file mode 100644 index 000000000000..2b0b2c32d5a1 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListSupportedOptimizationTypes.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "supportedOptimizationTypes": [ + "GeneralWebDelivery", + "DynamicSiteAcceleration" + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Migrate.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Migrate.json new file mode 100644 index 000000000000..d9eb28c9dea8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Migrate.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "migrationParameters": { + "sku": { + "name": "Standard_AzureFrontDoor" + }, + "classicResourceReference": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoors/frontdoorname" + }, + "profileName": "profile1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/operationresults/operationid/profileresults/profile1/migrateresults/profile1", + "type": "Microsoft.Cdn/migrate", + "properties": { + "migratedProfileResourceId": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1" + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/operationresults/operationid/profileresults/profile1/migrateresults/profile1", + "type": "Microsoft.Cdn/migrate", + "properties": { + "migratedProfileResourceId": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1" + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_MigrationAbort.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_MigrationAbort.json new file mode 100644 index 000000000000..cf5e080906d2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_MigrationAbort.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_MigrationCommit.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_MigrationCommit.json new file mode 100644 index 000000000000..9d516c0d1760 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_MigrationCommit.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Update.json new file mode 100644 index 000000000000..24082ad92c79 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Update.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "profileUpdateParameters": { + "tags": { + "additionalProperties": "Tag1" + } + } + }, + "responses": { + "200": { + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": { + "additionalProperties": "Tag1" + }, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": { + "additionalProperties": "Tag1" + }, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Updating", + "resourceState": "Active" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/ResourceUsage_List.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/ResourceUsage_List.json new file mode 100644 index 000000000000..01ac52f3af71 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/ResourceUsage_List.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "profile", + "unit": "count", + "currentValue": 31, + "limit": 200 + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Create.json new file mode 100644 index 000000000000..741d0f6a7627 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Create.json @@ -0,0 +1,196 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "routeName": "route1", + "route": { + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreSpecifiedQueryStrings", + "queryParameters": "querystring=test" + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreSpecifiedQueryStrings", + "queryParameters": "querystring=test" + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreSpecifiedQueryStrings", + "queryParameters": "querystring=test" + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreSpecifiedQueryStrings", + "queryParameters": "querystring=test" + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Creating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Delete.json new file mode 100644 index 000000000000..b9a57becda1c --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "routeName": "route1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Get.json new file mode 100644 index 000000000000..fef031e0b728 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "routeName": "route1" + }, + "responses": { + "200": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreQueryString", + "queryParameters": null + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_ListByEndpoint.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_ListByEndpoint.json new file mode 100644 index 000000000000..0bb626dc275b --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_ListByEndpoint.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreQueryString", + "queryParameters": null + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Update.json new file mode 100644 index 000000000000..47e32c75b17f --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Update.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "routeName": "route1", + "routeUpdateProperties": { + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreQueryString" + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreQueryString", + "queryParameters": null + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreQueryString", + "queryParameters": null + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Create.json new file mode 100644 index 000000000000..eb0b3eb03bb7 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Create.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1" + }, + "responses": { + "200": { + "body": { + "name": "ruleSet1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1", + "type": "Microsoft.Cdn/profiles/rulesets", + "properties": { + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "name": "ruleSet1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1", + "type": "Microsoft.Cdn/profiles/rulesets", + "properties": { + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Delete.json new file mode 100644 index 000000000000..5451157fbf6d --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Get.json new file mode 100644 index 000000000000..fb9c7c270b16 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1" + }, + "responses": { + "200": { + "body": { + "name": "ruleSet1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1", + "type": "Microsoft.Cdn/profiles/rulesets", + "properties": { + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_ListByProfile.json new file mode 100644 index 000000000000..cf8b9786c1b9 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_ListByProfile.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ruleSet1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1", + "type": "Microsoft.Cdn/profiles/rulesets", + "properties": { + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_ListResourceUsage.json new file mode 100644 index 000000000000..80b4c18fdab4 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_ListResourceUsage.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 0, + "limit": 25, + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "name": { + "value": "rule", + "localizedValue": "rule" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Create.json new file mode 100644 index 000000000000..6c5ddaaf1e0a --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Create.json @@ -0,0 +1,158 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1", + "ruleName": "rule1", + "rule": { + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Creating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Delete.json new file mode 100644 index 000000000000..a509654df62a --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1", + "ruleName": "rule1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Get.json new file mode 100644 index 000000000000..a62f63befd85 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Get.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1", + "ruleName": "rule1" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_ListByRuleSet.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_ListByRuleSet.json new file mode 100644 index 000000000000..20492a4573ff --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_ListByRuleSet.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Update.json new file mode 100644 index 000000000000..96f31db989d1 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Update.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1", + "ruleName": "rule1", + "ruleUpdateProperties": { + "properties": { + "order": 1, + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Create.json new file mode 100644 index 000000000000..802db088a6d6 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Create.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "secretName": "secret1", + "secret": { + "properties": { + "parameters": { + "type": "CustomerCertificate", + "secretVersion": "abcdef1234578900abcdef1234567890", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/certificatename" + }, + "useLatestVersion": false + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "CustomerCertificate", + "subject": "*.contoso.com", + "certificateAuthority": "Symantec", + "expirationDate": "2025-01-01T00:00:00-00:00", + "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename" + }, + "secretVersion": "abcdef1234578900abcdef1234567890", + "useLatestVersion": true, + "subjectAlternativeNames": [ + "foo.contoso.com", + "www3.foo.contoso.com" + ] + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "CustomerCertificate", + "subject": "*.contoso.com", + "certificateAuthority": "Symantec", + "expirationDate": "2025-01-01T00:00:00-00:00", + "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename" + }, + "secretVersion": "abcdef1234578900abcdef1234567890", + "useLatestVersion": true, + "subjectAlternativeNames": [ + "foo.contoso.com", + "www3.foo.contoso.com" + ] + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "CustomerCertificate", + "subject": "*.contoso.com", + "certificateAuthority": "Symantec", + "expirationDate": "2025-01-01T00:00:00-00:00", + "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename" + }, + "secretVersion": "abcdef1234578900abcdef1234567890", + "useLatestVersion": true, + "subjectAlternativeNames": [ + "foo.contoso.com", + "www3.foo.contoso.com" + ] + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Delete.json new file mode 100644 index 000000000000..77b2842a05b8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "secretName": "secret1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Get.json new file mode 100644 index 000000000000..350516a84b04 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "secretName": "secret1" + }, + "responses": { + "200": { + "body": { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "CustomerCertificate", + "subject": "*.contoso.com", + "certificateAuthority": "Symantec", + "expirationDate": "2025-01-01T00:00:00-00:00", + "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename" + }, + "secretVersion": "abcdef1234578900abcdef1234567890", + "useLatestVersion": true, + "subjectAlternativeNames": [ + "foo.contoso.com", + "www3.foo.contoso.com" + ] + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_ListByProfile.json new file mode 100644 index 000000000000..d04b5c8f79ff --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_ListByProfile.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "CustomerCertificate", + "subject": "*.contoso.com", + "certificateAuthority": "Symantec", + "expirationDate": "2025-01-01T00:00:00-00:00", + "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename" + }, + "secretVersion": "abcdef1234578900abcdef1234567890", + "useLatestVersion": true, + "subjectAlternativeNames": [ + "foo.contoso.com", + "www3.foo.contoso.com" + ] + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/autogenerated_secret_name", + "type": "Microsoft.Cdn/profiles/secrets", + "name": "69f05517-6aaf-4a1e-a96d-f8c02f66c756-test12-afdx-test-domains-azfdtest-xyz", + "properties": { + "parameters": { + "type": "ManagedCertificate", + "subject": "bar.contoso.com", + "expirationDate": "2025-01-01T00:00:00-00:00" + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Create.json new file mode 100644 index 000000000000..588c03856635 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Create.json @@ -0,0 +1,135 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "securityPolicyName": "securityPolicy1", + "securityPolicy": { + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Delete.json new file mode 100644 index 000000000000..50d4e6f69ec7 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "securityPolicyName": "securityPolicy1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Get.json new file mode 100644 index 000000000000..982f8795d8e3 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "securityPolicyName": "securityPolicy1" + }, + "responses": { + "200": { + "body": { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_ListByProfile.json new file mode 100644 index 000000000000..b0072b486db8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_ListByProfile.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Patch.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Patch.json new file mode 100644 index 000000000000..c3d5b6c395f2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Patch.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "securityPolicyName": "securityPolicy1", + "securityPolicyUpdateProperties": { + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Updating" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/ValidateProbe.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/ValidateProbe.json new file mode 100644 index 000000000000..d3728e5807c3 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/ValidateProbe.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "validateProbeInput": { + "probeURL": "https://www.bing.com/image" + } + }, + "responses": { + "200": { + "body": { + "isValid": true, + "errorCode": "None", + "message": null + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafListManagedRuleSets.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafListManagedRuleSets.json new file mode 100644 index 000000000000..6fd17a80c19d --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafListManagedRuleSets.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "DefaultRuleSet_1.0", + "id": "/subscriptions/subid/providers/Microsoft.Cdn/CdnWebApplicationFirewallManagedRuleSets", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallmanagedrulesets", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "provisioningState": "Succeeded", + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroups": [ + { + "ruleGroupName": "Group1", + "description": "Description for rule group 1.", + "rules": [ + { + "ruleId": "GROUP1-0001", + "description": "Generic managed web application firewall rule." + }, + { + "ruleId": "GROUP1-0002", + "description": "Generic managed web application firewall rule." + } + ] + }, + { + "ruleGroupName": "Group2", + "description": "Description for rule group 2.", + "rules": [ + { + "ruleId": "GROUP2-0001", + "description": "Generic managed web application firewall rule." + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafListPolicies.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafListPolicies.json new file mode 100644 index 000000000000..3daa50835a0d --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafListPolicies.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 429, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + }, + { + "name": "VerizonStandardCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/VerizonStandardCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Verizon" + }, + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 429, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "ECRS", + "ruleSetVersion": "2018-11-2", + "ruleGroupOverrides": [ + { + "ruleGroupName": "XSS", + "rules": [ + { + "ruleId": "XSS-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "XSS-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint3" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPatchPolicy.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPatchPolicy.json new file mode 100644 index 000000000000..2a3c080ad91a --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPatchPolicy.json @@ -0,0 +1,275 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "MicrosoftCdnWafPolicy", + "cdnWebApplicationFirewallPolicyPatchParameters": { + "tags": { + "foo": "bar" + } + } + }, + "responses": { + "200": { + "body": { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "foo": "bar" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 403, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Creating", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 403, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyCreateOrUpdate.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyCreateOrUpdate.json new file mode 100644 index 000000000000..abe3c83b1d08 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyCreateOrUpdate.json @@ -0,0 +1,508 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "MicrosoftCdnWafPolicy", + "cdnWebApplicationFirewallPolicy": { + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "policySettings": { + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 200, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 200, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + } + }, + "201": { + "body": { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 200, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Creating", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 200, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 3, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyDelete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyDelete.json new file mode 100644 index 000000000000..19b06efe8e72 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "Policy1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyGet.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyGet.json new file mode 100644 index 000000000000..7c3f34ff1bf8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyGet.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "MicrosoftCdnWafPolicy" + }, + "responses": { + "200": { + "body": { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 429, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/scenarios/AFDProfiles_Upgrade_WithoutWaf.yaml b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/scenarios/AFDProfiles_Upgrade_WithoutWaf.yaml new file mode 100644 index 000000000000..7259132992bd --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/scenarios/AFDProfiles_Upgrade_WithoutWaf.yaml @@ -0,0 +1,28 @@ +# yaml-language-server: $schema=https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/documentation/api-scenario/references/v1.2/schema.json +scope: ResourceGroup +variables: + afdprofileName: + type: string + prefix: afdprofile +scenarios: + - scenario: GeneratedScenario + steps: + - step: CheckNameAvailabilityWithSubscription + operationId: CheckNameAvailabilityWithSubscription + exampleFile: ../examples/CheckNameAvailabilityWithSubscription.json + - step: AFDProfiles_Create + operationId: Profiles_Create + parameters: + profileName: $(afdprofileName) + profile: + location: "global" + sku: + name: Standard_AzureFrontDoor + identity: + type: "SystemAssigned" + - step: AFDProfiles_Upgrade + operationId: AFDProfiles_Upgrade + parameters: + profileName: $(afdprofileName) + profileUpgradeParameters: + wafMappingList: [] diff --git a/specification/cdn/resource-manager/readme.md b/specification/cdn/resource-manager/readme.md index d53eb61cf0ca..443c5a4a8a57 100644 --- a/specification/cdn/resource-manager/readme.md +++ b/specification/cdn/resource-manager/readme.md @@ -29,7 +29,21 @@ These are the global settings for the Cdn API. title: CdnManagementClient description: Cdn Management Client openapi-type: arm -tag: package-2024-02 +tag: package-2024-09 +``` + +### Tag: package-2024-09 + +These settings apply only when `--tag=package-2024-09` is specified on the command line. + +```yaml $(tag) == 'package-2024-09' +input-file: + - Microsoft.Cdn/stable/2024-09-01/afdx.json + - Microsoft.Cdn/stable/2024-09-01/cdn.json + - Microsoft.Cdn/stable/2024-09-01/cdnwebapplicationfirewall.json +suppressions: + - code: MISSING_RESOURCE_ID + reason: Keeping it for legacy tooling ``` ### Tag: package-preview-2024-06 diff --git a/specification/cdn/resource-manager/sdk-suppressions.yaml b/specification/cdn/resource-manager/sdk-suppressions.yaml index 45f1cd17ed81..d9f6c6e4c768 100644 --- a/specification/cdn/resource-manager/sdk-suppressions.yaml +++ b/specification/cdn/resource-manager/sdk-suppressions.yaml @@ -106,3 +106,40 @@ suppressions: - Type of `URLRewriteActionParameters.TypeName` has been changed from `*URLRewriteActionParametersTypeName` to `*DeliveryRuleActionParametersType` - Type of `URLSigningAction.Name` has been changed from `*DeliveryRuleAction` to `*DeliveryRuleActionName` - Type of `URLSigningActionParameters.TypeName` has been changed from `*URLSigningActionParametersTypeName` to `*DeliveryRuleActionParametersType` + azure-sdk-for-python: + - package: azure-mgmt-cdn + breaking-changes: + - Deleted or renamed enum value `MatchProcessingBehavior.CONTINUE_ENUM` + - Deleted or renamed model `CacheExpirationActionParametersTypeName` + - Deleted or renamed model `CacheKeyQueryStringActionParametersTypeName` + - Deleted or renamed model `CdnCertificateSourceParametersTypeName` + - Deleted or renamed model `ClientPortMatchConditionParametersTypeName` + - Deleted or renamed model `CookiesMatchConditionParametersTypeName` + - Deleted or renamed model `HeaderActionParametersTypeName` + - Deleted or renamed model `HostNameMatchConditionParametersTypeName` + - Deleted or renamed model `HttpVersionMatchConditionParametersTypeName` + - Deleted or renamed model `IsDeviceMatchConditionParametersMatchValuesItem` + - Deleted or renamed model `IsDeviceMatchConditionParametersTypeName` + - Deleted or renamed model `KeyVaultCertificateSourceParametersTypeName` + - Deleted or renamed model `KeyVaultSigningKeyParametersTypeName` + - Deleted or renamed model `OriginGroupOverrideActionParametersTypeName` + - Deleted or renamed model `PostArgsMatchConditionParametersTypeName` + - Deleted or renamed model `QueryStringMatchConditionParametersTypeName` + - Deleted or renamed model `RemoteAddressMatchConditionParametersTypeName` + - Deleted or renamed model `RequestBodyMatchConditionParametersTypeName` + - Deleted or renamed model `RequestHeaderMatchConditionParametersTypeName` + - Deleted or renamed model `RequestMethodMatchConditionParametersMatchValuesItem` + - Deleted or renamed model `RequestMethodMatchConditionParametersTypeName` + - Deleted or renamed model `RequestSchemeMatchConditionParametersMatchValuesItem` + - Deleted or renamed model `RequestSchemeMatchConditionParametersTypeName` + - Deleted or renamed model `RequestUriMatchConditionParametersTypeName` + - Deleted or renamed model `RouteConfigurationOverrideActionParametersTypeName` + - Deleted or renamed model `ServerPortMatchConditionParametersTypeName` + - Deleted or renamed model `SocketAddrMatchConditionParametersTypeName` + - Deleted or renamed model `SslProtocolMatchConditionParametersTypeName` + - Deleted or renamed model `UrlFileExtensionMatchConditionParametersTypeName` + - Deleted or renamed model `UrlFileNameMatchConditionParametersTypeName` + - Deleted or renamed model `UrlPathMatchConditionParametersTypeName` + - Deleted or renamed model `UrlRedirectActionParametersTypeName` + - Deleted or renamed model `UrlRewriteActionParametersTypeName` + - Deleted or renamed model `UrlSigningActionParametersTypeName` From ae95eb6a4701d844bada7d1c4f5ecf4a7444e5b8 Mon Sep 17 00:00:00 2001 From: Sean McCullough <44180881+seanmcc-msft@users.noreply.github.com> Date: Fri, 27 Sep 2024 12:40:18 -0500 Subject: [PATCH 38/48] Files Provisioned Billing V2 updates (#30752) --- .../stable/2025-01-05/file.json | 38 +++++++++++-------- 1 file changed, 22 insertions(+), 16 deletions(-) diff --git a/specification/storage/data-plane/Microsoft.FileStorage/stable/2025-01-05/file.json b/specification/storage/data-plane/Microsoft.FileStorage/stable/2025-01-05/file.json index fddbcfb61b94..904e160827cb 100644 --- a/specification/storage/data-plane/Microsoft.FileStorage/stable/2025-01-05/file.json +++ b/specification/storage/data-plane/Microsoft.FileStorage/stable/2025-01-05/file.json @@ -328,19 +328,25 @@ "x-ms-client-name": "ShareProvisionedIops", "type": "integer", "format": "int64", - "description": "The provisioned IOPS of the share. If this is not specified, compute the recommended IOPS of the share using the formula for a share in this media tier (SSD/HDD as appropriate)." + "description": "The provisioned IOPS of the share." }, "x-ms-share-provisioned-bandwidth-mibps": { "x-ms-client-name": "ShareProvisionedBandwidthMibps", "type": "integer", "format": "int64", - "description": "The provisioned throughput of the share. If this is not specified, compute the recommended throughput of the share using the formula for a share in this media tier (SSD/HDD as appropriate)." + "description": "The provisioned throughput of the share." }, "x-ms-share-included-burst-iops": { "x-ms-client-name": "ShareIncludedBurstIops", "type": "integer", "format": "int64", - "description": "ShareIncludedBurstIops" + "description": "Returns the calculated burst IOPS of the share." + }, + "x-ms-share-max-burst-credits-for-iops": { + "x-ms-client-name": "MaxBurstCreditsForIops", + "description": "Returned the calculated maximum burst credits.", + "type": "integer", + "format": "int64" } } }, @@ -444,7 +450,7 @@ "x-ms-share-provisioned-bandwidth-mibps": { "x-ms-client-name": "ProvisionedBandwidthMibps", "type": "integer", - "description": "Returns the current share provisioned bandwidth in megabits per second." + "description": "Returns the current share provisioned bandwidth in mebibytes per second." }, "x-ms-lease-duration": { "x-ms-client-name": "LeaseDuration", @@ -559,13 +565,13 @@ }, "x-ms-share-next-allowed-provisioned-iops-downgrade-time": { "x-ms-client-name": "NextAllowedProvisionedIopsDowngradeTime", - "description": "Return timestamp for provisioned IOPS following existing rules for provisioned storage GiB.", + "description": "Returns the current share next allowed provisioned iops downgrade time.", "type": "string", "format": "date-time-rfc1123" }, "x-ms-share-next-allowed-provisioned-bandwidth-downgrade-time": { "x-ms-client-name": "NextAllowedProvisionedBandwidthDowngradeTime", - "description": "Return timestamp for provisioned throughput following existing rules for provisioned storage GiB.", + "description": "Returns the current share next allowed provisioned bandwidth downgrade time.", "type": "string", "format": "date-time-rfc1123" } @@ -630,15 +636,15 @@ "format": "date-time-rfc1123", "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." }, - "x-ms-share-usage-bytes": { + "x-ms-file-share-usage-bytes": { "type": "integer", "format": "int64", - "description": "The \"live share\" portion of the data that the customer will be billed for in the soft-deleted capacity (logical storage size)." + "description": "Returned only for provisioned v2 file shares. Returns an approximate used storage size of the share, in bytes." }, - "x-ms-share-snapshot-usage-bytes": { + "x-ms-file-share-snapshot-usage-bytes": { "type": "integer", "format": "int64", - "description": "The snapshot share portion of the data that the customer will be billed for in the soft-deleted capacity (this is the delta, or \"physical storage size\")." + "description": "Returned only for provisioned v2 file shares. Returns an approximate used snapshot storage size of the share, in bytes." } } }, @@ -1638,7 +1644,7 @@ "x-ms-client-name": "ProvisionedBandwidthMibps", "type": "integer", "format": "int64", - "description": "Returns the current share provisioned bandwidth in megabits per second." + "description": "Returns the current share provisioned bandwidth in mebibytes per second." }, "x-ms-share-included-burst-iops": { "x-ms-client-name": "IncludedBurstIops", @@ -1660,13 +1666,13 @@ }, "x-ms-share-next-allowed-provisioned-iops-downgrade-time": { "x-ms-client-name": "NextAllowedProvisionedIopsDowngradeTime", - "description": "Return timestamp for provisioned IOPS following existing rules for provisioned storage GiB.", + "description": "Returns the current share next allowed provisioned iops downgrade time.", "type": "string", "format": "date-time-rfc1123" }, "x-ms-share-next-allowed-provisioned-bandwidth-downgrade-time": { "x-ms-client-name": "NextAllowedProvisionedBandwidthDowngradeTime", - "description": "Return timestamp for provisioned throughput following existing rules for provisioned storage GiB.", + "description": "Returns the current share next allowed provisioned bandwidth downgrade time.", "type": "string", "format": "date-time-rfc1123" } @@ -2137,7 +2143,7 @@ "x-ms-client-name": "ProvisionedBandwidthMibps", "type": "integer", "format": "int64", - "description": "Returns the current share provisioned bandwidth in megabits per second." + "description": "Returns the current share provisioned bandwidth in mebibytes per second." }, "x-ms-share-included-burst-iops": { "x-ms-client-name": "IncludedBurstIops", @@ -7703,7 +7709,7 @@ "name": "x-ms-share-provisioned-iops", "x-ms-client-name": "shareProvisionedIops", "in": "header", - "description": "Optional. The provisioned IOPS of the share. If this is not specified, compute the recommended IOPS of the share using the formula for a share in this media tier (SSD/HDD as appropriate). The provisioned IOPS of the share is always explicitly stored on the share object, even if the recommendation formula is used.", + "description": "Optional. Supported in version 2025-01-05 and later. Only allowed for provisioned v2 file shares. Specifies the provisioned number of input/output operations per second (IOPS) of the share. If this is not specified, the provisioned IOPS is set to value calculated based on recommendation formula.", "required": false, "type": "integer", "format": "int64", @@ -7713,7 +7719,7 @@ "name": "x-ms-share-provisioned-bandwidth-mibps", "x-ms-client-name": "shareProvisionedBandwidthMibps", "in": "header", - "description": "Optional. The provisioned throughput of the share. If this is not specified, compute the recommended throughput of the share using the formula for a share in this media tier (SSD/HDD as appropriate).", + "description": "Optional. Supported in version 2025-01-05 and later. Only allowed for provisioned v2 file shares. Specifies the provisioned bandwidth of the share, in mebibytes per second (MiBps). If this is not specified, the provisioned bandwidth is set to value calculated based on recommendation formula.", "required": false, "type": "integer", "format": "int64", From 6e9a98ba9692ce2090945bcf5d63bd11f77fc9ff Mon Sep 17 00:00:00 2001 From: yijinglu-microsoft Date: Fri, 27 Sep 2024 13:15:32 -0700 Subject: [PATCH 39/48] Review request for Microsoft.Devices to add version preview/2025-02-01-preview (#30603) * Copied Content from Previous Api Version * Added MI features for IotHubs * Moved iothubs from Patch to Create * Reverted DPS Create Changes * Updated Description * Fixed Comments --- .../DPSCertificateCreateOrUpdate.json | 33 + .../examples/DPSCheckNameAvailability.json | 18 + .../examples/DPSCreate.json | 75 + ...eateOrUpdatePrivateEndpointConnection.json | 53 + .../examples/DPSDelete.json | 20 + .../examples/DPSDeleteCertificate.json | 14 + .../DPSDeletePrivateEndpointConnection.json | 51 + .../examples/DPSGenerateVerificationCode.json | 27 + .../2025-02-01-preview/examples/DPSGet.json | 47 + .../examples/DPSGetCertificate.json | 28 + .../examples/DPSGetCertificates.json | 31 + .../examples/DPSGetKey.json | 19 + .../examples/DPSGetOperationResult.json | 17 + .../DPSGetPrivateEndpointConnection.json | 28 + .../examples/DPSGetPrivateLinkResources.json | 27 + .../examples/DPSGetValidSku.json | 19 + .../examples/DPSListByResourceGroup.json | 83 + .../examples/DPSListBySubscription.json | 82 + .../examples/DPSListKeys.json | 28 + .../DPSListPrivateEndpointConnections.json | 29 + .../examples/DPSListPrivateLinkResources.json | 30 + .../examples/DPSOperations.json | 293 ++ .../2025-02-01-preview/examples/DPSPatch.json | 55 + .../examples/DPSUpdate.json | 103 + .../examples/DPSVerifyCertificate.json | 32 + .../preview/2025-02-01-preview/iotdps.json | 2602 +++++++++++++++++ .../resource-manager/readme.md | 10 +- 27 files changed, 3853 insertions(+), 1 deletion(-) create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCertificateCreateOrUpdate.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCheckNameAvailability.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCreate.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCreateOrUpdatePrivateEndpointConnection.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDelete.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDeleteCertificate.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDeletePrivateEndpointConnection.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGenerateVerificationCode.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGet.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetCertificate.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetCertificates.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetKey.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetOperationResult.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetPrivateEndpointConnection.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetPrivateLinkResources.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetValidSku.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListByResourceGroup.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListBySubscription.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListKeys.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListPrivateEndpointConnections.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListPrivateLinkResources.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSOperations.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSPatch.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSUpdate.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSVerifyCertificate.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/iotdps.json diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCertificateCreateOrUpdate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCertificateCreateOrUpdate.json new file mode 100644 index 000000000000..d384a67892f1 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCertificateCreateOrUpdate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "certificateDescription": { + "properties": { + "certificate": "MA==" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "subject": "CN=testdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "certificate": "MA==", + "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/ProvisioningServices/Certificates", + "etag": "AAAAAAExpNs=" + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCheckNameAvailability.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCheckNameAvailability.json new file mode 100644 index 000000000000..9a2550a599d0 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCheckNameAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "arguments": { + "name": "test213123" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "Invalid", + "message": "name is valid" + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCreate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCreate.json new file mode 100644 index 000000000000..ade2b482cfe3 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCreate.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "iotDpsDescription": { + "location": "East US", + "properties": { + "enableDataResidency": false + }, + "sku": { + "name": "S1", + "capacity": 1 + }, + "tags": {} + } + }, + "responses": { + "200": { + "body": { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "authorizationPolicies": [], + "enableDataResidency": false, + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + }, + "201": { + "body": { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "authorizationPolicies": [], + "enableDataResidency": false, + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCreateOrUpdatePrivateEndpointConnection.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCreateOrUpdatePrivateEndpointConnection.json new file mode 100644 index 000000000000..e393b70cd333 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCreateOrUpdatePrivateEndpointConnection.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "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/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/ProvisioningServices/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/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/ProvisioningServices/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/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDelete.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDelete.json new file mode 100644 index 000000000000..93cfb7bacbc5 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Retry-After": "15", + "Location": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15", + "Azure-AsyncOperation": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15" + } + }, + "404": {} + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDeleteCertificate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDeleteCertificate.json new file mode 100644 index 000000000000..192680070d18 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDeleteCertificate.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "If-Match": "AAAAAAAADGk=" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDeletePrivateEndpointConnection.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..b33bd8fcda96 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDeletePrivateEndpointConnection.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "privateEndpointConnectionName": "myPrivateEndpointConnection" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/ProvisioningServices/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/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/ProvisioningServices/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Disconnected", + "description": "Deleted", + "actionsRequired": "None" + } + } + }, + "headers": { + "Retry-After": "15", + "Location": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15", + "Azure-AsyncOperation": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15" + } + }, + "204": {} + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGenerateVerificationCode.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGenerateVerificationCode.json new file mode 100644 index 000000000000..906c9f322fa7 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGenerateVerificationCode.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "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": "##############################", + "certificate": "MA==", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:26:56 GMT" + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGet.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGet.json new file mode 100644 index 000000000000..313e13101156 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "authorizationPolicies": [], + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "aa80bd74-a3f0-4f14-b9da-99c5351cf9d5", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": { + "clientId": "c38f618d-47f6-4260-8b3d-1dd8c130f323", + "principalId": "f1b0b133-10dc-4985-966f-a98a04675fe9" + } + } + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetCertificate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetCertificate.json new file mode 100644 index 000000000000..4c79e9ed564b --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetCertificate.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "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", + "certificate": "MA==", + "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/ProvisioningServices/Certificates", + "etag": "AAAAAAExpNs=" + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetCertificates.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetCertificates.json new file mode 100644 index 000000000000..fdd7f9e93c67 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetCertificates.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "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", + "certificate": "MA==" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/andbuc-hub/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/ProvisioningServices/Certificates", + "etag": "AAAAAAExpNs=" + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetKey.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetKey.json new file mode 100644 index 000000000000..3aea3230851b --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetKey.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "keyName": "testKey" + }, + "responses": { + "200": { + "body": { + "keyName": "testKey", + "primaryKey": "##################################", + "secondaryKey": "################################", + "rights": "RegistrationStatusWrite" + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetOperationResult.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetOperationResult.json new file mode 100644 index 000000000000..594c23b12226 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetOperationResult.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "operationId": "MTY5OTNmZDctODI5Yy00N2E2LTkxNDQtMDU1NGIyYzY1ZjRl", + "asyncinfo": "1508265712453" + }, + "responses": { + "200": { + "body": { + "status": "Succeeded" + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetPrivateEndpointConnection.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetPrivateEndpointConnection.json new file mode 100644 index 000000000000..54f909fa8f3e --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetPrivateEndpointConnection.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "privateEndpointConnectionName": "myPrivateEndpointConnection" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/ProvisioningServices/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/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetPrivateLinkResources.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetPrivateLinkResources.json new file mode 100644 index 000000000000..9a88329068a9 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetPrivateLinkResources.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "groupId": "iotDps" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateLinkResources/iotDps", + "name": "iotDps", + "type": "Microsoft.Devices/ProvisioningServices/PrivateLinkResources", + "properties": { + "groupId": "iotDps", + "requiredMembers": [ + "iotDps" + ], + "requiredZoneNames": [ + "privatelink.azure-devices-provisioning.net" + ] + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetValidSku.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetValidSku.json new file mode 100644 index 000000000000..81468e225ea9 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetValidSku.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "S1" + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListByResourceGroup.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListByResourceGroup.json new file mode 100644 index 000000000000..74995ef2de66 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListByResourceGroup.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "aa80bd74-a3f0-4f14-b9da-99c5351cf9d5", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": { + "clientId": "c38f618d-47f6-4260-8b3d-1dd8c130f323", + "principalId": "f1b0b133-10dc-4985-966f-a98a04675fe9" + } + } + } + }, + { + "etag": "AAAAAAAADGk=", + "name": "mySecondProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "mySecondProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/mySecondProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "01341f2b-d497-4117-b5c1-1f1d50b25444", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity2": { + "clientId": "8cd6d250-17dd-4c1b-9847-225237b94c55", + "principalId": "8785a11f-848a-4d5d-a55b-e381b9e15512" + } + } + } + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListBySubscription.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListBySubscription.json new file mode 100644 index 000000000000..8675aa9965c4 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListBySubscription.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "aa80bd74-a3f0-4f14-b9da-99c5351cf9d5", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": { + "clientId": "c38f618d-47f6-4260-8b3d-1dd8c130f323", + "principalId": "f1b0b133-10dc-4985-966f-a98a04675fe9" + } + } + } + }, + { + "etag": "AAAAAAAADGk=", + "name": "mySecondProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/mySecondProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "01341f2b-d497-4117-b5c1-1f1d50b25444", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity2": { + "clientId": "8cd6d250-17dd-4c1b-9847-225237b94c55", + "principalId": "8785a11f-848a-4d5d-a55b-e381b9e15512" + } + } + } + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListKeys.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListKeys.json new file mode 100644 index 000000000000..fcc4739fa765 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListKeys.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "keyName": "key1", + "primaryKey": "#####################################", + "secondaryKey": "###################################", + "rights": "ServiceConfig" + }, + { + "keyName": "key2", + "primaryKey": "#######################################", + "secondaryKey": "####################################=", + "rights": "ServiceConfig" + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListPrivateEndpointConnections.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListPrivateEndpointConnections.json new file mode 100644 index 000000000000..24a98070ae4b --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListPrivateEndpointConnections.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": [ + { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/ProvisioningServices/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/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListPrivateLinkResources.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListPrivateLinkResources.json new file mode 100644 index 000000000000..47b21410a6a9 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListPrivateLinkResources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateLinkResources/iotDps", + "name": "iotDps", + "type": "Microsoft.Devices/ProvisioningServices/PrivateLinkResources", + "properties": { + "groupId": "iotDps", + "requiredMembers": [ + "iotDps" + ], + "requiredZoneNames": [ + "privatelink.azure-devices-provisioning.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSOperations.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSOperations.json new file mode 100644 index 000000000000..d5f1c5649b8b --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSOperations.json @@ -0,0 +1,293 @@ +{ + "parameters": { + "api-version": "2025-02-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Devices/register/action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Register Resource Provider" + } + }, + { + "name": "Microsoft.Devices/IotHubs/diagnosticSettings/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Diagnostic Setting" + } + }, + { + "name": "Microsoft.Devices/IotHubs/diagnosticSettings/write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Set Diagnostic Setting" + } + }, + { + "name": "Microsoft.Devices/IotHubs/metricDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read IotHub service metric definitions" + } + }, + { + "name": "Microsoft.Devices/IotHubs/logDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read IotHub service log definitions" + } + }, + { + "name": "Microsoft.Devices/operations/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get All ResourceProvider Operations" + } + }, + { + "name": "Microsoft.Devices/checkNameAvailability/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Check If IotHub name is available" + } + }, + { + "name": "Microsoft.Devices/usages/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Subscription Usages" + } + }, + { + "name": "Microsoft.Devices/iotHubs/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get IotHub(s)" + } + }, + { + "name": "Microsoft.Devices/iotHubs/Write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Create or update IotHub Resource" + } + }, + { + "name": "Microsoft.Devices/iotHubs/Delete", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Delete IotHub Resource" + } + }, + { + "name": "Microsoft.Devices/iotHubs/iotHubStats/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get IotHub Statistics" + } + }, + { + "name": "Microsoft.Devices/iotHubs/skus/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get valid IotHub Skus" + } + }, + { + "name": "Microsoft.Devices/iotHubs/listkeys/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "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" + } + }, + { + "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Create EventHub Consumer Group" + } + }, + { + "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get EventHub Consumer Group(s)" + } + }, + { + "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Delete", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Delete EventHub Consumer Group" + } + }, + { + "name": "Microsoft.Devices/iotHubs/exportDevices/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Export Devices" + } + }, + { + "name": "Microsoft.Devices/iotHubs/importDevices/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Import Devices" + } + }, + { + "name": "Microsoft.Devices/iotHubs/jobs/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get the Job(s) on IotHub" + } + }, + { + "name": "Microsoft.Devices/iotHubs/quotaMetrics/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Quota Metrics" + } + }, + { + "name": "Microsoft.Devices/iotHubs/routing/routes/$testall/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Routing Rule Test All" + } + }, + { + "name": "Microsoft.Devices/iotHubs/routing/routes/$testnew/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Routing Rule Test Route" + } + }, + { + "name": "Microsoft.Devices/iotHubs/routingEndpointsHealth/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Endpoint Health" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/diagnosticSettings/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Diagnostic Setting" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/diagnosticSettings/write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Set Diagnostic Setting" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/metricDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read DPS service metric definitions" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/logDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read DPS service log definitions" + } + }, + { + "name": "Microsoft.Devices/checkProvisioningServiceNameAvailability/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServives", + "operation": "Check If Provisioning Service name is available" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Get Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/Write", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Create Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/Delete", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Delete Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/skus/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Delete Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/listkeys/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "get security related metadata" + } + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSPatch.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSPatch.json new file mode 100644 index 000000000000..fc501f9960dd --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSPatch.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "location": "East US", + "type": "Microsoft.Devices/ProvisioningServices", + "ProvisioningServiceTags": { + "tags": { + "foo": "bar" + } + } + }, + "responses": { + "200": { + "body": { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": { + "foo": "bar" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "aa80bd74-a3f0-4f14-b9da-99c5351cf9d5", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": { + "clientId": "c38f618d-47f6-4260-8b3d-1dd8c130f323", + "principalId": "f1b0b133-10dc-4985-966f-a98a04675fe9" + } + } + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSUpdate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSUpdate.json new file mode 100644 index 000000000000..a3e15626d8e9 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSUpdate.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "iotDpsDescription": { + "location": "East US", + "properties": { + "enableDataResidency": false + }, + "sku": { + "name": "S1", + "capacity": 1 + }, + "tags": {}, + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "authorizationPolicies": [], + "enableDataResidency": false, + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "aa80bd74-a3f0-4f14-b9da-99c5351cf9d5", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": { + "clientId": "c38f618d-47f6-4260-8b3d-1dd8c130f323", + "principalId": "f1b0b133-10dc-4985-966f-a98a04675fe9" + } + } + } + } + }, + "201": { + "body": { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "authorizationPolicies": [], + "enableDataResidency": false, + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "aa80bd74-a3f0-4f14-b9da-99c5351cf9d5", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": { + "clientId": "c38f618d-47f6-4260-8b3d-1dd8c130f323", + "principalId": "f1b0b133-10dc-4985-966f-a98a04675fe9" + } + } + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSVerifyCertificate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSVerifyCertificate.json new file mode 100644 index 000000000000..e8b4d390e502 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSVerifyCertificate.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "If-Match": "AAAAAAAADGk=", + "request": { + "certificate": "#####################################" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "subject": "CN=andbucdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "certificate": "MA==", + "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/ProvisioningServices/Certificates", + "etag": "AAAAAAExpTQ=" + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/iotdps.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/iotdps.json new file mode 100644 index 000000000000..733eba185022 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/iotdps.json @@ -0,0 +1,2602 @@ +{ + "swagger": "2.0", + "info": { + "version": "2025-02-01-preview", + "x-ms-code-generation-settings": { + "host": "management.azure.com" + }, + "title": "iotDpsClient", + "description": "API for using the Azure IoT Hub Device Provisioning Service features." + }, + "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" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "DPSOperations": { + "$ref": "./examples/DPSOperations.json" + } + }, + "description": "Lists all of the available Microsoft.Devices REST API operations.", + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}": { + "get": { + "tags": [ + "DpsCertificate" + ], + "operationId": "DpsCertificate_Get", + "description": "Get the certificate from the provisioning service.", + "x-ms-examples": { + "DPSGetCertificate": { + "$ref": "./examples/DPSGetCertificate.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "certificateName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the certificate to retrieve." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the provisioning service the certificate is associated with." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the certificate." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Metadata for the specified certificate.", + "schema": { + "$ref": "#/definitions/CertificateResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "put": { + "tags": [ + "DpsCertificate" + ], + "summary": "Upload the certificate to the provisioning service.", + "description": "Add new certificate or update an existing certificate.", + "operationId": "DpsCertificate_CreateOrUpdate", + "x-ms-examples": { + "DPSCreateOrUpdateCertificate": { + "$ref": "./examples/DPSCertificateCreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group identifier.", + "required": true, + "type": "string" + }, + { + "name": "provisioningServiceName", + "in": "path", + "description": "The name of the provisioning service.", + "required": true, + "type": "string" + }, + { + "name": "certificateName", + "in": "path", + "description": "The name of the certificate create or update.", + "required": true, + "type": "string", + "maxLength": 256 + }, + { + "name": "certificateDescription", + "in": "body", + "description": "The certificate body.", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateResponse" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate." + } + ], + "responses": { + "200": { + "description": "If certificate already exist and update was successful, the operation returns HTTP status code of 201 (OK).", + "schema": { + "$ref": "#/definitions/CertificateResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "DpsCertificate" + ], + "operationId": "DpsCertificate_Delete", + "summary": "Delete the Provisioning Service Certificate.", + "description": "Deletes the specified certificate associated with the Provisioning Service", + "x-ms-examples": { + "DPSDeleteCertificate": { + "$ref": "./examples/DPSDeleteCertificate.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "ETag of the certificate" + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the provisioning service." + }, + { + "name": "certificateName", + "in": "path", + "required": true, + "type": "string", + "description": "This is a mandatory field, and is the logical name of the certificate that the provisioning service will access by." + }, + { + "name": "certificate.name", + "in": "query", + "required": false, + "type": "string", + "description": "This is optional, and it is the Common Name of the certificate." + }, + { + "name": "certificate.rawBytes", + "in": "query", + "required": false, + "type": "string", + "format": "byte", + "description": "Raw data within the certificate." + }, + { + "name": "certificate.isVerified", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates if certificate has been verified by owner of the private key." + }, + { + "name": "certificate.purpose", + "in": "query", + "required": false, + "type": "string", + "description": "A description that mentions the purpose of the certificate.", + "enum": [ + "clientAuthentication", + "serverAuthentication" + ], + "x-ms-enum": { + "name": "CertificatePurpose", + "modelAsString": true + } + }, + { + "name": "certificate.created", + "in": "query", + "description": "Time the certificate is created.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "certificate.lastUpdated", + "in": "query", + "required": false, + "type": "string", + "description": "Time the certificate is last updated.", + "format": "date-time" + }, + { + "name": "certificate.hasPrivateKey", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates if the certificate contains a private key." + }, + { + "name": "certificate.nonce", + "in": "query", + "required": false, + "type": "string", + "description": "Random number generated to indicate Proof of Possession." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}": { + "get": { + "tags": [ + "IotDpsResource" + ], + "summary": "Get the non-security related metadata of the provisioning service.", + "description": "Get the metadata of the provisioning service without SAS keys.", + "operationId": "IotDpsResource_Get", + "x-ms-examples": { + "DPSGet": { + "$ref": "./examples/DPSGet.json" + } + }, + "parameters": [ + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the provisioning service to retrieve." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Provisioning service description with no keys is included in the response.", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescription" + } + }, + "default": { + "description": "Default error response", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "put": { + "tags": [ + "IotDpsResource" + ], + "summary": "Create or update the metadata of the provisioning service.", + "description": "Create or update the metadata of the provisioning service. The usual pattern to modify a property is to retrieve the provisioning service metadata and security metadata, and then combine them with the modified values in a new body to update the provisioning service.", + "x-ms-long-running-operation": true, + "operationId": "IotDpsResource_CreateOrUpdate", + "x-ms-examples": { + "DPSCreate": { + "$ref": "./examples/DPSCreate.json" + }, + "DPSUpdate": { + "$ref": "./examples/DPSUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service to create or update." + }, + { + "name": "iotDpsDescription", + "in": "body", + "required": true, + "description": "Description of the provisioning service to create or update.", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescription" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The body contains all the non-security properties of the provisioning service. Security-related properties are set to null.", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescription" + } + }, + "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/ProvisioningServiceDescription" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "patch": { + "tags": [ + "IotDpsResource" + ], + "summary": "Update an existing provisioning service's tags.", + "description": "Update an existing provisioning service's tags. to update other fields use the CreateOrUpdate method", + "x-ms-long-running-operation": true, + "operationId": "IotDpsResource_Update", + "x-ms-examples": { + "DPSPatch": { + "$ref": "./examples/DPSPatch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service to create or update." + }, + { + "name": "ProvisioningServiceTags", + "in": "body", + "required": true, + "description": "Updated tag information to set into the provisioning service instance.", + "schema": { + "$ref": "#/definitions/TagsResource" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Provisioning Service was successfully updated", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescription" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "IotDpsResource" + ], + "summary": "Delete the Provisioning Service", + "description": "Deletes the Provisioning Service.", + "x-ms-long-running-operation": true, + "operationId": "IotDpsResource_Delete", + "x-ms-examples": { + "DPSDelete": { + "$ref": "./examples/DPSDelete.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service to delete." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "202": { + "description": "The provisioning service 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 provisioning service status directly, or query the operation resource." + }, + "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." + }, + "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 provisioning service 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 provisioning service metadata in the service." + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates": { + "get": { + "tags": [ + "DpsCertificate" + ], + "operationId": "DpsCertificate_List", + "description": "Get all the certificates tied to the provisioning service.", + "x-ms-examples": { + "DPSGetCertificates": { + "$ref": "./examples/DPSGetCertificates.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of resource group." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service to retrieve certificates for." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "List of certificate descriptions in a JSON-serialized array.", + "schema": { + "$ref": "#/definitions/CertificateListDescription" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/provisioningServices": { + "get": { + "tags": [ + "IotDpsResource" + ], + "summary": "Get all the provisioning services in a subscription.", + "description": "List all the provisioning services for a given subscription id.", + "operationId": "IotDpsResource_ListBySubscription", + "x-ms-examples": { + "DPSListBySubscription": { + "$ref": "./examples/DPSListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the provisioning services in the subscription.", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescriptionListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices": { + "get": { + "tags": [ + "IotDpsResource" + ], + "operationId": "IotDpsResource_ListByResourceGroup", + "description": "Get a list of all provisioning services in the given resource group.", + "x-ms-examples": { + "DPSListByResourceGroup": { + "$ref": "./examples/DPSListByResourceGroup.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "List of provisioning services in the resource group.", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescriptionListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/operationresults/{operationId}": { + "get": { + "tags": [ + "IotDpsResource" + ], + "operationId": "IotDpsResource_GetOperationResult", + "description": "Gets the status of a long running operation, such as create, update or delete a provisioning service.", + "x-ms-examples": { + "DPSGetOperationResult": { + "$ref": "./examples/DPSGetOperationResult.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "Operation id corresponding to long running operation. Use this to poll for the status." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service that the operation is running on." + }, + { + "name": "asyncinfo", + "in": "query", + "description": "Async header used to poll on the status of the operation, obtained while creating the long running operation.", + "required": true, + "type": "string", + "default": "true" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The status of the long running operation.", + "schema": { + "$ref": "#/definitions/AsyncOperationResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/skus": { + "get": { + "tags": [ + "IotDpsResource" + ], + "summary": "Get the list of valid SKUs for a provisioning service.", + "description": "Gets the list of valid SKUs and tiers for a provisioning service.", + "operationId": "IotDpsResource_listValidSkus", + "x-ms-examples": { + "DPSGetValidSku": { + "$ref": "./examples/DPSGetValidSku.json" + } + }, + "parameters": [ + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of resource group." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the valid SKUs for this provisioning service.", + "schema": { + "$ref": "#/definitions/IotDpsSkuDefinitionListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/generateVerificationCode": { + "post": { + "tags": [ + "DpsCertificate" + ], + "operationId": "DpsCertificate_GenerateVerificationCode", + "description": "Generate verification code for Proof of Possession.", + "x-ms-examples": { + "DPSGenerateVerificationCode": { + "$ref": "./examples/DPSGenerateVerificationCode.json" + } + }, + "parameters": [ + { + "name": "certificateName", + "in": "path", + "required": true, + "type": "string", + "description": "The mandatory logical name of the certificate, that the provisioning service uses to access." + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "name of resource group." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service." + }, + { + "name": "certificate.name", + "in": "query", + "required": false, + "type": "string", + "description": "Common Name for the certificate." + }, + { + "name": "certificate.rawBytes", + "in": "query", + "required": false, + "type": "string", + "format": "byte", + "description": "Raw data of certificate." + }, + { + "name": "certificate.isVerified", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates if the certificate has been verified by owner of the private key." + }, + { + "name": "certificate.purpose", + "in": "query", + "required": false, + "type": "string", + "description": "Description mentioning the purpose of the certificate.", + "enum": [ + "clientAuthentication", + "serverAuthentication" + ], + "x-ms-enum": { + "name": "CertificatePurpose", + "modelAsString": true + } + }, + { + "name": "certificate.created", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "Certificate creation time." + }, + { + "name": "certificate.lastUpdated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "Certificate last updated time." + }, + { + "name": "certificate.hasPrivateKey", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates if the certificate contains private key." + }, + { + "name": "certificate.nonce", + "in": "query", + "required": false, + "type": "string", + "description": "Random number generated to indicate Proof of Possession." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Generated verification code for that certificate is returned.", + "schema": { + "$ref": "#/definitions/VerificationCodeResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/verify": { + "post": { + "tags": [ + "DpsCertificate" + ], + "operationId": "DpsCertificate_VerifyCertificate", + "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.", + "x-ms-examples": { + "DPSVerifyCertificate": { + "$ref": "./examples/DPSVerifyCertificate.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "certificateName", + "in": "path", + "required": true, + "type": "string", + "description": "The mandatory logical name of the certificate, that the provisioning service uses to access." + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "ETag of the certificate." + }, + { + "name": "request", + "in": "body", + "required": true, + "description": "The name of the certificate", + "schema": { + "$ref": "#/definitions/VerificationCodeRequest" + } + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group name." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Provisioning service name." + }, + { + "name": "certificate.name", + "in": "query", + "required": false, + "type": "string", + "description": "Common Name for the certificate." + }, + { + "name": "certificate.rawBytes", + "in": "query", + "required": false, + "type": "string", + "format": "byte", + "description": "Raw data of certificate." + }, + { + "name": "certificate.isVerified", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates if the certificate has been verified by owner of the private key." + }, + { + "name": "certificate.purpose", + "in": "query", + "required": false, + "description": "Describe the purpose of the certificate.", + "type": "string", + "enum": [ + "clientAuthentication", + "serverAuthentication" + ], + "x-ms-enum": { + "name": "CertificatePurpose", + "modelAsString": true + } + }, + { + "name": "certificate.created", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "Certificate creation time." + }, + { + "name": "certificate.lastUpdated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "Certificate last updated time." + }, + { + "name": "certificate.hasPrivateKey", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates if the certificate contains private key." + }, + { + "name": "certificate.nonce", + "in": "query", + "required": false, + "type": "string", + "description": "Random number generated to indicate Proof of Possession." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CertificateResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkProvisioningServiceNameAvailability": { + "post": { + "tags": [ + "IotDpsResource" + ], + "operationId": "IotDpsResource_CheckProvisioningServiceNameAvailability", + "x-ms-examples": { + "DPSCheckName": { + "$ref": "./examples/DPSCheckNameAvailability.json" + } + }, + "summary": "Check if a provisioning service name is available.", + "description": "Check if a provisioning service name is available. This will validate if the name is syntactically valid and if the name is usable", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "arguments", + "in": "body", + "required": true, + "description": "Set the name parameter in the OperationInputs structure to the name of the provisioning service to check.", + "schema": { + "$ref": "#/definitions/OperationInputs" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the provisioning service name is available. If the name is not available, the body contains the reason.", + "schema": { + "$ref": "#/definitions/NameAvailabilityInfo" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/listkeys": { + "post": { + "tags": [ + "IotDpsResource" + ], + "operationId": "IotDpsResource_ListKeys", + "x-ms-examples": { + "DPSListKeys": { + "$ref": "./examples/DPSListKeys.json" + } + }, + "summary": "Get the security metadata for a provisioning service.", + "description": "List the primary and secondary keys for a provisioning service.", + "parameters": [ + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The provisioning service name to get the shared access keys for." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "resource group name" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "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 provisioning service endpoints.", + "schema": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRuleListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/keys/{keyName}/listkeys": { + "post": { + "tags": [ + "IotDpsResource" + ], + "operationId": "IotDpsResource_ListKeysForKeyName", + "x-ms-examples": { + "DPSGetKey": { + "$ref": "./examples/DPSGetKey.json" + } + }, + "summary": "Get a shared access policy by name from a provisioning service.", + "description": "List primary and secondary keys for a specific key name", + "parameters": [ + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the provisioning service." + }, + { + "name": "keyName", + "in": "path", + "required": true, + "type": "string", + "description": "Logical key name to get key-values for." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The name of the resource group that contains the provisioning service.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "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 provisioning service endpoints.", + "schema": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule[AccessRightsDescription]" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "IotDpsResource" + ], + "summary": "List private link resources", + "description": "List private link resources for the given provisioning service", + "operationId": "IotDpsResource_ListPrivateLinkResources", + "x-ms-examples": { + "PrivateLinkResources_List": { + "$ref": "./examples/DPSListPrivateLinkResources.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/provisioningServices/{resourceName}/privateLinkResources/{groupId}": { + "get": { + "tags": [ + "IotDpsResource" + ], + "summary": "Get the specified private link resource", + "description": "Get the specified private link resource for the given provisioning service", + "operationId": "IotDpsResource_GetPrivateLinkResources", + "x-ms-examples": { + "PrivateLinkResources_List": { + "$ref": "./examples/DPSGetPrivateLinkResources.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/provisioningServices/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "IotDpsResource" + ], + "summary": "List private endpoint connections", + "description": "List private endpoint connection properties", + "operationId": "IotDpsResource_ListPrivateEndpointConnections", + "x-ms-examples": { + "PrivateEndpointConnections_List": { + "$ref": "./examples/DPSListPrivateEndpointConnections.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/provisioningServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "IotDpsResource" + ], + "summary": "Get private endpoint connection", + "description": "Get private endpoint connection properties", + "operationId": "IotDpsResource_GetPrivateEndpointConnection", + "x-ms-examples": { + "PrivateEndpointConnection_Get": { + "$ref": "./examples/DPSGetPrivateEndpointConnection.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": [ + "IotDpsResource" + ], + "summary": "Create or update private endpoint connection", + "description": "Create or update the status of a private endpoint connection with the specified name", + "operationId": "IotDpsResource_CreateOrUpdatePrivateEndpointConnection", + "x-ms-examples": { + "PrivateEndpointConnection_CreateOrUpdate": { + "$ref": "./examples/DPSCreateOrUpdatePrivateEndpointConnection.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": [ + "IotDpsResource" + ], + "summary": "Delete private endpoint connection", + "description": "Delete private endpoint connection with the specified name", + "operationId": "IotDpsResource_DeletePrivateEndpointConnection", + "x-ms-examples": { + "PrivateEndpointConnection_Delete": { + "$ref": "./examples/DPSDeletePrivateEndpointConnection.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" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "Operation Status Location URI" + }, + "Location": { + "type": "string", + "description": "Operation Status Location URI" + }, + "Retry-After": { + "description": "Retry After", + "type": "string" + } + } + }, + "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": { + "AsyncOperationResult": { + "type": "object", + "description": "Result of a long running operation.", + "properties": { + "status": { + "description": "current status of a long running operation.", + "type": "string" + }, + "error": { + "description": "Error message containing code, description and details", + "$ref": "#/definitions/ErrorMessage" + } + } + }, + "ErrorMessage": { + "description": "Error response containing message and code.", + "type": "object", + "properties": { + "code": { + "description": "standard error code", + "type": "string" + }, + "message": { + "description": "standard error description", + "type": "string" + }, + "details": { + "description": "detailed summary of error", + "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/CertificateResponse" + } + } + } + }, + "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" + }, + "isVerified": { + "description": "True indicates that the certificate will be created in verified state and proof of possession will not be required.", + "type": "boolean" + } + } + }, + "CertificateResponse": { + "description": "The X509 Certificate.", + "type": "object", + "properties": { + "properties": { + "description": "properties of a certificate", + "$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." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "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" + }, + "certificate": { + "description": "base-64 representation of X509 certificate .cer file or just .pem file content.", + "type": "string", + "format": "byte" + }, + "created": { + "description": "The certificate's creation 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 + } + } + }, + "IotDpsSkuInfo": { + "type": "object", + "description": "List of possible provisioning service SKUs.", + "properties": { + "name": { + "description": "Sku name.", + "enum": [ + "S1" + ], + "type": "string", + "x-ms-enum": { + "name": "IotDpsSku", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "readOnly": true, + "description": "Pricing tier name of the provisioning service." + }, + "capacity": { + "format": "int64", + "type": "integer", + "description": "The number of units to provision" + } + } + }, + "ProvisioningServiceDescription": { + "description": "The description of the provisioning service.", + "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": "Service specific properties for a provisioning service", + "$ref": "#/definitions/IotDpsPropertiesDescription" + }, + "sku": { + "description": "Sku info for a provisioning Service.", + "$ref": "#/definitions/IotDpsSkuInfo" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "identity": { + "description": "The managed identities for a provisioning service.", + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "sku", + "properties" + ] + }, + "IotDpsPropertiesDescription": { + "description": "the service specific properties of a provisioning service, including keys, linked iot hubs, current state, and system generated properties such as hostname and idScope", + "type": "object", + "properties": { + "state": { + "description": "Current state of the provisioning service.", + "enum": [ + "Activating", + "Active", + "Deleting", + "Deleted", + "ActivationFailed", + "DeletionFailed", + "Transitioning", + "Suspending", + "Suspended", + "Resuming", + "FailingOver", + "FailoverFailed" + ], + "type": "string", + "x-ms-enum": { + "name": "state", + "modelAsString": true + } + }, + "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" + } + }, + "privateEndpointConnections": { + "description": "Private endpoint connections created on this IotHub", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "provisioningState": { + "description": "The ARM provisioning state of the provisioning service.", + "type": "string" + }, + "iotHubs": { + "type": "array", + "description": "List of IoT hubs associated with this provisioning service.", + "items": { + "$ref": "#/definitions/IotHubDefinitionDescription" + } + }, + "allocationPolicy": { + "enum": [ + "Hashed", + "GeoLatency", + "Static" + ], + "type": "string", + "description": "Allocation policy to be used by this provisioning service.", + "x-ms-enum": { + "name": "AllocationPolicy", + "modelAsString": true + } + }, + "serviceOperationsHostName": { + "description": "Service endpoint for provisioning service.", + "type": "string", + "readOnly": true + }, + "deviceProvisioningHostName": { + "type": "string", + "description": "Device endpoint for this provisioning service.", + "readOnly": true + }, + "idScope": { + "type": "string", + "description": "Unique identifier of this provisioning service.", + "readOnly": true + }, + "authorizationPolicies": { + "description": "List of authorization keys for a provisioning service.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule[AccessRightsDescription]" + } + }, + "enableDataResidency": { + "type": "boolean", + "description": "Optional.\nIndicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery." + }, + "portalOperationsHostName": { + "type": "string", + "description": "Portal endpoint to enable CORS for this provisioning service." + } + } + }, + "IotHubDefinitionDescription": { + "type": "object", + "description": "Description of the IoT hub.", + "properties": { + "applyAllocationPolicy": { + "description": "flag for applying allocationPolicy or not for a given iot hub.", + "type": "boolean" + }, + "allocationWeight": { + "description": "weight to apply for a given iot h.", + "format": "int32", + "type": "integer" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Host name of the IoT hub." + }, + "connectionString": { + "type": "string", + "description": "Connection string of the IoT hub." + }, + "location": { + "type": "string", + "description": "ARM region of the IoT hub." + }, + "authenticationType": { + "description": "IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned.", + "enum": [ + "KeyBased", + "UserAssigned", + "SystemAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "IotHubAuthenticationType", + "modelAsString": true + } + }, + "selectedUserAssignedIdentityResourceId": { + "type": "string", + "format": "arm-id", + "description": "The selected user-assigned identity resource Id associated with IoT Hub. This is required when authenticationType is UserAssigned.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ] + } + } + }, + "required": [ + "location" + ] + }, + "IpFilterRule": { + "description": "The IP filter rules for a provisioning Service.", + "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" + }, + "target": { + "description": "Target for requests captured by this rule.", + "enum": [ + "all", + "serviceApi", + "deviceApi" + ], + "type": "string", + "x-ms-enum": { + "name": "IpFilterTargetType", + "modelAsString": false + } + } + }, + "required": [ + "filterName", + "action", + "ipMask" + ] + }, + "PrivateLinkResources": { + "description": "The available private link resources for a provisioning service", + "type": "object", + "properties": { + "value": { + "description": "The list of available private link resources for a provisioning service", + "type": "array", + "items": { + "$ref": "#/definitions/GroupIdInformation" + } + } + } + }, + "GroupIdInformation": { + "description": "The group information for creating a private endpoint on a provisioning service", + "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": { + "description": "The properties for a group information object", + "$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 a provisioning service", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "PrivateEndpointConnection": { + "description": "The private endpoint connection of a provisioning service", + "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": { + "description": "The properties of a private endpoint connection", + "$ref": "#/definitions/PrivateEndpointConnectionProperties" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + }, + "required": [ + "properties" + ] + }, + "PrivateEndpointConnectionProperties": { + "description": "The properties of a private endpoint connection", + "type": "object", + "properties": { + "privateEndpoint": { + "description": "The private endpoint property of a private endpoint connection", + "$ref": "#/definitions/PrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "description": "The current state of a private endpoint connection", + "$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" + ] + }, + "SharedAccessSignatureAuthorizationRule[AccessRightsDescription]": { + "type": "object", + "description": "Description of the shared access key.", + "properties": { + "keyName": { + "type": "string", + "description": "Name of the key." + }, + "primaryKey": { + "type": "string", + "description": "Primary SAS key value." + }, + "secondaryKey": { + "type": "string", + "description": "Secondary SAS key value." + }, + "rights": { + "description": "Rights that this key has.", + "enum": [ + "ServiceConfig", + "EnrollmentRead", + "EnrollmentWrite", + "DeviceConnect", + "RegistrationStatusRead", + "RegistrationStatusWrite" + ], + "type": "string", + "x-ms-enum": { + "name": "AccessRightsDescription", + "modelAsString": true + } + } + }, + "required": [ + "keyName", + "rights" + ] + }, + "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." + }, + "resourcegroup": { + "type": "string", + "description": "The resource group of the resource." + }, + "subscriptionid": { + "type": "string", + "description": "The subscription id of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + }, + "x-ms-azure-resource": true, + "required": [ + "location" + ] + }, + "OperationListResult": { + "description": "Result of the request to list provisioning service operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "Provisioning service 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": "Provisioning Service 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: ProvisioningServices." + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Name of the operation." + } + } + } + } + }, + "ErrorDetails": { + "description": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "format": "int32", + "type": "integer", + "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 + } + } + }, + "SharedAccessSignatureAuthorizationRuleListResult": { + "type": "object", + "description": "List of shared access keys.", + "properties": { + "value": { + "description": "The list of shared access policies.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule[AccessRightsDescription]" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "IotDpsSkuDefinitionListResult": { + "type": "object", + "description": "List of available SKUs.", + "properties": { + "value": { + "description": "The list of SKUs", + "type": "array", + "items": { + "$ref": "#/definitions/IotDpsSkuDefinition" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "IotDpsSkuDefinition": { + "type": "object", + "description": "Available SKUs of tier and units.", + "properties": { + "name": { + "description": "Sku name.", + "enum": [ + "S1" + ], + "type": "string", + "x-ms-enum": { + "name": "IotDpsSku", + "modelAsString": true + } + } + } + }, + "OperationInputs": { + "description": "Input values for operation results call.", + "type": "object", + "properties": { + "name": { + "description": "The name of the Provisioning Service to check.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "NameAvailabilityInfo": { + "type": "object", + "description": "Description of name availability.", + "properties": { + "nameAvailable": { + "description": "specifies if a name is available or not", + "type": "boolean" + }, + "reason": { + "description": "specifies the reason a name is unavailable", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "x-ms-enum": { + "name": "NameUnavailabilityReason", + "modelAsString": true + } + }, + "message": { + "description": "message containing a detailed reason name is unavailable", + "type": "string" + } + } + }, + "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 a Provisioning Service instance." + }, + "ProvisioningServiceDescriptionListResult": { + "type": "object", + "description": "List of provisioning service descriptions.", + "properties": { + "value": { + "description": "List of provisioning service descriptions.", + "type": "array", + "items": { + "$ref": "#/definitions/ProvisioningServiceDescription" + } + }, + "nextLink": { + "description": "the next link", + "type": "string", + "readOnly": true + } + } + }, + "VerificationCodeResponse": { + "type": "object", + "description": "Description of the response of the verification code.", + "properties": { + "name": { + "type": "string", + "description": "Name of certificate.", + "readOnly": true + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "Request etag." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "type": "object", + "properties": { + "verificationCode": { + "type": "string", + "description": "Verification code." + }, + "subject": { + "type": "string", + "description": "Certificate subject." + }, + "expiry": { + "type": "string", + "description": "Code expiry." + }, + "thumbprint": { + "type": "string", + "description": "Certificate thumbprint." + }, + "isVerified": { + "type": "boolean", + "description": "Indicate if the certificate is verified by owner of private key." + }, + "certificate": { + "description": "base-64 representation of X509 certificate .cer file or just .pem file content.", + "type": "string", + "format": "byte" + }, + "created": { + "type": "string", + "description": "Certificate created time." + }, + "updated": { + "type": "string", + "description": "Certificate updated time." + } + } + } + }, + "x-ms-azure-resource": true + }, + "VerificationCodeRequest": { + "type": "object", + "description": "The JSON-serialized leaf certificate", + "properties": { + "certificate": { + "description": "base-64 representation of X509 certificate .cer file or just .pem file content.", + "type": "string" + } + } + } + }, + "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 provisioning service.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the provisioning service.", + "required": true, + "type": "string", + "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/deviceprovisioningservices/resource-manager/readme.md b/specification/deviceprovisioningservices/resource-manager/readme.md index 2bfdcf86e814..23b469e6f14a 100644 --- a/specification/deviceprovisioningservices/resource-manager/readme.md +++ b/specification/deviceprovisioningservices/resource-manager/readme.md @@ -27,10 +27,18 @@ These are the global settings for the API. ``` yaml openapi-type: arm azure-arm: true -tag: package-preview-2023-03 +tag: package-preview-2025-02 ``` +### Tag: package-preview-2025-02 + +These settings apply only when `--tag=package-preview-2025-02` is specified on the command line. + +```yaml $(tag) == 'package-preview-2025-02' +input-file: + - Microsoft.Devices/preview/2025-02-01-preview/iotdps.json +``` ### Tag: package-preview-2023-03 These settings apply only when `--tag=package-preview-2023-03` is specified on the command line. From 39cc29c14aa67059b22e1fca64eafa53c9c3a593 Mon Sep 17 00:00:00 2001 From: Pan Shao <97225342+pshao25@users.noreply.github.com> Date: Sun, 29 Sep 2024 10:35:02 +0800 Subject: [PATCH 40/48] update document for DPG sdk-automation (#30457) * update document for DPG sdk-automation * update --------- Co-authored-by: Pan Shao --- .../.net/README.md | 28 +++++++------------ 1 file changed, 10 insertions(+), 18 deletions(-) diff --git a/documentation/onboard-dpg-in-sdkautomation/.net/README.md b/documentation/onboard-dpg-in-sdkautomation/.net/README.md index c4d4ec97060b..3c071bd90db4 100644 --- a/documentation/onboard-dpg-in-sdkautomation/.net/README.md +++ b/documentation/onboard-dpg-in-sdkautomation/.net/README.md @@ -1,22 +1,14 @@ -# Add Autorest Configuration of .Net SDK +# Add TypeSpec Configuration of .Net SDK -## Parameter Description +Please copy the following configuration into `tspconfig.yaml` in your spec folder and replace `package-dir` and `namespace` to your own values. -- ``: The RP name, which is usually same as folder name in swagger. -- ``: Python package name. -- ``: SDK Client Name. It's optional if there is a title defined in spec readme.md file. - -## Autorest Configuration -Please copy the following configuration into spec PR comment. -~~~ -# azure-sdk-for-net-track2 ``` yaml -title: <Title> -output-folder: sdk/<ServiceName>/<NameSpace> -require: - - specification/<RPName>/data-plane/readme.md + "@azure-tools/typespec-csharp": + package-dir: "Azure.AI.Vision.Face" + flavor: azure + namespace: "{package-dir}" ``` -~~~ -- `title`: If it's already defined in spec readme.md, you don't need to define it here again. (By default, there is no `title` defined in spec readme.md in multi client scenario.) -- `output-folder`: The relative path of destination to generate SDK. -- `require`: The item of the value is the relative path of spec readme.md file. + +- `package-dir`: Name of your package directory. It should be several parts concatenated with `.` and all the paerts should be pascal case. +- `flavor`: Always `azure` for Azure SDK. +- `namespace`: Should be the same as `package-dir`. From 778fdb20839c487eba95a6b161812ad9d9d6337d Mon Sep 17 00:00:00 2001 From: tsaiggo <yangcai@microsoft.com> Date: Sun, 29 Sep 2024 11:42:48 +0800 Subject: [PATCH 41/48] Fix PGSQL V2 missing auth type (#30552) * Fix PGSQL V2 missing auth type * Update sdk-suppressions.yaml --------- Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> --- .../stable/2018-06-01/entityTypes/LinkedService.json | 8 +++++++- .../datafactory/resource-manager/sdk-suppressions.yaml | 1 + .../stable/2020-12-01/entityTypes/LinkedService.json | 7 ++++++- 3 files changed, 14 insertions(+), 2 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index 1d953301708b..3d5f1ee81e26 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 @@ -1939,6 +1939,11 @@ "x-ms-format": "dfe-string", "description": "Database name for connection. Type: string." }, + "authenticationType": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The authentication type to use. Type: string." + }, "sslMode": { "type": "object", "x-ms-format": "dfe-int", @@ -2017,7 +2022,8 @@ "server", "username", "database", - "sslMode" + "sslMode", + "authenticationType" ] }, "SybaseLinkedService": { diff --git a/specification/datafactory/resource-manager/sdk-suppressions.yaml b/specification/datafactory/resource-manager/sdk-suppressions.yaml index b22077464b74..cbeef851b326 100644 --- a/specification/datafactory/resource-manager/sdk-suppressions.yaml +++ b/specification/datafactory/resource-manager/sdk-suppressions.yaml @@ -13,3 +13,4 @@ suppressions: - package: "@azure/arm-datafactory" breaking-changes: - Interface HDInsightOnDemandLinkedService has a new required parameter versionTypePropertiesVersion + - Interface PostgreSqlV2LinkedService has a new required parameter authenticationType diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json index 4eba34e78a99..b057e1e32b20 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json @@ -1680,6 +1680,10 @@ "type": "object", "description": "Database name for connection. Type: string." }, + "authenticationType": { + "type": "object", + "description": "The authentication type to use. Type: string." + }, "sslMode": { "type": "object", "description": "SSL mode for connection. Type: integer. 0: disable, 1:allow, 2: prefer, 3: require, 4: verify-ca, 5: verify-full. Type: integer." @@ -1745,7 +1749,8 @@ "server", "username", "database", - "sslMode" + "sslMode", + "authenticationType" ] }, "SybaseLinkedService": { From b61dcef24c4dbd9d1c26e321c9ea67465a5d8be7 Mon Sep 17 00:00:00 2001 From: t-ivrihikri <112947032+t-ivrihikri@users.noreply.github.com> Date: Sun, 29 Sep 2024 09:27:28 +0300 Subject: [PATCH 42/48] New API Version From 2024-04-01, Including Total Minutes Indexed (#30684) * First commit - deep copy * Added new field * Editting Readme * another update to readme * Last update for readme.md * Changed and compared to Mani's PR 5 months ago --- .../ViAccountCheckNameAvailabilityFree.json | 17 + .../ViAccountCheckNameAvailabilityTaken.json | 19 + .../examples/ViAccountDelete.json | 13 + .../examples/ViAccountGet.json | 46 + .../PatchAccountWithSystemAssignedMi.json | 49 + .../PatchAccountWithUserAssignedMi.json | 66 + ...ountToArmAccountUsingSystemAssignedMI.json | 72 ++ ...ccountToArmAccountUsingUserAssignedMi.json | 86 ++ ...teOrUpdateAccountWithSystemAssignedMi.json | 80 ++ ...eateOrUpdateAccountWithUserAssignedMi.json | 106 ++ .../examples/ViAccountsList.json | 49 + .../ViAccountsListByResourceGroup.json | 50 + ...GenerateAccountContributerAccessToken.json | 19 + .../ViGenerateAccountReaderAccessToken.json | 19 + ...GenerateProjectContributerAccessToken.json | 20 + .../ViGenerateProjectReaderAccessToken.json | 20 + ...ViGenerateVideoContributerAccessToken.json | 20 + .../ViGenerateVideoReaderAccessToken.json | 20 + ...ateAccountRestrictedViewerAccessToken.json | 18 + ...ateProjectRestrictedViewerAccessToken.json | 19 + ...erateVideoRestrictedViewerAccessToken.json | 19 + .../examples/ViOperationsList.json | 40 + .../preview/2024-09-23-preview/vi.json | 1076 +++++++++++++++++ specification/vi/resource-manager/readme.md | 11 + 24 files changed, 1954 insertions(+) create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountCheckNameAvailabilityFree.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountCheckNameAvailabilityTaken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountDelete.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountGet.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPatch/PatchAccountWithSystemAssignedMi.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPatch/PatchAccountWithUserAssignedMi.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingSystemAssignedMI.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingUserAssignedMi.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/CreateOrUpdateAccountWithSystemAssignedMi.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/CreateOrUpdateAccountWithUserAssignedMi.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountsList.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountsListByResourceGroup.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateAccountRestrictedViewerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateProjectRestrictedViewerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateVideoRestrictedViewerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViOperationsList.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/vi.json diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountCheckNameAvailabilityFree.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountCheckNameAvailabilityFree.json new file mode 100644 index 000000000000..e059a4547ac0 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountCheckNameAvailabilityFree.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-09-23-preview", + "subscriptionId": "586d4f48-8f08-4a4e-96b7-e1892d6dba9e", + "checkNameAvailabilityParameters": { + "name": "vi1", + "type": "Microsoft.VideoIndexer/accounts" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountCheckNameAvailabilityTaken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountCheckNameAvailabilityTaken.json new file mode 100644 index 000000000000..80885075d4d7 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountCheckNameAvailabilityTaken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-09-23-preview", + "subscriptionId": "586d4f48-8f08-4a4e-96b7-e1892d6dba9e", + "checkNameAvailabilityParameters": { + "name": "vi1", + "type": "Microsoft.VideoIndexer/accounts" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "Resource name already exists" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountDelete.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountDelete.json new file mode 100644 index 000000000000..0225c76e84fe --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contoso-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountGet.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountGet.json new file mode 100644 index 000000000000..68526f20ed9d --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountGet.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contoso-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "586d4f48-8f08-4a4e-96b7-e1892d6dba9e" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-videoanalyzer", + "name": "vi1", + "type": "Microsoft.VideoIndexer/accounts", + "location": "NorthEurope", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2" + }, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + }, + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2": { + "principalId": "d2844978-40e3-4b7d-af13-cb6eeebd2726", + "clientId": "433ac7cb-6071-4052-ba31-65d9e26e21ed" + } + } + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPatch/PatchAccountWithSystemAssignedMi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPatch/PatchAccountWithSystemAssignedMi.json new file mode 100644 index 000000000000..4945fbc30995 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPatch/PatchAccountWithSystemAssignedMi.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contoso-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "properties": { + "storageServices": {}, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + } + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "43a83441-c17f-4e06-84a3-2eaf86668da7", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPatch/PatchAccountWithUserAssignedMi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPatch/PatchAccountWithUserAssignedMi.json new file mode 100644 index 000000000000..935bc4354167 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPatch/PatchAccountWithUserAssignedMi.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "properties": { + "storageServices": { + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {}, + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + }, + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2": { + "principalId": "d2844978-40e3-4b7d-af13-cb6eeebd2726", + "clientId": "433ac7cb-6071-4052-ba31-65d9e26e21ed" + } + } + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingSystemAssignedMI.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingSystemAssignedMI.json new file mode 100644 index 000000000000..1a7119f362c8 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingSystemAssignedMI.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms" + } + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "43a83441-c17f-4e06-84a3-2eaf86668da7", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "43a83441-c17f-4e06-84a3-2eaf86668da7", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingUserAssignedMi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingUserAssignedMi.json new file mode 100644 index 000000000000..c8883260a9a4 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingUserAssignedMi.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/CreateOrUpdateAccountWithSystemAssignedMi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/CreateOrUpdateAccountWithSystemAssignedMi.json new file mode 100644 index 000000000000..264693ebf9cc --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/CreateOrUpdateAccountWithSystemAssignedMi.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + } + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "43a83441-c17f-4e06-84a3-2eaf86668da7", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "43a83441-c17f-4e06-84a3-2eaf86668da7", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/CreateOrUpdateAccountWithUserAssignedMi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/CreateOrUpdateAccountWithUserAssignedMi.json new file mode 100644 index 000000000000..4a4964b182c6 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/CreateOrUpdateAccountWithUserAssignedMi.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {}, + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + }, + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-videoindexer", + "name": "contoso-videoindexer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contoso-videoindexer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoindexer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi2" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + }, + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi2": { + "principalId": "d2844978-40e3-4b7d-af13-cb6eeebd2726", + "clientId": "433ac7cb-6071-4052-ba31-65d9e26e21ed" + } + } + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountsList.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountsList.json new file mode 100644 index 000000000000..7db0770aac86 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountsList.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-09-23-preview", + "subscriptionId": "586d4f48-8f08-4a4e-96b7-e1892d6dba9e" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-videoanalyzer", + "name": "vi1", + "type": "Microsoft.VideoIndexer/accounts", + "location": "NorthEurope", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2" + }, + "provisioningState": "Provisioning" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + }, + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2": { + "principalId": "d2844978-40e3-4b7d-af13-cb6eeebd2726", + "clientId": "433ac7cb-6071-4052-ba31-65d9e26e21ed" + } + } + } + } + ], + "nextLink": "link" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountsListByResourceGroup.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountsListByResourceGroup.json new file mode 100644 index 000000000000..0ef3f06cbd1b --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountsListByResourceGroup.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "resourceGroupName": "contoso-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "586d4f48-8f08-4a4e-96b7-e1892d6dba9e" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-videoanalyzer-rg", + "name": "vi1", + "type": "Microsoft.VideoIndexer/accounts", + "location": "NorthEurope", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2" + }, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + }, + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2": { + "principalId": "d2844978-40e3-4b7d-af13-cb6eeebd2726", + "clientId": "433ac7cb-6071-4052-ba31-65d9e26e21ed" + } + } + } + } + ], + "nextLink": "link" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json new file mode 100644 index 000000000000..fdba33d78933 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Contributor", + "scope": "Account" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json new file mode 100644 index 000000000000..18fe4a67f055 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Reader", + "scope": "Account" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken.json new file mode 100644 index 000000000000..356c1057e431 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Contributor", + "scope": "Project", + "projectId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken.json new file mode 100644 index 000000000000..71587dfc5923 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Reader", + "scope": "Project", + "projectId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken.json new file mode 100644 index 000000000000..142cac7282cc --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Contributor", + "scope": "Video", + "videoId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken.json new file mode 100644 index 000000000000..0f23754ea11f --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Reader", + "scope": "Video", + "videoId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateAccountRestrictedViewerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateAccountRestrictedViewerAccessToken.json new file mode 100644 index 000000000000..cf6569bdac6c --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateAccountRestrictedViewerAccessToken.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "accountName": "contosto-azurevideoindexer", + "resourceGroupName": "contosto-azurevideoindexer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "scope": "Account" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateProjectRestrictedViewerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateProjectRestrictedViewerAccessToken.json new file mode 100644 index 000000000000..a90c27d34143 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateProjectRestrictedViewerAccessToken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "contosto-azurevideoindexer", + "resourceGroupName": "contosto-azurevideoindexer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "scope": "Project", + "projectId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateVideoRestrictedViewerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateVideoRestrictedViewerAccessToken.json new file mode 100644 index 000000000000..cc9a68e6e1a7 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateVideoRestrictedViewerAccessToken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "contosto-azurevideoindexer", + "resourceGroupName": "contosto-azurevideoindexer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "scope": "Video", + "videoId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViOperationsList.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViOperationsList.json new file mode 100644 index 000000000000..7c3fc03a4904 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViOperationsList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-09-23-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.VideoIndexer/accounts/read", + "display": { + "provider": "Microsoft Azure Video Indexer", + "resource": "Account", + "operation": "Read accounts", + "description": "Read accounts" + } + }, + { + "name": "Microsoft.VideoIndexer/accounts/write", + "display": { + "provider": "Microsoft Azure Video Indexer", + "resource": "Account", + "operation": "Update accounts", + "description": "Update accounts" + } + }, + { + "name": "Microsoft.VideoIndexer/accounts/delete", + "display": { + "provider": "Microsoft Azure Video Indexer", + "resource": "Account", + "operation": "Delete accounts", + "description": "Delete accounts" + } + } + ] + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/vi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/vi.json new file mode 100644 index 000000000000..2f5048fe2f2c --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/vi.json @@ -0,0 +1,1076 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-23-preview", + "title": "vi", + "description": "Microsoft Azure Video Indexer" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.VideoIndexer/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Azure Video Indexer provider operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "List operations": { + "$ref": "./examples/ViOperationsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.VideoIndexer/checkNameAvailability": { + "post": { + "tags": [ + "NameAvailability" + ], + "operationId": "Accounts_CheckNameAvailability", + "description": "Checks that the Video Indexer account name is valid and is not already in use.", + "x-ms-examples": { + "Check free account name availability": { + "$ref": "./examples/ViAccountCheckNameAvailabilityFree.json" + }, + "Check taken account name availability": { + "$ref": "./examples/ViAccountCheckNameAvailabilityTaken.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "checkNameAvailabilityParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccountCheckNameAvailabilityParameters" + }, + "description": "The name of the Video Indexer account. Name must be unique globally" + } + ], + "responses": { + "200": { + "description": "OK - Operation to check the Video Indexer account name availability was successful. Ok does not indicate the name is available, the body of the response does.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.VideoIndexer/accounts": { + "get": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_List", + "description": "List all Azure Video Indexer accounts available under the subscription", + "x-ms-examples": { + "List accounts": { + "$ref": "./examples/ViAccountsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts": { + "get": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_ListByResourceGroup", + "description": "List all Azure Video Indexer accounts available under the resource group", + "x-ms-examples": { + "List accounts by resource group": { + "$ref": "./examples/ViAccountsListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}": { + "get": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_Get", + "description": "Gets the properties of an Azure Video Indexer account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Azure Video Indexer account properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get account": { + "$ref": "./examples/ViAccountGet.json" + } + } + }, + "patch": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_Update", + "x-ms-long-running-operation": false, + "description": "Updates the properties of an existing Azure Video Indexer account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The parameters to provide for the current Azure Video Indexer account.", + "schema": { + "$ref": "#/definitions/AccountPatch" + } + } + ], + "responses": { + "200": { + "description": "The resource was updated successfully.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch account with system assigned Mi": { + "$ref": "./examples/ViAccountPatch/PatchAccountWithSystemAssignedMi.json" + }, + "Patch account with user assigned Mi": { + "$ref": "./examples/ViAccountPatch/PatchAccountWithUserAssignedMi.json" + } + } + }, + "put": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_CreateOrUpdate", + "description": "Creates or updates an Azure Video Indexer account.", + "x-ms-long-running-operation": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The parameters to provide for the Azure Video Indexer account.", + "schema": { + "$ref": "#/definitions/Account" + } + } + ], + "responses": { + "200": { + "description": "The resource was successfully updated.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "201": { + "description": "The resource was successfully created.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update account with system assigned Mi": { + "$ref": "./examples/ViAccountPut/CreateOrUpdateAccountWithSystemAssignedMi.json" + }, + "Create or update account with user assigned Mi": { + "$ref": "./examples/ViAccountPut/CreateOrUpdateAccountWithUserAssignedMi.json" + }, + "Connect classic account to arm account using system assigned Mi": { + "$ref": "./examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingSystemAssignedMI.json" + }, + "Connect classic account to arm account using user assigned Mi": { + "$ref": "./examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingUserAssignedMi.json" + } + } + }, + "delete": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_Delete", + "description": "Delete an Azure Video Indexer account.", + "x-ms-long-running-operation": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Azure Video Indexer account was successfully deleted." + }, + "202": { + "description": "The Azure Video Indexer account will be deleted asynchronously." + }, + "204": { + "description": "The Azure Video Indexer account does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete account": { + "$ref": "./examples/ViAccountDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/generateAccessToken": { + "post": { + "tags": [ + "AccessToken" + ], + "operationId": "Generate_AccessToken", + "description": "Generate an Azure Video Indexer access token.", + "x-ms-examples": { + "Generate accessToken for video contributor": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken.json" + }, + "Generate accessToken for video reader": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken.json" + }, + "Generate accessToken for project contributor": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken.json" + }, + "Generate accessToken for project reader": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken.json" + }, + "Generate accessToken for account contributor": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json" + }, + "Generate accessToken for account reader": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "x-ms-client-flatten": true, + "description": "The parameters for generating access token", + "schema": { + "$ref": "#/definitions/GenerateAccessTokenParameters" + } + } + ], + "responses": { + "200": { + "description": "The Azure Video Indexer account's access token properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/AccessToken" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/generateRestrictedViewerAccessToken": { + "post": { + "tags": [ + "AccessToken" + ], + "operationId": "Generate_RestrictedViewerAccessToken", + "description": "Generate an Azure Video Indexer restricted viewer access token.", + "x-ms-examples": { + "Generate restricted viewer accessToken for video": { + "$ref": "./examples/ViGenerateRestrictedViewerAccessToken/ViGenerateVideoRestrictedViewerAccessToken.json" + }, + "Generate restricted viewer accessToken for project": { + "$ref": "./examples/ViGenerateRestrictedViewerAccessToken/ViGenerateProjectRestrictedViewerAccessToken.json" + }, + "Generate restricted viewer accessToken for account": { + "$ref": "./examples/ViGenerateRestrictedViewerAccessToken/ViGenerateAccountRestrictedViewerAccessToken.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "x-ms-client-flatten": true, + "description": "The parameters for generating restricted viewer access token", + "schema": { + "$ref": "#/definitions/GenerateRestrictedViewerAccessTokenParameters" + } + } + ], + "responses": { + "200": { + "description": "The Azure Video Indexer account's access token properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/AccessToken" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Tags": { + "type": "object", + "description": "Resource tags", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags" + } + } + }, + "Account": { + "description": "An Azure Video Indexer account.", + "type": "object", + "properties": { + "properties": { + "description": "List of account properties", + "type": "object", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccountPropertiesForPutRequest" + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ] + }, + "AccountPatch": { + "type": "object", + "description": "Azure Video Indexer account", + "properties": { + "properties": { + "description": "List of account properties", + "type": "object", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccountPropertiesForPatchRequest" + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Tags" + } + ] + }, + "AccountPropertiesForPutRequest": { + "description": "Azure Video Indexer account properties", + "type": "object", + "properties": { + "tenantId": { + "description": "The account's tenant id", + "type": "string", + "readOnly": true, + "example": "2b9bcf6d-39d5-460a-a6bb-7b40b7ccf139" + }, + "accountId": { + "description": "The account's data-plane ID. This can be set only when connecting an existing classic account", + "type": "string", + "default": "00000000-0000-0000-0000-000000000000", + "example": "3575690b-a569-449c-ab7b-11020f948f76" + }, + "accountName": { + "description": "The account's name", + "type": "string", + "readOnly": true, + "example": "contoso-videoAnalyzer" + }, + "storageServices": { + "description": "The storage services details", + "type": "object", + "$ref": "#/definitions/StorageServicesForPutRequest" + }, + "openAiServices": { + "description": "The openAi services details", + "type": "object", + "$ref": "#/definitions/OpenAiServicesForPutRequest" + }, + "totalSecondsIndexed": { + "description": "An integer representing the total seconds that have been indexed on the account", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "totalMinutesIndexed": { + "description": "An integer representing the total minutes that have been indexed on the account", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the account at the time the operation was called.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning", + "Deleting" + ], + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + } + } + }, + "AccountPropertiesForPatchRequest": { + "description": "Azure Video Indexer account properties", + "type": "object", + "properties": { + "tenantId": { + "description": "The account's tenant id", + "type": "string", + "readOnly": true, + "example": "2b9bcf6d-39d5-460a-a6bb-7b40b7ccf139" + }, + "accountId": { + "description": "The account's data-plane ID", + "readOnly": true, + "type": "string", + "example": "3575690b-a569-449c-ab7b-11020f948f76" + }, + "storageServices": { + "description": "The storage services details", + "type": "object", + "$ref": "#/definitions/StorageServicesForPatchRequest" + }, + "openAiServices": { + "description": "The openAi services details", + "type": "object", + "$ref": "#/definitions/OpenAiServicesForPatchRequest" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the account at the time the operation was called.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning", + "Deleting" + ], + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + } + } + }, + "AccountList": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Account" + }, + "description": "List of accounts and their properties." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any.", + "example": "https://management.azure.com/{accountsOperation}?api-version={version}&%24skiptoken={token}" + } + }, + "description": "The list operation response, that contains the data pools and their properties.", + "type": "object" + }, + "GenerateAccessTokenParameters": { + "description": "Access token generation request's parameters", + "type": "object", + "required": [ + "permissionType", + "scope" + ], + "properties": { + "permissionType": { + "type": "string", + "description": "The requested permission", + "enum": [ + "Contributor", + "Reader" + ], + "x-ms-enum": { + "name": "permissionType", + "modelAsString": true + } + }, + "scope": { + "type": "string", + "description": "The requested media type", + "enum": [ + "Video", + "Account", + "Project" + ], + "x-ms-enum": { + "name": "scope", + "modelAsString": true + } + }, + "videoId": { + "description": "The video ID", + "type": "string", + "example": "07ec9e38d4" + }, + "projectId": { + "description": "The project ID", + "type": "string" + } + } + }, + "GenerateRestrictedViewerAccessTokenParameters": { + "description": "Restricted viewer access token generation request's parameters", + "type": "object", + "required": [ + "scope" + ], + "properties": { + "scope": { + "type": "string", + "description": "The requested media type", + "enum": [ + "Video", + "Account", + "Project" + ], + "x-ms-enum": { + "name": "scope", + "modelAsString": true + } + }, + "videoId": { + "description": "The video ID", + "type": "string", + "example": "07ec9e38d4" + }, + "projectId": { + "description": "The project ID", + "type": "string" + } + } + }, + "StorageServicesForPutRequest": { + "description": "The storage services details", + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Storage/storageAccounts" + } + ] + }, + "description": "The storage services resource id", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoAnalyzer-ms" + }, + "userAssignedIdentity": { + "type": "string", + "description": "The user assigned identity to be used to grant permissions", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoAnalyzer-mi" + } + } + }, + "OpenAiServicesForPutRequest": { + "description": "The openAi services details", + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.CognitiveServices/accounts" + } + ] + }, + "description": "The openAi services resource id", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + }, + "userAssignedIdentity": { + "type": "string", + "description": "The user assigned identity to be used to grant permissions", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoAnalyzer-mi" + } + } + }, + "StorageServicesForPatchRequest": { + "description": "The storage services details", + "type": "object", + "properties": { + "userAssignedIdentity": { + "type": "string", + "description": "The user assigned identity to be used to grant permissions", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoAnalyzer-mi" + } + } + }, + "OpenAiServicesForPatchRequest": { + "description": "The openAi services details", + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.CognitiveServices/accounts" + } + ] + }, + "description": "The openAi services resource id", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + }, + "userAssignedIdentity": { + "type": "string", + "description": "The user assigned identity to be used to grant permissions", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoAnalyzer-mi" + } + } + }, + "AccessToken": { + "description": "Azure Video Indexer access token.", + "type": "object", + "properties": { + "accessToken": { + "type": "string", + "readOnly": true, + "description": "The access token.", + "x-ms-secret": true, + "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJPbmxpbmUgSldUIEJ1aWxkZXIiLCJpYXQiOjE2MjI0NDc3MzMsImV4cCI6MTY1Mzk4MzczMywiYXVkIjoid3d3LmV4YW1wbGUuY29tIiwic3ViIjoianJvY2tldEBleGFtcGxlLmNvbSIsIkdpdmVuTmFtZSI6IkpvaG5ueSIsIlN1cm5hbWUiOiJSb2NrZXQiLCJFbWFpbCI6Impyb2NrZXRAZXhhbXBsZS5jb20iLCJSb2xlIjpbIk1hbmFnZXIiLCJQcm9qZWN0IEFkbWluaXN0cmF0b3IiXX0" + } + } + }, + "Operation": { + "description": "Operation detail payload", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation", + "readOnly": true, + "type": "string", + "example": "Microsoft.VideoIndexer/accounts/read" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "readOnly": true, + "type": "boolean", + "example": false + }, + "actionType": { + "description": "Indicates the action type.", + "readOnly": true, + "type": "string", + "example": "Internal" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "readOnly": true, + "description": "Display of the operation" + }, + "origin": { + "description": "Origin of the operation", + "readOnly": true, + "type": "string", + "example": "user" + } + } + }, + "OperationDisplay": { + "description": "Operation display payload", + "type": "object", + "properties": { + "provider": { + "description": "Resource provider of the operation", + "readOnly": true, + "type": "string", + "example": "Microsoft Azure Video Indexer" + }, + "resource": { + "description": "Resource of the operation", + "readOnly": true, + "type": "string", + "example": "accounts" + }, + "operation": { + "description": "Localized friendly name for the operation", + "readOnly": true, + "type": "string", + "example": "Read accounts" + }, + "description": { + "description": "Localized friendly description for the operation", + "readOnly": true, + "type": "string", + "example": "Read accounts details" + } + } + }, + "OperationListResult": { + "description": "Available operations of the service.", + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of operations supported by the Resource Provider." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "URL to get the next set of operation list results if there are any.", + "example": "https://management.azure.com/{operation}?api-version={version}&%24skiptoken={token}" + } + } + }, + "ErrorResponse": { + "description": "Error response.", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDefinition", + "description": "The error details." + } + } + }, + "ErrorDefinition": { + "description": "Error definition.", + "type": "object", + "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 + } + } + }, + "AccountCheckNameAvailabilityParameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The VideoIndexer account name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.VideoIndexer/accounts" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": true + }, + "description": "The type of resource, Microsoft.VideoIndexer/accounts" + } + }, + "required": [ + "name", + "type" + ], + "description": "The parameters used to check the availability of the Video Indexer account name." + }, + "CheckNameAvailabilityResult": { + "type": "object", + "properties": { + "nameAvailable": { + "readOnly": true, + "type": "boolean", + "description": "Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken." + }, + "reason": { + "readOnly": true, + "type": "string", + "description": "Gets the reason that a Video Indexer account name could not be used. The Reason element is only returned if NameAvailable is false.", + "enum": [ + "AlreadyExists" + ], + "x-ms-enum": { + "name": "Reason", + "modelAsString": true + } + }, + "message": { + "readOnly": true, + "type": "string", + "description": "Gets an error message explaining the Reason value in more detail." + } + }, + "description": "The CheckNameAvailability operation response." + } + }, + "parameters": { + "AccountNameParameter": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Video Indexer account.", + "pattern": "^[A-Za-z0-9-]+$", + "maxLength": 50, + "minLength": 3, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/vi/resource-manager/readme.md b/specification/vi/resource-manager/readme.md index ecf5ef8d23a9..949f1d71709c 100644 --- a/specification/vi/resource-manager/readme.md +++ b/specification/vi/resource-manager/readme.md @@ -31,6 +31,7 @@ directive: - Microsoft.VideoIndexer/preview/2022-07-20-preview/vi.json - Microsoft.VideoIndexer/preview/2024-04-01-preview/vi.json - Microsoft.VideoIndexer/preview/2024-06-01-preview/vi.json + - Microsoft.VideoIndexer/preview/2024-09-23-preview/vi.json - Microsoft.VideoIndexer/stable/2022-08-01/vi.json where: @@ -53,6 +54,16 @@ openapi-subtype: rpaas tag: package-2024-01 ``` +### Tag: package-2024-09-23-preview + +These settings apply only when `--tag=2024-09-23-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-09-23-preview' +version-with-underscores: 2024_09_23_preview +input-file: + - Microsoft.VideoIndexer/preview/2024-09-23-preview/vi.json +``` + ### Tag: package-2024-06-01-preview These settings apply only when `--tag=2024-06-01-preview` is specified on the command line. From 1e028c56972480c9c80187dbdbd6e73c931ff8ac Mon Sep 17 00:00:00 2001 From: manishpatil8149 <38776869+manishpatil8149@users.noreply.github.com> Date: Mon, 30 Sep 2024 17:38:35 +0530 Subject: [PATCH 43/48] Pre GA readiness changes (#30685) * base commit * added 2024-09-30 api version * fixed tsv validation * fixed prettier failures --------- Co-authored-by: Manish Patil (from Dev Box) <mapatil@microsoft.com> --- .../CertificateProfiles_Create.json | 68 + .../CertificateProfiles_Delete.json | 23 + .../CertificateProfiles_Get.json | 42 + ...cateProfiles_ListByCodeSigningAccount.json | 45 + ...CertificateProfiles_RevokeCertificate.json | 21 + ...SigningAccounts_CheckNameAvailability.json | 18 + .../CodeSigningAccounts_Create.json | 48 + .../CodeSigningAccounts_Delete.json | 24 + .../CodeSigningAccounts_Get.json | 29 + ...deSigningAccounts_ListByResourceGroup.json | 32 + ...odeSigningAccounts_ListBySubscription.json | 31 + .../CodeSigningAccounts_Update.json | 40 + .../2024-09-30-preview/Operations_List.json | 44 + .../CodeSigning.Management/main.tsp | 2 + .../CodeSigning.Management/models.tsp | 28 +- .../codeSigningAccount.json | 1358 +++++++++++++++++ .../examples/CertificateProfiles_Create.json | 68 + .../examples/CertificateProfiles_Delete.json | 23 + .../examples/CertificateProfiles_Get.json | 42 + ...cateProfiles_ListByCodeSigningAccount.json | 45 + ...CertificateProfiles_RevokeCertificate.json | 21 + ...SigningAccounts_CheckNameAvailability.json | 18 + .../examples/CodeSigningAccounts_Create.json | 48 + .../examples/CodeSigningAccounts_Delete.json | 24 + .../examples/CodeSigningAccounts_Get.json | 29 + ...deSigningAccounts_ListByResourceGroup.json | 32 + ...odeSigningAccounts_ListBySubscription.json | 31 + .../examples/CodeSigningAccounts_Update.json | 40 + .../examples/Operations_List.json | 44 + .../codesigning/resource-manager/readme.md | 11 +- .../resource-manager/readme.python.md | 2 +- 31 files changed, 2327 insertions(+), 4 deletions(-) create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Create.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Delete.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Get.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_ListByCodeSigningAccount.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_RevokeCertificate.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_CheckNameAvailability.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Create.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Delete.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Get.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_ListByResourceGroup.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_ListBySubscription.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Update.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/Operations_List.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/codeSigningAccount.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Create.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Delete.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Get.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_ListByCodeSigningAccount.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_RevokeCertificate.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_CheckNameAvailability.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Create.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Delete.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Get.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_ListByResourceGroup.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_ListBySubscription.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Update.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/Operations_List.json diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Create.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Create.json new file mode 100644 index 000000000000..8d6b159c024a --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Create.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resource": { + "properties": { + "profileType": "PublicTrust", + "identityValidationId": "00000000-1234-5678-3333-444444444444", + "includePostalCode": true, + "includeStreetAddress": false + } + }, + "profileName": "profileA", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "profileA", + "type": "Microsoft.CodeSigning/codeSigningAccounts/certificateProfiles", + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount/certificateProfiles/profileA", + "properties": { + "certificates": [ + { + "createdDate": "3/14/2023 5:27:49 PM", + "expiryDate": "3/17/2023 5:27:49 PM", + "enhancedKeyUsage": "1.3.6.1.4.1.311.yy.xxxxxxxx.xxxxxxxx.xxxxxxxxx.xxxxxxxx", + "serialNumber": "xxxxxxxxxxxxxxxxxx", + "status": "Active", + "subjectName": "CN=Contoso Inc, O=Contoso Inc, L=New York, S=New York, C=US", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + } + ], + "identityValidationId": "00000000-1234-5678-3333-444444444444", + "includeCity": false, + "includeCountry": false, + "includePostalCode": true, + "includeState": false, + "includeStreetAddress": false, + "profileType": "PublicTrust", + "provisioningState": "Succeeded", + "status": "Active" + } + } + }, + "201": { + "body": { + "name": "profileA", + "type": "Microsoft.CodeSigning/codeSigningAccounts/certificateProfiles", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount/certificateProfiles/profileA", + "properties": { + "certificates": [], + "identityValidationId": "00000000-1234-5678-3333-444444444444", + "includeCity": false, + "includeCountry": false, + "includePostalCode": true, + "includeState": false, + "includeStreetAddress": false, + "profileType": "PublicTrust", + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "CertificateProfiles_Create", + "title": "Create a certificate profile." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Delete.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Delete.json new file mode 100644 index 000000000000..e0a743a2cc25 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "profileName": "profileA", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "CertificateProfiles_Delete", + "title": "Delete a certificate profile." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Get.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Get.json new file mode 100644 index 000000000000..be65a4ceddde --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "profileName": "profileA", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "profileA", + "type": "Microsoft.CodeSigning/codeSigningAccounts/certificateProfiles", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount/certificateProfiles/profileA", + "properties": { + "certificates": [ + { + "createdDate": "3/14/2023 5:27:49 PM", + "expiryDate": "3/17/2023 5:27:49 PM", + "enhancedKeyUsage": "1.3.6.1.4.1.311.yy.xxxxxxxx.xxxxxxxx.xxxxxxxxx.xxxxxxxx", + "serialNumber": "xxxxxxxxxxxxxxxxxx", + "status": "Active", + "subjectName": "CN=Contoso Inc, O=Contoso Inc, L=New York, S=New York, C=US", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + } + ], + "identityValidationId": "123456", + "includeCity": false, + "includeCountry": false, + "includePostalCode": true, + "includeState": false, + "includeStreetAddress": false, + "profileType": "PublicTrust", + "provisioningState": "Succeeded", + "status": "Active" + } + } + } + }, + "operationId": "CertificateProfiles_Get", + "title": "Get details of a certificate profile." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_ListByCodeSigningAccount.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_ListByCodeSigningAccount.json new file mode 100644 index 000000000000..ba0db472226c --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_ListByCodeSigningAccount.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "profileA", + "type": "Microsoft.CodeSigning/codeSigningAccounts/certificateProfiles", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/profileA", + "properties": { + "certificates": [ + { + "createdDate": "3/14/2023 5:27:49 PM", + "expiryDate": "3/17/2023 5:27:49 PM", + "enhancedKeyUsage": "1.3.6.1.4.1.311.yy.xxxxxxxx.xxxxxxxx.xxxxxxxxx.xxxxxxxx", + "serialNumber": "xxxxxxxxxxxxxxxxxx", + "status": "Active", + "subjectName": "CN=Contoso Inc, O=Contoso Inc, L=New York, S=New York, C=US", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + } + ], + "identityValidationId": "123456", + "includeCity": false, + "includeCountry": false, + "includePostalCode": true, + "includeState": false, + "includeStreetAddress": false, + "profileType": "PublicTrust", + "provisioningState": "Succeeded", + "status": "Active" + } + } + ] + } + } + }, + "operationId": "CertificateProfiles_ListByCodeSigningAccount", + "title": "List certificate profiles under a trusted signing account." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_RevokeCertificate.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_RevokeCertificate.json new file mode 100644 index 000000000000..17e9e7baa606 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_RevokeCertificate.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "profileName": "profileA", + "resourceGroupName": "MyResourceGroup", + "body": { + "effectiveAt": "2023-11-12T23:40:25+00:00", + "reason": "KeyCompromised", + "remarks": "test", + "serialNumber": "xxxxxxxxxxxxxxxxxx", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + }, + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "204": {} + }, + "operationId": "CertificateProfiles_RevokeCertificate", + "title": "Revoke a certificate under a certificate profile." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_CheckNameAvailability.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_CheckNameAvailability.json new file mode 100644 index 000000000000..ae1cfb811407 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_CheckNameAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "body": { + "name": "sample-account" + }, + "api-version": "2024-09-30-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + }, + "operationId": "CodeSigningAccounts_CheckNameAvailability", + "title": "Checks that the trusted signing account name is available." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Create.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Create.json new file mode 100644 index 000000000000..214d8e3aa374 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Create.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resource": { + "location": "westus", + "properties": { + "sku": { + "name": "Basic" + } + } + }, + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "MyAccount", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + } + } + }, + "201": { + "body": { + "name": "MyAccount", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Accepted", + "sku": { + "name": "Basic" + } + } + } + } + }, + "operationId": "CodeSigningAccounts_Create", + "title": "Create a trusted Signing Account." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Delete.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Delete.json new file mode 100644 index 000000000000..062f0fda1600 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Delete.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status", + "location": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status", + "location": "http://azure.async.operation/status" + } + } + }, + "operationId": "CodeSigningAccounts_Delete", + "title": "Delete a trusted signing account." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Get.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Get.json new file mode 100644 index 000000000000..f5d4e090907c --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "MyAccount", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + }, + "tags": { + "key1": "value1" + } + } + } + }, + "operationId": "CodeSigningAccounts_Get", + "title": "Get a Trusted Signing Account" +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_ListByResourceGroup.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_ListByResourceGroup.json new file mode 100644 index 000000000000..50fd72f56334 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_ListByResourceGroup.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-09-30-preview", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "alpha", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + }, + "tags": { + "key1": "value1" + } + } + ] + } + } + }, + "operationId": "CodeSigningAccounts_ListByResourceGroup", + "title": "Lists trusted signing accounts within a resource group." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_ListBySubscription.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_ListBySubscription.json new file mode 100644 index 000000000000..5c14b6bc07bd --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_ListBySubscription.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-30-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "alpha", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + }, + "tags": { + "key1": "value1" + } + } + ] + } + } + }, + "operationId": "CodeSigningAccounts_ListBySubscription", + "title": "Lists trusted signing accounts within a subscription." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Update.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Update.json new file mode 100644 index 000000000000..1ed4f660a665 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "properties": { + "tags": { + "key1": "value1" + } + }, + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "MyAccount", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + }, + "tags": { + "key1": "value1" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status", + "location": "http://azure.async.operation/status" + } + } + }, + "operationId": "CodeSigningAccounts_Update", + "title": "Update a trusted signing account." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/Operations_List.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/Operations_List.json new file mode 100644 index 000000000000..e5f631eac339 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/Operations_List.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "api-version": "2024-09-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.CodeSigning/codeSigningAccounts/write", + "display": { + "provider": "Microsoft.CodeSigning", + "resource": "codeSigningAccounts", + "operation": "Create CodeSigningAccount", + "description": "Create any CodeSigningAccount" + } + }, + { + "name": "Microsoft.CodeSigning/codeSigningAccounts/read", + "display": { + "provider": "Microsoft.CodeSigning", + "resource": "codeSigningAccounts", + "operation": "Get CodeSigningAccount", + "description": "Get any CodeSigningAccount" + } + }, + { + "name": "Microsoft.CodeSigning/codeSigningAccounts/delete", + "display": { + "provider": "Microsoft.CodeSigning", + "resource": "codeSigningAccounts", + "operation": "Delete CodeSigningAccount", + "description": "Delete any CodeSigningAccount" + } + } + ] + } + } + }, + "operationId": "Operations_List", + "title": "List trusted signing account operations." +} diff --git a/specification/codesigning/CodeSigning.Management/main.tsp b/specification/codesigning/CodeSigning.Management/main.tsp index 54a7a1eed540..12a7314db219 100644 --- a/specification/codesigning/CodeSigning.Management/main.tsp +++ b/specification/codesigning/CodeSigning.Management/main.tsp @@ -28,4 +28,6 @@ enum Versions { @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) @useDependency(Azure.Core.Versions.v1_0_Preview_1) v2024_02_05_preview: "2024-02-05-preview", + + v2024_09_30_preview: "2024-09-30-preview", } diff --git a/specification/codesigning/CodeSigning.Management/models.tsp b/specification/codesigning/CodeSigning.Management/models.tsp index bb8b69ae8130..9e0a56c48d02 100644 --- a/specification/codesigning/CodeSigning.Management/models.tsp +++ b/specification/codesigning/CodeSigning.Management/models.tsp @@ -4,6 +4,7 @@ import "@azure-tools/typespec-azure-core"; import "@typespec/openapi"; import "@azure-tools/typespec-azure-resource-manager"; import "@azure-tools/typespec-client-generator-core"; +import "@typespec/versioning"; using TypeSpec.Rest; using TypeSpec.Http; @@ -11,6 +12,7 @@ using Azure.Core; using TypeSpec.OpenAPI; using Azure.ResourceManager; using Azure.ResourceManager.Foundations; +using TypeSpec.Versioning; namespace Microsoft.CodeSigning; @@ -158,7 +160,15 @@ model CodeSigningAccountPatch { @doc("Properties of the trusted signing account.") model CodeSigningAccountPatchProperties { @doc("SKU of the trusted signing account.") - sku?: AccountSku; + @typeChangedFrom(Versions.v2024_09_30_preview, AccountSku) + sku?: AccountSkuPatch; +} + +@doc("SKU of the trusted signing account.") +@added(Versions.v2024_09_30_preview) +model AccountSkuPatch { + @doc("Name of the SKU.") + name?: SkuName; } @doc("Properties of the certificate profile.") @@ -166,18 +176,22 @@ model CertificateProfileProperties { @doc("Profile type of the certificate.") profileType: ProfileType; + @removed(Versions.v2024_09_30_preview) @doc("Used as CN in the certificate subject name.") @visibility("read") commonName?: string; + @removed(Versions.v2024_09_30_preview) @doc("Used as O in the certificate subject name.") @visibility("read") organization?: string; + @removed(Versions.v2024_09_30_preview) @doc("Used as OU in the private trust certificate subject name.") @visibility("read") organizationUnit?: string; + @removed(Versions.v2024_09_30_preview) @doc("Used as STREET in the certificate subject name.") @visibility("read") streetAddress?: string; @@ -185,6 +199,7 @@ model CertificateProfileProperties { @doc("Whether to include STREET in the certificate subject name.") includeStreetAddress?: boolean = false; + @removed(Versions.v2024_09_30_preview) @doc("Used as L in the certificate subject name.") @visibility("read") city?: string; @@ -192,6 +207,7 @@ model CertificateProfileProperties { @doc("Whether to include L in the certificate subject name. Applicable only for private trust, private trust ci profile types") includeCity?: boolean = false; + @removed(Versions.v2024_09_30_preview) @doc("Used as S in the certificate subject name.") @visibility("read") state?: string; @@ -199,6 +215,7 @@ model CertificateProfileProperties { @doc("Whether to include S in the certificate subject name. Applicable only for private trust, private trust ci profile types") includeState?: boolean = false; + @removed(Versions.v2024_09_30_preview) @doc("Used as C in the certificate subject name.") @visibility("read") country?: string; @@ -206,6 +223,7 @@ model CertificateProfileProperties { @doc("Whether to include C in the certificate subject name. Applicable only for private trust, private trust ci profile types") includeCountry?: boolean = false; + @removed(Versions.v2024_09_30_preview) @doc("Used as PC in the certificate subject name.") @visibility("read") postalCode?: string; @@ -213,12 +231,14 @@ model CertificateProfileProperties { @doc("Whether to include PC in the certificate subject name.") includePostalCode?: boolean = false; + @removed(Versions.v2024_09_30_preview) @doc("Enhanced key usage of the certificate.") @visibility("read") enhancedKeyUsage?: string; @doc("Identity validation id used for the certificate subject name.") - identityValidationId?: string; + @madeRequired(Versions.v2024_09_30_preview) + identityValidationId: string; @doc("Status of the current operation on certificate profile.") @visibility("read") @@ -241,6 +261,10 @@ model Certificate { @doc("Serial number of the certificate.") serialNumber?: string; + @doc("Enhanced key usage of the certificate.") + @added(Versions.v2024_09_30_preview) + enhancedKeyUsage?: string; + @doc("Subject name of the certificate.") subjectName?: string; diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/codeSigningAccount.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/codeSigningAccount.json new file mode 100644 index 000000000000..1aa1997bdac2 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/codeSigningAccount.json @@ -0,0 +1,1358 @@ +{ + "swagger": "2.0", + "info": { + "title": "CodeSigningManagementClient", + "version": "2024-09-30-preview", + "description": "Code Signing resource provider api.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "CodeSigningAccounts" + }, + { + "name": "CertificateProfiles" + } + ], + "paths": { + "/providers/Microsoft.CodeSigning/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List trusted signing account operations.": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CodeSigning/checkNameAvailability": { + "post": { + "operationId": "CodeSigningAccounts_CheckNameAvailability", + "tags": [ + "CodeSigningAccounts" + ], + "description": "Checks that the trusted signing account name is valid and is not already in use.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "body", + "in": "body", + "description": "The CheckAvailability request", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailability" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Checks that the trusted signing account name is available.": { + "$ref": "./examples/CodeSigningAccounts_CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CodeSigning/codeSigningAccounts": { + "get": { + "operationId": "CodeSigningAccounts_ListBySubscription", + "tags": [ + "CodeSigningAccounts" + ], + "description": "Lists trusted signing accounts within a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CodeSigningAccountListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Lists trusted signing accounts within a subscription.": { + "$ref": "./examples/CodeSigningAccounts_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CodeSigning/codeSigningAccounts": { + "get": { + "operationId": "CodeSigningAccounts_ListByResourceGroup", + "tags": [ + "CodeSigningAccounts" + ], + "description": "Lists trusted signing accounts within a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CodeSigningAccountListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Lists trusted signing accounts within a resource group.": { + "$ref": "./examples/CodeSigningAccounts_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CodeSigning/codeSigningAccounts/{accountName}": { + "get": { + "operationId": "CodeSigningAccounts_Get", + "tags": [ + "CodeSigningAccounts" + ], + "description": "Get a trusted Signing Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CodeSigningAccount" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a Trusted Signing Account": { + "$ref": "./examples/CodeSigningAccounts_Get.json" + } + } + }, + "put": { + "operationId": "CodeSigningAccounts_Create", + "tags": [ + "CodeSigningAccounts" + ], + "description": "Create a trusted Signing Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "name": "resource", + "in": "body", + "description": "Parameters to create the trusted signing account", + "required": true, + "schema": { + "$ref": "#/definitions/CodeSigningAccount" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CodeSigningAccount' update operation succeeded", + "schema": { + "$ref": "#/definitions/CodeSigningAccount" + } + }, + "201": { + "description": "Resource 'CodeSigningAccount' create operation succeeded", + "schema": { + "$ref": "#/definitions/CodeSigningAccount" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a trusted Signing Account.": { + "$ref": "./examples/CodeSigningAccounts_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CodeSigningAccounts_Update", + "tags": [ + "CodeSigningAccounts" + ], + "description": "Update a trusted signing account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "name": "properties", + "in": "body", + "description": "Parameters supplied to update the trusted signing account", + "required": true, + "schema": { + "$ref": "#/definitions/CodeSigningAccountPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CodeSigningAccount" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update a trusted signing account.": { + "$ref": "./examples/CodeSigningAccounts_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CodeSigningAccounts_Delete", + "tags": [ + "CodeSigningAccounts" + ], + "description": "Delete a trusted signing account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a trusted signing account.": { + "$ref": "./examples/CodeSigningAccounts_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CodeSigning/codeSigningAccounts/{accountName}/certificateProfiles": { + "get": { + "operationId": "CertificateProfiles_ListByCodeSigningAccount", + "tags": [ + "CertificateProfiles" + ], + "description": "List certificate profiles under a trusted signing account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateProfileListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List certificate profiles under a trusted signing account.": { + "$ref": "./examples/CertificateProfiles_ListByCodeSigningAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CodeSigning/codeSigningAccounts/{accountName}/certificateProfiles/{profileName}": { + "get": { + "operationId": "CertificateProfiles_Get", + "tags": [ + "CertificateProfiles" + ], + "description": "Get details of a certificate profile.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "name": "profileName", + "in": "path", + "description": "Certificate profile name.", + "required": true, + "type": "string", + "pattern": "^(?=.{5,100}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateProfile" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get details of a certificate profile.": { + "$ref": "./examples/CertificateProfiles_Get.json" + } + } + }, + "put": { + "operationId": "CertificateProfiles_Create", + "tags": [ + "CertificateProfiles" + ], + "description": "Create a certificate profile.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "name": "profileName", + "in": "path", + "description": "Certificate profile name.", + "required": true, + "type": "string", + "pattern": "^(?=.{5,100}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "name": "resource", + "in": "body", + "description": "Parameters to create the certificate profile", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateProfile" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CertificateProfile' update operation succeeded", + "schema": { + "$ref": "#/definitions/CertificateProfile" + } + }, + "201": { + "description": "Resource 'CertificateProfile' create operation succeeded", + "schema": { + "$ref": "#/definitions/CertificateProfile" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a certificate profile.": { + "$ref": "./examples/CertificateProfiles_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CertificateProfiles_Delete", + "tags": [ + "CertificateProfiles" + ], + "description": "Delete a certificate profile.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "name": "profileName", + "in": "path", + "description": "Certificate profile name.", + "required": true, + "type": "string", + "pattern": "^(?=.{5,100}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a certificate profile.": { + "$ref": "./examples/CertificateProfiles_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CodeSigning/codeSigningAccounts/{accountName}/certificateProfiles/{profileName}/revokeCertificate": { + "post": { + "operationId": "CertificateProfiles_RevokeCertificate", + "tags": [ + "CertificateProfiles" + ], + "description": "Revoke a certificate under a certificate profile.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "name": "profileName", + "in": "path", + "description": "Certificate profile name.", + "required": true, + "type": "string", + "pattern": "^(?=.{5,100}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "name": "body", + "in": "body", + "description": "Parameters to revoke the certificate profile", + "required": true, + "schema": { + "$ref": "#/definitions/RevokeCertificate" + } + } + ], + "responses": { + "204": { + "description": "Action completed successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Revoke a certificate under a certificate profile.": { + "$ref": "./examples/CertificateProfiles_RevokeCertificate.json" + } + } + } + } + }, + "definitions": { + "AccountSku": { + "type": "object", + "description": "SKU of the trusted signing account.", + "properties": { + "name": { + "$ref": "#/definitions/SkuName", + "description": "Name of the SKU." + } + }, + "required": [ + "name" + ] + }, + "AccountSkuPatch": { + "type": "object", + "description": "SKU of the trusted signing account.", + "properties": { + "name": { + "$ref": "#/definitions/SkuName", + "description": "Name of the SKU." + } + } + }, + "Certificate": { + "type": "object", + "description": "Properties of the certificate.", + "properties": { + "serialNumber": { + "type": "string", + "description": "Serial number of the certificate." + }, + "enhancedKeyUsage": { + "type": "string", + "description": "Enhanced key usage of the certificate." + }, + "subjectName": { + "type": "string", + "description": "Subject name of the certificate." + }, + "thumbprint": { + "type": "string", + "description": "Thumbprint of the certificate." + }, + "createdDate": { + "type": "string", + "description": "Certificate created date." + }, + "expiryDate": { + "type": "string", + "description": "Certificate expiry date." + }, + "status": { + "$ref": "#/definitions/CertificateStatus", + "description": "Status of the certificate." + }, + "revocation": { + "$ref": "#/definitions/Revocation", + "description": "Revocations history of a certificate.", + "x-ms-client-flatten": true + } + } + }, + "CertificateProfile": { + "type": "object", + "description": "Certificate profile resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CertificateProfileProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "CertificateProfileListResult": { + "type": "object", + "description": "The response of a CertificateProfile list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CertificateProfile items on this page", + "items": { + "$ref": "#/definitions/CertificateProfile" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CertificateProfileProperties": { + "type": "object", + "description": "Properties of the certificate profile.", + "properties": { + "profileType": { + "$ref": "#/definitions/ProfileType", + "description": "Profile type of the certificate." + }, + "includeStreetAddress": { + "type": "boolean", + "description": "Whether to include STREET in the certificate subject name.", + "default": false + }, + "includeCity": { + "type": "boolean", + "description": "Whether to include L in the certificate subject name. Applicable only for private trust, private trust ci profile types", + "default": false + }, + "includeState": { + "type": "boolean", + "description": "Whether to include S in the certificate subject name. Applicable only for private trust, private trust ci profile types", + "default": false + }, + "includeCountry": { + "type": "boolean", + "description": "Whether to include C in the certificate subject name. Applicable only for private trust, private trust ci profile types", + "default": false + }, + "includePostalCode": { + "type": "boolean", + "description": "Whether to include PC in the certificate subject name.", + "default": false + }, + "identityValidationId": { + "type": "string", + "description": "Identity validation id used for the certificate subject name." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Status of the current operation on certificate profile.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/CertificateProfileStatus", + "description": "Status of the certificate profile.", + "readOnly": true + }, + "certificates": { + "type": "array", + "description": "List of renewed certificates.", + "items": { + "$ref": "#/definitions/Certificate" + }, + "readOnly": true, + "x-ms-client-flatten": true, + "x-ms-identifiers": [] + } + }, + "required": [ + "profileType", + "identityValidationId" + ] + }, + "CertificateProfileStatus": { + "type": "string", + "description": "Status of the certificate profiles.", + "enum": [ + "Active", + "Disabled", + "Suspended" + ], + "x-ms-enum": { + "name": "CertificateProfileStatus", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "The certificate profile is active." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The certificate profile is disabled." + }, + { + "name": "Suspended", + "value": "Suspended", + "description": "The certificate profile is suspended." + } + ] + } + }, + "CertificateStatus": { + "type": "string", + "description": "Status of the certificate", + "enum": [ + "Active", + "Expired", + "Revoked" + ], + "x-ms-enum": { + "name": "CertificateStatus", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "The certificate is active." + }, + { + "name": "Expired", + "value": "Expired", + "description": "The certificate is expired." + }, + { + "name": "Revoked", + "value": "Revoked", + "description": "The certificate is revoked." + } + ] + } + }, + "CheckNameAvailability": { + "type": "object", + "description": "The parameters used to check the availability of the trusted signing account name.", + "properties": { + "name": { + "type": "string", + "description": "Trusted signing account name." + } + }, + "required": [ + "name" + ] + }, + "CheckNameAvailabilityResult": { + "type": "object", + "description": "The CheckNameAvailability operation response.", + "properties": { + "nameAvailable": { + "type": "boolean", + "description": "A boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or is invalid and cannot be used.", + "readOnly": true + }, + "reason": { + "$ref": "#/definitions/NameUnavailabilityReason", + "description": "The reason that a trusted signing account name could not be used. The Reason element is only returned if nameAvailable is false.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "An error message explaining the Reason value in more detail.", + "readOnly": true + } + } + }, + "CodeSigningAccount": { + "type": "object", + "description": "Trusted signing account resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CodeSigningAccountProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CodeSigningAccountListResult": { + "type": "object", + "description": "The response of a CodeSigningAccount list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CodeSigningAccount items on this page", + "items": { + "$ref": "#/definitions/CodeSigningAccount" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CodeSigningAccountPatch": { + "type": "object", + "description": "Parameters for creating or updating a trusted signing account.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/CodeSigningAccountPatchProperties", + "description": "Properties of the trusted signing account.", + "x-ms-client-flatten": true + } + } + }, + "CodeSigningAccountPatchProperties": { + "type": "object", + "description": "Properties of the trusted signing account.", + "properties": { + "sku": { + "$ref": "#/definitions/AccountSkuPatch", + "description": "SKU of the trusted signing account." + } + } + }, + "CodeSigningAccountProperties": { + "type": "object", + "description": "Properties of the trusted signing account.", + "properties": { + "accountUri": { + "type": "string", + "description": "The URI of the trusted signing account which is used during signing files.", + "readOnly": true + }, + "sku": { + "$ref": "#/definitions/AccountSku", + "description": "SKU of the trusted signing account." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Status of the current operation on trusted signing account.", + "readOnly": true + } + } + }, + "NameUnavailabilityReason": { + "type": "string", + "description": "The reason that a trusted signing account name could not be used. The Reason element is only returned if nameAvailable is false.", + "enum": [ + "AccountNameInvalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "NameUnavailabilityReason", + "modelAsString": true, + "values": [ + { + "name": "AccountNameInvalid", + "value": "AccountNameInvalid", + "description": "Account name is invalid" + }, + { + "name": "AlreadyExists", + "value": "AlreadyExists", + "description": "Account name already exists" + } + ] + } + }, + "ProfileType": { + "type": "string", + "description": "Type of the certificate", + "enum": [ + "PublicTrust", + "PrivateTrust", + "PrivateTrustCIPolicy", + "VBSEnclave", + "PublicTrustTest" + ], + "x-ms-enum": { + "name": "ProfileType", + "modelAsString": true, + "values": [ + { + "name": "PublicTrust", + "value": "PublicTrust", + "description": "Used for signing files which are distributed publicly." + }, + { + "name": "PrivateTrust", + "value": "PrivateTrust", + "description": "Used for signing files which are distributed internally within organization or group boundary." + }, + { + "name": "PrivateTrustCIPolicy", + "value": "PrivateTrustCIPolicy", + "description": "Used for signing CI policy files." + }, + { + "name": "VBSEnclave", + "value": "VBSEnclave", + "description": "Used for signing files which are run in secure vbs enclave." + }, + { + "name": "PublicTrustTest", + "value": "PublicTrustTest", + "description": "Used for signing files for testing purpose." + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The status of the current operation.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Updating in progress." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Deletion in progress." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Resource creation started." + } + ] + }, + "readOnly": true + }, + "Revocation": { + "type": "object", + "description": "Revocation details of the certificate.", + "properties": { + "requestedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp when the revocation is requested." + }, + "effectiveAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp when the revocation is effective." + }, + "reason": { + "type": "string", + "description": "Reason for revocation." + }, + "remarks": { + "type": "string", + "description": "Remarks for the revocation." + }, + "status": { + "$ref": "#/definitions/RevocationStatus", + "description": "Status of the revocation." + }, + "failureReason": { + "type": "string", + "description": "Reason for the revocation failure." + } + } + }, + "RevocationStatus": { + "type": "string", + "description": "Revocation status of the certificate.", + "enum": [ + "Succeeded", + "InProgress", + "Failed" + ], + "x-ms-enum": { + "name": "RevocationStatus", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Certificate revocation succeeded." + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "Certificate revocation is in progress." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Certificate revocation failed." + } + ] + }, + "readOnly": true + }, + "RevokeCertificate": { + "type": "object", + "description": "Defines the certificate revocation properties.", + "properties": { + "serialNumber": { + "type": "string", + "description": "Serial number of the certificate." + }, + "thumbprint": { + "type": "string", + "description": "Thumbprint of the certificate." + }, + "effectiveAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp when the revocation is effective." + }, + "reason": { + "type": "string", + "description": "Reason for the revocation." + }, + "remarks": { + "type": "string", + "description": "Remarks for the revocation." + } + }, + "required": [ + "serialNumber", + "thumbprint", + "effectiveAt", + "reason" + ] + }, + "SkuName": { + "type": "string", + "description": "Name of the sku.", + "enum": [ + "Basic", + "Premium" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true, + "values": [ + { + "name": "Basic", + "value": "Basic", + "description": "Basic sku." + }, + { + "name": "Premium", + "value": "Premium", + "description": "Premium sku." + } + ] + } + } + }, + "parameters": {} +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Create.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Create.json new file mode 100644 index 000000000000..8d6b159c024a --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Create.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resource": { + "properties": { + "profileType": "PublicTrust", + "identityValidationId": "00000000-1234-5678-3333-444444444444", + "includePostalCode": true, + "includeStreetAddress": false + } + }, + "profileName": "profileA", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "profileA", + "type": "Microsoft.CodeSigning/codeSigningAccounts/certificateProfiles", + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount/certificateProfiles/profileA", + "properties": { + "certificates": [ + { + "createdDate": "3/14/2023 5:27:49 PM", + "expiryDate": "3/17/2023 5:27:49 PM", + "enhancedKeyUsage": "1.3.6.1.4.1.311.yy.xxxxxxxx.xxxxxxxx.xxxxxxxxx.xxxxxxxx", + "serialNumber": "xxxxxxxxxxxxxxxxxx", + "status": "Active", + "subjectName": "CN=Contoso Inc, O=Contoso Inc, L=New York, S=New York, C=US", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + } + ], + "identityValidationId": "00000000-1234-5678-3333-444444444444", + "includeCity": false, + "includeCountry": false, + "includePostalCode": true, + "includeState": false, + "includeStreetAddress": false, + "profileType": "PublicTrust", + "provisioningState": "Succeeded", + "status": "Active" + } + } + }, + "201": { + "body": { + "name": "profileA", + "type": "Microsoft.CodeSigning/codeSigningAccounts/certificateProfiles", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount/certificateProfiles/profileA", + "properties": { + "certificates": [], + "identityValidationId": "00000000-1234-5678-3333-444444444444", + "includeCity": false, + "includeCountry": false, + "includePostalCode": true, + "includeState": false, + "includeStreetAddress": false, + "profileType": "PublicTrust", + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "CertificateProfiles_Create", + "title": "Create a certificate profile." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Delete.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Delete.json new file mode 100644 index 000000000000..e0a743a2cc25 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "profileName": "profileA", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "CertificateProfiles_Delete", + "title": "Delete a certificate profile." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Get.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Get.json new file mode 100644 index 000000000000..be65a4ceddde --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "profileName": "profileA", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "profileA", + "type": "Microsoft.CodeSigning/codeSigningAccounts/certificateProfiles", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount/certificateProfiles/profileA", + "properties": { + "certificates": [ + { + "createdDate": "3/14/2023 5:27:49 PM", + "expiryDate": "3/17/2023 5:27:49 PM", + "enhancedKeyUsage": "1.3.6.1.4.1.311.yy.xxxxxxxx.xxxxxxxx.xxxxxxxxx.xxxxxxxx", + "serialNumber": "xxxxxxxxxxxxxxxxxx", + "status": "Active", + "subjectName": "CN=Contoso Inc, O=Contoso Inc, L=New York, S=New York, C=US", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + } + ], + "identityValidationId": "123456", + "includeCity": false, + "includeCountry": false, + "includePostalCode": true, + "includeState": false, + "includeStreetAddress": false, + "profileType": "PublicTrust", + "provisioningState": "Succeeded", + "status": "Active" + } + } + } + }, + "operationId": "CertificateProfiles_Get", + "title": "Get details of a certificate profile." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_ListByCodeSigningAccount.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_ListByCodeSigningAccount.json new file mode 100644 index 000000000000..ba0db472226c --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_ListByCodeSigningAccount.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "profileA", + "type": "Microsoft.CodeSigning/codeSigningAccounts/certificateProfiles", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/profileA", + "properties": { + "certificates": [ + { + "createdDate": "3/14/2023 5:27:49 PM", + "expiryDate": "3/17/2023 5:27:49 PM", + "enhancedKeyUsage": "1.3.6.1.4.1.311.yy.xxxxxxxx.xxxxxxxx.xxxxxxxxx.xxxxxxxx", + "serialNumber": "xxxxxxxxxxxxxxxxxx", + "status": "Active", + "subjectName": "CN=Contoso Inc, O=Contoso Inc, L=New York, S=New York, C=US", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + } + ], + "identityValidationId": "123456", + "includeCity": false, + "includeCountry": false, + "includePostalCode": true, + "includeState": false, + "includeStreetAddress": false, + "profileType": "PublicTrust", + "provisioningState": "Succeeded", + "status": "Active" + } + } + ] + } + } + }, + "operationId": "CertificateProfiles_ListByCodeSigningAccount", + "title": "List certificate profiles under a trusted signing account." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_RevokeCertificate.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_RevokeCertificate.json new file mode 100644 index 000000000000..17e9e7baa606 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_RevokeCertificate.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "profileName": "profileA", + "resourceGroupName": "MyResourceGroup", + "body": { + "effectiveAt": "2023-11-12T23:40:25+00:00", + "reason": "KeyCompromised", + "remarks": "test", + "serialNumber": "xxxxxxxxxxxxxxxxxx", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + }, + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "204": {} + }, + "operationId": "CertificateProfiles_RevokeCertificate", + "title": "Revoke a certificate under a certificate profile." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_CheckNameAvailability.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_CheckNameAvailability.json new file mode 100644 index 000000000000..ae1cfb811407 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_CheckNameAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "body": { + "name": "sample-account" + }, + "api-version": "2024-09-30-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + }, + "operationId": "CodeSigningAccounts_CheckNameAvailability", + "title": "Checks that the trusted signing account name is available." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Create.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Create.json new file mode 100644 index 000000000000..214d8e3aa374 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Create.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resource": { + "location": "westus", + "properties": { + "sku": { + "name": "Basic" + } + } + }, + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "MyAccount", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + } + } + }, + "201": { + "body": { + "name": "MyAccount", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Accepted", + "sku": { + "name": "Basic" + } + } + } + } + }, + "operationId": "CodeSigningAccounts_Create", + "title": "Create a trusted Signing Account." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Delete.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Delete.json new file mode 100644 index 000000000000..062f0fda1600 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Delete.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status", + "location": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status", + "location": "http://azure.async.operation/status" + } + } + }, + "operationId": "CodeSigningAccounts_Delete", + "title": "Delete a trusted signing account." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Get.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Get.json new file mode 100644 index 000000000000..f5d4e090907c --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "MyAccount", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + }, + "tags": { + "key1": "value1" + } + } + } + }, + "operationId": "CodeSigningAccounts_Get", + "title": "Get a Trusted Signing Account" +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_ListByResourceGroup.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_ListByResourceGroup.json new file mode 100644 index 000000000000..50fd72f56334 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_ListByResourceGroup.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-09-30-preview", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "alpha", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + }, + "tags": { + "key1": "value1" + } + } + ] + } + } + }, + "operationId": "CodeSigningAccounts_ListByResourceGroup", + "title": "Lists trusted signing accounts within a resource group." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_ListBySubscription.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_ListBySubscription.json new file mode 100644 index 000000000000..5c14b6bc07bd --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_ListBySubscription.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-30-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "alpha", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + }, + "tags": { + "key1": "value1" + } + } + ] + } + } + }, + "operationId": "CodeSigningAccounts_ListBySubscription", + "title": "Lists trusted signing accounts within a subscription." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Update.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Update.json new file mode 100644 index 000000000000..1ed4f660a665 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "properties": { + "tags": { + "key1": "value1" + } + }, + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "MyAccount", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + }, + "tags": { + "key1": "value1" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status", + "location": "http://azure.async.operation/status" + } + } + }, + "operationId": "CodeSigningAccounts_Update", + "title": "Update a trusted signing account." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/Operations_List.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/Operations_List.json new file mode 100644 index 000000000000..e5f631eac339 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/Operations_List.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "api-version": "2024-09-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.CodeSigning/codeSigningAccounts/write", + "display": { + "provider": "Microsoft.CodeSigning", + "resource": "codeSigningAccounts", + "operation": "Create CodeSigningAccount", + "description": "Create any CodeSigningAccount" + } + }, + { + "name": "Microsoft.CodeSigning/codeSigningAccounts/read", + "display": { + "provider": "Microsoft.CodeSigning", + "resource": "codeSigningAccounts", + "operation": "Get CodeSigningAccount", + "description": "Get any CodeSigningAccount" + } + }, + { + "name": "Microsoft.CodeSigning/codeSigningAccounts/delete", + "display": { + "provider": "Microsoft.CodeSigning", + "resource": "codeSigningAccounts", + "operation": "Delete CodeSigningAccount", + "description": "Delete any CodeSigningAccount" + } + } + ] + } + } + }, + "operationId": "Operations_List", + "title": "List trusted signing account operations." +} diff --git a/specification/codesigning/resource-manager/readme.md b/specification/codesigning/resource-manager/readme.md index e546f51a3f5d..cf10e999a1d8 100644 --- a/specification/codesigning/resource-manager/readme.md +++ b/specification/codesigning/resource-manager/readme.md @@ -26,7 +26,16 @@ These are the global settings for the CodeSigning API. ```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2024-02-05-preview +tag: package-2024-09-30-preview +``` + +### Tag: package-2024-09-30-preview + +These settings apply only when `--tag=package-2024-09-30-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-09-30-preview' +input-file: +- Microsoft.CodeSigning/preview/2024-09-30-preview/codeSigningAccount.json ``` ### Tag: package-2024-02-05-preview diff --git a/specification/codesigning/resource-manager/readme.python.md b/specification/codesigning/resource-manager/readme.python.md index f095e0bf7e39..7a142f8ff5c7 100644 --- a/specification/codesigning/resource-manager/readme.python.md +++ b/specification/codesigning/resource-manager/readme.python.md @@ -8,7 +8,7 @@ azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-trustedsigning namespace: azure.mgmt.trustedsigning -package-version: 1.0.0b1 +package-version: 1.0.0b2 clear-output-folder: true ``` From 1b9c5dafba0f4b5185279197f82b350a46fe43ba Mon Sep 17 00:00:00 2001 From: James Lim <125409279+MicroJamesLim@users.noreply.github.com> Date: Mon, 30 Sep 2024 12:54:21 -0400 Subject: [PATCH 44/48] Added Azure Container Instance API Version 2024-10-01-preview (#30569) * Copy files from stable/2023-05-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-10-01-preview Updated the API version from stable/2023-05-01 to preview/2024-10-01-preview. * Added tag for 2024-10-01-preview in readme file * added 2024-10-01-preview * remove additionalProperties * Copy files from stable/2023-05-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-10-01-preview Updated the API version from stable/2023-05-01 to preview/2024-10-01-preview. * Added tag for 2024-10-01-preview in readme file * added 2024-10-01-preview * remove additionalProperties * resolved PR comment * update from secrets to secretReferences * suppress additionalProperties * delete file * update to 'arm-id' format --------- Co-authored-by: jameszlim <limcheolhyun930421@gmail.com> --- .../2024-10-01-preview/containerInstance.json | 2610 +++++++++++++++++ .../examples/CachedImagesList.json | 27 + .../examples/CapabilitiesList.json | 39 + .../examples/ContainerAttach.json | 17 + .../examples/ContainerExec.json | 24 + .../ContainerGroupCreateConfidential.json | 182 ++ .../ContainerGroupEncryptionProperties.json | 192 ++ .../examples/ContainerGroupExtensions.json | 208 ++ .../examples/ContainerGroupUsage.json | 24 + .../ContainerGroupsCreateOrUpdate.json | 316 ++ ...erGroupsCreateOrUpdateSecretReference.json | 445 +++ .../ContainerGroupsCreatePriority.json | 120 + .../examples/ContainerGroupsDelete.json | 85 + .../examples/ContainerGroupsGetPriority.json | 87 + .../examples/ContainerGroupsGet_Failed.json | 115 + .../ContainerGroupsGet_Succeeded.json | 79 + .../examples/ContainerGroupsList.json | 90 + .../ContainerGroupsListByResourceGroup.json | 82 + .../examples/ContainerGroupsRestart.json | 11 + .../examples/ContainerGroupsStart.json | 16 + .../examples/ContainerGroupsStop.json | 11 + .../examples/ContainerGroupsUpdate.json | 100 + .../examples/ContainerListLogs.json | 17 + .../examples/OperationsList.json | 23 + .../SubnetServiceAssociationLinkDelete.json | 18 + .../resource-manager/readme.md | 17 +- 26 files changed, 4954 insertions(+), 1 deletion(-) create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/containerInstance.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/CachedImagesList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/CapabilitiesList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerAttach.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerExec.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupCreateConfidential.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupEncryptionProperties.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupExtensions.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupUsage.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreateOrUpdate.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreateOrUpdateSecretReference.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreatePriority.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsDelete.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGetPriority.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGet_Failed.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGet_Succeeded.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsListByResourceGroup.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsRestart.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsStart.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsStop.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsUpdate.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerListLogs.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/OperationsList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/SubnetServiceAssociationLinkDelete.json diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/containerInstance.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/containerInstance.json new file mode 100644 index 000000000000..d6d69d152438 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/containerInstance.json @@ -0,0 +1,2610 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-10-01-preview", + "title": "ContainerInstanceManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/containerGroups": { + "get": { + "operationId": "ContainerGroups_List", + "x-ms-examples": { + "ContainerGroupsList": { + "$ref": "./examples/ContainerGroupsList.json" + } + }, + "summary": "Get a list of container groups in the specified subscription.", + "description": "Get a list of container groups in the specified subscription. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups": { + "get": { + "operationId": "ContainerGroups_ListByResourceGroup", + "x-ms-examples": { + "ContainerGroupsListByResourceGroup": { + "$ref": "./examples/ContainerGroupsListByResourceGroup.json" + } + }, + "summary": "Get a list of container groups in the specified subscription and resource group.", + "description": "Get a list of container groups in a specified subscription and resource group. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}": { + "get": { + "operationId": "ContainerGroups_Get", + "x-ms-examples": { + "ContainerGroupsGet_Succeeded": { + "$ref": "./examples/ContainerGroupsGet_Succeeded.json" + }, + "ContainerGroupsGet_Failed": { + "$ref": "./examples/ContainerGroupsGet_Failed.json" + }, + "ContainerGroupsGetWithPriority": { + "$ref": "./examples/ContainerGroupsGetPriority.json" + } + }, + "summary": "Get the properties of the specified container group.", + "description": "Gets the properties of the specified container group in the specified subscription and resource group. The operation returns the properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "ContainerGroups_CreateOrUpdate", + "x-ms-examples": { + "ContainerGroupsCreateOrUpdate": { + "$ref": "./examples/ContainerGroupsCreateOrUpdate.json" + }, + "ContainerGroupsCreateOrUpdateSecretReference": { + "$ref": "./examples/ContainerGroupsCreateOrUpdateSecretReference.json" + }, + "ContainerGroupCreateWithExtensions": { + "$ref": "./examples/ContainerGroupExtensions.json" + }, + "ContainerGroupWithEncryptionProperties": { + "$ref": "./examples/ContainerGroupEncryptionProperties.json" + }, + "ConfidentialContainerGroup": { + "$ref": "./examples/ContainerGroupCreateConfidential.json" + }, + "ContainerGroupsCreateWithPriority": { + "$ref": "./examples/ContainerGroupsCreatePriority.json" + } + }, + "summary": "Create or update container groups.", + "description": "Create or update container groups with specified configurations.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerGroup", + "description": "The properties of the container group to be created or updated.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "201": { + "description": "Created - the container group is created.", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ContainerGroups_Update", + "x-ms-examples": { + "ContainerGroupsUpdate": { + "$ref": "./examples/ContainerGroupsUpdate.json" + } + }, + "summary": "Update container groups.", + "description": "Updates container group tags with specified values.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "Resource", + "description": "The container group resource with just the tags to be updated.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/Resource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "ContainerGroups_Delete", + "x-ms-examples": { + "ContainerGroupsDelete": { + "$ref": "./examples/ContainerGroupsDelete.json" + } + }, + "summary": "Delete the specified container group.", + "description": "Delete the specified container group in the specified subscription and resource group. The operation does not delete other resources provided by the user, such as volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "202": { + "description": "Delete started." + }, + "204": { + "description": "No Content - the specified container group was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/restart": { + "post": { + "operationId": "ContainerGroups_Restart", + "x-ms-examples": { + "ContainerRestart": { + "$ref": "./examples/ContainerGroupsRestart.json" + } + }, + "summary": "Restarts all containers in a container group.", + "description": "Restarts all containers in a container group in place. If container image has updates, new image will be downloaded.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/stop": { + "post": { + "operationId": "ContainerGroups_Stop", + "x-ms-examples": { + "ContainerStop": { + "$ref": "./examples/ContainerGroupsStop.json" + } + }, + "summary": "Stops all containers in a container group.", + "description": "Stops all containers in a container group. Compute resources will be deallocated and billing will stop.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/start": { + "post": { + "operationId": "ContainerGroups_Start", + "x-ms-examples": { + "ContainerStart": { + "$ref": "./examples/ContainerGroupsStart.json" + } + }, + "summary": "Starts all containers in a container group.", + "description": "Starts all containers in a container group. Compute resources will be allocated and billing will start.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "202": { + "description": "Started - the container group is starting." + }, + "204": { + "description": "Started - the container group is already running or starting." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.ContainerInstance/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "description": "List the operations for Azure Container Instance service.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/usages": { + "get": { + "operationId": "Location_ListUsage", + "x-ms-examples": { + "ContainerUsage": { + "$ref": "./examples/ContainerGroupUsage.json" + } + }, + "description": "Get the usage for a subscription", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/logs": { + "get": { + "operationId": "Containers_ListLogs", + "x-ms-examples": { + "ContainerListLogs": { + "$ref": "./examples/ContainerListLogs.json" + } + }, + "summary": "Get the logs for a specified container instance.", + "description": "Get the logs for a specified container instance in a specified resource group and container group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerName", + "in": "path", + "description": "The name of the container instance.", + "required": true, + "type": "string" + }, + { + "name": "tail", + "in": "query", + "description": "The number of lines to show from the tail of the container instance log. If not provided, all available logs are shown up to 4mb.", + "type": "integer", + "format": "int32" + }, + { + "name": "timestamps", + "in": "query", + "description": "If true, adds a timestamp at the beginning of every line of log output. If not provided, defaults to false.", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Logs" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/exec": { + "post": { + "operationId": "Containers_ExecuteCommand", + "x-ms-examples": { + "ContainerExec": { + "$ref": "./examples/ContainerExec.json" + } + }, + "summary": "Executes a command in a specific container instance.", + "description": "Executes a command for a specific container instance in a specified resource group and container group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerName", + "in": "path", + "description": "The name of the container instance.", + "required": true, + "type": "string" + }, + { + "name": "containerExecRequest", + "in": "body", + "description": "The request for the exec command.", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerExecRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerExecResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/attach": { + "post": { + "operationId": "Containers_Attach", + "x-ms-examples": { + "ContainerAttach": { + "$ref": "./examples/ContainerAttach.json" + } + }, + "summary": "Attach to the output of a specific container instance.", + "description": "Attach to the output stream of a specific container instance in a specified resource group and container group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerName", + "in": "path", + "description": "The name of the container instance.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerAttachResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/cachedImages": { + "get": { + "operationId": "Location_ListCachedImages", + "x-ms-examples": { + "CachedImages": { + "$ref": "./examples/CachedImagesList.json" + } + }, + "summary": "Get the list of cached images.", + "description": "Get the list of cached images on specific OS type for a subscription in a region.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CachedImagesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/capabilities": { + "get": { + "operationId": "Location_ListCapabilities", + "x-ms-examples": { + "GetCapabilities": { + "$ref": "./examples/CapabilitiesList.json" + } + }, + "summary": "Get the list of capabilities of the location.", + "description": "Get the list of CPU/memory/GPU capabilities of a region.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapabilitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/outboundNetworkDependenciesEndpoints": { + "get": { + "operationId": "ContainerGroups_GetOutboundNetworkDependenciesEndpoints", + "x-ms-examples": {}, + "summary": "Get all network dependencies for container group.", + "description": "Gets all the network dependencies for this container group to allow complete control of network setting and configuration. For container groups, this will always be an empty list.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkDependenciesResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/providers/Microsoft.ContainerInstance/serviceAssociationLinks/default": { + "delete": { + "operationId": "SubnetServiceAssociationLink_Delete", + "x-ms-examples": { + "SubnetServiceAssociationLinkDelete": { + "$ref": "./examples/SubnetServiceAssociationLinkDelete.json" + } + }, + "summary": "Delete container group virtual network association links.", + "description": "Delete container group virtual network association links. The operation does not delete other resources provided by the user.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkNameParameter" + }, + { + "$ref": "#/parameters/SubnetNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Delete started." + }, + "204": { + "description": "No Content - the specified container group was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "SecretReference": { + "description": "A secret reference", + "type": "object", + "required": [ + "name", + "identity", + "secretReferenceUri" + ], + "properties": { + "name": { + "description": "The identifier of the secret reference", + "type": "string" + }, + "identity": { + "description": "The ARM resource id of the managed identity that has access to the secret in the key vault", + "type": "string", + "format": "arm-id" + }, + "secretReferenceUri": { + "description": "The URI to the secret in key vault", + "type": "string", + "format": "uri" + } + } + }, + "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" + }, + "x-ms-identifiers": [ + "port" + ] + }, + "environmentVariables": { + "description": "The environment variables to set in the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "instanceView": { + "description": "The instance view of the container instance. Only valid in response.", + "readOnly": true, + "type": "object", + "properties": { + "restartCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of times that the container instance has been restarted." + }, + "currentState": { + "readOnly": true, + "description": "Current container instance state.", + "$ref": "#/definitions/ContainerState" + }, + "previousState": { + "readOnly": true, + "description": "Previous container instance state.", + "$ref": "#/definitions/ContainerState" + }, + "events": { + "readOnly": true, + "description": "The events of the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/Event" + }, + "x-ms-identifiers": [ + "name", + "type" + ] + } + } + }, + "resources": { + "description": "The resource requirements of the container instance.", + "$ref": "#/definitions/ResourceRequirements" + }, + "volumeMounts": { + "description": "The volume mounts available to the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeMount" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "livenessProbe": { + "description": "The liveness probe.", + "$ref": "#/definitions/ContainerProbe" + }, + "readinessProbe": { + "description": "The readiness probe.", + "$ref": "#/definitions/ContainerProbe" + }, + "securityContext": { + "description": "The container security properties.", + "$ref": "#/definitions/SecurityContextDefinition" + } + } + }, + "SecurityContextDefinition": { + "description": "The security context for the container.", + "type": "object", + "properties": { + "privileged": { + "type": "boolean", + "description": "The flag to determine if the container permissions is elevated to Privileged." + }, + "allowPrivilegeEscalation": { + "type": "boolean", + "description": "A boolean value indicating whether the init process can elevate its privileges" + }, + "capabilities": { + "description": "The capabilities to add or drop from a container.", + "$ref": "#/definitions/SecurityContextCapabilitiesDefinition" + }, + "runAsGroup": { + "type": "integer", + "format": "int32", + "description": "Sets the User GID for the container." + }, + "runAsUser": { + "type": "integer", + "format": "int32", + "description": "Sets the User UID for the container." + }, + "seccompProfile": { + "type": "string", + "description": "a base64 encoded string containing the contents of the JSON in the seccomp profile" + } + } + }, + "SecurityContextCapabilitiesDefinition": { + "description": "The capabilities to add or drop from a container.", + "type": "object", + "properties": { + "add": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The capabilities to add to the container." + }, + "drop": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The capabilities to drop from the container." + } + } + }, + "ContainerState": { + "description": "The container instance state.", + "type": "object", + "readOnly": true, + "properties": { + "state": { + "type": "string", + "readOnly": true, + "description": "The state of the container instance." + }, + "startTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time when the container instance state started." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The container instance exit codes correspond to those from the `docker run` command." + }, + "finishTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time when the container instance state finished." + }, + "detailStatus": { + "type": "string", + "readOnly": true, + "description": "The human-readable status of the container instance state." + } + } + }, + "Event": { + "description": "A container group or container instance event.", + "type": "object", + "readOnly": true, + "properties": { + "count": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The count of the event." + }, + "firstTimestamp": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time of the earliest logged event." + }, + "lastTimestamp": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time of the latest logged event." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The event name." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The event message." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The event type." + } + } + }, + "ResourceRequirements": { + "description": "The resource requirements.", + "type": "object", + "required": [ + "requests" + ], + "properties": { + "requests": { + "description": "The resource requests of this container instance.", + "$ref": "#/definitions/ResourceRequests" + }, + "limits": { + "description": "The resource limits of this container instance.", + "$ref": "#/definitions/ResourceLimits" + } + } + }, + "ResourceRequests": { + "description": "The resource requests.", + "type": "object", + "required": [ + "memoryInGB", + "cpu" + ], + "properties": { + "memoryInGB": { + "description": "The memory request in GB of this container instance.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "The CPU request of this container instance.", + "type": "number", + "format": "double" + }, + "gpu": { + "description": "The GPU request of this container instance.", + "$ref": "#/definitions/GpuResource" + } + } + }, + "ResourceLimits": { + "description": "The resource limits.", + "type": "object", + "properties": { + "memoryInGB": { + "description": "The memory limit in GB of this container instance.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "The CPU limit of this container instance.", + "type": "number", + "format": "double" + }, + "gpu": { + "description": "The GPU limit of this container instance.", + "$ref": "#/definitions/GpuResource" + } + } + }, + "GpuResource": { + "description": "The GPU resource.", + "type": "object", + "required": [ + "count", + "sku" + ], + "properties": { + "count": { + "description": "The count of the GPU resource.", + "type": "integer", + "format": "int32" + }, + "sku": { + "type": "string", + "description": "The SKU of the GPU resource.", + "enum": [ + "K80", + "P100", + "V100" + ], + "x-ms-enum": { + "name": "GpuSku", + "modelAsString": true + } + } + } + }, + "AzureFileVolume": { + "description": "The properties of the Azure File volume. Azure File shares are mounted as volumes.", + "type": "object", + "required": [ + "shareName", + "storageAccountName" + ], + "properties": { + "shareName": { + "description": "The name of the Azure File share to be mounted as a volume.", + "type": "string" + }, + "readOnly": { + "description": "The flag indicating whether the Azure File shared mounted as a volume is read-only.", + "type": "boolean" + }, + "storageAccountName": { + "description": "The name of the storage account that contains the Azure File share.", + "type": "string" + }, + "storageAccountKey": { + "description": "The storage account access key used to access the Azure File share.", + "type": "string" + }, + "storageAccountKeyReference": { + "description": "The reference to 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" + } + }, + "SecretReferenceVolume": { + "description": "The secret reference 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" + }, + "secretReference": { + "description": "The secret reference volume.", + "$ref": "#/definitions/SecretReferenceVolume" + }, + "gitRepo": { + "description": "The git repo volume.", + "$ref": "#/definitions/GitRepoVolume" + } + } + }, + "VolumeMount": { + "description": "The properties of the volume mount.", + "type": "object", + "required": [ + "name", + "mountPath" + ], + "properties": { + "name": { + "description": "The name of the volume mount.", + "type": "string" + }, + "mountPath": { + "description": "The path within the container where the volume should be mounted. Must not contain colon (:).", + "type": "string" + }, + "readOnly": { + "description": "The flag indicating whether the volume mount is read-only.", + "type": "boolean" + } + } + }, + "ContainerExec": { + "type": "object", + "description": "The container execution command, for liveness or readiness probe", + "properties": { + "command": { + "description": "The commands to execute within the container.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ContainerHttpGet": { + "type": "object", + "description": "The container Http Get settings, for liveness or readiness probe", + "properties": { + "path": { + "description": "The path to probe.", + "type": "string" + }, + "port": { + "type": "integer", + "description": "The port number to probe.", + "format": "int32" + }, + "scheme": { + "description": "The scheme.", + "type": "string", + "enum": [ + "http", + "https" + ], + "x-ms-enum": { + "name": "Scheme", + "modelAsString": true + } + }, + "httpHeaders": { + "description": "The HTTP headers.", + "type": "array", + "items": { + "$ref": "#/definitions/HttpHeader" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "required": [ + "port" + ] + }, + "ContainerProbe": { + "type": "object", + "description": "The container probe, for liveness or readiness", + "properties": { + "exec": { + "description": "The execution command to probe", + "$ref": "#/definitions/ContainerExec" + }, + "httpGet": { + "description": "The Http Get settings to probe", + "$ref": "#/definitions/ContainerHttpGet" + }, + "initialDelaySeconds": { + "description": "The initial delay seconds.", + "type": "integer", + "format": "int32" + }, + "periodSeconds": { + "description": "The period seconds.", + "type": "integer", + "format": "int32" + }, + "failureThreshold": { + "description": "The failure threshold.", + "type": "integer", + "format": "int32" + }, + "successThreshold": { + "description": "The success threshold.", + "type": "integer", + "format": "int32" + }, + "timeoutSeconds": { + "description": "The timeout seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "ContainerGroup": { + "description": "A container group.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "$ref": "#/definitions/ContainerGroupProperties" + } + ] + }, + "ContainerGroupProperties": { + "description": "The container group properties", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "identity": { + "$ref": "#/definitions/ContainerGroupIdentity", + "description": "The identity of the container group, if configured." + }, + "properties": { + "x-ms-client-flatten": true, + "type": "object", + "description": "The container group properties", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the container group. This only appears in the response." + }, + "secretReferences": { + "type": "array", + "description": "The secret references that will be referenced within the container group.", + "items": { + "$ref": "#/definitions/SecretReference" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "containers": { + "type": "array", + "description": "The containers within the container group.", + "items": { + "$ref": "#/definitions/Container" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "imageRegistryCredentials": { + "type": "array", + "description": "The image registry credentials by which the container group is created from.", + "items": { + "$ref": "#/definitions/ImageRegistryCredential" + }, + "x-ms-identifiers": [ + "username" + ] + }, + "restartPolicy": { + "type": "string", + "description": "Restart policy for all containers within the container group. \n- `Always` Always restart\n- `OnFailure` Restart on failure\n- `Never` Never restart\n", + "enum": [ + "Always", + "OnFailure", + "Never" + ], + "x-ms-enum": { + "name": "ContainerGroupRestartPolicy", + "modelAsString": true + } + }, + "ipAddress": { + "description": "The IP address type of the container group.", + "$ref": "#/definitions/IpAddress" + }, + "osType": { + "type": "string", + "description": "The operating system type required by the containers in the container group.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": true + } + }, + "volumes": { + "type": "array", + "description": "The list of volumes that can be mounted by containers in this container group.", + "items": { + "$ref": "#/definitions/Volume" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "instanceView": { + "description": "The instance view of the container group. Only valid in response.", + "readOnly": true, + "type": "object", + "properties": { + "events": { + "description": "The events of this container group.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Event" + }, + "x-ms-identifiers": [ + "name", + "type" + ] + }, + "state": { + "readOnly": true, + "type": "string", + "description": "The state of the container group. Only valid in response." + } + } + }, + "diagnostics": { + "description": "The diagnostic information for a container group.", + "$ref": "#/definitions/ContainerGroupDiagnostics" + }, + "subnetIds": { + "type": "array", + "description": "The subnet resource IDs for a container group.", + "items": { + "$ref": "#/definitions/ContainerGroupSubnetId" + } + }, + "dnsConfig": { + "description": "The DNS config information for a container group.", + "$ref": "#/definitions/DnsConfiguration" + }, + "sku": { + "description": "The SKU for a container group.", + "$ref": "#/definitions/ContainerGroupSku" + }, + "encryptionProperties": { + "description": "The encryption properties for a container group.", + "$ref": "#/definitions/EncryptionProperties" + }, + "initContainers": { + "type": "array", + "description": "The init containers for a container group.", + "items": { + "$ref": "#/definitions/InitContainerDefinition" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "extensions": { + "type": "array", + "description": "extensions used by virtual kubelet", + "items": { + "$ref": "#/definitions/DeploymentExtensionSpec" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "confidentialComputeProperties": { + "description": "The properties for confidential container group", + "$ref": "#/definitions/ConfidentialComputeProperties" + }, + "priority": { + "type": "string", + "description": "The priority of the container group.", + "enum": [ + "Regular", + "Spot" + ], + "x-ms-enum": { + "name": "ContainerGroupPriority", + "modelAsString": true + } + } + }, + "required": [ + "containers", + "osType" + ] + } + } + }, + "DeploymentExtensionSpec": { + "description": "Extension sidecars to be added to the deployment.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the extension." + }, + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "Extension specific properties", + "properties": { + "extensionType": { + "type": "string", + "description": "Type of extension to be added." + }, + "version": { + "type": "string", + "description": "Version of the extension being used." + }, + "settings": { + "type": "object", + "description": "Settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "Protected settings for the extension." + } + }, + "required": [ + "extensionType", + "version" + ] + } + }, + "required": [ + "name" + ] + }, + "ContainerGroupIdentity": { + "description": "Identity for the container group.", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the container group identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the container group. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the container group. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the container group.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "description": "The list of user identities associated with the container group.", + "additionalProperties": { + "description": "The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "$ref": "#/definitions/UserAssignedIdentities" + } + } + } + }, + "UserAssignedIdentities": { + "type": "object", + "description": "The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "ImageRegistryCredential": { + "description": "Image registry credential.", + "type": "object", + "properties": { + "server": { + "type": "string", + "description": "The Docker image registry server without a protocol such as \"http\" and \"https\"." + }, + "username": { + "type": "string", + "description": "The username for the private registry." + }, + "password": { + "type": "string", + "description": "The password for the private registry.", + "x-ms-secret": true + }, + "passwordReference": { + "type": "string", + "description": "The reference for the private registry password." + }, + "identity": { + "type": "string", + "description": "The identity for the private registry." + }, + "identityUrl": { + "type": "string", + "description": "The identity URL for the private registry." + } + }, + "required": [ + "server" + ] + }, + "ContainerGroupDiagnostics": { + "description": "Container group diagnostic information.", + "type": "object", + "properties": { + "logAnalytics": { + "description": "Container group log analytics information.", + "$ref": "#/definitions/LogAnalytics" + } + } + }, + "LogAnalytics": { + "description": "Container group log analytics information.", + "type": "object", + "properties": { + "workspaceId": { + "description": "The workspace id for log analytics", + "type": "string" + }, + "workspaceKey": { + "description": "The workspace key for log analytics", + "type": "string", + "x-ms-secret": true + }, + "logType": { + "type": "string", + "description": "The log type to be used.", + "enum": [ + "ContainerInsights", + "ContainerInstanceLogs" + ], + "x-ms-enum": { + "name": "LogAnalyticsLogType", + "modelAsString": true + } + }, + "metadata": { + "type": "object", + "description": "Metadata for log analytics.", + "additionalProperties": { + "type": "string" + } + }, + "workspaceResourceId": { + "description": "The workspace resource id for log analytics", + "type": "string", + "x-ms-secret": true + } + }, + "required": [ + "workspaceId", + "workspaceKey" + ] + }, + "ContainerGroupSubnetId": { + "description": "Container group subnet information.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID of virtual network and subnet.", + "type": "string" + }, + "name": { + "description": "Friendly name for the subnet.", + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "IpAddress": { + "description": "IP address for the container group.", + "type": "object", + "properties": { + "ports": { + "type": "array", + "description": "The list of ports exposed on the container group.", + "items": { + "$ref": "#/definitions/Port" + }, + "x-ms-identifiers": [ + "port" + ] + }, + "type": { + "type": "string", + "description": "Specifies if the IP is exposed to the public internet or private VNET.", + "enum": [ + "Public", + "Private" + ], + "x-ms-enum": { + "name": "ContainerGroupIpAddressType", + "modelAsString": true + } + }, + "ip": { + "type": "string", + "description": "The IP exposed to the public internet." + }, + "dnsNameLabel": { + "type": "string", + "description": "The Dns name label for the IP." + }, + "autoGeneratedDomainNameLabelScope": { + "type": "string", + "description": "The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant.", + "enum": [ + "Unsecure", + "TenantReuse", + "SubscriptionReuse", + "ResourceGroupReuse", + "Noreuse" + ], + "default": "Unsecure", + "x-ms-enum": { + "name": "dnsNameLabelReusePolicy", + "modelAsString": true + } + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "The FQDN for the IP." + } + }, + "required": [ + "ports", + "type" + ] + }, + "Port": { + "description": "The port exposed on the container group.", + "type": "object", + "properties": { + "protocol": { + "type": "string", + "description": "The protocol associated with the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "ContainerGroupNetworkProtocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "description": "The port number.", + "format": "int32" + } + }, + "required": [ + "port" + ] + }, + "ContainerPort": { + "description": "The port exposed on the container instance.", + "type": "object", + "properties": { + "protocol": { + "type": "string", + "description": "The protocol associated with the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "ContainerNetworkProtocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port number exposed within the container group." + } + }, + "required": [ + "port" + ] + }, + "EnvironmentVariable": { + "description": "The environment variable to set within the container instance.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the environment variable." + }, + "value": { + "type": "string", + "description": "The value of the environment variable." + }, + "secureValue": { + "type": "string", + "description": "The value of the secure environment variable.", + "x-ms-secret": true + }, + "secureValueReference": { + "type": "string", + "description": "The reference 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" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of operations." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of operations." + } + } + }, + "Operation": { + "description": "An operation for Azure Container Instance service.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "display": { + "description": "The display information of the operation.", + "type": "object", + "properties": { + "provider": { + "description": "The name of the provider of the operation.", + "type": "string" + }, + "resource": { + "type": "string", + "description": "The name of the resource type of the operation." + }, + "operation": { + "description": "The friendly name of the operation.", + "type": "string" + }, + "description": { + "description": "The description of the operation.", + "type": "string" + } + } + }, + "properties": { + "type": "object", + "description": "The additional properties.", + "x-ms-client-flatten": true + }, + "origin": { + "type": "string", + "description": "The intended executor of the operation.", + "enum": [ + "User", + "System" + ], + "x-ms-enum": { + "name": "ContainerInstanceOperationsOrigin", + "modelAsString": true + } + } + }, + "required": [ + "name", + "display" + ] + }, + "UsageListResult": { + "description": "The response containing the usage data", + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "description": "The usage data.", + "items": { + "$ref": "#/definitions/Usage" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "Usage": { + "description": "A single usage result", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Id of the usage result" + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "Unit of the usage result" + }, + "currentValue": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The current usage of the resource" + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "readOnly": true, + "type": "object", + "description": "The name object of the resource", + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The localized name of the resource" + } + } + } + } + }, + "ContainerGroupListResult": { + "description": "The container group list response that contains the container group properties.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerGroup" + }, + "description": "The list of container groups." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of container groups." + } + } + }, + "Logs": { + "description": "The logs.", + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The content of the log." + } + } + }, + "ContainerExecRequest": { + "description": "The container exec request.", + "type": "object", + "properties": { + "command": { + "type": "string", + "description": "The command to be executed." + }, + "terminalSize": { + "type": "object", + "description": "The size of the terminal.", + "properties": { + "rows": { + "type": "integer", + "format": "int32", + "description": "The row size of the terminal" + }, + "cols": { + "type": "integer", + "format": "int32", + "description": "The column size of the terminal" + } + } + } + } + }, + "ContainerExecResponse": { + "description": "The information for the container exec command.", + "type": "object", + "properties": { + "webSocketUri": { + "type": "string", + "description": "The uri for the exec websocket." + }, + "password": { + "type": "string", + "description": "The password to start the exec command.", + "x-ms-secret": true + } + } + }, + "ContainerAttachResponse": { + "description": "The information for the output stream from container attach.", + "type": "object", + "properties": { + "webSocketUri": { + "type": "string", + "description": "The uri for the output stream from the attach." + }, + "password": { + "type": "string", + "description": "The password to the output stream from the attach. Send as an Authorization header value when connecting to the websocketUri.", + "x-ms-secret": true + } + } + }, + "HttpHeader": { + "description": "The HTTP header.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The header name." + }, + "value": { + "type": "string", + "description": "The header value." + } + } + }, + "DnsConfiguration": { + "description": "DNS configuration for the container group.", + "type": "object", + "required": [ + "nameServers" + ], + "properties": { + "nameServers": { + "description": "The DNS servers for the container group.", + "type": "array", + "items": { + "type": "string" + } + }, + "searchDomains": { + "description": "The DNS search domains for hostname lookup in the container group.", + "type": "string" + }, + "options": { + "description": "The DNS options for the container group.", + "type": "string" + } + } + }, + "Resource": { + "type": "object", + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource id." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "location": { + "type": "string", + "description": "The resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + }, + "zones": { + "description": "The zones for the container group.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-azure-resource": true + }, + "CachedImagesListResult": { + "description": "The response containing cached images.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/cachedImages" + }, + "x-ms-identifiers": [ + "image" + ], + "description": "The list of cached images." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of cached images." + } + } + }, + "cachedImages": { + "description": "The cached image and OS type.", + "type": "object", + "required": [ + "osType", + "image" + ], + "properties": { + "osType": { + "type": "string", + "description": "The OS type of the cached image." + }, + "image": { + "type": "string", + "description": "The cached image name." + } + } + }, + "CapabilitiesListResult": { + "description": "The response containing list of capabilities.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Capabilities" + }, + "x-ms-identifiers": [ + "resourceType", + "location" + ], + "description": "The list of capabilities." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of capabilities." + } + } + }, + "Capabilities": { + "description": "The regional capabilities.", + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "readOnly": true, + "description": "The resource type that this capability describes." + }, + "osType": { + "type": "string", + "readOnly": true, + "description": "The OS type that this capability describes." + }, + "location": { + "type": "string", + "readOnly": true, + "description": "The resource location." + }, + "ipAddressType": { + "type": "string", + "readOnly": true, + "description": "The ip address type that this capability describes." + }, + "gpu": { + "type": "string", + "readOnly": true, + "description": "The GPU sku that this capability describes." + }, + "capabilities": { + "type": "object", + "readOnly": true, + "description": "The supported capabilities.", + "properties": { + "maxMemoryInGB": { + "type": "number", + "readOnly": true, + "description": "The maximum allowed memory request in GB." + }, + "maxCpu": { + "type": "number", + "readOnly": true, + "description": "The maximum allowed CPU request in cores." + }, + "maxGpuCount": { + "type": "number", + "readOnly": true, + "description": "The maximum allowed GPU count." + } + } + } + } + }, + "ContainerGroupSku": { + "description": "The container group SKU.", + "type": "string", + "enum": [ + "Standard", + "Dedicated", + "Confidential" + ], + "x-ms-enum": { + "name": "ContainerGroupSku", + "modelAsString": true + } + }, + "EncryptionProperties": { + "description": "The container group encryption properties.", + "type": "object", + "properties": { + "vaultBaseUrl": { + "description": "The keyvault base url.", + "type": "string" + }, + "keyName": { + "description": "The encryption key name.", + "type": "string" + }, + "keyVersion": { + "description": "The encryption key version.", + "type": "string" + }, + "identity": { + "type": "string", + "description": "The keyvault managed identity." + } + }, + "required": [ + "vaultBaseUrl", + "keyName", + "keyVersion" + ] + }, + "InitContainerDefinition": { + "description": "The init container definition.", + "type": "object", + "properties": { + "name": { + "description": "The name for the init container.", + "type": "string" + }, + "properties": { + "description": "The properties for the init container.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/InitContainerPropertiesDefinition" + } + }, + "required": [ + "name", + "properties" + ] + }, + "InitContainerPropertiesDefinition": { + "description": "The init container definition properties.", + "type": "object", + "properties": { + "image": { + "description": "The image of the init container.", + "type": "string" + }, + "command": { + "description": "The command to execute within the init container in exec form.", + "type": "array", + "items": { + "type": "string" + } + }, + "environmentVariables": { + "description": "The environment variables to set in the init container.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "instanceView": { + "description": "The instance view of the init container. Only valid in response.", + "readOnly": true, + "type": "object", + "properties": { + "restartCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of times that the init container has been restarted." + }, + "currentState": { + "readOnly": true, + "description": "The current state of the init container.", + "$ref": "#/definitions/ContainerState" + }, + "previousState": { + "readOnly": true, + "description": "The previous state of the init container.", + "$ref": "#/definitions/ContainerState" + }, + "events": { + "readOnly": true, + "description": "The events of the init container.", + "type": "array", + "items": { + "$ref": "#/definitions/Event" + }, + "x-ms-identifiers": [ + "name", + "type" + ] + } + } + }, + "volumeMounts": { + "description": "The volume mounts available to the init container.", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeMount" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "securityContext": { + "description": "The container security properties.", + "$ref": "#/definitions/SecurityContextDefinition" + } + } + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the Container Instance service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [ + "message", + "target" + ], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Container Instance service." + }, + "NetworkDependenciesResponse": { + "description": "Response for network dependencies, always empty list.", + "type": "array", + "items": { + "type": "string" + } + }, + "ConfidentialComputeProperties": { + "description": "The properties for confidential container group", + "type": "object", + "properties": { + "ccePolicy": { + "type": "string", + "description": "The base64 encoded confidential compute enforcement policy" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "x-ms-parameter-location": "client" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The identifier for the physical azure location.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version", + "x-ms-parameter-location": "client" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ContainerGroupNameParameter": { + "name": "containerGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the container group.", + "x-ms-parameter-location": "method" + }, + "VirtualNetworkNameParameter": { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network.", + "x-ms-parameter-location": "method" + }, + "SubnetNameParameter": { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet.", + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The operation Id.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/CachedImagesList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/CachedImagesList.json new file mode 100644 index 000000000000..ed0d0d2363f5 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/CachedImagesList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "westcentralus", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "osType": "Linux", + "image": "ubuntu:16.04" + }, + { + "osType": "Linux", + "image": "alpine:3.6" + }, + { + "osType": "Windows", + "image": "microsoft/nanoserver:10.0.14393.2485" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/CapabilitiesList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/CapabilitiesList.json new file mode 100644 index 000000000000..925e127e09db --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/CapabilitiesList.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "westus", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "containerGroups", + "osType": "Linux", + "location": "West US", + "ipAddressType": "Public", + "gpu": "K80", + "capabilities": { + "maxMemoryInGB": 14, + "maxCpu": 4, + "maxGpuCount": 4 + } + }, + { + "resourceType": "containerGroups", + "osType": "Windows", + "location": "West US", + "ipAddressType": "Public", + "gpu": "None", + "capabilities": { + "maxMemoryInGB": 14, + "maxCpu": 4, + "maxGpuCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerAttach.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerAttach.json new file mode 100644 index 000000000000..77bd776e187d --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerAttach.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerName": "container1" + }, + "responses": { + "200": { + "body": { + "webSocketUri": "wss://web-socket-uri", + "password": "password" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerExec.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerExec.json new file mode 100644 index 000000000000..06ec0926cfaf --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerExec.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerName": "container1", + "containerExecRequest": { + "command": "/bin/bash", + "terminalSize": { + "rows": 12, + "cols": 12 + } + } + }, + "responses": { + "200": { + "body": { + "webSocketUri": "wss://web-socket-uri", + "password": "password" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupCreateConfidential.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupCreateConfidential.json new file mode 100644 index 000000000000..c96ab2b7b19e --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupCreateConfidential.json @@ -0,0 +1,182 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "westeurope", + "properties": { + "containers": [ + { + "name": "accdemo", + "properties": { + "command": [], + "environmentVariables": [], + "image": "confiimage", + "ports": [ + { + "port": 8000 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "securityContext": { + "privileged": false, + "capabilities": { + "add": [ + "CAP_NET_ADMIN" + ] + } + } + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 8000 + } + ], + "type": "Public" + }, + "osType": "Linux", + "sku": "Confidential", + "confidentialComputeProperties": { + "ccePolicy": "eyJhbGxvd19hbGwiOiB0cnVlLCAiY29udGFpbmVycyI6IHsibGVuZ3RoIjogMCwgImVsZW1lbnRzIjogbnVsbH19" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Confidential", + "provisioningState": "Succeeded", + "containers": [ + { + "name": "accdemo", + "properties": { + "image": "confiimage", + "command": [], + "ports": [ + { + "port": 8000 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + }, + "securityContext": { + "privileged": false, + "capabilities": { + "add": [ + "CAP_NET_ADMIN" + ] + } + } + } + } + ], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 8000 + } + ], + "type": "Public" + }, + "initContainers": [], + "imageRegistryCredentials": [], + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Running" + }, + "confidentialComputeProperties": { + "ccePolicy": "eyJhbGxvd19hbGwiOiB0cnVlLCAiY29udGFpbmVycyI6IHsibGVuZ3RoIjogMCwgImVsZW1lbnRzIjogbnVsbH19" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "westeurope" + } + }, + "201": { + "body": { + "properties": { + "sku": "Confidential", + "provisioningState": "Succeeded", + "containers": [ + { + "name": "accdemo", + "properties": { + "image": "confiimage", + "command": [], + "ports": [ + { + "port": 8000 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + }, + "securityContext": { + "privileged": false, + "capabilities": { + "add": [ + "CAP_NET_ADMIN" + ] + } + } + } + } + ], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 8000 + } + ], + "type": "Public" + }, + "initContainers": [], + "imageRegistryCredentials": [], + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Running" + }, + "confidentialComputeProperties": { + "ccePolicy": "eyJhbGxvd19hbGwiOiB0cnVlLCAiY29udGFpbmVycyI6IHsibGVuZ3RoIjogMCwgImVsZW1lbnRzIjogbnVsbH19" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "westeurope" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupEncryptionProperties.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupEncryptionProperties.json new file mode 100644 index 000000000000..5fb43920d62a --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupEncryptionProperties.json @@ -0,0 +1,192 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "eastus2", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity": {} + } + }, + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + } + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public" + }, + "osType": "Linux", + "encryptionProperties": { + "vaultBaseUrl": "https://testkeyvault.vault.azure.net", + "keyName": "test-key", + "keyVersion": "<key version>", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "encryptionProperties": { + "vaultBaseUrl": "https://testkeyvault.vault.azure.net/", + "keyName": "test-key", + "keyVersion": "<key version>", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity" + }, + "provisioningState": "Pending", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public" + }, + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Pending" + } + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity": { + "principalId": "<principal id>", + "clientId": "<client id>" + } + }, + "tenantId": "<tenant id>", + "type": "UserAssigned" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + }, + "201": { + "body": { + "properties": { + "sku": "Standard", + "encryptionProperties": { + "vaultBaseUrl": "https://testkeyvault.vault.azure.net/", + "keyName": "test-key", + "keyVersion": "key version", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity" + }, + "provisioningState": "Running", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public" + }, + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Pending" + } + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity": { + "principalId": "<principal id>", + "clientId": "<client id>" + } + }, + "tenantId": "<tenant id>", + "type": "UserAssigned" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupExtensions.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupExtensions.json new file mode 100644 index 000000000000..4756b7442c1d --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupExtensions.json @@ -0,0 +1,208 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "eastus2", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + } + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Private" + }, + "osType": "Linux", + "subnetIds": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-rg-vnet/subnets/test-subnet" + } + ], + "extensions": [ + { + "name": "kube-proxy", + "properties": { + "extensionType": "kube-proxy", + "version": "1.0", + "settings": { + "clusterCidr": "10.240.0.0/16", + "kubeVersion": "v1.9.10" + }, + "protectedSettings": { + "kubeConfig": "<kubeconfig encoded string>" + } + } + }, + { + "name": "vk-realtime-metrics", + "properties": { + "extensionType": "realtime-metrics", + "version": "1.0" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Pending", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "extensions": [ + { + "name": "kube-proxy", + "properties": { + "extensionType": "kube-proxy", + "version": "1.0", + "settings": { + "clusterCidr": "10.240.0.0/16", + "kubeVersion": "v1.9.10" + } + } + }, + { + "name": "vk-realtime-metrics", + "properties": { + "extensionType": "realtime-metrics", + "version": "1.0" + } + } + ], + "imageRegistryCredentials": [], + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Pending" + }, + "subnetIds": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-rg-vnet/subnets/test-subnet" + } + ] + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + }, + "201": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Pending", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "extensions": [ + { + "name": "kube-proxy", + "properties": { + "extensionType": "kube-proxy", + "version": "1.0", + "settings": { + "clusterCidr": "10.240.0.0/16", + "kubeVersion": "v1.9.10" + } + } + }, + { + "name": "vk-realtime-metrics", + "properties": { + "extensionType": "realtime-metrics", + "version": "1.0" + } + } + ], + "imageRegistryCredentials": [], + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Running" + }, + "subnetIds": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-rg-vnet/subnets/test-subnet" + } + ] + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupUsage.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupUsage.json new file mode 100644 index 000000000000..ecb826c3e487 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupUsage.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "westcentralus", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 1, + "limit": 2000, + "name": { + "value": "ContainerGroups", + "localizedValue": "Container Groups" + } + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreateOrUpdate.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreateOrUpdate.json new file mode 100644 index 000000000000..9850e024b673 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreateOrUpdate.json @@ -0,0 +1,316 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "west us", + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name": {} + } + }, + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "diagnostics": { + "logAnalytics": { + "workspaceId": "workspaceid", + "workspaceKey": "workspaceKey", + "logType": "ContainerInsights", + "metadata": { + "test-key": "test-metadata-value" + }, + "workspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/microsoft.operationalinsights/workspaces/workspace" + } + }, + "subnetIds": [ + { + "id": "[resourceId('Microsoft.Network/virtualNetworks/subnets', parameters('vnetName'), parameters('subnetName'))]" + } + ], + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ], + "searchDomains": "cluster.local svc.cluster.local", + "options": "ndots:2" + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure" + }, + "osType": "Linux", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName", + "storageAccountKey": "accountKey" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": { + "secretKey1": "SecretValue1InBase64", + "secretKey2": "SecretValue2InBase64" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "diagnostics": { + "logAnalytics": { + "workspaceId": "workspaceid" + } + }, + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ], + "searchDomains": "cluster.local svc.cluster.local", + "options": "ndots:2" + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ] + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreateOrUpdateSecretReference.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreateOrUpdateSecretReference.json new file mode 100644 index 000000000000..c8d892255752 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreateOrUpdateSecretReference.json @@ -0,0 +1,445 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "west us", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name": {} + } + }, + "properties": { + "secretReferences": [ + { + "name": "envSecretRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/envSecret" + }, + { + "name": "accountKeyRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/accountKey" + }, + { + "name": "volumeSecretRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/volumeSecret" + }, + { + "name": "privateRegistryKeyRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/privateRegistryKey" + } + ], + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [ + { + "name": "envSecret", + "secureValueReference": "envSecretRef" + } + ], + "image": "privateRegistryImage", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "diagnostics": { + "logAnalytics": { + "workspaceId": "workspaceid", + "workspaceKey": "workspaceKey", + "logType": "ContainerInsights", + "metadata": { + "test-key": "test-metadata-value" + }, + "workspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/microsoft.operationalinsights/workspaces/workspace" + } + }, + "subnetIds": [ + { + "id": "[resourceId('Microsoft.Network/virtualNetworks/subnets', parameters('vnetName'), parameters('subnetName'))]" + } + ], + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ], + "searchDomains": "cluster.local svc.cluster.local", + "options": "ndots:2" + }, + "imageRegistryCredentials": [ + { + "server": "demoregistry.azurecr.io", + "username": "registryUserName", + "passwordReference": "privateRegistryKeyRef" + } + ], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure" + }, + "osType": "Linux", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName", + "storageAccountKeyReference": "accountKeyRef" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": { + "secretKey1": "SecretValue1InBase64" + }, + "secretReference": { + "secretKey2": "volumeSecretRef" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "identity": { + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + }, + "tenantId": "00000000-0000-0000-0000-000000000000", + "type": "UserAssigned" + }, + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "secretReferences": [ + { + "name": "envSecretRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/envSecret" + }, + { + "name": "accountKeyRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/accountKey" + }, + { + "name": "volumeSecretRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/volumeSecret" + }, + { + "name": "privateRegistryKeyRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/privateRegistryKey" + } + ], + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [ + { + "name": "envSecret", + "secureValueReference": "envSecretRef" + } + ], + "image": "privateRegistryImage", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "diagnostics": { + "logAnalytics": { + "workspaceId": "workspaceid" + } + }, + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ], + "searchDomains": "cluster.local svc.cluster.local", + "options": "ndots:2" + }, + "imageRegistryCredentials": [ + { + "server": "demoregistry.azurecr.io", + "username": "registryUserName", + "passwordReference": "privateRegistryKeyRef" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName", + "storageAccountKeyReference": "accountKeyRef" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {}, + "secretReference": { + "secretKey2": "volumeSecretRef" + } + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "identity": { + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + }, + "tenantId": "00000000-0000-0000-0000-000000000000", + "type": "UserAssigned" + }, + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "secretReferences": [ + { + "name": "envSecretRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/envSecret" + }, + { + "name": "accountKeyRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/accountKey" + }, + { + "name": "volumeSecretRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/volumeSecret" + }, + { + "name": "privateRegistryKeyRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/privateRegistryKey" + } + ], + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [ + { + "name": "envSecret", + "secureValueReference": "envSecretRef" + } + ], + "image": "privateRegistryImage", + "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": [ + { + "server": "demoregistry.azurecr.io", + "username": "registryUserName", + "passwordReference": "privateRegistryKeyRef" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName", + "storageAccountKeyReference": "accountKeyRef" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {}, + "secretReference": { + "secretKey2": "volumeSecretRef" + } + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreatePriority.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreatePriority.json new file mode 100644 index 000000000000..c131ccea87ed --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreatePriority.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerGroup": { + "properties": { + "sku": "Standard", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "restartPolicy": "Never", + "osType": "Linux", + "priority": "Spot" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Succeeded", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "ports": [], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "initContainers": [], + "restartPolicy": "Never", + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Succeeded" + }, + "priority": "Spot" + }, + "id": "/subscriptions/subId/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus" + } + }, + "201": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Created", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "ports": [], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "initContainers": [], + "restartPolicy": "Never", + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Created" + }, + "priority": "Spot" + }, + "id": "/subscriptions/subId/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsDelete.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsDelete.json new file mode 100644 index 000000000000..4c52d95afb11 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsDelete.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/locations/location/operations/operationId?api-version=apiVersion" + } + }, + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGetPriority.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGetPriority.json new file mode 100644 index 000000000000..beaad8bc9180 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGetPriority.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Succeeded", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "ports": [], + "environmentVariables": [], + "instanceView": { + "restartCount": 0, + "currentState": { + "state": "Terminated", + "startTime": "2022-11-11T19:33:44.217Z", + "exitCode": 0, + "finishTime": "2022-11-11T19:33:55.565Z", + "detailStatus": "Completed" + }, + "events": [ + { + "count": 2, + "firstTimestamp": "2022-11-11T19:28:22Z", + "lastTimestamp": "2022-11-11T19:32:09Z", + "name": "Pulling", + "message": "pulling image \"alpine@sha256:1304f174557314a7ed9eddb4eab12fed12cb0cd9809e4c28f29af86979a3c870\"", + "type": "Normal" + }, + { + "count": 2, + "firstTimestamp": "2022-11-11T19:32:08Z", + "lastTimestamp": "2022-11-11T19:32:38Z", + "name": "Pulled", + "message": "Successfully pulled image \"alpine@sha256:1304f174557314a7ed9eddb4eab12fed12cb0cd9809e4c28f29af86979a3c870\"", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2022-11-11T19:33:44Z", + "lastTimestamp": "2022-11-11T19:33:44Z", + "name": "Started", + "message": "Started container", + "type": "Normal" + } + ] + }, + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "initContainers": [], + "restartPolicy": "Never", + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Succeeded" + }, + "priority": "Spot" + }, + "id": "/subscriptions/subId/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGet_Failed.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGet_Failed.json new file mode 100644 index 000000000000..8c9f1d80ceb3 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGet_Failed.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "instanceView": { + "restartCount": 0, + "currentState": { + "state": "Waiting", + "startTime": "2017-08-08T00:09:10Z", + "detailStatus": "" + }, + "events": [ + { + "count": 1, + "firstTimestamp": "2017-08-08T00:09:01Z", + "lastTimestamp": "2017-08-08T00:09:01Z", + "message": "pulling image \"nginx\"", + "name": "Pulling", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2017-08-08T00:09:10Z", + "lastTimestamp": "2017-08-08T00:09:10Z", + "message": "Successfully pulled image \"nginx\"", + "name": "Pulled", + "type": "Normal" + } + ] + }, + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "instanceView": { + "events": [ + { + "count": 1, + "firstTimestamp": "2017-10-08T00:19:10Z", + "lastTimestamp": "2017-10-08T00:19:10Z", + "message": "Output: mount error(2): Permission denied", + "name": "FailedMount", + "type": "Normal" + } + ], + "state": "Pending" + }, + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Failed", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGet_Succeeded.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGet_Succeeded.json new file mode 100644 index 000000000000..4e824a241331 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGet_Succeeded.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsList.json new file mode 100644 index 000000000000..bc0ed9a5d99c --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsList.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "instanceView": { + "restartCount": 0, + "currentState": { + "state": "Running", + "startTime": "2017-10-17T17:27:21Z", + "detailStatus": "" + }, + "events": [] + }, + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsListByResourceGroup.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsListByResourceGroup.json new file mode 100644 index 000000000000..df87822690b9 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsListByResourceGroup.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsRestart.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsRestart.json new file mode 100644 index 000000000000..62b5ef24b019 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsRestart.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsStart.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsStart.json new file mode 100644 index 000000000000..c95afb0fdf8c --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsStart.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/locations/location/operations/operationId?api-version=apiVersion" + } + }, + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsStop.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsStop.json new file mode 100644 index 000000000000..62b5ef24b019 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsStop.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsUpdate.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsUpdate.json new file mode 100644 index 000000000000..dcc708e6bc8d --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsUpdate.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demoResource", + "containerGroupName": "demo1", + "Resource": { + "tags": { + "tag1key": "tag1Value", + "tag2key": "tag2Value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demoResource/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "tags": { + "tag1key": "tag1Value", + "tag2key": "tag2Value" + }, + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ] + } + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerListLogs.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerListLogs.json new file mode 100644 index 000000000000..85e3bb2cb061 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerListLogs.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerName": "container1", + "tail": 10 + }, + "responses": { + "200": { + "body": { + "content": "log content" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/OperationsList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/OperationsList.json new file mode 100644 index 000000000000..7dbd9db81afe --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/OperationsList.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ContainerInstance/containerGroups/read", + "display": { + "provider": "Microsoft Container Instance", + "resource": "Container Group", + "operation": "Get Container Groups", + "description": "Get all container goups." + }, + "origin": "User" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/SubnetServiceAssociationLinkDelete.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/SubnetServiceAssociationLinkDelete.json new file mode 100644 index 000000000000..fb57e873a21b --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/SubnetServiceAssociationLinkDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "virtualNetworkName": "demo2", + "subnetName": "demo3" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/locations/location/operations/operationId?api-version=apiVersion" + } + }, + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/readme.md b/specification/containerinstance/resource-manager/readme.md index 6c4d309167c1..37a58d82b8e1 100644 --- a/specification/containerinstance/resource-manager/readme.md +++ b/specification/containerinstance/resource-manager/readme.md @@ -26,7 +26,16 @@ These are the global settings for the ContainerInstance API. ``` yaml openapi-type: arm -tag: package-preview-2024-05 +tag: package-preview-2024-10 +``` + +### Tag: package-preview-2024-10 + +These settings apply only when `--tag=package-preview-2024-10` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-10' +input-file: + - Microsoft.ContainerInstance/preview/2024-10-01-preview/containerInstance.json ``` ### Tag: package-preview-2024-05 @@ -214,6 +223,12 @@ suppressions: - containerInstance.json where: - $.definitions.ConfigMap.properties.keyValuePairs + - code: AvoidAdditionalProperties + reason: additional feature addition to existing secretVolumes which is defined as a dictionary + from: + - containerInstance.json + where: + - $.definitions.SecretReferenceVolume ``` --- From 1736812b284437b88286035449806283f5d87e73 Mon Sep 17 00:00:00 2001 From: Ray Chen <raychen@microsoft.com> Date: Mon, 30 Sep 2024 13:57:10 -0700 Subject: [PATCH 45/48] Updated Go sdk support owner (#30801) --- documentation/ci-fix.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/ci-fix.md b/documentation/ci-fix.md index 9ccbb91f092b..fc05ead8d05c 100644 --- a/documentation/ci-fix.md +++ b/documentation/ci-fix.md @@ -88,7 +88,7 @@ If you have an issue or with any of checks listed in the first column of the tab | Check name | Owner | |-----------------------------------|----------------| -| `SDK azure-sdk-for-go` | Ray Chen | +| `SDK azure-sdk-for-go` | Chenjie Shi | | `SDK azure-sdk-for-java` | Weidong Xu | | `SDK azure-sdk-for-js` | Qiaoqiao Zhang | | `SDK azure-sdk-for-net` | Wei Hu | From be9347d403c9ba3179321fe9500b956245e8f3e7 Mon Sep 17 00:00:00 2001 From: Mike Harder <mharder@microsoft.com> Date: Mon, 30 Sep 2024 15:33:18 -0700 Subject: [PATCH 46/48] [TypeSpecValidation] Apply "all" suppressions when core files changed (#30805) - Fixes #30521 --- eng/scripts/Get-TypeSpec-Folders.ps1 | 6 +++++- eng/scripts/TypeSpec-Validation.ps1 | 4 ++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/eng/scripts/Get-TypeSpec-Folders.ps1 b/eng/scripts/Get-TypeSpec-Folders.ps1 index 1ddb8ef0fc55..e667216b0bdb 100644 --- a/eng/scripts/Get-TypeSpec-Folders.ps1 +++ b/eng/scripts/Get-TypeSpec-Folders.ps1 @@ -9,10 +9,13 @@ Set-StrictMode -Version 3 . $PSScriptRoot/ChangedFiles-Functions.ps1 $repoPath = Resolve-Path "$PSScriptRoot/../.." + $checkAllPath = ((Get-ChildItem "specification" -Directory).Name -replace '^', 'specification/') -replace '$', '/' +$checkedAll = $false if ($CheckAll) { $changedFiles = $checkAllPath + $checkedAll = $true } else { $changedFiles = @(Get-ChangedFiles -baseCommitish $BaseCommitish -targetCommitish $TargetCommitish -diffFilter "") @@ -21,6 +24,7 @@ else { if ($coreChangedFiles) { Write-Verbose "Found changes to core eng or root files so checking all specs." $changedFiles = $checkAllPath + $checkedAll = $true } else { $changedFiles = Get-ChangedFilesUnderSpecification $changedFiles @@ -49,4 +53,4 @@ foreach ($skippedTypespecFolder in $skippedTypespecFolders | Select-Object -Uniq $typespecFolders = $typespecFolders | ForEach-Object { [IO.Path]::GetRelativePath($repoPath, $_) -replace '\\', '/' } | Sort-Object -Unique -return $typespecFolders +return @($typespecFolders, $checkedAll) diff --git a/eng/scripts/TypeSpec-Validation.ps1 b/eng/scripts/TypeSpec-Validation.ps1 index 30985a681fb7..031ae7d69000 100644 --- a/eng/scripts/TypeSpec-Validation.ps1 +++ b/eng/scripts/TypeSpec-Validation.ps1 @@ -10,7 +10,7 @@ param ( . $PSScriptRoot/Logging-Functions.ps1 . $PSScriptRoot/Suppressions-Functions.ps1 -$typespecFolders = &"$PSScriptRoot/Get-TypeSpec-Folders.ps1" -BaseCommitish:$BaseCommitish -TargetCommitish:$TargetCommitish -CheckAll:$CheckAll +$typespecFolders, $checkedAll = &"$PSScriptRoot/Get-TypeSpec-Folders.ps1" -BaseCommitish:$BaseCommitish -TargetCommitish:$TargetCommitish -CheckAll:$CheckAll $typespecFoldersWithFailures = @() if ($typespecFolders) { @@ -18,7 +18,7 @@ if ($typespecFolders) { foreach ($typespecFolder in $typespecFolders) { LogGroupStart "Validating $typespecFolder" - if ($CheckAll) { + if ($checkedAll) { $suppression = Get-Suppression "TypeSpecValidationAll" $typespecFolder if ($suppression) { $reason = $suppression["reason"] ?? "<no reason specified>" From b4e2402f686dda5237ed140897d49624e6d2a462 Mon Sep 17 00:00:00 2001 From: Sean Wells <swells@users.noreply.github.com> Date: Mon, 30 Sep 2024 15:49:24 -0700 Subject: [PATCH 47/48] feat(azurearcdata): Welcome 2024-05-01-preview (#30613) * feat(azurearcdata): Welcome 2024-05-01-preview * fix(azurearcdata): update cSpell.json 2024-05-01-preview * fix(azurearcdata): 2024-05-01 Update readme.md * Update sqlServerAvailabilityGroups.json * chore(azurearcdata): prettier * Update sqlServerAvailabilityGroups.json * chore(azurearcdata): prettier * chore(azurearcdata): prettier * chore(azurearcdata): sync from private * Update sqlServerDatabases.json --- cSpell.json | 15 + .../activeDirectoryConnectors.json | 240 ++ .../2024-05-01-preview/azurearcdata.json | 2193 +++++++++++++++++ .../preview/2024-05-01-preview/common.json | 159 ++ .../2024-05-01-preview/dataControllers.json | 253 ++ .../AddDatabasesToAvailabilityGroup.json | 120 + ...reateOrUpdateActiveDirectoryConnector.json | 134 + ...OrUpdateArcSqlServerAvailabilityGroup.json | 223 ++ .../CreateOrUpdateArcSqlServerDatabase.json | 156 ++ .../CreateOrUpdateDataController.json | 166 ++ .../examples/CreateOrUpdateFailoverGroup.json | 74 + .../CreateOrUpdatePostgresInstance.json | 172 ++ .../CreateOrUpdateSqlManagedInstance.json | 267 ++ .../CreateOrUpdateSqlServerEsuLicense.json | 83 + .../CreateOrUpdateSqlServerInstance.json | 179 ++ .../CreateOrUpdateSqlServerLicense.json | 81 + .../CreateSqlServerAvailabilityGroup.json | 187 ++ ...SqlServerDistributedAvailabilityGroup.json | 155 ++ .../DeleteActiveDirectoryConnector.json | 26 + .../DeleteArcSqlServerAvailabilityGroup.json | 21 + .../examples/DeleteArcSqlServerDatabase.json | 21 + .../examples/DeleteDataController.json | 25 + .../examples/DeleteFailoverGroup.json | 18 + .../examples/DeletePostgresInstance.json | 25 + .../examples/DeleteSqlManagedInstance.json | 25 + .../examples/DeleteSqlServerEsuLicense.json | 16 + .../examples/DeleteSqlServerInstance.json | 25 + .../examples/DeleteSqlServerLicense.json | 16 + ...FailoverArcSqlServerAvailabilityGroup.json | 183 ++ ...FailoverArcSqlServerAvailabilityGroup.json | 183 ++ .../examples/GetActiveDirectoryConnector.json | 57 + .../GetArcSqlServerAvailabilityGroup.json | 113 + .../examples/GetArcSqlServerDatabase.json | 92 + .../examples/GetDataController.json | 65 + .../examples/GetFailoverGroup.json | 38 + .../examples/GetPostgresInstance.json | 43 + .../examples/GetSqlManagedInstance.json | 99 + .../examples/GetSqlServerEsuLicense.json | 40 + .../examples/GetSqlServerInstance.json | 191 ++ .../GetSqlServerInstanceJobsStatus.json | 51 + .../GetSqlServerInstanceTelemetry.json | 154 ++ .../examples/GetSqlServerLicense.json | 39 + ...ataControllerActiveDirectoryConnector.json | 104 + .../ListByResourceGroupDataController.json | 115 + .../ListByResourceGroupPostgresInstance.json | 77 + ...ListByResourceGroupSqlManagedInstance.json | 162 ++ ...istByResourceGroupSqlServerEsuLicense.json | 71 + .../ListByResourceGroupSqlServerInstance.json | 248 ++ .../ListByResourceGroupSqlServerLicense.json | 69 + ...ListBySqlManagedInstanceFailoverGroup.json | 66 + ...tBySqlServerInstanceAvailabilityGroup.json | 215 ++ .../ListBySqlServerInstanceDatabase.json | 167 ++ .../examples/ListOperation.json | 353 +++ .../ListSubscriptionDataController.json | 119 + .../ListSubscriptionPostgresInstance.json | 76 + .../ListSubscriptionSqlManagedInstance.json | 163 ++ .../ListSubscriptionSqlServerEsuLicense.json | 70 + .../ListSubscriptionSqlServerInstance.json | 249 ++ .../ListSubscriptionSqlServerLicense.json | 68 + .../PostUpgradeSqlServerInstance.json | 77 + .../examples/PreUpgradeSqlServerInstance.json | 77 + .../RemoveDatabasesFromAvailabilityGroup.json | 118 + ...nMigrationAssessmentSqlServerInstance.json | 43 + .../UpdateArcSqlServerAvailabilityGroup.json | 123 + .../examples/UpdateDataController.json | 75 + .../examples/UpdatePostgresInstance.json | 48 + .../examples/UpdateSqlManagedInstance.json | 101 + .../examples/UpdateSqlServerDatabase.json | 102 + .../examples/UpdateSqlServerEsuLicense.json | 49 + .../examples/UpdateSqlServerInstance.json | 88 + .../examples/UpdateSqlServerLicense.json | 44 + .../ViewArcSqlServerAvailabilityGroup.json | 183 ++ .../2024-05-01-preview/failoverGroups.json | 157 ++ .../2024-05-01-preview/operations.json | 125 + .../2024-05-01-preview/postgresInstances.json | 174 ++ .../sqlManagedInstances.json | 403 +++ .../sqlServerAvailabilityGroups.json | 1573 ++++++++++++ .../sqlServerDatabases.json | 680 +++++ .../sqlServerEsuLicenses.json | 545 ++++ .../sqlServerInstances.json | 1367 ++++++++++ .../2024-05-01-preview/sqlServerLicenses.json | 259 ++ .../azurearcdata/resource-manager/readme.md | 23 +- 82 files changed, 15248 insertions(+), 1 deletion(-) create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/activeDirectoryConnectors.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/azurearcdata.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/common.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/dataControllers.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/AddDatabasesToAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateActiveDirectoryConnector.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateArcSqlServerAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateArcSqlServerDatabase.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateDataController.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateFailoverGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdatePostgresInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlManagedInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerEsuLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateSqlServerAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateSqlServerDistributedAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteActiveDirectoryConnector.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteArcSqlServerAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteArcSqlServerDatabase.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteDataController.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteFailoverGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeletePostgresInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlManagedInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerEsuLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/FailoverArcSqlServerAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ForceFailoverArcSqlServerAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetActiveDirectoryConnector.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetArcSqlServerAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetArcSqlServerDatabase.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetDataController.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetFailoverGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetPostgresInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlManagedInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerEsuLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstanceJobsStatus.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstanceTelemetry.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByDataControllerActiveDirectoryConnector.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupDataController.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupPostgresInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlManagedInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerEsuLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlManagedInstanceFailoverGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlServerInstanceAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlServerInstanceDatabase.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListOperation.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionDataController.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionPostgresInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlManagedInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerEsuLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/PostUpgradeSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/PreUpgradeSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/RemoveDatabasesFromAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/RunMigrationAssessmentSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateArcSqlServerAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateDataController.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdatePostgresInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlManagedInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerDatabase.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerEsuLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ViewArcSqlServerAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/failoverGroups.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/operations.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/postgresInstances.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlManagedInstances.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerAvailabilityGroups.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerDatabases.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerEsuLicenses.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerInstances.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerLicenses.json diff --git a/cSpell.json b/cSpell.json index 29ff06a9c8f4..e7aeb6374c29 100644 --- a/cSpell.json +++ b/cSpell.json @@ -47,6 +47,21 @@ "typescript" ], "overrides": [ + { + "filename": "**/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/**/*.json", + "words": [ + "azurearcdata" + ] + }, + { + "filename": "**/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/**/*.json", + "words": [ + "SSRS", + "SSAS", + "SSIS", + "PBIRS" + ] + }, { "filename": "**/specification/batch/**/*.json", "words": [ diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/activeDirectoryConnectors.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/activeDirectoryConnectors.json new file mode 100644 index 000000000000..76600b07efcc --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/activeDirectoryConnectors.json @@ -0,0 +1,240 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "ActiveDirectoryConnectorListResult": { + "description": "A list of active directory connectors", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ActiveDirectoryConnectorResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ActiveDirectoryConnectorResource": { + "type": "object", + "description": "Active directory connector resource", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ActiveDirectoryConnectorProperties", + "description": "null", + "x-ms-client-flatten": false + } + }, + "required": [ + "properties" + ] + }, + "ActiveDirectoryConnectorProperties": { + "type": "object", + "description": "The properties of an Active Directory connector resource", + "properties": { + "domainServiceAccountLoginInformation": { + "$ref": "./common.json#/definitions/BasicLoginInformation", + "description": "Username and password for domain service account authentication." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the Active Directory connector resource.", + "readOnly": true + }, + "spec": { + "$ref": "#/definitions/ActiveDirectoryConnectorSpec", + "description": "null", + "x-ms-client-flatten": false + }, + "status": { + "$ref": "#/definitions/ActiveDirectoryConnectorStatus", + "description": "null", + "x-ms-client-flatten": false + } + }, + "required": [ + "spec" + ] + }, + "ActiveDirectoryConnectorSpec": { + "description": "The specifications of the AD Kubernetes resource.", + "type": "object", + "properties": { + "activeDirectory": { + "$ref": "#/definitions/ActiveDirectoryConnectorDomainDetails", + "description": "null", + "x-ms-client-flatten": false + }, + "dns": { + "$ref": "#/definitions/ActiveDirectoryConnectorDNSDetails", + "description": "null", + "x-ms-client-flatten": false + } + }, + "required": [ + "activeDirectory", + "dns" + ] + }, + "ActiveDirectoryConnectorDomainDetails": { + "type": "object", + "description": "Active Directory domain details", + "properties": { + "realm": { + "type": "string", + "description": "Name (uppercase) of the Active Directory domain that this AD connector will be associated with." + }, + "netbiosDomainName": { + "type": "string", + "description": "NETBIOS name of the Active Directory domain." + }, + "serviceAccountProvisioning": { + "type": "string", + "enum": [ + "automatic", + "manual" + ], + "x-ms-enum": { + "name": "accountProvisioningMode", + "modelAsString": true + }, + "default": "manual", + "description": "The service account provisioning mode for this Active Directory connector." + }, + "ouDistinguishedName": { + "type": "string", + "description": "The distinguished name of the Active Directory Organizational Unit." + }, + "domainControllers": { + "$ref": "#/definitions/ActiveDirectoryDomainControllers", + "description": "null", + "x-ms-client-flatten": false + } + }, + "required": [ + "realm" + ] + }, + "ActiveDirectoryConnectorDNSDetails": { + "type": "object", + "description": "DNS server details", + "properties": { + "domainName": { + "type": "string", + "description": "DNS domain name for which DNS lookups should be forwarded to the Active Directory DNS servers." + }, + "nameserverIPAddresses": { + "type": "array", + "description": "List of Active Directory DNS server IP addresses.", + "items": { + "type": "string", + "minimum": 1 + } + }, + "replicas": { + "type": "integer", + "description": "Replica count for DNS proxy service. Default value is 1.", + "default": 1, + "format": "int64" + }, + "preferK8sDnsForPtrLookups": { + "type": "boolean", + "description": "Flag indicating whether to prefer Kubernetes DNS server response over AD DNS server response for IP address lookups.", + "default": true + } + }, + "required": [ + "nameserverIPAddresses" + ] + }, + "ActiveDirectoryDomainControllers": { + "type": "object", + "description": "Details about the Active Directory domain controllers associated with this AD connector instance", + "properties": { + "primaryDomainController": { + "$ref": "#/definitions/ActiveDirectoryDomainController", + "description": "Information about the Primary Domain Controller (PDC) in the AD domain.", + "x-ms-client-flatten": false + }, + "secondaryDomainControllers": { + "$ref": "#/definitions/ActiveDirectorySecondaryDomainControllers", + "description": "null", + "x-ms-client-flatten": false + } + } + }, + "ActiveDirectoryDomainController": { + "type": "object", + "description": "Information about a domain controller in the AD domain.", + "properties": { + "hostname": { + "type": "string", + "description": "Fully-qualified domain name of a domain controller in the AD domain." + } + }, + "required": [ + "hostname" + ] + }, + "ActiveDirectorySecondaryDomainControllers": { + "type": "array", + "description": "Information about the secondary domain controllers in the AD domain.", + "items": { + "$ref": "#/definitions/ActiveDirectoryDomainController", + "description": "List of the fully-qualified domain names of the secondary domain controllers in the AD domain.", + "x-ms-client-flatten": false + }, + "x-ms-identifiers": [ + "hostname" + ] + }, + "ActiveDirectoryConnectorStatus": { + "type": "object", + "description": "The status of the Kubernetes custom resource.", + "properties": { + "lastUpdateTime": { + "type": "string", + "description": "The time that the custom resource was last updated." + }, + "observedGeneration": { + "type": "integer", + "format": "int64", + "description": "The version of the replicaSet associated with the AD connector custom resource." + }, + "state": { + "type": "string", + "description": "The state of the AD connector custom resource." + } + }, + "additionalProperties": {} + } + }, + "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/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/azurearcdata.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/azurearcdata.json new file mode 100644 index 000000000000..5f93b34b812f --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/azurearcdata.json @@ -0,0 +1,2193 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.AzureArcData/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Azure Data Services on Azure Arc API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved operations.", + "schema": { + "$ref": "./operations.json#/definitions/OperationListResult" + } + }, + "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 * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Lists all of the available Azure Data Services on Azure Arc API operations.": { + "$ref": "./examples/ListOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/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": "./sqlManagedInstances.json#/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": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "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.AzureArcData/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": "./sqlManagedInstances.json#/definitions/SqlManagedInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "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.AzureArcData/sqlManagedInstances/{sqlManagedInstanceName}": { + "get": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Get", + "description": "Retrieves a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlManagedInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "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" + }, + { + "$ref": "#/parameters/sqlManagedInstanceName" + }, + { + "name": "sqlManagedInstance", + "in": "body", + "description": "The SQL Managed Instance to be created or updated.", + "required": true, + "schema": { + "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstance" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstance" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a SQL Managed Instance": { + "$ref": "./examples/CreateOrUpdateSqlManagedInstance.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Delete", + "description": "Deletes a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlManagedInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SQL Managed Instance." + }, + "202": { + "description": "Resource deletion is in progress." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified SQL Managed Instance does not exist." + } + }, + "x-ms-examples": { + "Delete a SQL Instance.": { + "$ref": "./examples/DeleteSqlManagedInstance.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Update", + "description": "Updates a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlManagedInstanceName" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL Managed Instance.", + "required": true, + "schema": { + "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstanceUpdate" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a sql Instance tags.": { + "$ref": "./examples/UpdateSqlManagedInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances/{sqlManagedInstanceName}/failoverGroups": { + "get": { + "tags": [ + "FailoverGroups" + ], + "operationId": "FailoverGroups_List", + "summary": "List the failover groups associated with the given sql managed instance.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlManagedInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./failoverGroups.json#/definitions/FailoverGroupListResult" + } + }, + "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": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all failover groups associated with a sql managed instance.": { + "$ref": "./examples/ListBySqlManagedInstanceFailoverGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances/{sqlManagedInstanceName}/failoverGroups/{failoverGroupName}": { + "put": { + "tags": [ + "FailoverGroups" + ], + "operationId": "FailoverGroups_Create", + "description": "Creates or replaces a failover group resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "failoverGroupResource", + "description": "desc", + "required": true, + "in": "body", + "schema": { + "$ref": "./failoverGroups.json#/definitions/FailoverGroupResource" + } + }, + { + "$ref": "#/parameters/sqlManagedInstanceName" + }, + { + "$ref": "#/parameters/failoverGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./failoverGroups.json#/definitions/FailoverGroupResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./failoverGroups.json#/definitions/FailoverGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create or update a failover group instance.": { + "$ref": "./examples/CreateOrUpdateFailoverGroup.json" + } + } + }, + "delete": { + "tags": [ + "FailoverGroups" + ], + "operationId": "FailoverGroups_Delete", + "description": "Deletes a failover group resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlManagedInstanceName" + }, + { + "$ref": "#/parameters/failoverGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the failover group." + }, + "202": { + "description": "Resource deletion is in progress." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified failover group does not exist." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes a failover group instance.": { + "$ref": "./examples/DeleteFailoverGroup.json" + } + } + }, + "get": { + "tags": [ + "FailoverGroups" + ], + "operationId": "FailoverGroups_Get", + "description": "Retrieves a failover group resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlManagedInstanceName" + }, + { + "$ref": "#/parameters/failoverGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./failoverGroups.json#/definitions/FailoverGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieves a failover group resource.": { + "$ref": "./examples/GetFailoverGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/sqlServerInstances": { + "get": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_List", + "summary": "List sqlServerInstance resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceListResult" + } + }, + "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": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Server Instance in a subscription.": { + "$ref": "./examples/ListSubscriptionSqlServerInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances": { + "get": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_ListByResourceGroup", + "description": "Gets all sqlServerInstances in a resource group.", + "summary": "List sqlServerInstance resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Server Instance in a resource group.": { + "$ref": "./examples/ListByResourceGroupSqlServerInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}": { + "get": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_Get", + "description": "Retrieves a SQL Server Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Server Instance tags.": { + "$ref": "./examples/GetSqlServerInstance.json" + } + } + }, + "put": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_Create", + "description": "Creates or replaces a SQL Server Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "name": "sqlServerInstance", + "in": "body", + "description": "The SQL Server Instance to be created or updated.", + "required": true, + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Server Instance tags.": { + "$ref": "./examples/CreateOrUpdateSqlServerInstance.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_Delete", + "description": "Deletes a SQL Server Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SQL Server Instance." + }, + "202": { + "description": "Resource deletion is in progress." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified SQL Server Instance does not exist." + } + }, + "x-ms-examples": { + "Delete a SQL Server Instance.": { + "$ref": "./examples/DeleteSqlServerInstance.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_Update", + "description": "Updates a SQL Server Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL Server Instance.", + "required": true, + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceUpdate" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" + } + }, + "202": { + "description": "Resource update is in progress.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Server Instance tags.": { + "$ref": "./examples/UpdateSqlServerInstance.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.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/getTelemetry": { + "post": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_getTelemetry", + "description": "Retrieves SQL Server instance telemetry", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "name": "sqlServerInstanceTelemetryRequest", + "in": "body", + "description": "Contains the parameters to get SQL Server instance telemetry.", + "required": true, + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceTelemetryRequest" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceTelemetryResponse" + } + }, + "202": { + "description": "Arc SQL Server telemetry retrieval is in progress.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the operation status." + } + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "operationName": "SqlServerInstances_PostInstanceTelemetry", + "itemName": "rows" + }, + "x-ms-examples": { + "Retrieves Arc SQL Server cpu utilization telemetry": { + "$ref": "./examples/GetSqlServerInstanceTelemetry.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.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/runMigrationAssessment": { + "post": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_runMigrationAssessment", + "description": "Runs migration assessment for SQL Server instance", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceRunMigrationAssessmentResponse" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Trigger migration assessment run on sql server instance": { + "$ref": "./examples/RunMigrationAssessmentSqlServerInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/getJobsStatus": { + "post": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_getJobsStatus", + "description": "Gets jobs status details for sql arc resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "name": "SqlServerInstanceJobsStatusRequest", + "in": "body", + "description": "Contains the parameters to get SQL Server instance agent jobs status.", + "required": false, + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceJobsStatusRequest" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceJobsStatusResponse" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieves Arc SQL Server instance jobs status": { + "$ref": "./examples/GetSqlServerInstanceJobsStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/preUpgrade": { + "post": { + "tags": [ + "SqlServerInstances" + ], + "description": "Request Upgrade Permission before upgrading.", + "operationId": "SqlServerInstances_preUpgrade", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully requested upgrade permission for the instance.", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Prepare SQL server instance for AUM Upgrade.": { + "$ref": "./examples/PreUpgradeSqlServerInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/postUpgrade": { + "post": { + "tags": [ + "SqlServerInstances" + ], + "description": "Clean up after upgrading.", + "operationId": "SqlServerInstances_postUpgrade", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully clean up upgrade request for the instance.", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Post AUM Upgrade to complete SQL Instance Upgrade Process": { + "$ref": "./examples/PostUpgradeSqlServerInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/sqlServerLicenses": { + "get": { + "tags": [ + "SqlServerLicenses" + ], + "operationId": "SqlServerLicenses_List", + "summary": "List sqlServerLicense resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerLicenses.json#/definitions/SqlServerLicenseListResult" + } + }, + "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": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Server license in a subscription.": { + "$ref": "./examples/ListSubscriptionSqlServerLicense.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerLicenses": { + "get": { + "tags": [ + "SqlServerLicenses" + ], + "operationId": "SqlServerLicenses_ListByResourceGroup", + "description": "Gets all sqlServerLicenses in a resource group.", + "summary": "List sqlServerLicense resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerLicenses.json#/definitions/SqlServerLicenseListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Server license in a resource group.": { + "$ref": "./examples/ListByResourceGroupSqlServerLicense.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerLicenses/{sqlServerLicenseName}": { + "get": { + "tags": [ + "SqlServerLicenses" + ], + "operationId": "SqlServerLicenses_Get", + "description": "Retrieves a SQL Server license resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerLicenseName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerLicenses.json#/definitions/SqlServerLicense" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets a SQL Server license tags.": { + "$ref": "./examples/GetSqlServerLicense.json" + } + } + }, + "put": { + "tags": [ + "SqlServerLicenses" + ], + "operationId": "SqlServerLicenses_Create", + "description": "Creates or replaces a SQL Server license resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerLicenseName" + }, + { + "name": "sqlServerLicense", + "in": "body", + "description": "The SQL Server license to be created or updated.", + "required": true, + "schema": { + "$ref": "./sqlServerLicenses.json#/definitions/SqlServerLicense" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerLicenses.json#/definitions/SqlServerLicense" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./sqlServerLicenses.json#/definitions/SqlServerLicense" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Server license tags.": { + "$ref": "./examples/CreateOrUpdateSqlServerLicense.json" + } + } + }, + "delete": { + "tags": [ + "SqlServerLicenses" + ], + "operationId": "SqlServerLicenses_Delete", + "description": "Deletes a SQL Server license resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerLicenseName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SQL Server license." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified SQL Server license does not exist." + } + }, + "x-ms-examples": { + "Delete a SQL Server license.": { + "$ref": "./examples/DeleteSqlServerLicense.json" + } + } + }, + "patch": { + "tags": [ + "SqlServerLicenses" + ], + "operationId": "SqlServerLicenses_Update", + "description": "Updates a SQL Server license resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerLicenseName" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL Server license.", + "required": true, + "schema": { + "$ref": "./sqlServerLicenses.json#/definitions/SqlServerLicenseUpdate" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerLicenses.json#/definitions/SqlServerLicense" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch a SQL Server license tags.": { + "$ref": "./examples/UpdateSqlServerLicense.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/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": "./dataControllers.json#/definitions/PageOfDataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all dataControllers in a subscription.": { + "$ref": "./examples/ListSubscriptionDataController.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/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": "./dataControllers.json#/definitions/PageOfDataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "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.AzureArcData/dataControllers/{dataControllerName}": { + "put": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_PutDataController", + "description": "Creates or replaces a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "dataControllerResource", + "description": "desc", + "required": true, + "in": "body", + "schema": { + "$ref": "./dataControllers.json#/definitions/DataControllerResource" + } + }, + { + "$ref": "#/parameters/dataControllerName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./dataControllers.json#/definitions/DataControllerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./dataControllers.json#/definitions/DataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a Data Controller.": { + "$ref": "./examples/CreateOrUpdateDataController.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_DeleteDataController", + "description": "Deletes a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/dataControllerName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the DataController." + }, + "202": { + "description": "Resource deletion is in progress." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified DataController does not exist." + } + }, + "x-ms-examples": { + "Delete a dataController.": { + "$ref": "./examples/DeleteDataController.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_GetDataController", + "description": "Retrieves a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/dataControllerName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./dataControllers.json#/definitions/DataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a data controller.": { + "$ref": "./examples/GetDataController.json" + } + } + }, + "patch": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_PatchDataController", + "description": "Updates a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/dataControllerName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "name": "dataControllerResource", + "description": "The update data controller resource", + "required": true, + "in": "body", + "schema": { + "$ref": "./dataControllers.json#/definitions/DataControllerUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./dataControllers.json#/definitions/DataControllerResource" + } + }, + "202": { + "description": "Resource update is in progress." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a dataController tags.": { + "$ref": "./examples/UpdateDataController.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.AzureArcData/dataControllers/{dataControllerName}/activeDirectoryConnectors": { + "get": { + "tags": [ + "ActiveDirectoryConnectors" + ], + "operationId": "ActiveDirectoryConnectors_List", + "summary": "List the active directory connectors associated with the given data controller.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/dataControllerName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./activeDirectoryConnectors.json#/definitions/ActiveDirectoryConnectorListResult" + } + }, + "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": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all Active Directory connectors associated with a data controller.": { + "$ref": "./examples/ListByDataControllerActiveDirectoryConnector.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers/{dataControllerName}/activeDirectoryConnectors/{activeDirectoryConnectorName}": { + "put": { + "tags": [ + "ActiveDirectoryConnectors" + ], + "operationId": "ActiveDirectoryConnectors_Create", + "description": "Creates or replaces an Active Directory connector resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "activeDirectoryConnectorResource", + "description": "desc", + "required": true, + "in": "body", + "schema": { + "$ref": "./activeDirectoryConnectors.json#/definitions/ActiveDirectoryConnectorResource" + } + }, + { + "$ref": "#/parameters/dataControllerName" + }, + { + "$ref": "#/parameters/activeDirectoryConnectorName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./activeDirectoryConnectors.json#/definitions/ActiveDirectoryConnectorResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./activeDirectoryConnectors.json#/definitions/ActiveDirectoryConnectorResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create or update an Active Directory connector instance.": { + "$ref": "./examples/CreateOrUpdateActiveDirectoryConnector.json" + } + } + }, + "delete": { + "tags": [ + "ActiveDirectoryConnectors" + ], + "operationId": "ActiveDirectoryConnectors_Delete", + "description": "Deletes an Active Directory connector resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/dataControllerName" + }, + { + "$ref": "#/parameters/activeDirectoryConnectorName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the active directory connector." + }, + "202": { + "description": "Resource deletion is in progress." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified active directory connector does not exist." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes an Active Directory connector instance.": { + "$ref": "./examples/DeleteActiveDirectoryConnector.json" + } + } + }, + "get": { + "tags": [ + "ActiveDirectoryConnectors" + ], + "operationId": "ActiveDirectoryConnectors_Get", + "description": "Retrieves an Active Directory connector resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/dataControllerName" + }, + { + "$ref": "#/parameters/activeDirectoryConnectorName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./activeDirectoryConnectors.json#/definitions/ActiveDirectoryConnectorResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieves an Active Directory connector resource.": { + "$ref": "./examples/GetActiveDirectoryConnector.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/postgresInstances": { + "get": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_List", + "summary": "List postgres Instance resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./postgresInstances.json#/definitions/PostgresInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all Postgres Instance in a subscription.": { + "$ref": "./examples/ListSubscriptionPostgresInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/postgresInstances": { + "get": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_ListByResourceGroup", + "description": "Get a postgres Instances list by Resource group name.", + "summary": "List postgres Instance resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./postgresInstances.json#/definitions/PostgresInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all postgres Instances in a resource group.": { + "$ref": "./examples/ListByResourceGroupPostgresInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/postgresInstances/{postgresInstanceName}": { + "get": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_Get", + "description": "Retrieves a postgres Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/postgresInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./postgresInstances.json#/definitions/PostgresInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "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" + }, + { + "$ref": "#/parameters/postgresInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "name": "resource", + "description": "The postgres instance", + "required": true, + "in": "body", + "schema": { + "$ref": "./postgresInstances.json#/definitions/PostgresInstance" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./postgresInstances.json#/definitions/PostgresInstance" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./postgresInstances.json#/definitions/PostgresInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a Postgres Instance.": { + "$ref": "./examples/CreateOrUpdatePostgresInstance.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_Delete", + "description": "Deletes a postgres Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/postgresInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the Postgres Instance." + }, + "202": { + "description": "Resource deletion is in progress." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified Postgres Instance does not exist." + } + }, + "x-ms-examples": { + "Deletes a PostgresInstances.": { + "$ref": "./examples/DeletePostgresInstance.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_Update", + "description": "Updates a postgres Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/postgresInstanceName" + }, + { + "name": "parameters", + "in": "body", + "description": "The Postgres Instance.", + "required": true, + "schema": { + "$ref": "./postgresInstances.json#/definitions/PostgresInstanceUpdate" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./postgresInstances.json#/definitions/PostgresInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a postgres Instances tags.": { + "$ref": "./examples/UpdatePostgresInstance.json" + } + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Azure subscription", + "x-ms-parameter-location": "client" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group", + "x-ms-parameter-location": "method" + }, + "location": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure region to use for the request", + "x-ms-parameter-location": "method" + }, + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + }, + "dataControllerName": { + "name": "dataControllerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the data controller", + "x-ms-parameter-location": "method" + }, + "activeDirectoryConnectorName": { + "name": "activeDirectoryConnectorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Active Directory connector instance", + "x-ms-parameter-location": "method" + }, + "sqlManagedInstanceName": { + "name": "sqlManagedInstanceName", + "description": "Name of SQL Managed Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "failoverGroupName": { + "name": "failoverGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Failover Group", + "x-ms-parameter-location": "method" + }, + "sqlServerInstanceName": { + "name": "sqlServerInstanceName", + "description": "Name of SQL Server Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "sqlServerLicenseName": { + "name": "sqlServerLicenseName", + "description": "Name of SQL Server License", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "x-ms-parameter-location": "method" + }, + "postgresInstanceName": { + "name": "postgresInstanceName", + "description": "Name of Postgres Instance", + "in": "path", + "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/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/common.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/common.json new file mode 100644 index 000000000000..165fc4a44d4a --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/common.json @@ -0,0 +1,159 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "CommonSku": { + "description": "The resource model definition representing SKU for ARM resources", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU. It is typically a letter+number code" + }, + "dev": { + "type": "boolean", + "default": true, + "description": "Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose. " + }, + "size": { + "type": "string", + "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. " + }, + "family": { + "type": "string", + "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here." + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted." + } + }, + "required": [ + "name" + ] + }, + "ExtendedLocation": { + "type": "object", + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "The type of the extended location." + } + } + }, + "ExtendedLocationType": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "CustomLocation" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true + } + }, + "BasicLoginInformation": { + "type": "object", + "description": "Username and password for basic login authentication.", + "properties": { + "username": { + "type": "string", + "description": "Login username." + }, + "password": { + "type": "string", + "description": "Login password.", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + }, + "ConnectionAuth": { + "type": "string", + "description": "The endpoint connection authentication type(s).", + "enum": [ + "Windows_NTLM", + "Windows_Kerberos", + "Windows_Negotiate", + "Certificate", + "Windows_NTLM_Certificate", + "Windows_Kerberos_Certificate", + "Windows_Negotiate_Certificate", + "Certificate_Windows_NTLM", + "Certificate_Windows_Kerberos", + "Certificate_Windows_Negotiate" + ], + "x-ms-enum": { + "name": "connectionAuth", + "modelAsString": true + } + }, + "EncryptionAlgorithm": { + "type": "string", + "description": "The encryption algorithm(s) used by the endpoint.", + "enum": [ + "NONE", + "RC4", + "AES", + "NONE, RC4", + "NONE, AES", + "RC4, AES", + "AES, RC4", + "NONE, RC4, AES", + "NONE, AES, RC4" + ], + "x-ms-enum": { + "name": "encryptionAlgorithm", + "modelAsString": true + } + }, + "SkuRecommendationResultsRecommendationStatus": { + "description": "The target recommendation Status for this database.", + "type": "string", + "enum": [ + "NotReady", + "Ready", + "Unknown" + ], + "x-ms-enum": { + "name": "recommendationStatus", + "modelAsString": true + } + } + }, + "parameters": { + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + } + }, + "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/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/dataControllers.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/dataControllers.json new file mode 100644 index 000000000000..49ddde5fc14f --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/dataControllers.json @@ -0,0 +1,253 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "DataControllerResource": { + "description": "Data controller resource", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "extendedLocation": { + "$ref": "./common.json#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + }, + "properties": { + "$ref": "#/definitions/DataControllerProperties", + "description": "The data controller's properties", + "x-ms-client-flatten": false + } + }, + "required": [ + "properties" + ] + }, + "PageOfDataControllerResource": { + "type": "object", + "description": "A list of data controllers.", + "properties": { + "value": { + "items": { + "$ref": "#/definitions/DataControllerResource" + }, + "type": "array", + "description": "Array of results." + }, + "nextLink": { + "type": "string", + "description": "Link to retrieve next page of results." + } + } + }, + "DataControllerUpdate": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "properties": { + "$ref": "#/definitions/DataControllerProperties", + "description": "The data controller's properties", + "x-ms-client-flatten": false + } + }, + "description": "Used for updating a data controller resource." + }, + "DataControllerProperties": { + "description": "The data controller properties.", + "type": "object", + "properties": { + "infrastructure": { + "type": "string", + "enum": [ + "azure", + "gcp", + "aws", + "alibaba", + "onpremises", + "other" + ], + "x-ms-enum": { + "name": "infrastructure", + "modelAsString": false + }, + "default": "other", + "description": "The infrastructure the data controller is running on." + }, + "onPremiseProperty": { + "$ref": "#/definitions/OnPremiseProperty" + }, + "k8sRaw": { + "type": "object", + "description": "The raw kubernetes information" + }, + "uploadWatermark": { + "$ref": "#/definitions/UploadWatermark" + }, + "lastUploadedDate": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date from Kubernetes cluster. Defaults to current date time" + }, + "basicLoginInformation": { + "$ref": "./common.json#/definitions/BasicLoginInformation", + "description": "Deprecated. Azure Arc Data Services data controller no longer expose any endpoint. All traffic are exposed through Kubernetes native API." + }, + "metricsDashboardCredential": { + "$ref": "./common.json#/definitions/BasicLoginInformation", + "description": "Login credential for metrics dashboard on the Kubernetes cluster." + }, + "logsDashboardCredential": { + "$ref": "./common.json#/definitions/BasicLoginInformation", + "description": "Login credential for logs dashboard on the Kubernetes cluster." + }, + "logAnalyticsWorkspaceConfig": { + "$ref": "#/definitions/LogAnalyticsWorkspaceConfig" + }, + "uploadServicePrincipal": { + "$ref": "#/definitions/UploadServicePrincipal", + "description": "Deprecated. Service principal is deprecated in favor of Arc Kubernetes service extension managed identity." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the Arc Data Controller resource.", + "readOnly": true + }, + "clusterId": { + "type": "string", + "description": "If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to." + }, + "extensionId": { + "type": "string", + "description": "If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to." + } + } + }, + "UploadWatermark": { + "description": "Properties on upload watermark. Mostly timestamp for each upload data type", + "type": "object", + "properties": { + "metrics": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date for metrics from kubernetes cluster. Defaults to current date time" + }, + "logs": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date for logs from kubernetes cluster. Defaults to current date time" + }, + "usages": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date for usages from kubernetes cluster. Defaults to current date time" + } + } + }, + "OnPremiseProperty": { + "description": "Properties from the Kubernetes data controller", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "A globally unique ID identifying the associated Kubernetes cluster" + }, + "publicSigningKey": { + "type": "string", + "description": "Certificate that contains the Kubernetes cluster public key used to verify signing" + }, + "signingCertificateThumbprint": { + "type": "string", + "description": "Unique thumbprint returned to customer to verify the certificate being uploaded" + } + }, + "required": [ + "id", + "publicSigningKey" + ] + }, + "LogAnalyticsWorkspaceConfig": { + "type": "object", + "description": "Log analytics workspace id and primary key", + "properties": { + "workspaceId": { + "type": "string", + "format": "uuid", + "description": "Azure Log Analytics workspace ID" + }, + "primaryKey": { + "type": "string", + "description": "Primary key of the workspace", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + }, + "UploadServicePrincipal": { + "type": "object", + "description": "Service principal for uploading billing, metrics and logs.", + "properties": { + "clientId": { + "type": "string", + "format": "uuid", + "description": "Client ID of the service principal for uploading data." + }, + "tenantId": { + "type": "string", + "format": "uuid", + "description": "Tenant ID of the service principal." + }, + "authority": { + "type": "string", + "description": "Authority for the service principal. Example: https://login.microsoftonline.com/" + }, + "clientSecret": { + "type": "string", + "description": "Secret of the service principal", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + } + }, + "parameters": { + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + } + }, + "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/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/AddDatabasesToAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/AddDatabasesToAvailabilityGroup.json new file mode 100644 index 000000000000..10d381325fed --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/AddDatabasesToAvailabilityGroup.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "availabilityGroupName": "testAG", + "databases": { + "values": [ + "db1", + "db2", + "db3" + ] + }, + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY", + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateActiveDirectoryConnector.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateActiveDirectoryConnector.json new file mode 100644 index 000000000000..b14fcf3fda0e --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateActiveDirectoryConnector.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "activeDirectoryConnectorName": "testADConnector", + "api-version": "2024-05-01-preview", + "activeDirectoryConnectorResource": { + "properties": { + "spec": { + "activeDirectory": { + "realm": "CONTOSO.LOCAL", + "serviceAccountProvisioning": "manual", + "domainControllers": { + "primaryDomainController": { + "hostname": "dc1.contoso.local" + }, + "secondaryDomainControllers": [ + { + "hostname": "dc2.contoso.local" + }, + { + "hostname": "dc3.contoso.local" + } + ] + } + }, + "dns": { + "nameserverIPAddresses": [ + "11.11.111.111", + "22.22.222.222" + ], + "replicas": 1, + "preferK8sDnsForPtrLookups": false + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "spec": { + "activeDirectory": { + "realm": "CONTOSO.LOCAL", + "serviceAccountProvisioning": "manual", + "domainControllers": { + "primaryDomainController": { + "hostname": "dc1.contoso.local" + }, + "secondaryDomainControllers": [ + { + "hostname": "dc2.contoso.local" + }, + { + "hostname": "dc3.contoso.local" + } + ] + }, + "netbiosDomainName": "CONTOSO" + }, + "dns": { + "nameserverIPAddresses": [ + "11.11.111.111", + "22.22.222.222" + ], + "replicas": 1, + "preferK8sDnsForPtrLookups": false, + "domainName": "contoso.local" + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController/activeDirectoryConnectors/testADConnector", + "name": "testADConnector", + "type": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors" + } + }, + "201": { + "body": { + "properties": { + "spec": { + "activeDirectory": { + "realm": "CONTOSO.LOCAL", + "serviceAccountProvisioning": "manual", + "domainControllers": { + "primaryDomainController": { + "hostname": "dc1.contoso.local" + }, + "secondaryDomainControllers": [ + { + "hostname": "dc2.contoso.local" + }, + { + "hostname": "dc3.contoso.local" + } + ] + }, + "netbiosDomainName": "CONTOSO" + }, + "dns": { + "nameserverIPAddresses": [ + "11.11.111.111", + "22.22.222.222" + ], + "replicas": 1, + "preferK8sDnsForPtrLookups": false, + "domainName": "contoso.local" + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController/activeDirectoryConnectors/testADConnector", + "name": "testADConnector", + "type": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateArcSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateArcSqlServerAvailabilityGroup.json new file mode 100644 index 000000000000..5a7af1d03c87 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateArcSqlServerAvailabilityGroup.json @@ -0,0 +1,223 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "availabilityGroupName": "testAG", + "api-version": "2024-05-01-preview", + "sqlServerAvailabilityGroupResource": { + "location": "southeastasia", + "tags": { + "mytag": "myval" + }, + "properties": { + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "secondaryRecoveryHealthDescription": null, + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "sessionTimeout": 10, + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1" + }, + { + "databaseName": "db2" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServerInstance", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + }, + "201": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServerInstance", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateArcSqlServerDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateArcSqlServerDatabase.json new file mode 100644 index 000000000000..2fc04715ef44 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateArcSqlServerDatabase.json @@ -0,0 +1,156 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServerInstance", + "databaseName": "testdb", + "api-version": "2024-05-01-preview", + "sqlServerDatabaseResource": { + "location": "southeastasia", + "tags": { + "mytag": "myval" + }, + "properties": { + "collationName": "SQL_Latin1_General_CP1_CI_AS", + "databaseCreationDate": "2022-04-05T16:26:33.883Z", + "compatibilityLevel": 150, + "state": "Online", + "isReadOnly": true, + "recoveryMode": "Full", + "sizeMB": 150.0, + "spaceAvailableMB": 100.0, + "databaseOptions": { + "isAutoCloseOn": true, + "isAutoShrinkOn": true, + "isAutoCreateStatsOn": true, + "isAutoUpdateStatsOn": true, + "isMemoryOptimizationEnabled": true, + "isRemoteDataArchiveEnabled": true, + "isEncrypted": true, + "isTrustworthyOn": true + }, + "backupInformation": { + "lastFullBackup": "2022-05-05T16:26:33.883Z", + "lastLogBackup": "2022-05-10T16:26:33.883Z" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "createMode": "PointInTimeRestore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/MyDatabase", + "restorePointInTime": "2022-05-05T16:26:33.883Z" + } + } + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/testdb", + "name": "testdb", + "type": "Microsoft.AzureArcData/sqlServerInstances/databases", + "properties": { + "collationName": "SQL_Latin1_General_CP1_CI_AS", + "databaseCreationDate": "2022-04-05T16:26:33.883Z", + "compatibilityLevel": 150, + "state": "Online", + "isReadOnly": true, + "recoveryMode": "Full", + "sizeMB": 150.0, + "spaceAvailableMB": 100.0, + "databaseOptions": { + "isAutoCloseOn": true, + "isAutoShrinkOn": true, + "isAutoCreateStatsOn": true, + "isAutoUpdateStatsOn": true, + "isMemoryOptimizationEnabled": true, + "isRemoteDataArchiveEnabled": true, + "isEncrypted": true, + "isTrustworthyOn": true + }, + "backupInformation": { + "lastFullBackup": "2022-05-05T16:26:33.883Z", + "lastLogBackup": "2022-05-10T16:26:33.883Z" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "earliestRestoreDate": "2022-05-10T16:26:33.883Z", + "createMode": "PointInTimeRestore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/MyDatabase", + "restorePointInTime": "2022-05-05T16:26:33.883Z" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + }, + "201": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/testdb", + "name": "testdb", + "type": "Microsoft.AzureArcData/sqlServerInstances/databases", + "properties": { + "collationName": "SQL_Latin1_General_CP1_CI_AS", + "databaseCreationDate": "2022-04-05T16:26:33.883Z", + "compatibilityLevel": 150, + "state": "Online", + "isReadOnly": true, + "recoveryMode": "Full", + "sizeMB": 150.0, + "spaceAvailableMB": 100.0, + "databaseOptions": { + "isAutoCloseOn": true, + "isAutoShrinkOn": true, + "isAutoCreateStatsOn": true, + "isAutoUpdateStatsOn": true, + "isMemoryOptimizationEnabled": true, + "isRemoteDataArchiveEnabled": true, + "isEncrypted": true, + "isTrustworthyOn": true + }, + "backupInformation": { + "lastFullBackup": "2022-05-05T16:26:33.883Z", + "lastLogBackup": "2022-05-10T16:26:33.883Z" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "earliestRestoreDate": "2022-05-10T16:26:33.883Z", + "createMode": "PointInTimeRestore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/MyDatabase", + "restorePointInTime": "2022-05-05T16:26:33.883Z" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateDataController.json new file mode 100644 index 000000000000..0073fe4ff49d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateDataController.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "api-version": "2024-05-01-preview", + "dataControllerResource": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey" + }, + "basicLoginInformation": { + "username": "username", + "password": "********" + }, + "metricsDashboardCredential": { + "username": "username", + "password": "********" + }, + "logsDashboardCredential": { + "username": "username", + "password": "********" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444", + "primaryKey": "********" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/", + "clientSecret": "********" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate being uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "metricsDashboardCredential": { + "username": "username" + }, + "logsDashboardCredential": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController", + "name": "testdataController", + "type": "Microsoft.AzureArcData/dataControllers" + } + }, + "201": { + "body": { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate being uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "metricsDashboardCredential": { + "username": "username" + }, + "logsDashboardCredential": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController", + "name": "testdataController", + "type": "Microsoft.AzureArcData/dataControllers" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateFailoverGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateFailoverGroup.json new file mode 100644 index 000000000000..068b2580a5ff --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateFailoverGroup.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testSqlManagedInstance", + "failoverGroupName": "testFailoverGroupName", + "api-version": "2024-05-01-preview", + "failoverGroupResource": { + "properties": { + "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/partnerMI", + "spec": { + "partnerSyncMode": "async", + "role": "primary" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/partnerMI", + "spec": { + "sharedName": "testSharedName", + "sourceMI": "sourceSQLMI", + "partnerMI": "partnerMI", + "partnerMirroringURL": "11.11.111.111:1111", + "partnerMirroringCert": "testCert", + "partnerSyncMode": "async", + "role": "primary" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testSqlManagedInstance/failoverGroups/testFailoverGroupName", + "name": "testFailoverGroupName", + "type": "Microsoft.AzureArcData/sqlManagedInstances/failoverGroups" + } + }, + "201": { + "body": { + "properties": { + "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/partnerMI", + "spec": { + "sharedName": "testSharedName", + "sourceMI": "sourceSQLMI", + "partnerMI": "partnerMI", + "partnerMirroringURL": "11.11.111.111:1111", + "partnerMirroringCert": "testCert", + "partnerSyncMode": "async", + "role": "primary" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testSqlManagedInstance/failoverGroups/testFailoverGroupName", + "name": "testFailoverGroupName", + "type": "Microsoft.AzureArcData/sqlManagedInstances/failoverGroups" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdatePostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdatePostgresInstance.json new file mode 100644 index 000000000000..e6a865dc7e08 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdatePostgresInstance.json @@ -0,0 +1,172 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "postgresInstanceName": "testpostgresInstance", + "api-version": "2024-05-01-preview", + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "resource": { + "location": "eastus", + "properties": { + "dataControllerId": "dataControllerId", + "admin": "admin", + "basicLoginInformation": { + "username": "username", + "password": "********" + }, + "k8sRaw": { + "apiVersion": "apiVersion", + "kind": "postgresql-12", + "metadata": { + "creationTimestamp": "2020-08-25T14:55:10Z", + "generation": 1, + "name": "pg1", + "namespace": "test", + "resourceVersion": "527780", + "selfLink": "/apis/arcdata.microsoft.com/v1alpha1/namespaces/test/postgresql-12s/pg1", + "uid": "1111aaaa-ffff-ffff-ffff-99999aaaaaaa" + }, + "spec": { + "backups": { + "deltaMinutes": 3, + "fullMinutes": 10, + "tiers": [ + { + "retention": { + "maximums": [ + "6", + "512MB" + ], + "minimums": [ + "3" + ] + }, + "storage": { + "volumeSize": "1Gi" + } + } + ] + }, + "engine": { + "extensions": [ + { + "name": "citus" + } + ] + }, + "scale": { + "shards": 3 + }, + "scheduling": { + "default": { + "resources": { + "requests": { + "memory": "256Mi" + } + } + } + }, + "service": { + "type": "NodePort" + }, + "storage": { + "data": { + "className": "local-storage", + "size": "5Gi" + }, + "logs": { + "className": "local-storage", + "size": "5Gi" + } + } + }, + "status": { + "externalEndpoint": null, + "readyPods": "4/4", + "state": "Ready" + } + } + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstance/testpostgresInstance", + "name": "testpostgresInstance", + "type": "Microsoft.AzureArcData/PostgresInstance" + } + }, + "201": { + "body": { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstance/testpostgresInstance", + "name": "testsqlregistration", + "type": "Microsoft.AzureArcData/PostgresInstance" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlManagedInstance.json new file mode 100644 index 000000000000..3d0384a2843c --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlManagedInstance.json @@ -0,0 +1,267 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2024-05-01-preview", + "sqlManagedInstance": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username", + "password": "********" + }, + "activeDirectoryInformation": { + "keytabInformation": { + "keytab": "********" + } + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + }, + "security": { + "adminLoginSecret": "test-sql-login-secret", + "serviceCertificateSecret": "Service Certificate Secret", + "activeDirectory": { + "connector": { + "name": "Name of connector", + "namespace": "Namespace of connector" + }, + "accountName": "Account name", + "keytabSecret": "Key tab secret of account", + "encryptionTypes": [ + "Encryption type item1, Encryption type item2,..." + ] + }, + "transparentDataEncryption": { + "mode": "SystemManaged" + } + }, + "settings": { + "network": { + "forceencryption": 0, + "tlsciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384", + "tlsprotocols": "1.2" + } + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "activeDirectoryInformation": { + "keytabInformation": {} + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + }, + "security": { + "adminLoginSecret": "test-sql-login-secret", + "serviceCertificateSecret": "Service Certificate Secret", + "activeDirectory": { + "connector": { + "name": "Name of connector", + "namespace": "Namespace of connector" + }, + "accountName": "Account name", + "keytabSecret": "Key tab secret of account", + "encryptionTypes": [ + "Encryption type item1, Encryption type item2,..." + ] + }, + "transparentDataEncryption": { + "mode": "SystemManaged" + } + }, + "settings": { + "network": { + "forceencryption": 0, + "tlsciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384", + "tlsprotocols": "1.2" + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + }, + "201": { + "body": { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "activeDirectoryInformation": { + "keytabInformation": {} + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + }, + "security": { + "adminLoginSecret": "test-sql-login-secret", + "serviceCertificateSecret": "Service Certificate Secret", + "activeDirectory": { + "connector": { + "name": "Name of connector", + "namespace": "Namespace of connector" + }, + "accountName": "Account name", + "keytabSecret": "Key tab secret of account", + "encryptionTypes": [ + "Encryption type item1, Encryption type item2,..." + ] + }, + "transparentDataEncryption": { + "mode": "SystemManaged" + } + }, + "settings": { + "network": { + "forceencryption": 0, + "tlsciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384", + "tlsprotocols": "1.2" + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerEsuLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerEsuLicense.json new file mode 100644 index 000000000000..5c06a00b721d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerEsuLicense.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerEsuLicenseName": "testsqlServerEsuLicense", + "api-version": "2024-05-01-preview", + "sqlServerEsuLicense": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "properties": { + "billingPlan": "PAYG", + "version": "SQL Server 2012", + "physicalCores": 24, + "activationState": "Inactive", + "scopeType": "Subscription" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "billingPlan": "PAYG", + "version": "SQL Server 2012", + "uniqueId": "00000000-1111-2222-3333-444444444444", + "physicalCores": 24, + "activationState": "Inactive", + "scopeType": "Subscription", + "activatedAt": "2020-01-01T17:18:19.1234567Z", + "terminatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/sqlServerEsuLicense", + "name": "sqlServerEsuLicense", + "type": "Microsoft.AzureArcData/sqlServerEsuLicenses" + } + }, + "201": { + "body": { + "properties": { + "billingPlan": "PAYG", + "version": "SQL Server 2012", + "uniqueId": "00000000-1111-2222-3333-444444444444", + "physicalCores": 24, + "activationState": "Inactive", + "scopeType": "Subscription", + "activatedAt": "2020-01-01T17:18:19.1234567Z", + "terminatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/sqlServerEsuLicense", + "name": "sqlServerEsuLicense", + "type": "Microsoft.AzureArcData/sqlServerEsuLicenses" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerInstance.json new file mode 100644 index 000000000000..4e7749baa078 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerInstance.json @@ -0,0 +1,179 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2024-05-01-preview", + "sqlServerInstance": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "properties": { + "version": "SQL Server 2012", + "edition": "Developer", + "cores": "4", + "instanceName": "name of instance", + "hostType": "Physical Server", + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "monitoring": { + "enabled": false + }, + "migration": { + "assessment": { + "enabled": false + } + }, + "clientConnection": { + "enabled": false + }, + "serviceType": "Engine" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "version": "SQL Server 2012", + "edition": "Developer", + "containerResourceId": "Resource id of hosting Arc Machine", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2012", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "status": "Registered", + "azureDefenderStatus": "Protected", + "hostType": "Physical Server", + "lastInventoryUploadTime": "2023-03-29T14:13:12Z", + "lastUsageUploadTime": "2023-03-29T14:13:12Z", + "alwaysOnRole": "FailoverClusterInstance", + "failoverCluster": { + "id": "f836af7e-85ed-4ea4-91fb-67709b34e323", + "networkName": "networkNameOfSQLFCI", + "sqlInstanceIds": [ + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer1", + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer2" + ], + "hostNames": [ + "DEV-HOSTNAME1", + "DEV-HOSTNAME2" + ] + }, + "databaseMirroringEndpoint": { + "endpointName": "testMirroringEndpoint", + "role": "PARTNER", + "isEncryptionEnabled": true, + "encryptionAlgorithm": "AES", + "connectionAuth": "Certificate", + "port": 12345, + "isDynamicPort": false, + "ipAddress": "123.124.125.126", + "certificateName": "testCertificateName" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "upgradeLockedUntil": "2022-05-05T16:26:33.883Z", + "monitoring": { + "enabled": false + }, + "serviceType": "Engine" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + }, + "201": { + "body": { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "status": "Connected", + "azureDefenderStatus": "Protected", + "monitoring": { + "enabled": false + }, + "migration": { + "assessment": { + "enabled": false + } + }, + "clientConnection": { + "enabled": false + }, + "serviceType": "SSRS" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerLicense.json new file mode 100644 index 000000000000..df774923e646 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerLicense.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerLicenseName": "testsqlServerLicense", + "api-version": "2024-05-01-preview", + "sqlServerLicense": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription", + "lastActivatedAt": "2020-01-01T17:18:19.1234567Z", + "lastDeactivatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerLicenses/sqlServerLicense", + "name": "sqlServerLicense", + "type": "Microsoft.AzureArcData/SqlServerLicenses" + } + }, + "201": { + "body": { + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription", + "lastActivatedAt": "2020-01-01T17:18:19.1234567Z", + "lastDeactivatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerLicenses/sqlServerLicense", + "name": "sqlServerLicense", + "type": "Microsoft.AzureArcData/SqlServerLicenses" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateSqlServerAvailabilityGroup.json new file mode 100644 index 000000000000..6387ac3dea93 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateSqlServerAvailabilityGroup.json @@ -0,0 +1,187 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "api-version": "2024-05-01-preview", + "createAgConfiguration": { + "availabilityGroupName": "myNewAg", + "replicas": [ + { + "serverInstance": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/", + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://testSqlServer_INST1.testSqlserverDomain:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityMode": "SYNCHRONOUS_COMMIT", + "failoverMode": "AUTOMATIC", + "seedingMode": "AUTOMATIC", + "backupPriority": 50, + "secondaryRoleAllowConnections": "ALL", + "secondaryRoleReadOnlyRoutingUrl": null, + "primaryRoleAllowConnections": "ALL", + "primaryRoleReadOnlyRoutingList": null, + "sessionTimeout": 10 + }, + { + "serverInstance": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST2/", + "endpointName": "inst2DBMEndpoint", + "endpointUrl": "TCP://testSqlServer_INST2.testSqlserverDomain:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityMode": "SYNCHRONOUS_COMMIT", + "failoverMode": "AUTOMATIC", + "seedingMode": "AUTOMATIC", + "backupPriority": 50, + "secondaryRoleAllowConnections": "ALL", + "secondaryRoleReadOnlyRoutingUrl": null, + "primaryRoleAllowConnections": "ALL", + "primaryRoleReadOnlyRoutingList": null, + "sessionTimeout": 10 + } + ], + "databases": [ + "database1", + "database2" + ], + "automatedBackupPreference": "SECONDARY", + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "dbFailover": "ON", + "dtcSupport": "NONE", + "requiredSynchronizedSecondariesToCommit": 0, + "clusterType": "WSFC", + "listener": { + "dnsName": "myNewAgListener", + "ipV4AddressesAndMasks": [ + { + "ipAddress": "192.1.168.5", + "mask": "255.255.255.0" + }, + { + "ipAddress": "10.1.168.5", + "mask": "255.255.255.0" + } + ], + "port": 1433 + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.AzureArcData/operationResults/id1" + } + }, + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/myNewAg", + "name": "myNewag", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\Inst1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://testSqlServer_INST1.testSqlserverDomain:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "AUTOMATIC", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "PRIMARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + }, + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\Inst2", + "configure": { + "endpointName": "ins21DBMEndpoint", + "endpointUrl": "TCP://testSqlServer_INST2.testSqlserverDomain:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "AUTOMATIC", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "database1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "database2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateSqlServerDistributedAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateSqlServerDistributedAvailabilityGroup.json new file mode 100644 index 000000000000..bd9f3fd062c7 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateSqlServerDistributedAvailabilityGroup.json @@ -0,0 +1,155 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "api-version": "2024-05-01-preview", + "createDagConfiguration": { + "availabilityGroupName": "myNewDag", + "primaryAvailabilityGroup": { + "availabilityGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG1", + "listenerUrl": "TCP://testAG1.contoso.com:5022", + "availabilityMode": "ASYNCHRONOUS_COMMIT", + "failoverMode": "MANUAL", + "seedingMode": "AUTOMATIC", + "certificateConfiguration": { + "certificateName": "myCert" + } + }, + "secondaryAvailabilityGroup": { + "availabilityGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST2/availabilityGroups/testAG2", + "listenerUrl": "TCP://testAG2.contoso.com:5022", + "availabilityMode": "ASYNCHRONOUS_COMMIT", + "failoverMode": "MANUAL", + "seedingMode": "AUTOMATIC", + "certificateConfiguration": { + "certificateName": "myCert" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.AzureArcData/operationResults/id1" + } + }, + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/myNewDag", + "name": "myNewDag", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "isDistributed": true + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\Inst1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://testSqlServer_INST1.testSqlserverDomain:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "AUTOMATIC", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "PRIMARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + }, + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\Inst2", + "configure": { + "endpointName": "ins21DBMEndpoint", + "endpointUrl": "TCP://testSqlServer_INST2.testSqlserverDomain:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "AUTOMATIC", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "database1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "database2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteActiveDirectoryConnector.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteActiveDirectoryConnector.json new file mode 100644 index 000000000000..3edead6e00e2 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteActiveDirectoryConnector.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "activeDirectoryConnectorName": "testADConnector", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteArcSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteArcSqlServerAvailabilityGroup.json new file mode 100644 index 000000000000..666b2db57f72 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteArcSqlServerAvailabilityGroup.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlInstanceAvailabilityGroup", + "availabilityGroupName": "testAG", + "api-version": "2024-05-01-preview" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteArcSqlServerDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteArcSqlServerDatabase.json new file mode 100644 index 000000000000..8bcd13277d4d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteArcSqlServerDatabase.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlManagedInstance", + "databaseName": "testdb", + "api-version": "2024-05-01-preview" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteDataController.json new file mode 100644 index 000000000000..73053e5c0e7c --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteDataController.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteFailoverGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteFailoverGroup.json new file mode 100644 index 000000000000..acaf1b6effbd --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteFailoverGroup.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testSqlManagedInstance", + "failoverGroupName": "testFailoverGroupName", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeletePostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeletePostgresInstance.json new file mode 100644 index 000000000000..f99fda21bf30 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeletePostgresInstance.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "postgresInstanceName": "testpostgresInstance", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlManagedInstance.json new file mode 100644 index 000000000000..22b0c85fa325 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlManagedInstance.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerEsuLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerEsuLicense.json new file mode 100644 index 000000000000..c204c14cfe32 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerEsuLicense.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerEsuLicenseName": "testsqlServerEsuLicense", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerInstance.json new file mode 100644 index 000000000000..a60bed533dab --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerInstance.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerLicense.json new file mode 100644 index 000000000000..f1b375d71a7d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerLicense.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerLicenseName": "testsqlServerLicense", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/FailoverArcSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/FailoverArcSqlServerAvailabilityGroup.json new file mode 100644 index 000000000000..a329e153da55 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/FailoverArcSqlServerAvailabilityGroup.json @@ -0,0 +1,183 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "availabilityGroupName": "testAG", + "api-version": "2024-05-01-preview", + "sqlServerAvailabilityGroupResource": { + "location": "southeastasia", + "tags": { + "mytag": "myval" + }, + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY", + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServerInstance", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ForceFailoverArcSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ForceFailoverArcSqlServerAvailabilityGroup.json new file mode 100644 index 000000000000..a329e153da55 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ForceFailoverArcSqlServerAvailabilityGroup.json @@ -0,0 +1,183 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "availabilityGroupName": "testAG", + "api-version": "2024-05-01-preview", + "sqlServerAvailabilityGroupResource": { + "location": "southeastasia", + "tags": { + "mytag": "myval" + }, + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY", + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServerInstance", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetActiveDirectoryConnector.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetActiveDirectoryConnector.json new file mode 100644 index 000000000000..7a31dcc92155 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetActiveDirectoryConnector.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "activeDirectoryConnectorName": "testADConnector", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "spec": { + "activeDirectory": { + "realm": "CONTOSO.LOCAL", + "serviceAccountProvisioning": "manual", + "domainControllers": { + "primaryDomainController": { + "hostname": "dc1.contoso.local" + }, + "secondaryDomainControllers": [ + { + "hostname": "dc2.contoso.local" + }, + { + "hostname": "dc3.contoso.local" + } + ] + }, + "netbiosDomainName": "CONTOSO" + }, + "dns": { + "nameserverIPAddresses": [ + "11.11.111.111", + "22.22.222.222" + ], + "replicas": 1, + "preferK8sDnsForPtrLookups": false, + "domainName": "contoso.local" + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController/activeDirectoryConnectors/testADConnector", + "name": "testADConnector", + "type": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetArcSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetArcSqlServerAvailabilityGroup.json new file mode 100644 index 000000000000..091e1aef1546 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetArcSqlServerAvailabilityGroup.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "availabilityGroupName": "testAG", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY", + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetArcSqlServerDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetArcSqlServerDatabase.json new file mode 100644 index 000000000000..e524be7554ed --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetArcSqlServerDatabase.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServerInstance", + "databaseName": "testdb", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/testdb", + "name": "testdb", + "type": "Microsoft.AzureArcData/sqlServerInstances/databases", + "properties": { + "collationName": "SQL_Latin1_General_CP1_CI_AS", + "databaseCreationDate": "2022-04-05T16:26:33.883Z", + "compatibilityLevel": 150, + "state": "Online", + "isReadOnly": true, + "recoveryMode": "Full", + "sizeMB": 150.00, + "spaceAvailableMB": 100.00, + "databaseOptions": { + "isAutoCloseOn": true, + "isAutoShrinkOn": true, + "isAutoCreateStatsOn": true, + "isAutoUpdateStatsOn": true, + "isMemoryOptimizationEnabled": true, + "isRemoteDataArchiveEnabled": true, + "isEncrypted": true, + "isTrustworthyOn": true + }, + "backupInformation": { + "lastFullBackup": "2022-05-05T16:26:33.883Z", + "lastLogBackup": "2022-05-10T16:26:33.883Z" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "migration": { + "assessment": { + "assessmentUploadTime": "2024-03-15T00:14:52.0000000Z", + "databaseAssessments": [ + { + "appliesToMigrationTargetPlatform": "AzureSqlDatabase", + "featureId": "ServiceBroker", + "issueCategory": "Issue", + "moreInformation": "" + } + ], + "targetReadiness": { + "azureSqlDatabase": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + }, + "azureSqlManagedInstance": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + }, + "azureSqlVirtualMachine": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + } + } + } + }, + "earliestRestoreDate": "2022-05-10T16:26:33.883Z", + "lastDatabaseUploadTime": "2023-03-29T14:13:12Z", + "createMode": "PointInTimeRestore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/MyDatabase", + "restorePointInTime": "2022-05-05T16:26:33.883Z" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetDataController.json new file mode 100644 index 000000000000..047dfe542b35 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetDataController.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "metricsDashboardCredential": { + "username": "username" + }, + "logsDashboardCredential": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController", + "name": "testdataController", + "type": "Microsoft.AzureArcData/dataControllers" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetFailoverGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetFailoverGroup.json new file mode 100644 index 000000000000..c6a830d76e1e --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetFailoverGroup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testSqlManagedInstance", + "failoverGroupName": "testFailoverGroupName", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/partnerMI", + "spec": { + "sharedName": "testSharedName", + "sourceMI": "sourceSQLMI", + "partnerMI": "partnerMI", + "partnerMirroringURL": "11.11.111.111:1111", + "partnerMirroringCert": "testCert", + "partnerSyncMode": "async", + "role": "primary" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testSqlManagedInstance/failoverGroups/testFailoverGroupName", + "name": "testFailoverGroupName", + "type": "Microsoft.AzureArcData/sqlManagedInstances/failoverGroups" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetPostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetPostgresInstance.json new file mode 100644 index 000000000000..35dcf6bd7f6a --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetPostgresInstance.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "postgresInstanceName": "testpostgresInstances", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances", + "name": "testpostgresInstances", + "type": "Microsoft.AzureArcData/PostgresInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlManagedInstance.json new file mode 100644 index 000000000000..7014a0289953 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlManagedInstance.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "activeDirectoryInformation": { + "keytabInformation": {} + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + }, + "security": { + "adminLoginSecret": "test-sql-login-secret", + "serviceCertificateSecret": "Service Certificate Secret", + "activeDirectory": { + "connector": { + "name": "Name of connector", + "namespace": "Namespace of connector" + }, + "accountName": "Account name", + "keytabSecret": "Key tab secret of account", + "encryptionTypes": [ + "Encryption type item1, Encryption type item2,..." + ] + }, + "transparentDataEncryption": { + "mode": "SystemManaged" + } + }, + "settings": { + "network": { + "forceencryption": 0, + "tlsciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384", + "tlsprotocols": "1.2" + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureArcData/sqlManagedInstance" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerEsuLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerEsuLicense.json new file mode 100644 index 000000000000..09a4286a647f --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerEsuLicense.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerEsuLicenseName": "testsqlServerEsuLicense", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "billingPlan": "PAYG", + "version": "SQL Server 2012", + "uniqueId": "00000000-1111-2222-3333-444444444444", + "physicalCores": 24, + "activationState": "Inactive", + "scopeType": "Subscription", + "activatedAt": "2020-01-01T17:18:19.1234567Z", + "terminatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/testsqlServerEsuLicense", + "name": "testsqlServerEsuLicense", + "type": "Microsoft.AzureArcData/sqlServerEsuLicenses" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstance.json new file mode 100644 index 000000000000..877c6661c531 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstance.json @@ -0,0 +1,191 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "version": "SQL Server 2012", + "edition": "Developer", + "containerResourceId": "Resource id of hosting Arc Machine", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2012", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Registered", + "hostType": "Physical Server", + "lastInventoryUploadTime": "2023-03-29T14:13:12Z", + "lastUsageUploadTime": "2023-03-29T14:13:12Z", + "alwaysOnRole": "FailoverClusterInstance", + "failoverCluster": { + "id": "f836af7e-85ed-4ea4-91fb-67709b34e323", + "networkName": "networkNameOfSQLFCI", + "sqlInstanceIds": [ + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer1", + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer2" + ], + "hostNames": [ + "DEV-HOSTNAME1", + "DEV-HOSTNAME2" + ] + }, + "databaseMirroringEndpoint": { + "endpointName": "testMirroringEndpoint", + "role": "PARTNER", + "isEncryptionEnabled": true, + "encryptionAlgorithm": "RC4", + "connectionAuth": "Certificate", + "port": 12345, + "isDynamicPort": false, + "ipAddress": "123.124.125.126", + "certificateName": "testCertificateName" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "upgradeLockedUntil": "2022-05-05T16:26:33.883Z", + "monitoring": { + "enabled": false + }, + "migration": { + "assessment": { + "enabled": true, + "assessmentUploadTime": "2024-03-15T00:16:11.0000000Z", + "serverAssessments": [ + { + "appliesToMigrationTargetPlatform": "AzureSqlDatabase", + "featureId": "TraceFlags", + "impactedObjects": [ + { + "impactDetail": "", + "name": "8017", + "objectType": "TraceFlag" + } + ], + "issueCategory": "Warning", + "moreInformation": "Resolving Transact-SQL differences during migration to SQL Database" + }, + { + "appliesToMigrationTargetPlatform": "AzureSqlManagedInstance", + "featureId": "TraceFlags", + "impactedObjects": [ + { + "impactDetail": "", + "name": "8017", + "objectType": "TraceFlag" + } + ], + "issueCategory": "Warning", + "moreInformation": "Trace Flags" + } + ], + "skuRecommendationResults": { + "azureSqlDatabase": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "computeTier": "Provisioned", + "hardwareType": "Gen5", + "sqlPurchasingModel": "vCore", + "sqlServiceTier": "General Purpose", + "zoneRedundancyAvailable": false + } + }, + "monthlyCost": { + "computeCost": 245.13, + "storageCost": 0.18, + "totalCost": 245.31 + } + }, + "azureSqlManagedInstance": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "computeTier": "Provisioned", + "hardwareType": "Gen5", + "sqlPurchasingModel": "vCore", + "sqlServiceTier": "General Purpose", + "zoneRedundancyAvailable": false + } + }, + "monthlyCost": { + "computeCost": 490.26, + "storageCost": 0, + "totalCost": 490.26 + } + }, + "azureSqlVirtualMachine": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "availableVmSkus": [ + "Standard_D16as_v4", + "Standard_D2as_v4", + "Standard_D32as_v4", + "Standard_D48as_v4", + "Standard_D4as_v4", + "Standard_D64as_v4", + "Standard_D8as_v4", + "Standard_D96as_v4" + ], + "virtualMachineFamily": "standardDASv4Family" + } + }, + "monthlyCost": { + "computeCost": 81.98, + "storageCost": 2.4, + "totalCost": 84.38 + } + } + } + } + }, + "clientConnection": { + "enabled": false + }, + "serviceType": "Engine" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstanceJobsStatus.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstanceJobsStatus.json new file mode 100644 index 000000000000..6c842f3989d0 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstanceJobsStatus.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlserver", + "api-version": "2024-05-01-preview", + "SqlServerInstanceJobsStatusRequest": { + "featureName": "MigrationAssessment", + "jobType": "Ondemand" + } + }, + "responses": { + "200": { + "body": { + "jobsStatus": [ + { + "id": "/subscriptions/a5082b19-8a6e-4bc5-8fdd-8ef39dfebc39/resourceGroups/alzahedi-rg-easyup/providers/Microsoft.AzureArcData/sqlServerInstances/arcee-dev/jobs/235e045f:2D5237:2D38eb:2Db8fa:2Df0f549d1d7d9MigrationJobOnDemand", + "instanceName": "MSSQLSERVER", + "jobStatus": "Failed", + "jobException": "Something went wrong in collection suitability", + "backgroundJob": { + "state": "Completed", + "executionState": "Waiting", + "startTime": "2024-02-22T00:04:06.88265-08:00", + "endTime": "2024-03-15T02:04:06.88265-07:00", + "lastExecutionTime": "2024-02-22T21:18:21.6083558-08:00", + "lastExecutionStatus": "Succeeded" + }, + "sequencerActions": [ + { + "actionId": ":2Fsubscriptions:2Fa5082b19:2D8a6e:2D4bc5:2D8fdd:2D8ef39dfebc39:2FresourceGroups:2Falzahedi:2Drg:2Deasyup:2Fproviders:2FMicrosoft:2EAzureArcData:2FsqlServerInstances:2Farcee:2Ddev:2Faction:2FMicrosoft:2ESqlServer:2EManagement:2EMigrationAssessmentPlugin:2EActions:2ERunOnDemandMigrationJob", + "state": "Completed", + "result": "Failed" + }, + { + "actionId": "system.last", + "state": "Completed", + "result": "Succeeded" + }, + { + "actionId": "system.first", + "state": "Completed", + "result": "Succeeded" + } + ] + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstanceTelemetry.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstanceTelemetry.json new file mode 100644 index 000000000000..ee83800f4427 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstanceTelemetry.json @@ -0,0 +1,154 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlserver", + "api-version": "2024-05-01-preview", + "sqlServerInstanceTelemetryRequest": { + "datasetName": "sqlserver_storage_io", + "startTime": "2023-09-30T00:00:00Z" + } + }, + "responses": { + "200": { + "body": { + "columns": [ + { + "name": "row_id", + "type": "int" + }, + { + "name": "sample_time_utc", + "type": "datetime" + }, + { + "name": "database_id", + "type": "int" + }, + { + "name": "database_name", + "type": "string" + }, + { + "name": "file_id", + "type": "int" + }, + { + "name": "file_type", + "type": "string" + }, + { + "name": "file_size_mb", + "type": "double" + }, + { + "name": "file_max_size_mb", + "type": "double" + }, + { + "name": "io_stall_read_ms", + "type": "int" + }, + { + "name": "num_of_reads", + "type": "int" + }, + { + "name": "num_of_bytes_read", + "type": "int" + }, + { + "name": "io_stall_write_ms", + "type": "int" + }, + { + "name": "num_of_writes", + "type": "int" + }, + { + "name": "num_of_bytes_written", + "type": "int" + }, + { + "name": "io_stall_queued_read_ms", + "type": "int" + }, + { + "name": "io_stall_queued_write_ms", + "type": "int" + }, + { + "name": "size_on_disk_bytes", + "type": "int" + } + ], + "rows": [ + [ + "1", + "2023-09-30T00:00:00Z", + "1", + "master", + "1", + "Data", + "21.9375", + "0", + "88", + "56", + "3473408", + "2", + "3", + "24576", + "0", + "0", + "23003136" + ], + [ + "2", + "2023-09-30T00:00:00Z", + "5", + "arcDb", + "2", + "Log", + "0.625", + "0", + "12", + "11", + "208896", + "5989", + "853", + "3506176", + "0", + "0", + "4653056" + ], + [ + "3", + "2023-09-30T00:00:00Z", + "2", + "model", + "1", + "Data", + "4.4375", + "0", + "65", + "59", + "3284992", + "279", + "661", + "5922816", + "0", + "0", + "4653056" + ] + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/servers/testsqlserver/getTelemetry?api-version=2024-05-01-preview" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AzureArcData/locations/eastus2euap/operationStatuses/5abb198d-cc4b-46bd-9e6c-e3f0ba22015d?api-version=2024-05-01-preview", + "Location": "https://management.azure.com/providers/Microsoft.AzureArcData/locations/eastus2euap/operationStatuses/5abb198d-cc4b-46bd-9e6c-e3f0ba22015d?api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerLicense.json new file mode 100644 index 000000000000..10bc31bf0341 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerLicense.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerLicenseName": "testsqlServerLicense", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription", + "lastActivatedAt": "2020-01-01T17:18:19.1234567Z", + "lastDeactivatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerLicenses/testsqlServerLicense", + "name": "testsqlServerLicense", + "type": "Microsoft.AzureArcData/SqlServerLicenses" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByDataControllerActiveDirectoryConnector.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByDataControllerActiveDirectoryConnector.json new file mode 100644 index 000000000000..7749ce11b070 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByDataControllerActiveDirectoryConnector.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2024-05-01-preview", + "dataControllerName": "testdataController" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "spec": { + "activeDirectory": { + "realm": "CONTOSO.LOCAL", + "serviceAccountProvisioning": "manual", + "domainControllers": { + "primaryDomainController": { + "hostname": "dc1.contoso.local" + }, + "secondaryDomainControllers": [ + { + "hostname": "dc2.contoso.local" + }, + { + "hostname": "dc3.contoso.local" + } + ] + }, + "netbiosDomainName": "CONTOSO" + }, + "dns": { + "nameserverIPAddresses": [ + "11.11.111.111", + "22.22.222.222" + ], + "replicas": 1, + "preferK8sDnsForPtrLookups": false, + "domainName": "contoso.local" + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController/activeDirectoryConnectors/testADConnector1", + "name": "testADConnector1", + "type": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors" + }, + { + "properties": { + "spec": { + "activeDirectory": { + "realm": "CONTOSO.LOCAL", + "serviceAccountProvisioning": "manual", + "domainControllers": { + "primaryDomainController": { + "hostname": "dc4.contoso.local" + }, + "secondaryDomainControllers": [ + { + "hostname": "dc5.contoso.local" + }, + { + "hostname": "dc6.contoso.local" + } + ] + }, + "netbiosDomainName": "CONTOSO" + }, + "dns": { + "nameserverIPAddresses": [ + "11.11.111.111", + "22.22.222.222" + ], + "replicas": 1, + "preferK8sDnsForPtrLookups": false, + "domainName": "contoso.local" + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController/activeDirectoryConnectors/testADConnector2", + "name": "testADConnector2", + "type": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupDataController.json new file mode 100644 index 000000000000..e0c0038311ef --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupDataController.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "metricsDashboardCredential": { + "username": "username" + }, + "logsDashboardCredential": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController1", + "name": "testdataController1", + "type": "Microsoft.AzureArcData/dataControllers" + }, + { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController2", + "name": "testdataController2", + "type": "Microsoft.AzureArcData/dataControllers" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupPostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupPostgresInstance.json new file mode 100644 index 000000000000..e2459f3ecc1f --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupPostgresInstance.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances1", + "name": "testpostgresInstances1", + "type": "Microsoft.AzureArcData/PostgresInstances" + }, + { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances2", + "name": "testpostgresInstances2", + "type": "Microsoft.AzureArcData/PostgresInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlManagedInstance.json new file mode 100644 index 000000000000..ffc87618e06d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlManagedInstance.json @@ -0,0 +1,162 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "activeDirectoryInformation": { + "keytabInformation": {} + }, + "licenseType": "LicenseIncluded", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/sqlManagedInstance1", + "name": "sqlManagedInstances1", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + }, + { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "activeDirectoryInformation": { + "keytabInformation": {} + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + }, + "security": { + "adminLoginSecret": "test-sql-login-secret", + "serviceCertificateSecret": "Service Certificate Secret", + "activeDirectory": { + "connector": { + "name": "Name of connector", + "namespace": "Namespace of connector" + }, + "accountName": "Account name", + "keytabSecret": "Key tab secret of account", + "encryptionTypes": [ + "Encryption type item1, Encryption type item2,..." + ] + }, + "transparentDataEncryption": { + "mode": "SystemManaged" + } + }, + "settings": { + "network": { + "forceencryption": 0, + "tlsciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384", + "tlsprotocols": "1.2" + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/sqlManagedInstance2", + "name": "sqlManagedInstances2", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerEsuLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerEsuLicense.json new file mode 100644 index 000000000000..fe027b0ea133 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerEsuLicense.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "billingPlan": "PAYG", + "version": "SQL Server 2012", + "uniqueId": "00000000-1111-2222-3333-444444444444", + "physicalCores": 24, + "activationState": "Inactive", + "scopeType": "Subscription", + "activatedAt": "2020-01-01T17:18:19.1234567Z", + "terminatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/sqlServerEsuLicense1", + "name": "sqlServerEsuLicense1", + "type": "Microsoft.AzureArcData/sqlServerEsuLicenses" + }, + { + "properties": { + "billingPlan": "PAYG", + "version": "SQL Server 2012", + "uniqueId": "00000000-1111-2222-3333-444444444444", + "physicalCores": 24, + "activationState": "Inactive", + "scopeType": "Subscription", + "activatedAt": "2020-01-01T17:18:19.1234567Z", + "terminatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/sqlServerEsuLicense2", + "name": "sqlServerEsuLicense2", + "type": "Microsoft.AzureArcData/sqlServerEsuLicenses" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerInstance.json new file mode 100644 index 000000000000..c25935323139 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerInstance.json @@ -0,0 +1,248 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "version": "SQL Server 2012", + "edition": "Developer", + "containerResourceId": "Resource id of hosting Arc Machine", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2012", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Registered", + "hostType": "Physical Server", + "lastInventoryUploadTime": "2023-03-29T14:13:12Z", + "lastUsageUploadTime": "2023-03-29T14:13:12Z", + "alwaysOnRole": "FailoverClusterInstance", + "failoverCluster": { + "id": "f836af7e-85ed-4ea4-91fb-67709b34e323", + "networkName": "networkNameOfSQLFCI", + "sqlInstanceIds": [ + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer1", + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer2" + ], + "hostNames": [ + "DEV-HOSTNAME1", + "DEV-HOSTNAME2" + ] + }, + "databaseMirroringEndpoint": { + "endpointName": "testMirroringEndpoint", + "role": "PARTNER", + "isEncryptionEnabled": true, + "encryptionAlgorithm": "AES", + "connectionAuth": "Certificate", + "port": 12345, + "isDynamicPort": false, + "ipAddress": "123.124.125.126", + "certificateName": "testCertificateName" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "monitoring": { + "enabled": false + }, + "migration": { + "assessment": { + "enabled": true, + "assessmentUploadTime": "2024-03-15T00:16:11.0000000Z", + "serverAssessments": [ + { + "appliesToMigrationTargetPlatform": "AzureSqlDatabase", + "featureId": "TraceFlags", + "impactedObjects": [ + { + "impactDetail": "", + "name": "8017", + "objectType": "TraceFlag" + } + ], + "issueCategory": "Warning", + "moreInformation": "Resolving Transact-SQL differences during migration to SQL Database" + }, + { + "appliesToMigrationTargetPlatform": "AzureSqlManagedInstance", + "featureId": "TraceFlags", + "impactedObjects": [ + { + "impactDetail": "", + "name": "8017", + "objectType": "TraceFlag" + } + ], + "issueCategory": "Warning", + "moreInformation": "Trace Flags" + } + ], + "skuRecommendationResults": { + "azureSqlDatabase": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "computeTier": "Provisioned", + "hardwareType": "Gen5", + "sqlPurchasingModel": "vCore", + "sqlServiceTier": "General Purpose", + "zoneRedundancyAvailable": false + } + }, + "monthlyCost": { + "computeCost": 245.13, + "storageCost": 0.18, + "totalCost": 245.31 + } + }, + "azureSqlManagedInstance": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "computeTier": "Provisioned", + "hardwareType": "Gen5", + "sqlPurchasingModel": "vCore", + "sqlServiceTier": "General Purpose", + "zoneRedundancyAvailable": false + } + }, + "monthlyCost": { + "computeCost": 490.26, + "storageCost": 0, + "totalCost": 490.26 + } + }, + "azureSqlVirtualMachine": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "availableVmSkus": [ + "Standard_D16as_v4", + "Standard_D2as_v4", + "Standard_D32as_v4", + "Standard_D48as_v4", + "Standard_D4as_v4", + "Standard_D64as_v4", + "Standard_D8as_v4", + "Standard_D96as_v4" + ], + "virtualMachineFamily": "standardDASv4Family" + } + }, + "monthlyCost": { + "computeCost": 81.98, + "storageCost": 2.4, + "totalCost": 84.38 + } + } + } + } + }, + "clientConnection": { + "enabled": false + }, + "serviceType": "Engine" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServerInstance1", + "name": "sqlServerInstance1", + "type": "Microsoft.AzureArcData/SqlServerInstances" + }, + { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Connected", + "upgradeLockedUntil": "2022-05-05T16:26:33.883Z", + "monitoring": { + "enabled": false + }, + "migration": { + "assessment": { + "enabled": false + } + }, + "clientConnection": { + "enabled": false + }, + "serviceType": "SSRS" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServerInstance2", + "name": "sqlServerInstance2", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerLicense.json new file mode 100644 index 000000000000..0aec26805c32 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerLicense.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription", + "lastActivatedAt": "2020-01-01T17:18:19.1234567Z", + "lastDeactivatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerLicenses/sqlServerLicense1", + "name": "sqlServerLicense1", + "type": "Microsoft.AzureArcData/SqlServerLicenses" + }, + { + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription", + "lastActivatedAt": "2020-01-01T17:18:19.1234567Z", + "lastDeactivatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerLicenses/sqlServerLicense2", + "name": "sqlServerLicense2", + "type": "Microsoft.AzureArcData/SqlServerLicenses" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlManagedInstanceFailoverGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlManagedInstanceFailoverGroup.json new file mode 100644 index 000000000000..f65fbde5de33 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlManagedInstanceFailoverGroup.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2024-05-01-preview", + "sqlManagedInstanceName": "testSqlManagedInstance" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/partnerMI", + "spec": { + "sharedName": "testSharedName", + "sourceMI": "sourceSQLMI", + "partnerMI": "partnerMI", + "partnerMirroringURL": "11.11.111.111:1111", + "partnerMirroringCert": "testCert", + "partnerSyncMode": "async", + "role": "primary" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testSqlManagedInstance/failoverGroups/testFailoverGroupName", + "name": "testFailoverGroupName", + "type": "Microsoft.AzureArcData/sqlManagedInstances/failoverGroups" + }, + { + "properties": { + "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/partnerMI", + "spec": { + "sharedName": "testSharedName", + "sourceMI": "sourceSQLMI", + "partnerMI": "partnerMI", + "partnerMirroringURL": "11.11.111.111:1111", + "partnerMirroringCert": "testCert", + "partnerSyncMode": "async", + "role": "primary" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testSqlManagedInstance/failoverGroups/testFailoverGroupName", + "name": "testFailoverGroupName", + "type": "Microsoft.AzureArcData/sqlManagedInstances/failoverGroups" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlServerInstanceAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlServerInstanceAvailabilityGroup.json new file mode 100644 index 000000000000..fe6cdaa40f73 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlServerInstanceAvailabilityGroup.json @@ -0,0 +1,215 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY", + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + }, + { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG1", + "name": "testAG1", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY" + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlServerInstanceDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlServerInstanceDatabase.json new file mode 100644 index 000000000000..b7d6fe6058ed --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlServerInstanceDatabase.json @@ -0,0 +1,167 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServerInstance", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/testdb", + "name": "testdb", + "type": "Microsoft.AzureArcData/sqlServerInstances/databases", + "properties": { + "collationName": "SQL_Latin1_General_CP1_CI_AS", + "databaseCreationDate": "2022-04-05T16:26:33.883Z", + "compatibilityLevel": 150, + "state": "Online", + "isReadOnly": true, + "recoveryMode": "Full", + "sizeMB": 150.00, + "spaceAvailableMB": 100.00, + "databaseOptions": { + "isAutoCloseOn": true, + "isAutoShrinkOn": true, + "isAutoCreateStatsOn": true, + "isAutoUpdateStatsOn": true, + "isMemoryOptimizationEnabled": true, + "isRemoteDataArchiveEnabled": true, + "isEncrypted": true, + "isTrustworthyOn": true + }, + "backupInformation": { + "lastFullBackup": "2022-05-05T16:26:33.883Z", + "lastLogBackup": "2022-05-10T16:26:33.883Z" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "migration": { + "assessment": { + "assessmentUploadTime": "2024-03-15T00:14:52.0000000Z", + "databaseAssessments": [ + { + "appliesToMigrationTargetPlatform": "AzureSqlDatabase", + "featureId": "ServiceBroker", + "issueCategory": "Issue", + "moreInformation": "" + } + ], + "targetReadiness": { + "azureSqlDatabase": { + "numOfBlockerIssues": 0, + "recommendationStatus": "NotReady" + }, + "azureSqlManagedInstance": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + }, + "azureSqlVirtualMachine": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + } + } + } + }, + "earliestRestoreDate": "2022-05-10T16:26:33.883Z", + "lastDatabaseUploadTime": "2023-03-29T14:13:12Z", + "createMode": "PointInTimeRestore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/MyDatabase", + "restorePointInTime": "2022-05-05T16:26:33.883Z" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + }, + { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/testdb1", + "name": "testdb1", + "type": "Microsoft.AzureArcData/sqlServerInstances/databases", + "properties": { + "collationName": "SQL_Latin1_General_CP1_CI_AS", + "databaseCreationDate": "2022-04-05T16:26:33.883Z", + "compatibilityLevel": 150, + "state": "Online", + "isReadOnly": true, + "recoveryMode": "Full", + "sizeMB": 150.00, + "spaceAvailableMB": 100.00, + "databaseOptions": { + "isAutoCloseOn": true, + "isAutoShrinkOn": true, + "isAutoCreateStatsOn": true, + "isAutoUpdateStatsOn": true, + "isMemoryOptimizationEnabled": true, + "isRemoteDataArchiveEnabled": true, + "isEncrypted": true, + "isTrustworthyOn": true + }, + "backupInformation": { + "lastFullBackup": "2022-05-05T16:26:33.883Z", + "lastLogBackup": "2022-05-10T16:26:33.883Z" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "migration": { + "assessment": { + "assessmentUploadTime": "2024-03-15T00:14:52.0000000Z", + "databaseAssessments": [], + "targetReadiness": { + "azureSqlDatabase": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + }, + "azureSqlManagedInstance": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + }, + "azureSqlVirtualMachine": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + } + } + } + }, + "earliestRestoreDate": "2022-05-10T16:26:33.883Z", + "lastDatabaseUploadTime": "2023-03-29T14:13:12Z", + "createMode": "PointInTimeRestore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/MyDatabase", + "restorePointInTime": "2022-05-05T16:26:33.883Z" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListOperation.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListOperation.json new file mode 100644 index 000000000000..02c537b07e1b --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListOperation.json @@ -0,0 +1,353 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AzureArcData/Locations/OperationStatuses/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "Locations/OperationStatuses", + "operation": "read_OperationStatuses", + "description": "read OperationStatuses" + } + }, + { + "name": "Microsoft.AzureArcData/Locations/OperationStatuses/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "Locations/OperationStatuses", + "operation": "write_OperationStatuses", + "description": "write OperationStatuses" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers", + "operation": "DataControllers_ListInSubscription", + "description": "read dataControllers" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers", + "operation": "DataControllers_ListInGroup", + "description": "read dataControllers" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers", + "operation": "DataControllers_GetDataController", + "description": "Retrieves a dataController resource" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers", + "operation": "DataControllers_PutDataController", + "description": "Creates or replaces a dataController resource" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers", + "operation": "DataControllers_DeleteDataController", + "description": "Deletes a dataController resource" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers", + "operation": "DataControllers_PatchDataController", + "description": "Updates a dataController resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlManagedInstances", + "operation": "SqlManagedInstances_List", + "description": "read sqlManagedInstances" + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlManagedInstances", + "operation": "SqlManagedInstances_ListByResourceGroup", + "description": "Gets all sqlManagedInstances in a resource group." + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlManagedInstances", + "operation": "SqlManagedInstances_Get", + "description": "Retrieves a SQL Managed Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlManagedInstances", + "operation": "SqlManagedInstances_Create", + "description": "Creates or replaces a SQL Managed Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlManagedInstances", + "operation": "SqlManagedInstances_Delete", + "description": "Deletes a SQL Managed Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlManagedInstances", + "operation": "SqlManagedInstances_Update", + "description": "Updates a SQL Managed Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances", + "operation": "SqlServerInstances_List", + "description": "read sqlServerInstances" + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances", + "operation": "SqlServerInstances_ListByResourceGroup", + "description": "Gets all sqlServerInstances in a resource group." + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances", + "operation": "SqlServerInstances_Get", + "description": "Retrieves a SQL Server Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances", + "operation": "SqlServerInstances_Create", + "description": "Creates or replaces a SQL Server Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances", + "operation": "SqlServerInstances_Delete", + "description": "Deletes a SQL Server Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/databases/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances/databases", + "operation": "SqlServerDatabases_List", + "description": "List all database resources in a Sql Server Instance." + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/databases/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances/databases", + "operation": "SqlServerDatabases_Get", + "description": "Retrieves a database resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/databases/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances/databases", + "operation": "SqlServerDatabases_Create", + "description": "Creates or updates a database resource." + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/databases/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances/databases", + "operation": "SqlServerDatabases_Delete", + "description": "Deletes a database resource." + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances", + "operation": "SqlServerInstances_Update", + "description": "Updates a SQL Server Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers/activeDirectoryConnectors", + "operation": "ActiveDirectoryConnectors_List", + "description": "read activeDirectoryConnectors" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers/activeDirectoryConnectors", + "operation": "ActiveDirectoryConnectors_Get", + "description": "Retrieves an active directory connector resource" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers/activeDirectoryConnectors", + "operation": "ActiveDirectoryConnectors_Create", + "description": "Creates or replaces an active directory connector resource." + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers/activeDirectoryConnectors", + "operation": "ActiveDirectoryConnectors_Delete", + "description": "Deletes an active directory connector resource" + } + }, + { + "name": "Microsoft.AzureArcData/postgresInstances/read", + "isDataAction": false, + "display": { + "resource": "Microsoft.AzureArcData", + "provider": "Azure Arc Data Resource Provider.", + "operation": "Get Postgres Instance details.", + "description": "Retrieves details of Postgres Instances." + } + }, + { + "name": "Microsoft.AzureArcData/postgresInstances/write", + "isDataAction": false, + "display": { + "resource": "Microsoft.AzureArcData", + "provider": "Azure Arc Data Resource Provider.", + "operation": "Create new or update existing Postgres Instances.", + "description": "Create a new or change properties of existing Postgres Instances." + } + }, + { + "name": "Microsoft.AzureArcData/postgresInstances/delete", + "isDataAction": false, + "display": { + "resource": "Microsoft.AzureArcData", + "provider": "Azure Arc Data Resource Provider.", + "operation": "Delete exisiting Postgres Instances.", + "description": "Delete exisiting Postgres Instances." + } + }, + { + "name": "Microsoft.AzureArcData/register/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "Microsoft.AzureArcData", + "operation": "Register the Microsoft.AzureArcData", + "description": "Register the subscription for Microsoft.AzureArcData" + } + }, + { + "name": "Microsoft.AzureArcData/unregister/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "Microsoft.AzureArcData", + "operation": "Unregister the Microsoft.AzureArcData", + "description": "Unregister the subscription for Microsoft.AzureArcData" + } + }, + { + "name": "Microsoft.AzureArcData/Operations/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "Operations", + "operation": "read_Operations", + "description": "read Operations" + } + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionDataController.json new file mode 100644 index 000000000000..d72082c3a742 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionDataController.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "metricsDashboardCredential": { + "username": "username" + }, + "logsDashboardCredential": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController1", + "name": "testdataController1", + "type": "Microsoft.AzureArcData/dataControllers" + }, + { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "metricsDashboardCredential": { + "username": "username" + }, + "logsDashboardCredential": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension" + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController2", + "name": "testdataController2", + "type": "Microsoft.AzureArcData/dataControllers" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionPostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionPostgresInstance.json new file mode 100644 index 000000000000..fc076ad558ea --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionPostgresInstance.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances1", + "name": "testpostgresInstances1", + "type": "Microsoft.AzureArcData/PostgresInstances" + }, + { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances2", + "name": "testpostgresInstances2", + "type": "Microsoft.AzureArcData/PostgresInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlManagedInstance.json new file mode 100644 index 000000000000..3f125efbd360 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlManagedInstance.json @@ -0,0 +1,163 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "activeDirectoryInformation": { + "keytabInformation": {} + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + }, + "security": { + "adminLoginSecret": "test-sql-login-secret", + "serviceCertificateSecret": "Service Certificate Secret", + "activeDirectory": { + "connector": { + "name": "Name of connector", + "namespace": "Namespace of connector" + }, + "accountName": "Account name", + "keytabSecret": "Key tab secret of account", + "encryptionTypes": [ + "Encryption type item1, Encryption type item2,..." + ] + }, + "transparentDataEncryption": { + "mode": "SystemManaged" + } + }, + "settings": { + "network": { + "forceencryption": 0, + "tlsciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384", + "tlsprotocols": "1.2" + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlManagedInstances/sqlManagedInstance1", + "name": "sqlManagedInstances1", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + }, + { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "activeDirectoryInformation": { + "keytabInformation": {} + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlManagedInstances/sqlManagedInstance2", + "name": "sqlManagedInstances2", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerEsuLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerEsuLicense.json new file mode 100644 index 000000000000..d75e8e6a340a --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerEsuLicense.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "billingPlan": "PAYG", + "version": "SQL Server 2012", + "uniqueId": "00000000-1111-2222-3333-444444444444", + "physicalCores": 24, + "activationState": "Inactive", + "scopeType": "Subscription", + "activatedAt": "2020-01-01T17:18:19.1234567Z", + "terminatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/sqlServerEsuLicense1", + "name": "sqlServerEsuLicense1", + "type": "Microsoft.AzureArcData/sqlServerEsuLicenses" + }, + { + "properties": { + "billingPlan": "PAYG", + "version": "SQL Server 2012", + "uniqueId": "00000000-1111-2222-3333-444444444444", + "physicalCores": 24, + "activationState": "Inactive", + "scopeType": "Subscription", + "activatedAt": "2020-01-01T17:18:19.1234567Z", + "terminatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/sqlServerEsuLicense2", + "name": "sqlServerEsuLicense2", + "type": "Microsoft.AzureArcData/sqlServerEsuLicenses" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerInstance.json new file mode 100644 index 000000000000..28097d806c6e --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerInstance.json @@ -0,0 +1,249 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "version": "SQL Server 2012", + "edition": "Developer", + "containerResourceId": "Resource id of hosting Arc Machine", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Registered", + "hostType": "Physical Server", + "lastInventoryUploadTime": "2023-03-29T14:13:12Z", + "lastUsageUploadTime": "2023-03-29T14:13:12Z", + "alwaysOnRole": "FailoverClusterInstance", + "failoverCluster": { + "id": "f836af7e-85ed-4ea4-91fb-67709b34e323", + "networkName": "networkNameOfSQLFCI", + "sqlInstanceIds": [ + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer1", + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer2" + ], + "hostNames": [ + "DEV-HOSTNAME1", + "DEV-HOSTNAME2" + ] + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "upgradeLockedUntil": "2022-05-05T16:26:33.883Z", + "monitoring": { + "enabled": false + }, + "migration": { + "assessment": { + "enabled": false + } + }, + "clientConnection": { + "enabled": false + }, + "serviceType": "Engine" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServerInstance1", + "name": "sqlServerInstance1", + "type": "Microsoft.AzureArcData/SqlServerInstances" + }, + { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "lastInventoryUploadTime": "2023-03-29T14:13:12Z", + "lastUsageUploadTime": "2023-03-29T14:13:12Z", + "status": "Connected", + "databaseMirroringEndpoint": { + "endpointName": "testMirroringEndpoint", + "role": "PARTNER", + "isEncryptionEnabled": true, + "encryptionAlgorithm": "AES", + "connectionAuth": "Certificate", + "port": 12345, + "isDynamicPort": false, + "ipAddress": "123.124.125.126", + "certificateName": "testCertificateName" + }, + "monitoring": { + "enabled": false + }, + "migration": { + "assessment": { + "enabled": true, + "assessmentUploadTime": "2024-03-15T00:16:11.0000000Z", + "serverAssessments": [ + { + "appliesToMigrationTargetPlatform": "AzureSqlDatabase", + "featureId": "TraceFlags", + "impactedObjects": [ + { + "impactDetail": "", + "name": "8017", + "objectType": "TraceFlag" + } + ], + "issueCategory": "Warning", + "moreInformation": "Resolving Transact-SQL differences during migration to SQL Database" + }, + { + "appliesToMigrationTargetPlatform": "AzureSqlManagedInstance", + "featureId": "TraceFlags", + "impactedObjects": [ + { + "impactDetail": "", + "name": "8017", + "objectType": "TraceFlag" + } + ], + "issueCategory": "Warning", + "moreInformation": "Trace Flags" + } + ], + "skuRecommendationResults": { + "azureSqlDatabase": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "computeTier": "Provisioned", + "hardwareType": "Gen5", + "sqlPurchasingModel": "vCore", + "sqlServiceTier": "General Purpose", + "zoneRedundancyAvailable": false + } + }, + "monthlyCost": { + "computeCost": 245.13, + "storageCost": 0.18, + "totalCost": 245.31 + } + }, + "azureSqlManagedInstance": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "computeTier": "Provisioned", + "hardwareType": "Gen5", + "sqlPurchasingModel": "vCore", + "sqlServiceTier": "General Purpose", + "zoneRedundancyAvailable": false + } + }, + "monthlyCost": { + "computeCost": 490.26, + "storageCost": 0, + "totalCost": 490.26 + } + }, + "azureSqlVirtualMachine": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "availableVmSkus": [ + "Standard_D16as_v4", + "Standard_D2as_v4", + "Standard_D32as_v4", + "Standard_D48as_v4", + "Standard_D4as_v4", + "Standard_D64as_v4", + "Standard_D8as_v4", + "Standard_D96as_v4" + ], + "virtualMachineFamily": "standardDASv4Family" + } + }, + "monthlyCost": { + "computeCost": 81.98, + "storageCost": 2.4, + "totalCost": 84.38 + } + } + } + } + }, + "clientConnection": { + "enabled": false + }, + "serviceType": "SSRS" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServerInstance2", + "name": "sqlServerInstance2", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerLicense.json new file mode 100644 index 000000000000..3628189c69cc --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerLicense.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription", + "lastActivatedAt": "2020-01-01T17:18:19.1234567Z", + "lastDeactivatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerLicenses/sqlServerLicense1", + "name": "sqlServerLicense1", + "type": "Microsoft.AzureArcData/SqlServerLicenses" + }, + { + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription", + "lastActivatedAt": "2020-01-01T17:18:19.1234567Z", + "lastDeactivatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerLicenses/sqlServerLicense2", + "name": "sqlServerLicense2", + "type": "Microsoft.AzureArcData/SqlServerLicenses" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/PostUpgradeSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/PostUpgradeSqlServerInstance.json new file mode 100644 index 000000000000..1b61623f7a4d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/PostUpgradeSqlServerInstance.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "version": "SQL Server 2012", + "edition": "Developer", + "containerResourceId": "Resource id of hosting Arc Machine", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2012", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Registered", + "hostType": "Physical Server", + "lastInventoryUploadTime": "2023-03-29T14:13:12Z", + "alwaysOnRole": "FailoverClusterInstance", + "failoverCluster": { + "id": "f836af7e-85ed-4ea4-91fb-67709b34e323", + "networkName": "networkNameOfSQLFCI", + "sqlInstanceIds": [ + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer1", + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer2" + ], + "hostNames": [ + "DEV-HOSTNAME1", + "DEV-HOSTNAME2" + ] + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "upgradeLockedUntil": "2022-05-05T16:26:33.883Z", + "serviceType": "Engine" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/PreUpgradeSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/PreUpgradeSqlServerInstance.json new file mode 100644 index 000000000000..1b61623f7a4d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/PreUpgradeSqlServerInstance.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "version": "SQL Server 2012", + "edition": "Developer", + "containerResourceId": "Resource id of hosting Arc Machine", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2012", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Registered", + "hostType": "Physical Server", + "lastInventoryUploadTime": "2023-03-29T14:13:12Z", + "alwaysOnRole": "FailoverClusterInstance", + "failoverCluster": { + "id": "f836af7e-85ed-4ea4-91fb-67709b34e323", + "networkName": "networkNameOfSQLFCI", + "sqlInstanceIds": [ + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer1", + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer2" + ], + "hostNames": [ + "DEV-HOSTNAME1", + "DEV-HOSTNAME2" + ] + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "upgradeLockedUntil": "2022-05-05T16:26:33.883Z", + "serviceType": "Engine" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/RemoveDatabasesFromAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/RemoveDatabasesFromAvailabilityGroup.json new file mode 100644 index 000000000000..aa30961dbe28 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/RemoveDatabasesFromAvailabilityGroup.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "availabilityGroupName": "testAG", + "databases": { + "values": [ + "db1" + ] + }, + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY", + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/RunMigrationAssessmentSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/RunMigrationAssessmentSqlServerInstance.json new file mode 100644 index 000000000000..cc3d31a05092 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/RunMigrationAssessmentSqlServerInstance.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlserver", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/a5082b19-8a6e-4bc5-8fdd-8ef39dfebc39/resourceGroups/alzahedi-rg-easyup/providers/Microsoft.AzureArcData/sqlServerInstances/arcee-dev/jobs/235e045f:2D5237:2D38eb:2Db8fa:2Df0f549d1d7d9MigrationJobOnDemand", + "instanceName": "MSSQLSERVER", + "jobStatus": "InProgress", + "jobException": null, + "backgroundJob": { + "state": "Enabled", + "executionState": "Waiting", + "startTime": "2024-02-22T00:04:06.88265-08:00", + "endTime": "2024-03-15T02:04:06.88265-07:00", + "lastExecutionTime": null, + "lastExecutionStatus": null + }, + "sequencerActions": [ + { + "actionId": ":2Fsubscriptions:2Fa5082b19:2D8a6e:2D4bc5:2D8fdd:2D8ef39dfebc39:2FresourceGroups:2Falzahedi:2Drg:2Deasyup:2Fproviders:2FMicrosoft:2EAzureArcData:2FsqlServerInstances:2Farcee:2Ddev:2Faction:2FMicrosoft:2ESqlServer:2EManagement:2EMigrationAssessmentPlugin:2EActions:2ERunOnDemandMigrationJob", + "state": "NotStarted", + "result": "NotCompleted" + }, + { + "actionId": "system.last", + "state": "NotStarted", + "result": "NotCompleted" + }, + { + "actionId": "system.first", + "state": "NotStarted", + "result": "NotCompleted" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateArcSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateArcSqlServerAvailabilityGroup.json new file mode 100644 index 000000000000..7b832da95c86 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateArcSqlServerAvailabilityGroup.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "api-version": "2024-05-01-preview", + "availabilityGroupName": "testAG", + "sqlServerAvailabilityGroupUpdate": { + "tags": { + "mytag": "myval1" + } + } + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY", + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval1" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.AzureArcData/operationResults/id1" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateDataController.json new file mode 100644 index 000000000000..0a9f86e48554 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateDataController.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController1", + "api-version": "2024-05-01-preview", + "dataControllerResource": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "metricsDashboardCredential": { + "username": "username" + }, + "logsDashboardCredential": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController1", + "name": "testdataController1", + "type": "Microsoft.AzureArcData/dataControllers" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.AzureArcData/operationResults/id1" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdatePostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdatePostgresInstance.json new file mode 100644 index 000000000000..25f2a2d65b8d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdatePostgresInstance.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "postgresInstanceName": "testpostgresInstance", + "api-version": "2024-05-01-preview", + "parameters": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstance/testpostgresInstance", + "name": "testpostgresInstance", + "type": "Microsoft.AzureArcData/PostgresInstance" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlManagedInstance.json new file mode 100644 index 000000000000..480c85ef5bfc --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlManagedInstance.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2024-05-01-preview", + "parameters": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "activeDirectoryInformation": { + "keytabInformation": {} + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + }, + "security": { + "adminLoginSecret": "test-sql-login-secret", + "serviceCertificateSecret": "Service Certificate Secret", + "activeDirectory": { + "connector": { + "name": "Name of connector", + "namespace": "Namespace of connector" + }, + "accountName": "Account name", + "keytabSecret": "Key tab secret of account", + "encryptionTypes": [ + "Encryption type item1, Encryption type item2,..." + ] + }, + "transparentDataEncryption": { + "mode": "SystemManaged" + } + }, + "settings": { + "network": { + "forceencryption": 0, + "tlsciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384", + "tlsprotocols": "1.2" + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerDatabase.json new file mode 100644 index 000000000000..77de4a6e8db8 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerDatabase.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlManagedInstance", + "api-version": "2024-05-01-preview", + "databaseName": "testdb", + "sqlServerDatabaseUpdate": { + "tags": { + "mytag": "myval1" + } + } + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/testdb", + "name": "testdb", + "type": "Microsoft.AzureArcData/sqlServerInstances/databases", + "properties": { + "collationName": "SQL_Latin1_General_CP1_CI_AS", + "databaseCreationDate": "2022-04-05T16:26:33.883Z", + "compatibilityLevel": 150, + "state": "Online", + "isReadOnly": true, + "recoveryMode": "Full", + "sizeMB": 150.00, + "spaceAvailableMB": 100.00, + "databaseOptions": { + "isAutoCloseOn": true, + "isAutoShrinkOn": true, + "isAutoCreateStatsOn": true, + "isAutoUpdateStatsOn": true, + "isMemoryOptimizationEnabled": true, + "isRemoteDataArchiveEnabled": true, + "isEncrypted": true, + "isTrustworthyOn": true + }, + "backupInformation": { + "lastFullBackup": "2022-05-05T16:26:33.883Z", + "lastLogBackup": "2022-05-10T16:26:33.883Z" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "migration": { + "assessment": { + "assessmentUploadTime": "2024-03-15T00:14:52.0000000Z", + "databaseAssessments": [ + { + "appliesToMigrationTargetPlatform": "AzureSqlDatabase", + "featureId": "ServiceBroker", + "issueCategory": "Issue", + "moreInformation": "" + } + ], + "targetReadiness": { + "azureSqlDatabase": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + }, + "azureSqlManagedInstance": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + }, + "azureSqlVirtualMachine": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + } + } + } + }, + "earliestRestoreDate": "2022-05-10T16:26:33.883Z", + "createMode": "PointInTimeRestore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/MyDatabase", + "restorePointInTime": "2022-05-05T16:26:33.883Z", + "lastDatabaseUploadTime": "2023-03-29T14:13:12Z" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval1" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.AzureArcData/operationResults/id1" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerEsuLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerEsuLicense.json new file mode 100644 index 000000000000..9c8ec40997d8 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerEsuLicense.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerEsuLicenseName": "testsqlServerEsuLicense", + "api-version": "2024-05-01-preview", + "parameters": { + "properties": { + "billingPlan": "Paid", + "physicalCores": 28, + "activationState": "Active" + }, + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "billingPlan": "Paid", + "version": "SQL Server 2012", + "physicalCores": 28, + "activationState": "Active", + "scopeType": "Subscription", + "activatedAt": "2020-01-01T17:18:19.1234567Z", + "terminatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/testsqlServerEsuLicense", + "name": "testsqlServerEsuLicense", + "type": "Microsoft.AzureArcData/sqlServerEsuLicenses" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerInstance.json new file mode 100644 index 000000000000..e51b1168d586 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerInstance.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2024-05-01-preview", + "parameters": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "version": "SQL Server 2012", + "edition": "Developer", + "containerResourceId": "Resource id of hosting Arc Machine", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2012", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Registered", + "hostType": "Physical Server", + "lastInventoryUploadTime": "2023-03-29T14:13:12Z", + "lastUsageUploadTime": "2023-03-29T14:13:12Z", + "alwaysOnRole": "FailoverClusterInstance", + "failoverCluster": { + "id": "f836af7e-85ed-4ea4-91fb-67709b34e323", + "networkName": "networkNameOfSQLFCI", + "sqlInstanceIds": [ + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer1", + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer2" + ], + "hostNames": [ + "DEV-HOSTNAME1", + "DEV-HOSTNAME2" + ] + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "upgradeLockedUntil": "2022-05-05T16:26:33.883Z", + "serviceType": "Engine" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.AzureArcData/operationResults/id1" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerLicense.json new file mode 100644 index 000000000000..8629697226b0 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerLicense.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerLicenseName": "testsqlServerLicense", + "api-version": "2024-05-01-preview", + "parameters": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription", + "lastActivatedAt": "2020-01-01T17:18:19.1234567Z", + "lastDeactivatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerLicenses/testsqlServerLicense", + "name": "testsqlServerLicense", + "type": "Microsoft.AzureArcData/SqlServerLicenses" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ViewArcSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ViewArcSqlServerAvailabilityGroup.json new file mode 100644 index 000000000000..a329e153da55 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ViewArcSqlServerAvailabilityGroup.json @@ -0,0 +1,183 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "availabilityGroupName": "testAG", + "api-version": "2024-05-01-preview", + "sqlServerAvailabilityGroupResource": { + "location": "southeastasia", + "tags": { + "mytag": "myval" + }, + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY", + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServerInstance", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/failoverGroups.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/failoverGroups.json new file mode 100644 index 000000000000..396d72260627 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/failoverGroups.json @@ -0,0 +1,157 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "FailoverGroupListResult": { + "description": "A list of failover groups.", + "type": "object", + "properties": { + "value": { + "description": "Array of failover group results.", + "type": "array", + "items": { + "$ref": "#/definitions/FailoverGroupResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "FailoverGroupResource": { + "type": "object", + "description": "A failover group resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/FailoverGroupProperties", + "description": "null", + "x-ms-client-flatten": false + } + }, + "required": [ + "properties" + ] + }, + "FailoverGroupProperties": { + "type": "object", + "description": "The properties of a failover group resource.", + "properties": { + "provisioningState": { + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted" + ], + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + }, + "description": "The provisioning state of the failover group resource.", + "readOnly": true + }, + "partnerManagedInstanceId": { + "type": "string", + "description": "The resource ID of the partner SQL managed instance." + }, + "spec": { + "$ref": "#/definitions/FailoverGroupSpec", + "description": "The specifications of the failover group resource.", + "x-ms-client-flatten": false + }, + "status": { + "type": "object", + "description": "The status of the failover group custom resource." + } + }, + "additionalProperties": {}, + "required": [ + "partnerManagedInstanceId", + "spec" + ] + }, + "FailoverGroupSpec": { + "description": "The specifications of the failover group resource.", + "type": "object", + "properties": { + "sharedName": { + "type": "string", + "description": "The shared name of the failover group for this SQL managed instance. Both SQL managed instance and its partner have to use the same shared name." + }, + "sourceMI": { + "type": "string", + "description": "The name of the SQL managed instance with this failover group role." + }, + "partnerMI": { + "type": "string", + "description": "The name of the partner SQL managed instance." + }, + "partnerMirroringURL": { + "type": "string", + "description": "The mirroring endpoint URL of the partner SQL managed instance." + }, + "partnerMirroringCert": { + "type": "string", + "description": "The mirroring endpoint public certificate for the partner SQL managed instance. Only PEM format is supported." + }, + "partnerSyncMode": { + "type": "string", + "enum": [ + "async", + "sync" + ], + "x-ms-enum": { + "name": "failoverGroupPartnerSyncMode", + "modelAsString": true + }, + "default": "async", + "description": "The partner sync mode of the SQL managed instance." + }, + "role": { + "type": "string", + "enum": [ + "primary", + "secondary", + "force-primary-allow-data-loss", + "force-secondary" + ], + "x-ms-enum": { + "name": "instanceFailoverGroupRole", + "modelAsString": true + }, + "default": "primary", + "description": "The role of the SQL managed instance in this failover group." + } + }, + "additionalProperties": {}, + "required": [ + "role" + ] + } + }, + "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/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/operations.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/operations.json new file mode 100644 index 000000000000..70d26a7889e9 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/operations.json @@ -0,0 +1,125 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "Operation": { + "description": "Azure Data Services on Azure Arc operation definition.", + "type": "object", + "properties": { + "name": { + "description": "The name of the operation being performed on this particular object.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "The localized display information for this particular operation / action." + }, + "origin": { + "description": "The intended executor of the operation.", + "enum": [ + "user", + "system" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OperationOrigin", + "modelAsString": true + } + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "properties": { + "description": "Additional descriptions for the operation.", + "type": "object", + "additionalProperties": {}, + "readOnly": true, + "x-ms-client-flatten": false + } + }, + "required": [ + "name", + "display", + "isDataAction" + ] + }, + "OperationListResult": { + "description": "Result of the request to list Azure Data Services on Azure Arc operations.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "OperationDisplay": { + "description": "Display metadata associated with the operation.", + "type": "object", + "properties": { + "provider": { + "description": "The localized friendly form of the resource provider name.", + "type": "string" + }, + "resource": { + "description": "The localized friendly form of the resource type related to this action/operation.", + "type": "string" + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string" + }, + "description": { + "description": "The localized friendly description for the operation.", + "type": "string" + } + }, + "required": [ + "provider", + "resource", + "operation", + "description" + ] + } + }, + "parameters": { + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + } + }, + "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/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/postgresInstances.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/postgresInstances.json new file mode 100644 index 000000000000..9a494464f170 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/postgresInstances.json @@ -0,0 +1,174 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "PostgresInstanceSku": { + "description": "The resource model definition representing SKU for Azure Database for PostgresSQL - Azure Arc", + "type": "object", + "properties": { + "tier": { + "type": "string", + "enum": [ + "Hyperscale" + ], + "x-ms-enum": { + "name": "PostgresInstanceSkuTier", + "modelAsString": false + }, + "default": "Hyperscale", + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier." + } + }, + "allOf": [ + { + "$ref": "./common.json#/definitions/CommonSku" + } + ] + }, + "PostgresInstanceProperties": { + "description": "Postgres Instance properties.", + "type": "object", + "properties": { + "dataControllerId": { + "type": "string", + "description": "The data controller id" + }, + "admin": { + "type": "string", + "description": "The instance admin" + }, + "basicLoginInformation": { + "$ref": "./common.json#/definitions/BasicLoginInformation", + "description": "Username and password for basic authentication." + }, + "k8sRaw": { + "type": "object", + "description": "The raw kubernetes information" + }, + "lastUploadedDate": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date from Kubernetes cluster. Defaults to current date time" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state of the Azure Arc-enabled PostgreSQL instance." + } + } + }, + "PostgresInstance": { + "description": "A Postgres Instance.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "extendedLocation": { + "$ref": "./common.json#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + }, + "properties": { + "$ref": "#/definitions/PostgresInstanceProperties", + "x-ms-client-flatten": false, + "description": "null" + }, + "sku": { + "$ref": "#/definitions/PostgresInstanceSku", + "description": "Resource sku." + } + }, + "required": [ + "properties" + ] + }, + "PostgresInstanceUpdate": { + "description": "An update to a Postgres Instance.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/PostgresInstanceProperties", + "x-ms-client-flatten": false + } + } + }, + "PostgresInstanceListResult": { + "description": "A list of PostgresInstance.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/PostgresInstance" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Azure subscription", + "x-ms-parameter-location": "client" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group", + "x-ms-parameter-location": "method" + }, + "location": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure region to use for the request", + "x-ms-parameter-location": "method" + }, + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + } + }, + "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/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlManagedInstances.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlManagedInstances.json new file mode 100644 index 000000000000..86050e597106 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlManagedInstances.json @@ -0,0 +1,403 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "SqlManagedInstance": { + "description": "A SqlManagedInstance.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlManagedInstanceProperties", + "description": "null", + "x-ms-client-flatten": false + }, + "extendedLocation": { + "$ref": "./common.json#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + }, + "sku": { + "$ref": "#/definitions/SqlManagedInstanceSku", + "description": "Resource sku." + } + }, + "required": [ + "properties" + ] + }, + "SqlManagedInstanceSku": { + "description": "The resource model definition representing SKU for Azure Managed Instance - Azure Arc", + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "vCore" + ], + "description": "The name of the SKU.", + "x-ms-enum": { + "name": "SqlManagedInstanceSkuName", + "modelAsString": false + } + }, + "tier": { + "type": "string", + "enum": [ + "GeneralPurpose", + "BusinessCritical" + ], + "x-ms-enum": { + "name": "SqlManagedInstanceSkuTier", + "modelAsString": false + }, + "default": "GeneralPurpose", + "description": "The pricing tier for the instance." + }, + "dev": { + "type": "boolean", + "default": true, + "description": "Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose. " + }, + "size": { + "type": "string", + "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. " + }, + "family": { + "type": "string", + "description": "The SKU family" + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "The SKU capacity" + } + }, + "required": [ + "name" + ] + }, + "SqlManagedInstanceProperties": { + "description": "Properties of sqlManagedInstance.", + "type": "object", + "properties": { + "dataControllerId": { + "type": "string", + "description": "null" + }, + "admin": { + "type": "string", + "description": "The instance admin user" + }, + "startTime": { + "type": "string", + "description": "The instance start time" + }, + "endTime": { + "type": "string", + "description": "The instance end time" + }, + "k8sRaw": { + "$ref": "#/definitions/SqlManagedInstanceK8sRaw", + "description": "The raw kubernetes information" + }, + "basicLoginInformation": { + "$ref": "./common.json#/definitions/BasicLoginInformation", + "description": "Username and password for basic authentication." + }, + "lastUploadedDate": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date from Kubernetes cluster. Defaults to current date time" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state of the Arc-enabled SQL Managed Instance resource." + }, + "activeDirectoryInformation": { + "description": "Active Directory information related to this SQL Managed Instance.", + "$ref": "#/definitions/ActiveDirectoryInformation" + }, + "licenseType": { + "type": "string", + "enum": [ + "BasePrice", + "LicenseIncluded", + "DisasterRecovery" + ], + "x-ms-enum": { + "name": "arcSqlManagedInstanceLicenseType", + "modelAsString": true + }, + "default": "BasePrice", + "description": "The license type to apply for this managed instance." + }, + "clusterId": { + "type": "string", + "description": "If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to." + }, + "extensionId": { + "type": "string", + "description": "If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to." + } + } + }, + "SqlManagedInstanceUpdate": { + "description": "An update to a SQL Managed Instance.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SqlManagedInstanceK8sRaw": { + "type": "object", + "description": "The raw kubernetes information.", + "properties": { + "spec": { + "$ref": "#/definitions/SqlManagedInstanceK8sSpec" + } + }, + "additionalProperties": {} + }, + "SqlManagedInstanceK8sSpec": { + "type": "object", + "description": "The kubernetes spec information.", + "properties": { + "scheduling": { + "$ref": "#/definitions/K8sScheduling" + }, + "replicas": { + "type": "integer", + "format": "int32", + "description": "This option specifies the number of SQL Managed Instance replicas that will be deployed in your Kubernetes cluster for high availability purposes. If sku.tier is BusinessCritical, allowed values are '2' or '3' with default of '3'. If sku.tier is GeneralPurpose, replicas must be '1'." + }, + "security": { + "$ref": "#/definitions/K8sSecurity" + }, + "settings": { + "$ref": "#/definitions/K8sSettings" + } + }, + "additionalProperties": {} + }, + "K8sScheduling": { + "type": "object", + "description": "The kubernetes scheduling information.", + "properties": { + "default": { + "$ref": "#/definitions/K8sSchedulingOptions" + } + }, + "additionalProperties": {} + }, + "K8sSchedulingOptions": { + "type": "object", + "description": "The kubernetes scheduling options. It describes restrictions used to help Kubernetes select appropriate nodes to host the database service", + "properties": { + "resources": { + "$ref": "#/definitions/K8sResourceRequirements" + } + }, + "additionalProperties": {} + }, + "K8sResourceRequirements": { + "type": "object", + "description": "The kubernetes resource limits and requests used to restrict or reserve resource usage.", + "properties": { + "requests": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Requests for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'." + }, + "limits": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Limits for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'." + } + }, + "additionalProperties": {} + }, + "K8sSecurity": { + "type": "object", + "description": "The kubernetes security information.", + "properties": { + "adminLoginSecret": { + "type": "string", + "description": "Admin login secret key" + }, + "serviceCertificateSecret": { + "type": "string", + "description": "Service certificate secret used" + }, + "activeDirectory": { + "$ref": "#/definitions/K8sActiveDirectory" + }, + "transparentDataEncryption": { + "$ref": "#/definitions/k8stransparentDataEncryption" + } + }, + "additionalProperties": {} + }, + "K8sActiveDirectory": { + "type": "object", + "description": "The kubernetes active directory information.", + "properties": { + "connector": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the connector" + }, + "namespace": { + "type": "string", + "description": "Name space of the connector" + } + } + }, + "accountName": { + "type": "string", + "description": "Account name for AAD" + }, + "keytabSecret": { + "type": "string", + "description": "Keytab secret used to authenticate with Active Directory." + }, + "encryptionTypes": { + "type": "array", + "description": "An array of encryption types", + "items": { + "type": "string" + } + } + } + }, + "k8stransparentDataEncryption": { + "type": "object", + "description": "Transparent data encryption information.", + "properties": { + "mode": { + "type": "string", + "description": "Transparent data encryption mode. Can be Service Managed, Customer managed or disabled" + }, + "protectorSecret": { + "type": "string", + "description": "Protector secret for customer managed Transparent data encryption mode" + } + } + }, + "K8sSettings": { + "type": "object", + "description": "The kubernetes settings information.", + "properties": { + "network": { + "$ref": "#/definitions/K8sNetworkSettings" + } + }, + "additionalProperties": {} + }, + "K8sNetworkSettings": { + "type": "object", + "description": "The kubernetes network settings information.", + "properties": { + "forceencryption": { + "type": "integer", + "format": "int32", + "description": "If 1, then SQL Server forces all connections to be encrypted. By default, this option is 0" + }, + "tlsciphers": { + "type": "string", + "description": "Specifies which ciphers are allowed by SQL Server for TLS" + }, + "tlsprotocols": { + "type": "string", + "description": "A comma-separated list of which TLS protocols are allowed by SQL Server" + } + } + }, + "KeytabInformation": { + "type": "object", + "description": "Keytab used for authenticate with Active Directory.", + "properties": { + "keytab": { + "type": "string", + "description": "A base64-encoded keytab.", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + }, + "ActiveDirectoryInformation": { + "type": "object", + "description": "Active Directory information that related to the resource.", + "properties": { + "keytabInformation": { + "description": "Keytab information that is used for the Sql Managed Instance when Active Directory authentication is used.", + "$ref": "#/definitions/KeytabInformation" + } + } + }, + "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 + } + } + } + }, + "parameters": { + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + } + }, + "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/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerAvailabilityGroups.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerAvailabilityGroups.json new file mode 100644 index 000000000000..74120bb67ff2 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerAvailabilityGroups.json @@ -0,0 +1,1573 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}": { + "put": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "operationId": "SqlServerAvailabilityGroups_Create", + "description": "Creates or replaces an Arc Sql Server Availability Group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlServerAvailabilityGroupResource", + "description": "The request body for availability group resource.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Updated", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a Arc Sql Server availability group.": { + "$ref": "./examples/CreateOrUpdateArcSqlServerAvailabilityGroup.json" + } + } + }, + "delete": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "operationId": "SqlServerAvailabilityGroups_Delete", + "description": "Deletes an Arc Sql Server availability group resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Resource deletion is in progress.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "The specified availability group does not exist." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deletes a availability group resource": { + "$ref": "./examples/DeleteArcSqlServerAvailabilityGroup.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "operationId": "SqlServerAvailabilityGroups_Get", + "description": "Retrieves an Arc Sql Server availability group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieves an Arc Sql Server availability group resource.": { + "$ref": "./examples/GetArcSqlServerAvailabilityGroup.json" + } + } + }, + "patch": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "description": "Updates an existing Availability Group.", + "operationId": "SqlServerAvailabilityGroups_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "sqlServerAvailabilityGroupUpdate", + "in": "body", + "description": "The requested server availability group resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupUpdate" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the Availability Group.", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "202": { + "description": "Resource update is in progress.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update an availability group.": { + "$ref": "./examples/UpdateArcSqlServerAvailabilityGroup.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.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}/getDetailView": { + "post": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "description": "Retrieves detailed properties of the Availability Group.", + "operationId": "SqlServerAvailabilityGroups_DetailView", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the Run-time detailed properties of the Availability Group.", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "detail view for a server availability group.": { + "$ref": "./examples/ViewArcSqlServerAvailabilityGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}/failover": { + "post": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "description": "Request manual failover of the availability group to this server.", + "operationId": "SqlServerAvailabilityGroups_Failover", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully requested failover of the Availability Group.", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "availability group manual failover to this server.": { + "$ref": "./examples/FailoverArcSqlServerAvailabilityGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}/forceFailoverAllowDataLoss": { + "post": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "description": "Request forced failover of the availability group to this server.", + "operationId": "SqlServerAvailabilityGroups_ForceFailoverAllowDataLoss", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully requested forced failover of the Availability Group.", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "availability group force failover to this server.": { + "$ref": "./examples/ForceFailoverArcSqlServerAvailabilityGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/createAvailabilityGroup": { + "post": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "description": "Create a SQL Server availability group", + "operationId": "SqlServerAvailabilityGroups_CreateAvailabilityGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createAgConfiguration", + "in": "body", + "description": "The configuration for the new SQL Server availability group resource.", + "required": true, + "schema": { + "$ref": "#/definitions/AvailabilityGroupCreateUpdateConfiguration" + } + } + ], + "responses": { + "200": { + "description": "Successfully created the Availability Group.", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "202": { + "description": "Availability group creation is in progress.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create an availability group using this server for the primary replica.": { + "$ref": "./examples/CreateSqlServerAvailabilityGroup.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.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/createDistributedAvailabilityGroup": { + "post": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "description": "Create a SQL Server distributed availability group", + "operationId": "SqlServerAvailabilityGroups_CreateDistributedAvailabilityGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createDagConfiguration", + "in": "body", + "description": "The configuration for the new SQL Server availability group resource.", + "required": true, + "schema": { + "$ref": "#/definitions/DistributedAvailabilityGroupCreateUpdateConfiguration" + } + } + ], + "responses": { + "200": { + "description": "Successfully created the Availability Group.", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "202": { + "description": "Availability group creation is in progress.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a distributed availability group using this server for the primary replica.": { + "$ref": "./examples/CreateSqlServerDistributedAvailabilityGroup.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.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}/addDatabases": { + "post": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "description": "Request adding database(s) to an existing availability group.", + "operationId": "SqlServerAvailabilityGroups_AddDatabases", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "databases", + "in": "body", + "description": "The database names to add to the SQL Server availability group resource.", + "required": true, + "schema": { + "$ref": "#/definitions/databases" + } + } + ], + "responses": { + "200": { + "description": "Successfully requested adding databases to Availability Group.", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "add databases to this availability group.": { + "$ref": "./examples/AddDatabasesToAvailabilityGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}/removeDatabases": { + "post": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "description": "Request removing database(s) from an existing availability group.", + "operationId": "SqlServerAvailabilityGroups_RemoveDatabases", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "databases", + "in": "body", + "description": "The database names to remove from the SQL Server availability group resource.", + "required": true, + "schema": { + "$ref": "#/definitions/databases" + } + } + ], + "responses": { + "200": { + "description": "Successfully requested removing databases from Availability Group.", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "remove databases from this availability group.": { + "$ref": "./examples/RemoveDatabasesFromAvailabilityGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups": { + "get": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "operationId": "SqlServerAvailabilityGroups_List", + "summary": "List the availability group associated with the given Arc Sql Server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSqlServerAvailabilityGroupListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all availability groups associated with an Arc Enabled Sql server.": { + "$ref": "./examples/ListBySqlServerInstanceAvailabilityGroup.json" + } + } + } + } + }, + "definitions": { + "AvailabilityGroupConfigure": { + "description": "The specifications of the availability group replica configuration", + "type": "object", + "properties": { + "endpointName": { + "type": "string", + "description": "Name of the mirroring endpoint URL" + }, + "endpointUrl": { + "type": "string", + "description": "Mirroring endpoint URL of availability group replica" + }, + "endpointAuthenticationMode": { + "description": "Permitted authentication modes for the mirroring endpoint.", + "$ref": "./common.json#/definitions/ConnectionAuth" + }, + "certificateName": { + "type": "string", + "description": "Name of certificate to use for authentication. Required if any CERTIFICATE authentication modes are specified." + }, + "endpointConnectLogin": { + "type": "string", + "description": "The login which will connect to the mirroring endpoint." + }, + "availabilityMode": { + "type": "string", + "description": "Property that determines whether a given availability replica can run in synchronous-commit mode", + "enum": [ + "SYNCHRONOUS_COMMIT", + "ASYNCHRONOUS_COMMIT" + ], + "x-ms-enum": { + "name": "arcSqlServerAvailabilityMode", + "modelAsString": true + } + }, + "availabilityModeDescription": { + "type": "string", + "description": "The Availability Synchronization mode of the availability group replica.", + "readOnly": true + }, + "failoverMode": { + "type": "string", + "description": "Property to set the failover mode of the availability group replica", + "enum": [ + "AUTOMATIC", + "MANUAL", + "EXTERNAL" + ], + "x-ms-enum": { + "name": "arcSqlServerFailoverMode", + "modelAsString": true + } + }, + "failoverModeDescription": { + "type": "string", + "description": "The failover mode of the availability group replica.", + "readOnly": true + }, + "sessionTimeout": { + "type": "integer", + "description": "The time-out period of availability group session replica, in seconds.", + "format": "int32" + }, + "primaryAllowConnections": { + "type": "string", + "description": "Whether the primary replica should allow all connections or only READ_WRITE connections (disallowing ReadOnly connections)", + "enum": [ + "ALL", + "READ_WRITE" + ], + "x-ms-enum": { + "name": "primaryAllowConnections", + "modelAsString": false + } + }, + "primaryRoleAllowConnectionsDescription": { + "type": "string", + "description": "Whether the availability allows all connections or only read-write connections.", + "readOnly": true + }, + "secondaryAllowConnections": { + "type": "string", + "description": "Whether the secondary replica should allow all connections, no connections, or only ReadOnly connections.", + "enum": [ + "NO", + "ALL", + "READ_ONLY" + ], + "x-ms-enum": { + "name": "secondaryAllowConnections", + "modelAsString": false + } + }, + "secondaryRoleAllowConnectionsDescription": { + "type": "string", + "description": "Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients.", + "readOnly": true + }, + "replicaCreateDate": { + "type": "string", + "description": "Date that the replica was created.", + "format": "date-time", + "readOnly": true + }, + "replicaModifyDate": { + "type": "string", + "description": "Date that the replica was modified.", + "format": "date-time", + "readOnly": true + }, + "backupPriority": { + "type": "integer", + "description": "Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group.", + "format": "int32" + }, + "readOnlyRoutingUrl": { + "type": "string", + "description": "Connectivity endpoint (URL) of the read only availability replica." + }, + "readWriteRoutingUrl": { + "type": "string", + "description": "Connectivity endpoint (URL) of the read write availability replica." + }, + "seedingMode": { + "type": "string", + "description": "Specifies how the secondary replica will be initially seeded. AUTOMATIC enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. MANUAL specifies manual seeding (default). This method requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica.", + "enum": [ + "AUTOMATIC", + "MANUAL" + ], + "x-ms-enum": { + "name": "seedingMode", + "modelAsString": false + } + }, + "seedingModeDescription": { + "type": "string", + "description": "Describes seeding mode.", + "readOnly": true + } + } + }, + "AvailabilityGroupState": { + "description": "The specifications of the availability group state", + "type": "object", + "properties": { + "availabilityGroupReplicaRole": { + "type": "string", + "description": "Current Always On availability groups role of the availability group replica.", + "readOnly": true + }, + "operationalStateDescription": { + "type": "string", + "description": "Current operational state of the availability group replica", + "readOnly": true + }, + "recoveryHealthDescription": { + "type": "string", + "description": "Recovery health of the availability group replica.", + "readOnly": true + }, + "synchronizationHealthDescription": { + "type": "string", + "description": "Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica.", + "readOnly": true + }, + "connectedStateDescription": { + "type": "string", + "description": "Whether a secondary replica is currently connected to the primary replica.", + "readOnly": true + }, + "lastConnectErrorDescription": { + "type": "string", + "description": "Text description of the last connection error of the availability group replica.", + "readOnly": true + }, + "lastConnectErrorTimestamp": { + "type": "string", + "description": "Date and time timestamp indicating when the last connect error occurred.", + "format": "date-time", + "readOnly": true + } + } + }, + "AvailabilityGroupInfo": { + "description": "The specifications of the availability group state", + "type": "object", + "properties": { + "failureConditionLevel": { + "type": "integer", + "description": "User-defined failure condition level under which an automatic failover must be triggered.", + "format": "int32" + }, + "healthCheckTimeout": { + "type": "integer", + "description": "Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding.", + "format": "int32" + }, + "automatedBackupPreferenceDescription": { + "type": "string", + "description": "Preferred location for performing backups on the availability databases in this availability group.", + "readOnly": true + }, + "version": { + "type": "integer", + "description": "SQL Server availability group current version.", + "format": "int32", + "readOnly": true + }, + "basicFeatures": { + "type": "boolean", + "description": "Specifies whether this is a basic availability group." + }, + "dtcSupport": { + "type": "boolean", + "description": "Specifies whether DTC support has been enabled for this availability group." + }, + "dbFailover": { + "type": "boolean", + "description": "Specifies whether the availability group supports failover for database health conditions." + }, + "isDistributed": { + "type": "boolean", + "description": "Specifies whether this is a distributed availability group." + }, + "clusterTypeDescription": { + "type": "string", + "description": "SQL Server availability group cluster type description", + "readOnly": true + }, + "requiredSynchronizedSecondariesToCommit": { + "type": "integer", + "description": "The number of secondary replicas that must be in a synchronized state for a commit to complete.", + "format": "int32" + }, + "isContained": { + "type": "boolean", + "description": "SQL Server availability group contained system databases." + }, + "primaryReplica": { + "type": "string", + "description": "Name of the server instance that is hosting the current primary replica.", + "readOnly": true + }, + "primaryRecoveryHealthDescription": { + "type": "string", + "description": "Indicates the recovery health of the primary replica.", + "readOnly": true + }, + "secondaryRecoveryHealthDescription": { + "type": "string", + "description": "Indicates the recovery health of a secondary replica.", + "readOnly": true + }, + "synchronizationHealthDescription": { + "type": "string", + "description": "Reflects a roll-up of the synchronization health of all availability replicas in the availability group.", + "readOnly": true + }, + "replicationPartnerType": { + "type": "string", + "enum": [ + "SQLServer", + "AzureSQLVM", + "AzureSQLManagedInstance", + "Unknown" + ], + "x-ms-enum": { + "name": "replicationPartnerType", + "modelAsString": false + }, + "readOnly": true + }, + "listener": { + "description": "The listener for the sql server availability group", + "$ref": "#/definitions/SqlAvailabilityGroupStaticIPListenerProperties" + } + } + }, + "AvailabilityGroupCreateUpdateConfiguration": { + "description": "Options used in creating an availability group", + "type": "object", + "properties": { + "availabilityGroupName": { + "type": "string", + "description": "Name of the availability group." + }, + "replicas": { + "type": "array", + "description": "List of availability group replicas.", + "items": { + "$ref": "#/definitions/AvailabilityGroupCreateUpdateReplicaConfiguration" + }, + "x-ms-identifiers": [ + "serverInstance" + ] + }, + "databases": { + "type": "array", + "description": "List of databases to include in the availability group.", + "items": { + "type": "string" + } + }, + "automatedBackupPreference": { + "type": "string", + "description": "Preferred replica for running automated backups.", + "enum": [ + "PRIMARY", + "SECONDARY_ONLY", + "SECONDARY", + "NONE" + ], + "x-ms-enum": { + "name": "automatedBackupPreference", + "modelAsString": false + } + }, + "failureConditionLevel": { + "type": "integer", + "enum": [ + 1, + 2, + 3, + 4, + 5 + ], + "x-ms-enum": { + "name": "failureConditionLevel", + "modelAsString": false + }, + "description": "User-defined failure condition level under which an automatic failover must be triggered.", + "format": "int32" + }, + "healthCheckTimeout": { + "type": "integer", + "description": "Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding.", + "format": "int32" + }, + "dbFailover": { + "type": "string", + "description": "Specifies whether the availability group supports failover for database health conditions.", + "enum": [ + "ON", + "OFF" + ], + "x-ms-enum": { + "name": "dbFailover", + "modelAsString": false + } + }, + "dtcSupport": { + "type": "string", + "description": "Specifies whether DTC support has been enabled for this availability group.", + "enum": [ + "PER_DB", + "NONE" + ], + "x-ms-enum": { + "name": "dtcSupport", + "modelAsString": false + } + }, + "requiredSynchronizedSecondariesToCommit": { + "type": "integer", + "description": "The number of secondary replicas that must be in a synchronized state for a commit to complete.", + "format": "int32" + }, + "clusterType": { + "type": "string", + "description": "Set to WSFC when availability group is on a failover cluster instance on a Windows Server failover cluster. Set to NONE when availability group not using WSFC for cluster coordination.", + "enum": [ + "WSFC", + "NONE" + ], + "x-ms-enum": { + "name": "clusterType", + "modelAsString": false + } + }, + "listener": { + "description": "The listener for the sql server availability group", + "$ref": "#/definitions/SqlAvailabilityGroupStaticIPListenerProperties" + } + } + }, + "AvailabilityGroupCreateUpdateReplicaConfiguration": { + "description": "The specifications of the availability group replica configuration", + "type": "object", + "properties": { + "serverInstance": { + "type": "string", + "description": "the server instance hosting the replica." + }, + "endpointName": { + "type": "string", + "description": "Name of the database mirroring endpoint URL for the availability group replica" + }, + "endpointUrl": { + "type": "string", + "description": "Database mirroring endpoint URL of availability group replica" + }, + "endpointAuthenticationMode": { + "description": "Permitted authentication modes for the mirroring endpoint.", + "$ref": "./common.json#/definitions/ConnectionAuth" + }, + "certificateName": { + "type": "string", + "description": "Name of certificate to use for authentication. Required if any CERTIFICATE authentication modes are specified." + }, + "endpointConnectLogin": { + "type": "string", + "description": "The login which will connect to the mirroring endpoint" + }, + "availabilityMode": { + "type": "string", + "description": "Property that determines whether a given availability replica can run in synchronous-commit mode", + "enum": [ + "SYNCHRONOUS_COMMIT", + "ASYNCHRONOUS_COMMIT" + ], + "x-ms-enum": { + "name": "arcSqlServerAvailabilityMode", + "modelAsString": true + } + }, + "failoverMode": { + "type": "string", + "description": "Property to set the failover mode of the availability group replica", + "enum": [ + "AUTOMATIC", + "MANUAL", + "EXTERNAL" + ], + "x-ms-enum": { + "name": "arcSqlServerFailoverMode", + "modelAsString": true + } + }, + "seedingMode": { + "type": "string", + "description": "Specifies how the secondary replica will be initially seeded. AUTOMATIC enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. MANUAL specifies manual seeding (default). This method requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica.", + "enum": [ + "AUTOMATIC", + "MANUAL" + ], + "x-ms-enum": { + "name": "seedingMode", + "modelAsString": false + } + }, + "backupPriority": { + "type": "integer", + "description": "Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group.", + "format": "int32" + }, + "secondaryRoleAllowConnections": { + "type": "string", + "description": "Whether the secondary replica should allow all connections, no connections, or only ReadOnly connections.", + "enum": [ + "NO", + "ALL", + "READ_ONLY" + ], + "x-ms-enum": { + "name": "secondaryAllowConnections", + "modelAsString": false + } + }, + "secondaryRoleReadOnlyRoutingUrl": { + "type": "string", + "description": "Connectivity endpoint (URL) of the read only availability replica." + }, + "primaryRoleAllowConnections": { + "type": "string", + "description": "Whether the primary replica should allow all connections or only READ_WRITE connections (disallowing ReadOnly connections)", + "enum": [ + "ALL", + "READ_WRITE" + ], + "x-ms-enum": { + "name": "primaryAllowConnections", + "modelAsString": false + } + }, + "primaryRoleReadOnlyRoutingList": { + "type": "array", + "description": "List of read only routing URLs.", + "items": { + "type": "string" + } + }, + "sessionTimeout": { + "type": "integer", + "description": "The time-out period of availability group session replica, in seconds.", + "format": "int32" + } + } + }, + "databases": { + "description": "List of database names.", + "type": "object", + "properties": { + "values": { + "description": "List of database names.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ArcSqlServerAvailabilityGroupListResult": { + "description": "A list of Arc Sql Server Availability Groups.", + "type": "object", + "properties": { + "value": { + "description": "Array of Arc Sql Server Availability Groups.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "DistributedAvailabilityGroupCreateUpdateConfiguration": { + "description": "Options used in creating a distributed availability group.", + "type": "object", + "properties": { + "availabilityGroupName": { + "type": "string", + "description": "Name of the availability group." + }, + "primaryAvailabilityGroup": { + "description": "The initial primary availability group for the distributed availability group.", + "$ref": "#/definitions/DistributedAvailabilityGroupCreateUpdateAvailabilityGroupConfiguration" + }, + "secondaryAvailabilityGroup": { + "description": "The initial secondary availability group for the distributed availability group.", + "$ref": "#/definitions/DistributedAvailabilityGroupCreateUpdateAvailabilityGroupConfiguration" + } + } + }, + "DistributedAvailabilityGroupCreateUpdateAvailabilityGroupConfiguration": { + "description": "The availability group configuration specification for a distributed availability group.", + "type": "object", + "properties": { + "availabilityGroup": { + "type": "string", + "format": "arm-id", + "description": "The azure resource identifier for the availability group." + }, + "listenerUrl": { + "type": "string", + "format": "uri", + "description": "The listener URL of the availability group." + }, + "availabilityMode": { + "type": "string", + "description": "The availability mode of the availability group.", + "enum": [ + "SYNCHRONOUS_COMMIT", + "ASYNCHRONOUS_COMMIT" + ], + "x-ms-enum": { + "name": "arcSqlServerAvailabilityMode", + "modelAsString": true + } + }, + "failoverMode": { + "type": "string", + "description": "The failover mode of the availability group.", + "enum": [ + "AUTOMATIC", + "MANUAL", + "EXTERNAL" + ], + "x-ms-enum": { + "name": "arcSqlServerFailoverMode", + "modelAsString": true + } + }, + "seedingMode": { + "type": "string", + "description": "The seeding mode of the availability group.", + "enum": [ + "AUTOMATIC", + "MANUAL" + ], + "x-ms-enum": { + "name": "seedingMode", + "modelAsString": false + } + }, + "certificateConfiguration": { + "description": "The certificate configuration for the availability group.", + "$ref": "#/definitions/DistributedAvailabilityGroupCreateUpdateAvailabilityGroupCertificateConfiguration" + } + } + }, + "DistributedAvailabilityGroupCreateUpdateAvailabilityGroupCertificateConfiguration": { + "description": "The availability group certificate configuration.", + "type": "object", + "properties": { + "certificateName": { + "type": "string", + "description": "Name of the certificate." + } + } + }, + "SqlServerAvailabilityGroupResource": { + "type": "object", + "description": "Arc Sql Server Availability Group", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResourceProperties", + "description": "Properties of Arc Sql Server availability group", + "x-ms-client-flatten": false + } + }, + "required": [ + "properties" + ] + }, + "SqlServerAvailabilityGroupResourceProperties": { + "type": "object", + "description": "The properties of Arc Sql Server availability group resource", + "properties": { + "availabilityGroupId": { + "type": "string", + "description": "ID GUID of the availability group.", + "pattern": "^[A-Za-z0-9]{8}-([A-Za-z0-9]{4}-){3}[A-Za-z0-9]{12}$", + "readOnly": true + }, + "serverName": { + "type": "string", + "description": "the SQL server name.", + "readOnly": true + }, + "instanceName": { + "type": "string", + "description": "the SQL Server Instance name.", + "readOnly": true + }, + "collectionTimestamp": { + "description": "Timestamp for when the data was collected from the client machine.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "info": { + "$ref": "#/definitions/AvailabilityGroupInfo", + "description": "Availability Group Info", + "x-ms-client-flatten": false + }, + "replicas": { + "description": "A list of Availability Group Replicas.", + "type": "object", + "properties": { + "value": { + "description": "Array of Availability Group Replicas.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlAvailabilityGroupReplicaResourceProperties" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "databases": { + "description": "A list of Availability Group Database Replicas.", + "type": "object", + "properties": { + "value": { + "description": "Array of Availability Group Database Replicas.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlAvailabilityGroupDatabaseReplicaResourceProperties" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the Arc-enabled SQL Server availability group resource.", + "readOnly": true + } + } + }, + "SqlServerAvailabilityGroupUpdate": { + "description": "An update to availability group resource.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResourceProperties", + "description": "The Server Availability Group's properties", + "x-ms-client-flatten": false + } + } + }, + "SqlAvailabilityGroupReplicaResourceProperties": { + "type": "object", + "description": "The properties of Arc Sql availability group replica resource", + "properties": { + "replicaId": { + "type": "string", + "description": "ID GUID of the availability group.", + "pattern": "^[A-Za-z0-9]{8}-([A-Za-z0-9]{4}-){3}[A-Za-z0-9]{12}$", + "readOnly": true + }, + "replicaName": { + "type": "string", + "description": "the replica name." + }, + "configure": { + "$ref": "#/definitions/AvailabilityGroupConfigure", + "description": "null", + "x-ms-client-flatten": false + }, + "state": { + "$ref": "#/definitions/AvailabilityGroupState", + "description": "null", + "x-ms-client-flatten": false + } + } + }, + "SqlAvailabilityGroupDatabaseReplicaResourceProperties": { + "type": "object", + "description": "The properties of Arc Sql availability group database replica resource", + "properties": { + "databaseName": { + "type": "string", + "description": "the database name." + }, + "replicaName": { + "type": "string", + "description": "the database replica name.", + "readOnly": true + }, + "isLocal": { + "type": "boolean", + "description": "Whether the availability database is local.", + "readOnly": true + }, + "isPrimaryReplica": { + "type": "boolean", + "description": "Returns 1 if the replica is primary, or 0 if it is a secondary replica.", + "readOnly": true + }, + "synchronizationStateDescription": { + "type": "string", + "description": "Description of the data-movement state.", + "readOnly": true + }, + "isCommitParticipant": { + "type": "boolean", + "description": "Whether this replica is transaction committer.", + "readOnly": true + }, + "synchronizationHealthDescription": { + "type": "string", + "description": "Description of the health of database.", + "readOnly": true + }, + "databaseStateDescription": { + "type": "string", + "description": "Description of the database state of the availability replica.", + "readOnly": true + }, + "isSuspended": { + "type": "boolean", + "description": "Whether this data movement is suspended.", + "readOnly": true + }, + "suspendReasonDescription": { + "type": "string", + "description": "Description of the database suspended state reason.", + "readOnly": true + } + } + }, + "SqlAvailabilityGroupStaticIPListenerProperties": { + "type": "object", + "description": "The properties of a static IP Arc Sql availability group listener", + "properties": { + "dnsName": { + "type": "string", + "description": "the DNS name for the listener." + }, + "ipV4AddressesAndMasks": { + "$ref": "#/definitions/SqlAvailabilityGroupIpV4AddressesAndMasksProperties", + "description": "IP V4 Addresses and masks for the listener." + }, + "ipV6Addresses": { + "type": "array", + "description": "IP V6 Addresses for the listener", + "items": { + "type": "string" + } + }, + "port": { + "type": "integer", + "description": "Network port for the listener. Default is 1433.", + "format": "int32" + } + } + }, + "SqlAvailabilityGroupIpV4AddressesAndMasksProperties": { + "type": "array", + "description": "Address and netmask information for an IPv4 AG listener.", + "items": { + "type": "object", + "properties": { + "ipAddress": { + "type": "string", + "description": "IPV4 address" + }, + "mask": { + "type": "string", + "description": "IPV4 netmask" + } + } + }, + "x-ms-identifiers": [ + "ipAddress" + ] + }, + "SqlAvailabilityGroupDhcpListenerProperties": { + "type": "object", + "description": "The properties of a DHCP Arc Sql availability group listener", + "properties": { + "dnsName": { + "type": "string", + "description": "the DNS name for the listener." + }, + "subnet": { + "type": "string", + "description": "The IPV4 subnet for the listener." + }, + "mask": { + "type": "string", + "description": "The netmask for the listener." + }, + "port": { + "type": "integer", + "description": "Network port for the listener. Default is 1433.", + "format": "int32" + } + } + } + }, + "parameters": { + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group", + "x-ms-parameter-location": "method" + }, + "sqlServerInstanceName": { + "name": "sqlServerInstanceName", + "description": "Name of SQL Server Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "availabilityGroupName": { + "name": "availabilityGroupName", + "description": "Name of SQL Availability Group", + "in": "path", + "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/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerDatabases.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerDatabases.json new file mode 100644 index 000000000000..7da3f90ec544 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerDatabases.json @@ -0,0 +1,680 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/databases/{databaseName}": { + "put": { + "tags": [ + "SqlServerDatabases" + ], + "operationId": "SqlServerDatabases_Create", + "description": "Creates or replaces an Arc Sql Server Database.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlServerDatabaseResource", + "description": "The request body for database resource.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/SqlServerDatabaseResource" + } + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/databaseName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerDatabaseResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SqlServerDatabaseResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a Arc Sql Server database.": { + "$ref": "./examples/CreateOrUpdateArcSqlServerDatabase.json" + } + } + }, + "delete": { + "tags": [ + "SqlServerDatabases" + ], + "operationId": "SqlServerDatabases_Delete", + "description": "Deletes an Arc Sql Server database resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/databaseName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "202": { + "description": "Resource deletion is in progress.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "The specified database does not exist." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deletes a database resource": { + "$ref": "./examples/DeleteArcSqlServerDatabase.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "SqlServerDatabases" + ], + "operationId": "SqlServerDatabases_Get", + "description": "Retrieves an Arc Sql Server database.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/databaseName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerDatabaseResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieves an Arc Sql Server database resource.": { + "$ref": "./examples/GetArcSqlServerDatabase.json" + } + } + }, + "patch": { + "tags": [ + "SqlServerDatabases" + ], + "description": "Updates an existing database.", + "operationId": "SqlServerDatabases_Update", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/databaseName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "name": "sqlServerDatabaseUpdate", + "in": "body", + "description": "The requested database resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlServerDatabaseUpdate" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the database.", + "schema": { + "$ref": "#/definitions/SqlServerDatabaseResource" + } + }, + "202": { + "description": "Resource update is in progress.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update a database.": { + "$ref": "./examples/UpdateSqlServerDatabase.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.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/databases": { + "get": { + "tags": [ + "SqlServerDatabases" + ], + "operationId": "SqlServerDatabases_List", + "summary": "List the databases associated with the given Arc Sql Server.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSqlServerDatabaseListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all databases associated with an Arc Enabled Sql server.": { + "$ref": "./examples/ListBySqlServerInstanceDatabase.json" + } + } + } + } + }, + "definitions": { + "ArcSqlServerDatabaseListResult": { + "description": "A list of Arc Sql Server database.", + "type": "object", + "properties": { + "value": { + "description": "Array of Arc Sql Server database.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlServerDatabaseResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SqlServerDatabaseResource": { + "type": "object", + "description": "Arc Sql Server database", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlServerDatabaseResourceProperties", + "description": "Properties of Arc Sql Server database", + "x-ms-client-flatten": false + } + }, + "required": [ + "properties" + ] + }, + "SqlServerDatabaseResourceProperties": { + "type": "object", + "description": "The properties of Arc Sql Server database resource", + "properties": { + "collationName": { + "description": "Collation of the database.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "databaseCreationDate": { + "format": "date-time", + "description": "Creation date of the database.", + "type": "string" + }, + "compatibilityLevel": { + "type": "integer", + "minimum": 80, + "maximum": 200, + "format": "int32", + "description": "Compatibility level of the database" + }, + "sizeMB": { + "type": "number", + "format": "float", + "description": "Size of the database." + }, + "spaceAvailableMB": { + "type": "number", + "format": "float", + "description": "Space left of the database." + }, + "state": { + "description": "State of the database.", + "enum": [ + "Online", + "Restoring", + "Recovering", + "RecoveryPending", + "Suspect", + "Emergency", + "Offline", + "Copying", + "OfflineSecondary" + ], + "type": "string", + "x-ms-enum": { + "name": "DatabaseState", + "modelAsString": true + } + }, + "isReadOnly": { + "type": "boolean", + "description": "Whether the database is read only or not." + }, + "recoveryMode": { + "description": "Status of the database.", + "enum": [ + "Full", + "Bulk-logged", + "Simple" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryMode", + "modelAsString": true + } + }, + "databaseOptions": { + "type": "object", + "description": "List of features that are enabled for the database", + "properties": { + "isAutoCloseOn": { + "type": "boolean" + }, + "isAutoShrinkOn": { + "type": "boolean" + }, + "isAutoCreateStatsOn": { + "type": "boolean" + }, + "isAutoUpdateStatsOn": { + "type": "boolean" + }, + "isRemoteDataArchiveEnabled": { + "type": "boolean" + }, + "isMemoryOptimizationEnabled": { + "type": "boolean" + }, + "isEncrypted": { + "type": "boolean" + }, + "isTrustworthyOn": { + "type": "boolean" + } + } + }, + "backupInformation": { + "type": "object", + "properties": { + "lastFullBackup": { + "format": "date-time", + "description": "Date time of last full backup.", + "type": "string" + }, + "lastLogBackup": { + "format": "date-time", + "description": "Date time of last log backup.", + "type": "string" + } + } + }, + "backupPolicy": { + "description": "The backup profile for the SQL server.", + "$ref": "#/definitions/BackupPolicy" + }, + "earliestRestoreDate": { + "format": "date-time", + "description": "This records the earliest start date and time that restore is available for this database (ISO8601 format).", + "type": "string", + "readOnly": true + }, + "createMode": { + "description": "Database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. sourceDatabaseId and restorePointInTime must be specified.", + "enum": [ + "Default", + "PointInTimeRestore" + ], + "type": "string", + "x-ms-enum": { + "name": "DatabaseCreateMode", + "modelAsString": true + } + }, + "sourceDatabaseId": { + "description": "The name of the source database associated with create operation of this database.", + "type": "string", + "format": "arm-id" + }, + "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" + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the Arc-enabled SQL Server database resource.", + "readOnly": true + }, + "lastDatabaseUploadTime": { + "type": "string", + "format": "date-time", + "description": "The time when last successful database upload was performed.", + "readOnly": true + }, + "migration": { + "$ref": "#/definitions/DataBaseMigration" + } + } + }, + "DataBaseMigration": { + "description": "Migration related configuration.", + "type": "object", + "properties": { + "assessment": { + "description": "Migration assessments related configuration.", + "$ref": "#/definitions/DataBaseMigrationAssessment" + } + } + }, + "DataBaseMigrationAssessment": { + "description": "The migration assessment related configuration.", + "type": "object", + "properties": { + "assessmentUploadTime": { + "type": "string", + "format": "date-time", + "description": "The time when Migration Assessment Report upload was last performed.", + "readOnly": true + }, + "databaseAssessments": { + "$ref": "#/definitions/DatabaseAssessments" + }, + "targetReadiness": { + "$ref": "#/definitions/TargetReadiness" + } + } + }, + "DatabaseAssessments": { + "description": "Issues and warnings impacting the migration of Database to particular Azure Migration Target.", + "readOnly": true, + "type": "array", + "items": { + "type": "object", + "properties": { + "appliesToMigrationTargetPlatform": { + "type": "string" + }, + "featureId": { + "type": "string" + }, + "issueCategory": { + "type": "string" + }, + "moreInformation": { + "type": "string" + } + } + } + }, + "TargetReadiness": { + "description": "The target readiness for migration for this database.", + "type": "object", + "readOnly": true, + "properties": { + "azureSqlDatabase": { + "$ref": "#/definitions/SkuRecommendationSummary" + }, + "azureSqlManagedInstance": { + "$ref": "#/definitions/SkuRecommendationSummary" + }, + "azureSqlVirtualMachine": { + "$ref": "#/definitions/SkuRecommendationSummary" + } + } + }, + "SkuRecommendationSummary": { + "description": "The SKU recommendation summary.", + "type": "object", + "properties": { + "numOfBlockerIssues": { + "$ref": "#/definitions/SkuRecommendationResultsNumberOfBlockerIssues" + }, + "recommendationStatus": { + "$ref": "./common.json#/definitions/SkuRecommendationResultsRecommendationStatus" + } + } + }, + "SkuRecommendationResultsNumberOfBlockerIssues": { + "description": "Number of blocker issues to fix before migrating this database to the target platform.", + "type": "integer", + "format": "int32" + }, + "SqlServerDatabaseUpdate": { + "description": "An update to database resource.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/SqlServerDatabaseResourceProperties", + "description": "The data controller's properties", + "x-ms-client-flatten": false + } + } + }, + "BackupPolicy": { + "description": "The backup profile for the SQL server.", + "type": "object", + "properties": { + "retentionPeriodDays": { + "type": "integer", + "description": "The retention period for all the databases in this managed instance.", + "minimum": 0, + "maximum": 35, + "format": "int32" + }, + "fullBackupDays": { + "type": "integer", + "description": "The value indicating days between full backups.", + "minimum": 0, + "maximum": 7, + "format": "int32" + }, + "differentialBackupHours": { + "description": "The differential backup interval in hours.", + "enum": [ + 12, + 24 + ], + "type": "integer", + "format": "int32", + "x-ms-enum": { + "name": "differentialBackupHours", + "modelAsString": false + } + }, + "transactionLogBackupMinutes": { + "type": "integer", + "description": "The value indicating minutes between transaction log backups.", + "minimum": 0, + "maximum": 60, + "format": "int32" + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Azure subscription", + "x-ms-parameter-location": "client" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group", + "x-ms-parameter-location": "method" + }, + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + }, + "sqlServerInstanceName": { + "name": "sqlServerInstanceName", + "description": "Name of SQL Server Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "databaseName": { + "name": "databaseName", + "description": "Name of the database", + "in": "path", + "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/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerEsuLicenses.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerEsuLicenses.json new file mode 100644 index 000000000000..61ac6e8af6e2 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerEsuLicenses.json @@ -0,0 +1,545 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/sqlServerEsuLicenses": { + "get": { + "tags": [ + "SqlServerEsuLicenses" + ], + "operationId": "SqlServerEsuLicenses_List", + "summary": "List sqlServerEsuLicense resources in the subscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerEsuLicenseListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Server ESU licenses in a subscription.": { + "$ref": "./examples/ListSubscriptionSqlServerEsuLicense.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerEsuLicenses": { + "get": { + "tags": [ + "SqlServerEsuLicenses" + ], + "operationId": "SqlServerEsuLicenses_ListByResourceGroup", + "description": "Gets all sqlServerEsuLicenses in a resource group.", + "summary": "List sqlServerEsuLicense resources in the resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerEsuLicenseListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Server ESU licenses in a resource group.": { + "$ref": "./examples/ListByResourceGroupSqlServerEsuLicense.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/{sqlServerEsuLicenseName}": { + "get": { + "tags": [ + "SqlServerEsuLicenses" + ], + "operationId": "SqlServerEsuLicenses_Get", + "description": "Retrieves a SQL Server ESU license resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/sqlServerEsuLicenseName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerEsuLicense" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets a SQL Server ESU license.": { + "$ref": "./examples/GetSqlServerEsuLicense.json" + } + } + }, + "put": { + "tags": [ + "SqlServerEsuLicenses" + ], + "operationId": "SqlServerEsuLicenses_Create", + "description": "Creates or replaces a SQL Server ESU license resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/sqlServerEsuLicenseName" + }, + { + "name": "sqlServerEsuLicense", + "in": "body", + "description": "The SQL Server ESU license to be created or updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlServerEsuLicense" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerEsuLicense" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SqlServerEsuLicense" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Server ESU license.": { + "$ref": "./examples/CreateOrUpdateSqlServerEsuLicense.json" + } + } + }, + "delete": { + "tags": [ + "SqlServerEsuLicenses" + ], + "operationId": "SqlServerEsuLicenses_Delete", + "description": "Deletes a SQL Server ESU license resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/sqlServerEsuLicenseName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SQL Server ESU license." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified SQL Server ESU license does not exist." + } + }, + "x-ms-examples": { + "Delete a SQL Server ESU license.": { + "$ref": "./examples/DeleteSqlServerEsuLicense.json" + } + } + }, + "patch": { + "tags": [ + "SqlServerEsuLicenses" + ], + "operationId": "SqlServerEsuLicenses_Update", + "description": "Updates a SQL Server ESU license resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/sqlServerEsuLicenseName" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL Server ESU license.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlServerEsuLicenseUpdate" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerEsuLicense" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch a SQL Server ESU license.": { + "$ref": "./examples/UpdateSqlServerEsuLicense.json" + } + } + } + } + }, + "definitions": { + "SqlServerEsuLicense": { + "description": "Describe SQL Server ESU license resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlServerEsuLicenseProperties", + "description": "SQL Server ESU license properties", + "x-ms-client-flatten": false + } + }, + "required": [ + "properties" + ] + }, + "SqlServerEsuLicenseProperties": { + "description": "Properties of SQL Server ESU license.", + "type": "object", + "properties": { + "billingPlan": { + "type": "string", + "description": "SQL Server ESU license type.", + "enum": [ + "PAYG" + ], + "x-ms-enum": { + "name": "billingPlan", + "modelAsString": true + } + }, + "version": { + "type": "string", + "description": "The SQL Server version the license covers.", + "enum": [ + "SQL Server 2012", + "SQL Server 2014" + ], + "x-ms-enum": { + "name": "version", + "modelAsString": true + } + }, + "uniqueId": { + "type": "string", + "description": "The unique ID of this license. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "pattern": "^[A-Za-z0-9]{8}-([A-Za-z0-9]{4}-){3}[A-Za-z0-9]{12}$", + "readOnly": true + }, + "physicalCores": { + "type": "integer", + "format": "int32", + "multipleOf": 2, + "minimum": 16, + "description": "The number of total cores of the license covers." + }, + "activationState": { + "type": "string", + "description": "The activation state of the license.", + "enum": [ + "Inactive", + "Active", + "Terminated" + ], + "x-ms-enum": { + "name": "state", + "modelAsString": true + } + }, + "scopeType": { + "type": "string", + "description": "The Azure scope to which the license will apply.", + "enum": [ + "Tenant", + "Subscription", + "ResourceGroup" + ], + "x-ms-enum": { + "name": "scopeType", + "modelAsString": true + } + }, + "activatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the activation of the SqlServerEsuLicense in ISO 8601 date-time format.", + "readOnly": true + }, + "terminatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the termination of the SqlServerEsuLicense in ISO 8601 date-time format.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "The tenantId the SQL Server ESU license resource subscription resides in.", + "readOnly": true + } + }, + "required": [ + "billingPlan", + "version", + "physicalCores", + "scopeType", + "activationState" + ] + }, + "SqlServerEsuLicenseUpdateProperties": { + "description": "Properties of update SqlServerEsuLicense.", + "type": "object", + "properties": { + "billingPlan": { + "type": "string", + "description": "SQL Server ESU license type.", + "enum": [ + "PAYG" + ], + "x-ms-enum": { + "name": "billingPlan", + "modelAsString": true + } + }, + "version": { + "type": "string", + "description": "The SQL Server version the license covers.", + "enum": [ + "SQL Server 2012", + "SQL Server 2014" + ], + "x-ms-enum": { + "name": "version", + "modelAsString": true + } + }, + "uniqueId": { + "type": "string", + "description": "The unique ID of this license. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "pattern": "^[A-Za-z0-9]{8}-([A-Za-z0-9]{4}-){3}[A-Za-z0-9]{12}$", + "readOnly": true + }, + "physicalCores": { + "type": "integer", + "format": "int32", + "multipleOf": 2, + "minimum": 16, + "description": "The number of total cores of the license covers." + }, + "activationState": { + "type": "string", + "description": "The activation state of the license.", + "enum": [ + "Inactive", + "Active", + "Terminated" + ], + "x-ms-enum": { + "name": "state", + "modelAsString": true + } + }, + "scopeType": { + "type": "string", + "description": "The Azure scope to which the license will apply.", + "enum": [ + "Tenant", + "Subscription", + "ResourceGroup" + ], + "x-ms-enum": { + "name": "scopeType", + "modelAsString": true + } + }, + "activatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the activation of the SqlServerEsuLicense in ISO 8601 date-time format.", + "readOnly": true + }, + "terminatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the termination of the SqlServerEsuLicense in ISO 8601 date-time format.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "The tenantId the SQL Server ESU license resource subscription resides in.", + "readOnly": true + } + } + }, + "SqlServerEsuLicenseUpdate": { + "description": "An update to a SQL Server ESU license resource.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/SqlServerEsuLicenseUpdateProperties", + "description": "null", + "x-ms-client-flatten": false + } + } + }, + "SqlServerEsuLicenseListResult": { + "description": "A list of SQL Server ESU licenses.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlServerEsuLicense" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "sqlServerEsuLicenseName": { + "name": "sqlServerEsuLicenseName", + "description": "Name of SQL Server ESU License", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "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/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerInstances.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerInstances.json new file mode 100644 index 000000000000..07fc363b51a2 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerInstances.json @@ -0,0 +1,1367 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "SqlServerInstance": { + "description": "A SqlServerInstance.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlServerInstanceProperties", + "description": "null", + "x-ms-client-flatten": false + } + } + }, + "SqlServerInstanceProperties": { + "description": "Properties of SqlServerInstance.", + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "SQL Server version.", + "enum": [ + "SQL Server 2012", + "SQL Server 2014", + "SQL Server 2016", + "SQL Server 2017", + "SQL Server 2019", + "SQL Server 2022", + "Unknown" + ], + "x-ms-enum": { + "name": "sqlVersion", + "modelAsString": true + } + }, + "edition": { + "type": "string", + "description": "SQL Server edition.", + "enum": [ + "Evaluation", + "Enterprise", + "Standard", + "Web", + "Developer", + "Express", + "Business Intelligence" + ], + "x-ms-enum": { + "name": "editionType", + "modelAsString": true + } + }, + "containerResourceId": { + "type": "string", + "description": "ARM Resource id of the container resource (Azure Arc for Servers).", + "readOnly": true + }, + "createTime": { + "type": "string", + "description": "The time when the resource was created.", + "readOnly": true + }, + "vCore": { + "type": "string", + "description": "The number of logical processors used by the SQL Server instance.", + "readOnly": true + }, + "cores": { + "type": "string", + "description": "The number of total cores of the Operating System Environment (OSE) hosting the SQL Server instance." + }, + "status": { + "type": "string", + "description": "The cloud connectivity status.", + "readOnly": true, + "enum": [ + "Connected", + "Disconnected", + "Registered", + "Unknown" + ], + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "patchLevel": { + "type": "string", + "description": "SQL Server update level.", + "readOnly": true + }, + "collation": { + "type": "string", + "description": "SQL Server collation.", + "readOnly": true + }, + "dbMasterKeyExists": { + "type": "boolean", + "description": "Indicates whether database master key exists in SQL Server.", + "readOnly": true + }, + "isHadrEnabled": { + "type": "boolean", + "description": "Indicates whether always On availability groups is enabled in SQL Server.", + "readOnly": true + }, + "traceFlags": { + "type": "array", + "description": "An array of integers, where each value represents the enabled trace flags in SQL Server.", + "items": { + "type": "integer", + "format": "int32" + }, + "readOnly": true + }, + "currentVersion": { + "type": "string", + "description": "SQL Server current version.", + "readOnly": true + }, + "instanceName": { + "type": "string", + "description": "SQL Server instance name." + }, + "tcpDynamicPorts": { + "type": "string", + "description": "Dynamic TCP ports used by SQL Server.", + "readOnly": true + }, + "tcpStaticPorts": { + "type": "string", + "description": "Static TCP ports used by SQL Server.", + "readOnly": true + }, + "productId": { + "type": "string", + "description": "SQL Server product ID.", + "readOnly": true + }, + "licenseType": { + "type": "string", + "description": "SQL Server license type.", + "readOnly": true, + "enum": [ + "Undefined", + "Free", + "HADR", + "ServerCAL", + "LicenseOnly", + "PAYG", + "Paid" + ], + "x-ms-enum": { + "name": "arcSqlServerLicenseType", + "modelAsString": true + } + }, + "azureDefenderStatusLastUpdated": { + "type": "string", + "format": "date-time", + "description": "Timestamp of last Azure Defender status update.", + "readOnly": true + }, + "azureDefenderStatus": { + "type": "string", + "description": "Status of Azure Defender.", + "readOnly": true, + "enum": [ + "Protected", + "Unprotected", + "Unknown" + ], + "x-ms-enum": { + "name": "defenderStatus", + "modelAsString": true + } + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the Arc-enabled SQL Server resource.", + "readOnly": true + }, + "lastInventoryUploadTime": { + "type": "string", + "format": "date-time", + "description": "The time when last successful inventory upload was performed.", + "readOnly": true + }, + "lastUsageUploadTime": { + "type": "string", + "format": "date-time", + "description": "The time when last successful usage upload was performed.", + "readOnly": true + }, + "hostType": { + "type": "string", + "description": "Type of host for Azure Arc SQL Server", + "enum": [ + "Azure Virtual Machine", + "Azure VMWare Virtual Machine", + "Azure Kubernetes Service", + "AWS VMWare Virtual Machine", + "AWS Kubernetes Service", + "GCP VMWare Virtual Machine", + "GCP Kubernetes Service", + "Container", + "Virtual Machine", + "Physical Server", + "AWS Virtual Machine", + "GCP Virtual Machine", + "Other" + ], + "x-ms-enum": { + "name": "hostType", + "modelAsString": true + } + }, + "alwaysOnRole": { + "type": "string", + "description": "The role of the SQL Server, based on availability.", + "readOnly": true, + "enum": [ + "None", + "FailoverClusterInstance", + "FailoverClusterNode", + "AvailabilityGroupReplica" + ], + "x-ms-enum": { + "name": "alwaysOnRole", + "modelAsString": true + } + }, + "databaseMirroringEndpoint": { + "description": "Database mirroring endpoint related properties.", + "$ref": "#/definitions/DBMEndpoint" + }, + "failoverCluster": { + "description": "Failover Cluster Instance properties.", + "$ref": "#/definitions/FailoverCluster" + }, + "backupPolicy": { + "description": "The backup profile for the SQL server.", + "$ref": "#/definitions/BackupPolicy" + }, + "upgradeLockedUntil": { + "description": "Upgrade Action for this resource is locked until it expires. The Expiration time indicated by this value. It is not locked when it is empty.", + "type": "string", + "format": "date-time" + }, + "monitoring": { + "description": "The monitoring configuration.", + "$ref": "#/definitions/Monitoring" + }, + "migration": { + "description": "Migration related configuration.", + "$ref": "#/definitions/Migration" + }, + "clientConnection": { + "description": "Client connection related configuration.", + "$ref": "#/definitions/ClientConnection" + }, + "serviceType": { + "description": "Indicates if the resource represents a SQL Server engine or a SQL Server component service installed on the host.", + "$ref": "#/definitions/ServiceType" + } + } + }, + "SqlServerInstanceUpdateProperties": { + "description": "Properties of update SqlServerInstance.", + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "SQL Server version.", + "enum": [ + "SQL Server 2012", + "SQL Server 2014", + "SQL Server 2016", + "SQL Server 2017", + "SQL Server 2019", + "SQL Server 2022", + "Unknown" + ], + "x-ms-enum": { + "name": "sqlVersion", + "modelAsString": true + } + }, + "edition": { + "type": "string", + "description": "SQL Server edition.", + "enum": [ + "Evaluation", + "Enterprise", + "Standard", + "Web", + "Developer", + "Express", + "Business Intelligence" + ], + "x-ms-enum": { + "name": "editionType", + "modelAsString": true + } + }, + "containerResourceId": { + "type": "string", + "description": "ARM Resource id of the container resource (Azure Arc for Servers).", + "readOnly": true + }, + "createTime": { + "type": "string", + "description": "The time when the resource was created.", + "readOnly": true + }, + "vCore": { + "type": "string", + "description": "The number of logical processors used by the SQL Server instance.", + "readOnly": true + }, + "cores": { + "type": "string", + "description": "The number of total cores of the Operating System Environment (OSE) hosting the SQL Server instance." + }, + "status": { + "type": "string", + "description": "The cloud connectivity status.", + "readOnly": true, + "enum": [ + "Connected", + "Disconnected", + "Registered", + "Unknown" + ], + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "patchLevel": { + "type": "string", + "description": "SQL Server update level.", + "readOnly": true + }, + "collation": { + "type": "string", + "description": "SQL Server collation.", + "readOnly": true + }, + "dbMasterKeyExists": { + "type": "boolean", + "description": "Indicates whether database master key exists in SQL Server.", + "readOnly": true + }, + "isHadrEnabled": { + "type": "boolean", + "description": "Indicates whether always On availability groups is enabled in SQL Server.", + "readOnly": true + }, + "traceFlags": { + "type": "array", + "description": "An array of integers, where each value represents the enabled trace flags in SQL Server.", + "items": { + "type": "integer", + "format": "int32" + }, + "readOnly": true + }, + "currentVersion": { + "type": "string", + "description": "SQL Server current version.", + "readOnly": true + }, + "instanceName": { + "type": "string", + "description": "SQL Server instance name." + }, + "tcpDynamicPorts": { + "type": "string", + "description": "Dynamic TCP ports used by SQL Server.", + "readOnly": true + }, + "tcpStaticPorts": { + "type": "string", + "description": "Static TCP ports used by SQL Server.", + "readOnly": true + }, + "productId": { + "type": "string", + "description": "SQL Server product ID.", + "readOnly": true + }, + "licenseType": { + "type": "string", + "description": "SQL Server license type.", + "readOnly": true, + "enum": [ + "Undefined", + "Free", + "HADR", + "ServerCAL", + "LicenseOnly", + "PAYG", + "Paid" + ], + "x-ms-enum": { + "name": "arcSqlServerLicenseType", + "modelAsString": true + } + }, + "azureDefenderStatusLastUpdated": { + "type": "string", + "format": "date-time", + "description": "Timestamp of last Azure Defender status update.", + "readOnly": true + }, + "azureDefenderStatus": { + "type": "string", + "description": "Status of Azure Defender.", + "readOnly": true, + "enum": [ + "Protected", + "Unprotected", + "Unknown" + ], + "x-ms-enum": { + "name": "defenderStatus", + "modelAsString": true + } + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the Arc-enabled SQL Server resource.", + "readOnly": true + }, + "lastInventoryUploadTime": { + "type": "string", + "format": "date-time", + "description": "The time when last successful inventory upload was performed.", + "readOnly": true + }, + "lastUsageUploadTime": { + "type": "string", + "format": "date-time", + "description": "The time when last successful usage upload was performed.", + "readOnly": true + }, + "hostType": { + "type": "string", + "description": "Type of host for Azure Arc SQL Server", + "enum": [ + "Azure Virtual Machine", + "Azure VMWare Virtual Machine", + "Azure Kubernetes Service", + "AWS VMWare Virtual Machine", + "AWS Kubernetes Service", + "GCP VMWare Virtual Machine", + "GCP Kubernetes Service", + "Container", + "Virtual Machine", + "Physical Server", + "AWS Virtual Machine", + "GCP Virtual Machine", + "Other" + ], + "x-ms-enum": { + "name": "hostType", + "modelAsString": true + } + }, + "alwaysOnRole": { + "type": "string", + "description": "The role of the SQL Server, based on availability.", + "readOnly": true, + "enum": [ + "None", + "FailoverClusterInstance", + "FailoverClusterNode", + "AvailabilityGroupReplica" + ], + "x-ms-enum": { + "name": "alwaysOnRole", + "modelAsString": true + } + }, + "failoverCluster": { + "description": "Failover Cluster Instance properties.", + "$ref": "#/definitions/FailoverCluster" + }, + "backupPolicy": { + "description": "The backup profile for the SQL server.", + "$ref": "#/definitions/BackupPolicy" + }, + "upgradeLockedUntil": { + "description": "Upgrade Action for this resource is locked until it expires. The Expiration time indicated by this value. It is not locked when it is empty.", + "type": "string", + "format": "date-time" + }, + "monitoring": { + "description": "The monitoring configuration.", + "$ref": "#/definitions/Monitoring" + }, + "migration": { + "description": "Migration related configuration.", + "$ref": "#/definitions/Migration" + }, + "clientConnection": { + "description": "Client connection related configuration.", + "$ref": "#/definitions/ClientConnection" + }, + "serviceType": { + "description": "Indicates if the resource represents a SQL Server engine or a SQL Server component service installed on the host.", + "$ref": "#/definitions/ServiceType" + } + } + }, + "DBMEndpoint": { + "type": "object", + "description": "Database mirroring endpoint related properties.", + "properties": { + "endpointName": { + "type": "string", + "description": "Name of the database mirroring endpoint.", + "readOnly": true + }, + "role": { + "type": "string", + "description": "Mirroring Role", + "readOnly": true, + "enum": [ + "NONE", + "PARTNER", + "WITNESS", + "ALL" + ], + "x-ms-enum": { + "name": "role", + "modelAsString": true + } + }, + "isEncryptionEnabled": { + "type": "boolean", + "description": "Is Encryption enabled", + "readOnly": true + }, + "encryptionAlgorithm": { + "description": "Encryption Algorithm", + "$ref": "./common.json#/definitions/EncryptionAlgorithm", + "readOnly": true + }, + "connectionAuth": { + "description": "The type of connection authentication required for connections to this endpoint", + "$ref": "./common.json#/definitions/ConnectionAuth", + "readOnly": true + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port number that the endpoint is listening on.", + "readOnly": true + }, + "isDynamicPort": { + "type": "boolean", + "description": "Is the port number dynamically assigned.", + "readOnly": true + }, + "ipAddress": { + "type": "string", + "description": "Listener IP address.", + "readOnly": true + }, + "certificateName": { + "type": "string", + "description": "Name of the certificate.", + "readOnly": true + } + } + }, + "FailoverCluster": { + "type": "object", + "description": "Failover Cluster Instance properties.", + "properties": { + "id": { + "type": "string", + "description": "The GUID of the SQL Server's underlying Failover Cluster.", + "readOnly": true + }, + "networkName": { + "type": "string", + "description": "The network name to connect to the SQL FCI.", + "readOnly": true + }, + "sqlInstanceIds": { + "type": "array", + "description": "The ARM IDs of the Arc SQL Server resources, belonging to the current server's Failover cluster.", + "readOnly": true, + "items": { + "type": "string" + } + }, + "hostNames": { + "type": "array", + "description": "The host names which are part of the SQL FCI resource group.", + "readOnly": true, + "items": { + "type": "string" + } + } + } + }, + "SqlServerInstanceUpdate": { + "description": "An update to a SQL Server Instance.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/SqlServerInstanceUpdateProperties", + "description": "null", + "x-ms-client-flatten": false + } + } + }, + "SqlServerInstanceListResult": { + "description": "A list of SqlServerInstance.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlServerInstance" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "BackupPolicy": { + "description": "The backup profile for the SQL server.", + "type": "object", + "properties": { + "retentionPeriodDays": { + "type": "integer", + "description": "The retention period for all the databases in this managed instance.", + "minimum": 0, + "maximum": 35, + "format": "int32" + }, + "fullBackupDays": { + "type": "integer", + "description": "The value indicating days between full backups.", + "minimum": 0, + "maximum": 7, + "format": "int32" + }, + "differentialBackupHours": { + "description": "The differential backup interval in hours.", + "enum": [ + 12, + 24 + ], + "type": "integer", + "format": "int32", + "x-ms-enum": { + "name": "differentialBackupHours", + "modelAsString": false + } + }, + "transactionLogBackupMinutes": { + "type": "integer", + "description": "The value indicating minutes between transaction log backups.", + "minimum": 0, + "maximum": 60, + "format": "int32" + } + } + }, + "Monitoring": { + "description": "The monitoring configuration.", + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if monitoring is enabled for this SQL Server instance." + } + } + }, + "Migration": { + "description": "Migration related configuration.", + "type": "object", + "properties": { + "assessment": { + "description": "Migration assessments related configuration.", + "$ref": "#/definitions/MigrationAssessment" + } + } + }, + "MigrationAssessment": { + "description": "The migration assessment related configuration.", + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if migration assessment is enabled for this SQL Server instance." + }, + "assessmentUploadTime": { + "type": "string", + "format": "date-time", + "description": "The time when Migration Assessment Report upload was last performed.", + "readOnly": true + }, + "serverAssessments": { + "$ref": "#/definitions/ServerAssessments" + }, + "skuRecommendationResults": { + "$ref": "#/definitions/SkuRecommendationResults" + } + } + }, + "ClientConnection": { + "description": "Client connection related configuration.", + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if client connection is enabled for this SQL Server instance." + } + } + }, + "ServiceType": { + "description": "Indicates if the resource represents a SQL Server engine or a SQL Server component service installed on the host.", + "type": "string", + "enum": [ + "Engine", + "SSRS", + "SSAS", + "SSIS", + "PBIRS" + ], + "x-ms-enum": { + "name": "serviceType", + "modelAsString": true, + "values": [ + { + "value": "Engine", + "description": "SQL Server Database Services." + }, + { + "value": "SSRS", + "description": "SQL Server Reporting Services." + }, + { + "value": "SSAS", + "description": "SQL Server Analysis Services." + }, + { + "value": "SSIS", + "description": "SQL Server Integration Services." + }, + { + "value": "PBIRS", + "description": "Power BI Report Server." + } + ] + } + }, + "ServerAssessments": { + "description": "Issues and warnings impacting the migration of SQL Server instance to particular Azure Migration Target.", + "readOnly": true, + "type": "array", + "items": { + "type": "object", + "properties": { + "appliesToMigrationTargetPlatform": { + "type": "string" + }, + "featureId": { + "type": "string" + }, + "impactedObjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "impactDetail": { + "type": "string" + }, + "name": { + "type": "string" + }, + "objectType": { + "type": "string" + } + } + } + }, + "issueCategory": { + "type": "string" + }, + "moreInformation": { + "type": "string" + } + } + } + }, + "SkuRecommendationResults": { + "description": "SKU Recommendation results for Azure migration targets for SQL Server.", + "readOnly": true, + "type": "object", + "properties": { + "azureSqlDatabase": { + "$ref": "#/definitions/SkuRecommendationResultsAzureSqlDatabase" + }, + "azureSqlManagedInstance": { + "$ref": "#/definitions/SkuRecommendationResultsAzureSqlManagedInstance" + }, + "azureSqlVirtualMachine": { + "$ref": "#/definitions/SkuRecommendationResultsAzureSqlVirtualMachine" + } + } + }, + "SkuRecommendationResultsAzureSqlDatabase": { + "description": "SKU Recommendation results for Azure SQL Database.", + "type": "object", + "properties": { + "recommendationStatus": { + "$ref": "./common.json#/definitions/SkuRecommendationResultsRecommendationStatus" + }, + "numberOfServerBlockerIssues": { + "$ref": "#/definitions/SkuRecommendationResultsNumberOfServerBlockerIssues" + }, + "monthlyCost": { + "$ref": "#/definitions/SkuRecommendationResultsMonthlyCost" + }, + "targetSku": { + "type": "object", + "properties": { + "category": { + "type": "object", + "properties": { + "computeTier": { + "type": "string", + "description": "The compute tier of the target SKU." + }, + "hardwareType": { + "type": "string", + "description": "The hardware type of the target SKU." + }, + "sqlPurchasingModel": { + "type": "string", + "description": "The SQL purchasing model of the target SKU." + }, + "sqlServiceTier": { + "type": "string", + "description": "The SQL service tier of the target SKU." + }, + "zoneRedundancyAvailable": { + "type": "boolean", + "description": "Indicates if zone redundancy is available for the target SKU." + } + } + } + } + } + } + }, + "SkuRecommendationResultsAzureSqlManagedInstance": { + "description": "SKU Recommendation results for Azure SQL Managed Instance.", + "type": "object", + "properties": { + "recommendationStatus": { + "$ref": "./common.json#/definitions/SkuRecommendationResultsRecommendationStatus" + }, + "numberOfServerBlockerIssues": { + "$ref": "#/definitions/SkuRecommendationResultsNumberOfServerBlockerIssues" + }, + "monthlyCost": { + "$ref": "#/definitions/SkuRecommendationResultsMonthlyCost" + }, + "targetSku": { + "type": "object", + "properties": { + "category": { + "type": "object", + "properties": { + "computeTier": { + "type": "string", + "description": "The compute tier of the target SKU." + }, + "hardwareType": { + "type": "string", + "description": "The hardware type of the target SKU." + }, + "sqlPurchasingModel": { + "type": "string", + "description": "The SQL purchasing model of the target SKU." + }, + "sqlServiceTier": { + "type": "string", + "description": "The SQL service tier of the target SKU." + }, + "zoneRedundancyAvailable": { + "type": "boolean", + "description": "Indicates if zone redundancy is available for the target SKU." + } + } + } + } + } + } + }, + "SkuRecommendationResultsAzureSqlVirtualMachine": { + "description": "SKU Recommendation results for Azure SQL Virtual Machine.", + "type": "object", + "properties": { + "recommendationStatus": { + "$ref": "./common.json#/definitions/SkuRecommendationResultsRecommendationStatus" + }, + "numberOfServerBlockerIssues": { + "$ref": "#/definitions/SkuRecommendationResultsNumberOfServerBlockerIssues" + }, + "monthlyCost": { + "$ref": "#/definitions/SkuRecommendationResultsMonthlyCost" + }, + "targetSku": { + "type": "object", + "properties": { + "category": { + "type": "object", + "properties": { + "availableVmSkus": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Available VM SKUs for the Azure SQL Virtual Machine." + }, + "virtualMachineFamily": { + "type": "string", + "description": "The virtual machine family of the target SKU." + } + } + } + } + } + } + }, + "SkuRecommendationResultsNumberOfServerBlockerIssues": { + "description": "Number of blocker issues to fix before migrating to the target platform.", + "type": "integer", + "format": "int32" + }, + "SkuRecommendationResultsMonthlyCost": { + "description": "The Monthly cost of the particular SKU.", + "type": "object", + "properties": { + "computeCost": { + "format": "float", + "description": "Represents the Cost of Compute.", + "type": "number" + }, + "storageCost": { + "format": "float", + "description": "Represents the Cost of Storage.", + "type": "number" + }, + "totalCost": { + "format": "float", + "description": "Represents the Total Cost.", + "type": "number" + } + } + }, + "SqlServerInstanceTelemetryRequest": { + "description": "The Arc SQL Server instance telemetry retrieval request.", + "type": "object", + "properties": { + "datasetName": { + "type": "string", + "description": "The name of the telemetry dataset to retrieve." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time for the time range to fetch telemetry for. If not specified, the current time minus 1 hour is used." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time for the time range to fetch telemetry for. If not specified, the current time is used." + }, + "interval": { + "type": "string", + "format": "duration", + "description": "The time granularity to fetch telemetry for. This is an ISO8601 duration. Examples: PT15M, PT1H, P1D", + "default": "PT1H" + }, + "aggregationType": { + "type": "string", + "description": "The aggregation type to use for the numerical columns in the dataset.", + "enum": [ + "Average", + "Minimum", + "Maximum", + "Sum", + "Count" + ], + "x-ms-enum": { + "name": "aggregationType", + "modelAsString": true + }, + "default": "Average" + }, + "databaseNames": { + "type": "array", + "description": "The list of database names to return telemetry for. If not specified, telemetry for all databases will be aggregated and returned.", + "items": { + "type": "string" + } + } + }, + "required": [ + "datasetName" + ] + }, + "SqlServerInstanceTelemetryColumn": { + "description": "The telemetry column for the SQL Server instance.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the telemetry column." + }, + "type": { + "type": "string", + "description": "The type of the telemetry column.", + "enum": [ + "bool", + "datetime", + "int", + "long", + "double", + "string", + "guid", + "timespan" + ], + "x-ms-enum": { + "name": "SqlServerInstanceTelemetryColumnType", + "modelAsString": true + } + } + } + }, + "SqlServerInstanceTelemetryRow": { + "description": "An array of values representing a telemetry row for the SQL Server instance.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "SqlServerInstanceTelemetryResponse": { + "description": "A section of the telemetry response for the SQL Server instance.", + "type": "object", + "properties": { + "columns": { + "description": "The columns of the result telemetry table for the SQL Server instance.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlServerInstanceTelemetryColumn" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "rows": { + "description": "A list of rows from the result telemetry table for the SQL Server instance.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlServerInstanceTelemetryRow" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "The link to the next section of rows of the telemetry response for the SQL Server instance. Null if no more sections are available.", + "readOnly": true + } + }, + "required": [ + "columns", + "rows" + ] + }, + "SqlServerInstanceRunMigrationAssessmentResponse": { + "description": "The response for running migration assessment on the SQL Server instance.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the job." + }, + "instanceName": { + "type": "string", + "description": "The name of the SQL Server instance." + }, + "jobStatus": { + "type": "string", + "description": "The status of the job.", + "enum": [ + "NotStarted", + "InProgress", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "jobStatus", + "modelAsString": true + } + }, + "jobException": { + "type": "string", + "description": "The exception message if the job failed." + }, + "backgroundJob": { + "type": "object", + "description": "The background job details.", + "$ref": "#/definitions/BackgroundJob" + }, + "sequencerActions": { + "type": "array", + "description": "The list of sequencer actions.", + "items": { + "$ref": "#/definitions/SequencerAction" + }, + "x-ms-identifiers": [ + "actionId" + ] + } + } + }, + "SqlServerInstanceJobsStatusRequest": { + "description": "The request for the status of the jobs running on the SQL Server instance.", + "type": "object", + "properties": { + "featureName": { + "type": "string", + "description": "The name of the feature to retrieve the job status for." + }, + "jobType": { + "type": "string", + "description": "The type of the job to retrieve the status for." + } + } + }, + "SqlServerInstanceJobsStatusResponse": { + "description": "The response for the status of the jobs running on the SQL Server instance.", + "type": "object", + "properties": { + "jobsStatus": { + "type": "array", + "description": "The list of jobs status running on the SQL Server instance.", + "items": { + "$ref": "#/definitions/SqlServerInstanceJobStatus" + }, + "x-ms-identifiers": [ + "id" + ] + } + } + }, + "SqlServerInstanceJobStatus": { + "description": "The status of the job running on the SQL Server instance.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the job." + }, + "instanceName": { + "type": "string", + "description": "The name of the SQL Server instance." + }, + "jobStatus": { + "type": "string", + "description": "The status of the job.", + "enum": [ + "NotStarted", + "InProgress", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "jobStatus", + "modelAsString": true + } + }, + "jobException": { + "type": "string", + "description": "The exception message if the job failed." + }, + "backgroundJob": { + "type": "object", + "description": "The background job details.", + "$ref": "#/definitions/BackgroundJob" + }, + "sequencerActions": { + "type": "array", + "description": "The list of sequencer actions.", + "items": { + "$ref": "#/definitions/SequencerAction" + }, + "x-ms-identifiers": [ + "actionId" + ] + } + } + }, + "BackgroundJob": { + "description": "The background job details.", + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "The state of the background job.", + "enum": [ + "Enabled", + "Disabled", + "Deleted", + "Completed", + "Faulted", + "Suspended" + ], + "x-ms-enum": { + "name": "state", + "modelAsString": true + } + }, + "executionState": { + "type": "string", + "description": "The execution state of the background job.", + "enum": [ + "Waiting", + "Running" + ], + "x-ms-enum": { + "name": "executionState", + "modelAsString": true + } + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the background job." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the background job." + }, + "lastExecutionStatus": { + "type": "string", + "description": "The last execution status of the background job.", + "enum": [ + "Succeeded", + "Completed", + "Failed", + "Faulted", + "Postponed", + "Rescheduled" + ], + "x-ms-enum": { + "name": "lastExecutionStatus", + "modelAsString": true + } + }, + "lastExecutionTime": { + "type": "string", + "format": "date-time", + "description": "The last execution time of the background job." + } + } + }, + "SequencerAction": { + "description": "The sequencer action details.", + "type": "object", + "properties": { + "actionId": { + "type": "string", + "description": "The unique identifier of the sequencer action." + }, + "state": { + "type": "string", + "description": "The state of the sequencer action.", + "enum": [ + "NotStarted", + "WaitingPredecessors", + "ExecutingAction", + "CreatingSuccessors", + "Completed" + ], + "x-ms-enum": { + "name": "sequencerState", + "modelAsString": true + } + }, + "result": { + "type": "string", + "description": "The result of the sequencer action.", + "enum": [ + "NotCompleted", + "Succeeded", + "Failed", + "TimedOut", + "Skipped" + ], + "x-ms-enum": { + "name": "result", + "modelAsString": true + } + } + } + } + }, + "parameters": { + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + } + }, + "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/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerLicenses.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerLicenses.json new file mode 100644 index 000000000000..a54c9f98d397 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerLicenses.json @@ -0,0 +1,259 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "SqlServerLicense": { + "description": "Describe SQL Server license resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlServerLicenseProperties", + "description": "SQL Server license properties", + "x-ms-client-flatten": false + } + }, + "required": [ + "properties" + ] + }, + "SqlServerLicenseProperties": { + "description": "Properties of SQL Server License.", + "type": "object", + "properties": { + "billingPlan": { + "type": "string", + "description": "SQL Server license type.", + "enum": [ + "PAYG", + "Paid" + ], + "x-ms-enum": { + "name": "billingPlan", + "modelAsString": true + } + }, + "physicalCores": { + "type": "integer", + "format": "int32", + "multipleOf": 2, + "minimum": 16, + "description": "The number of total cores of the license covers." + }, + "licenseCategory": { + "type": "string", + "description": "This property represents the choice between SQL Server Core and ESU licenses.", + "enum": [ + "Core" + ], + "x-ms-enum": { + "name": "licenseCategory", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "activationState": { + "type": "string", + "description": "The activation state of the license.", + "enum": [ + "Activated", + "Deactivated" + ], + "x-ms-enum": { + "name": "activationState", + "modelAsString": true + } + }, + "scopeType": { + "type": "string", + "description": "The Azure scope to which the license will apply.", + "enum": [ + "Tenant", + "Subscription", + "ResourceGroup" + ], + "x-ms-enum": { + "name": "scopeType", + "modelAsString": true + } + }, + "lastActivatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the most recent activation of the SqlServerLicense.", + "readOnly": true + }, + "lastDeactivatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the most recent deactivation of the SqlServerLicense.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "The tenantId the SQL Server license resource subscription resides in.", + "readOnly": true + } + }, + "required": [ + "billingPlan", + "physicalCores", + "licenseCategory", + "scopeType", + "activationState" + ] + }, + "SqlServerLicenseUpdateProperties": { + "description": "Properties of update SqlServerLicense.", + "type": "object", + "properties": { + "billingPlan": { + "type": "string", + "description": "SQL Server license type.", + "enum": [ + "PAYG", + "Paid" + ], + "x-ms-enum": { + "name": "billingPlan", + "modelAsString": true + } + }, + "physicalCores": { + "type": "integer", + "format": "int32", + "multipleOf": 2, + "minimum": 16, + "description": "The number of total cores of the license covers." + }, + "licenseCategory": { + "type": "string", + "description": "This property represents the choice between SQL Server Core and ESU licenses.", + "enum": [ + "Core" + ], + "x-ms-enum": { + "name": "licenseCategory", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "activationState": { + "type": "string", + "description": "The activation state of the license.", + "enum": [ + "Activated", + "Deactivated" + ], + "x-ms-enum": { + "name": "activationState", + "modelAsString": true + } + }, + "scopeType": { + "type": "string", + "description": "The Azure scope to which the license will apply.", + "enum": [ + "Tenant", + "Subscription", + "ResourceGroup" + ], + "x-ms-enum": { + "name": "scopeType", + "modelAsString": true + } + }, + "lastActivatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the most recent activation of the SqlServerLicense.", + "readOnly": true + }, + "lastDeactivatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the most recent deactivation of the SqlServerLicense.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "The tenantId the SQL Server license resource subscription resides in.", + "readOnly": true + } + } + }, + "SqlServerLicenseUpdate": { + "description": "An update to a SQL Server license resource.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/SqlServerLicenseUpdateProperties", + "description": "null", + "x-ms-client-flatten": false + } + } + }, + "SqlServerLicenseListResult": { + "description": "A list of SQL Server licenses.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlServerLicense" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + } + }, + "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/azurearcdata/resource-manager/readme.md b/specification/azurearcdata/resource-manager/readme.md index a8737cff2a94..f422b91b3609 100644 --- a/specification/azurearcdata/resource-manager/readme.md +++ b/specification/azurearcdata/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the azurearcdata. ``` yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2024-01 +tag: package-preview-2024-05 ``` ``` yaml @@ -44,6 +44,27 @@ directive: reason: No Unicode support for attribute pattern regex on sqlServerInstanceName and others. This should be fixed by tooling. ``` +### Tag: package-preview-2024-05 + +These settings apply only when `--tag=package-preview-2024-05` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-05' +input-file: + - Microsoft.AzureArcData/preview/2024-05-01-preview/activeDirectoryConnectors.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/azurearcdata.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/common.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/dataControllers.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/failoverGroups.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/operations.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/postgresInstances.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/sqlManagedInstances.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerAvailabilityGroups.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerDatabases.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerEsuLicenses.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerInstances.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerLicenses.json +``` + ### Tag: package-2024-01 These settings apply only when `--tag=package-2024-01` is specified on the command line. From ad60d7f8eba124edc6999677c55aba2184e303b0 Mon Sep 17 00:00:00 2001 From: Sneha Nagendra <47864291+snehanagendra@users.noreply.github.com> Date: Mon, 30 Sep 2024 16:26:42 -0700 Subject: [PATCH 48/48] Add 2024-10-01-preview dataplane API version to the DevCenter (#30696) * Add base 2024-10-01-preview typespec changes, examples * Add SopOnNoConnect configuration for pool resource * Add LRO for capture snapshot, snapshot type enum * Add lastConnectedTime property on devbox * update comment per feedback --------- Co-authored-by: Sneha Nagendra <snnagen@microsoft.com> --- .../devcenter/DevCenter/DevBox/models.tsp | 66 + .../devcenter/DevCenter/DevBox/routes.tsp | 11 + .../DevBoxes_CaptureSnapshotDevBox.json | 25 + .../DevBoxes_CreateCustomizationGroup.json | 57 + .../DevBoxes_CreateDevBox.json | 74 + .../DevBoxes_DelayAction.json | 29 + .../DevBoxes_DelayActions.json | 51 + .../DevBoxes_DelayActionsWithError.json | 43 + .../DevBoxes_DeleteDevBox.json | 26 + .../DevBoxes_GetAction.json | 27 + .../DevBoxes_GetCustomizationGroup.json | 44 + ...Boxes_GetCustomizationTaskDefinitions.json | 36 + .../DevBoxes_GetCustomizationTaskLog.json | 18 + .../DevBoxes_GetDevBoxByUser.json | 41 + .../DevBoxes_GetImagingTaskLog.json | 15 + .../DevBoxes_GetOperation.json | 25 + .../2024-10-01-preview/DevBoxes_GetPool.json | 45 + .../DevBoxes_GetRemoteConnection.json | 18 + .../DevBoxes_GetScheduleByPool.json | 25 + .../DevBoxes_GetSnapshot.json | 21 + .../DevBoxes_ListActions.json | 42 + .../DevBoxes_ListAllDevBoxes.json | 42 + .../DevBoxes_ListAllDevBoxesByUser.json | 44 + .../DevBoxes_ListCustomizationGroups.json | 68 + ...s_ListCustomizationGroupsWithoutTasks.json | 32 + ...CustomizationTaskDefinitionsByProject.json | 53 + .../DevBoxes_ListDevBoxesByUser.json | 44 + .../DevBoxes_ListOperations.json | 42 + .../DevBoxes_ListPools.json | 79 + .../DevBoxes_ListSchedulesByPool.json | 28 + .../DevBoxes_ListSchedulesByProject.json | 27 + .../DevBoxes_ListSnapshots.json | 30 + .../DevBoxes_RepairDevBox.json | 25 + .../DevBoxes_RestartDevBox.json | 25 + .../DevBoxes_RestoreSnapshotDevBox.json | 26 + .../DevBoxes_SkipAction.json | 15 + .../DevBoxes_StartDevBox.json | 25 + .../DevBoxes_StopDevBox.json | 26 + ...oxes_ValidateCustomizationTasksAction.json | 40 + ...teCustomizationTasksActionWithFailure.json | 53 + .../DevCenter_GetProject.json | 19 + .../DevCenter_GetProjectAbilities.json | 37 + .../DevCenter_ListProjects.json | 22 + ...vironments_CreateOrReplaceEnvironment.json | 43 + .../Environments_DelayAction.json | 27 + .../Environments_DeleteEnvironment.json | 26 + .../Environments_ForceDeleteEnvironment.json | 27 + .../Environments_GetAction.json | 26 + .../Environments_GetCatalog.json | 18 + .../Environments_GetEnvironmentByUser.json | 30 + ...Environments_GetEnvironmentDefinition.json | 58 + ...ironments_GetEnvironmentTypeAbilities.json | 28 + .../Environments_GetEnvironmentTypes.json | 21 + .../Environments_GetLogsByOperation.json | 17 + .../Environments_GetOperation.json | 29 + .../Environments_GetOutputs.json | 51 + .../Environments_ListActions.json | 39 + .../Environments_ListCatalogsByProject.json | 21 + ...s_ListEnvironmentDefinitionsByCatalog.json | 69 + ...s_ListEnvironmentDefinitionsByProject.json | 68 + .../Environments_ListEnvironmentTypes.json | 24 + .../Environments_ListEnvironments.json | 32 + .../Environments_ListEnvironmentsByUser.json | 33 + .../Environments_ListOperations.json | 32 + .../Environments_PatchEnvironment.json | 32 + .../Environments_SkipAction.json | 21 + .../OperationStatuses_Get.json | 19 + specification/devcenter/DevCenter/main.tsp | 4 + .../preview/2024-10-01-preview/devcenter.json | 7219 +++++++++++++++++ .../DevBoxes_CaptureSnapshotDevBox.json | 25 + .../DevBoxes_CreateCustomizationGroup.json | 57 + .../examples/DevBoxes_CreateDevBox.json | 74 + .../examples/DevBoxes_DelayAction.json | 29 + .../examples/DevBoxes_DelayActions.json | 51 + .../examples/DevBoxes_DeleteDevBox.json | 26 + .../examples/DevBoxes_GetAction.json | 27 + .../DevBoxes_GetCustomizationGroup.json | 44 + ...Boxes_GetCustomizationTaskDefinitions.json | 36 + .../DevBoxes_GetCustomizationTaskLog.json | 18 + .../examples/DevBoxes_GetDevBoxByUser.json | 41 + .../examples/DevBoxes_GetImagingTaskLog.json | 15 + .../examples/DevBoxes_GetOperation.json | 25 + .../examples/DevBoxes_GetPool.json | 45 + .../DevBoxes_GetRemoteConnection.json | 18 + .../examples/DevBoxes_GetScheduleByPool.json | 25 + .../examples/DevBoxes_GetSnapshot.json | 21 + .../examples/DevBoxes_ListActions.json | 42 + .../examples/DevBoxes_ListAllDevBoxes.json | 42 + .../DevBoxes_ListAllDevBoxesByUser.json | 44 + .../DevBoxes_ListCustomizationGroups.json | 68 + ...CustomizationTaskDefinitionsByProject.json | 53 + .../examples/DevBoxes_ListDevBoxesByUser.json | 44 + .../examples/DevBoxes_ListOperations.json | 42 + .../examples/DevBoxes_ListPools.json | 79 + .../DevBoxes_ListSchedulesByPool.json | 28 + .../DevBoxes_ListSchedulesByProject.json | 27 + .../examples/DevBoxes_ListSnapshots.json | 30 + .../examples/DevBoxes_RepairDevBox.json | 25 + .../examples/DevBoxes_RestartDevBox.json | 25 + .../DevBoxes_RestoreSnapshotDevBox.json | 26 + .../examples/DevBoxes_SkipAction.json | 15 + .../examples/DevBoxes_StartDevBox.json | 25 + .../examples/DevBoxes_StopDevBox.json | 26 + ...oxes_ValidateCustomizationTasksAction.json | 40 + .../examples/DevCenter_GetProject.json | 19 + .../DevCenter_GetProjectAbilities.json | 37 + .../examples/DevCenter_ListProjects.json | 22 + ...vironments_CreateOrReplaceEnvironment.json | 43 + .../examples/Environments_DelayAction.json | 27 + .../Environments_DeleteEnvironment.json | 26 + .../Environments_ForceDeleteEnvironment.json | 27 + .../examples/Environments_GetAction.json | 26 + .../examples/Environments_GetCatalog.json | 18 + .../Environments_GetEnvironmentByUser.json | 30 + ...Environments_GetEnvironmentDefinition.json | 58 + ...ironments_GetEnvironmentTypeAbilities.json | 28 + .../Environments_GetEnvironmentTypes.json | 21 + .../Environments_GetLogsByOperation.json | 17 + .../examples/Environments_GetOperation.json | 29 + .../examples/Environments_GetOutputs.json | 51 + .../examples/Environments_ListActions.json | 39 + .../Environments_ListCatalogsByProject.json | 21 + ...s_ListEnvironmentDefinitionsByCatalog.json | 69 + ...s_ListEnvironmentDefinitionsByProject.json | 68 + .../Environments_ListEnvironmentTypes.json | 24 + .../Environments_ListEnvironments.json | 32 + .../Environments_ListEnvironmentsByUser.json | 33 + .../examples/Environments_ListOperations.json | 32 + .../Environments_PatchEnvironment.json | 32 + .../examples/Environments_SkipAction.json | 21 + .../examples/OperationStatuses_Get.json | 19 + specification/devcenter/data-plane/readme.md | 17 +- 132 files changed, 11698 insertions(+), 1 deletion(-) create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CaptureSnapshotDevBox.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CreateCustomizationGroup.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CreateDevBox.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayAction.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayActions.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayActionsWithError.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DeleteDevBox.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetAction.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationGroup.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationTaskDefinitions.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationTaskLog.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetDevBoxByUser.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetImagingTaskLog.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetOperation.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetPool.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetRemoteConnection.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetScheduleByPool.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetSnapshot.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListActions.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListAllDevBoxes.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListAllDevBoxesByUser.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationGroups.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationGroupsWithoutTasks.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationTaskDefinitionsByProject.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListDevBoxesByUser.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListOperations.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListPools.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSchedulesByPool.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSchedulesByProject.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSnapshots.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RepairDevBox.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestartDevBox.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestoreSnapshotDevBox.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_SkipAction.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_StartDevBox.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_StopDevBox.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ValidateCustomizationTasksAction.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ValidateCustomizationTasksActionWithFailure.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_GetProject.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_GetProjectAbilities.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_ListProjects.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_CreateOrReplaceEnvironment.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_DelayAction.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_DeleteEnvironment.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ForceDeleteEnvironment.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetAction.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetCatalog.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentByUser.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentDefinition.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentTypeAbilities.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentTypes.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetLogsByOperation.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetOperation.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetOutputs.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListActions.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListCatalogsByProject.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentDefinitionsByCatalog.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentDefinitionsByProject.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentTypes.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironments.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentsByUser.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListOperations.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_PatchEnvironment.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_SkipAction.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/OperationStatuses_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CaptureSnapshotDevBox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CreateCustomizationGroup.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CreateDevBox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DelayAction.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DelayActions.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DeleteDevBox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetAction.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationGroup.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationTaskDefinitions.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationTaskLog.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetDevBoxByUser.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetImagingTaskLog.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetOperation.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetPool.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetRemoteConnection.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetScheduleByPool.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetSnapshot.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListActions.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListAllDevBoxes.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListAllDevBoxesByUser.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListCustomizationGroups.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListCustomizationTaskDefinitionsByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListDevBoxesByUser.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListOperations.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListPools.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSchedulesByPool.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSchedulesByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSnapshots.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RepairDevBox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestartDevBox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestoreSnapshotDevBox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_SkipAction.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_StartDevBox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_StopDevBox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ValidateCustomizationTasksAction.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_GetProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_GetProjectAbilities.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_ListProjects.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_CreateOrReplaceEnvironment.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_DelayAction.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_DeleteEnvironment.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ForceDeleteEnvironment.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetAction.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetCatalog.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentByUser.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentDefinition.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentTypeAbilities.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentTypes.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetLogsByOperation.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetOperation.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetOutputs.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListActions.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListCatalogsByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentDefinitionsByCatalog.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentDefinitionsByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentTypes.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironments.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentsByUser.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListOperations.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_PatchEnvironment.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_SkipAction.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/OperationStatuses_Get.json diff --git a/specification/devcenter/DevCenter/DevBox/models.tsp b/specification/devcenter/DevCenter/DevBox/models.tsp index 3300bbd0ba9e..a3f225c5ea4d 100644 --- a/specification/devcenter/DevCenter/DevBox/models.tsp +++ b/specification/devcenter/DevCenter/DevBox/models.tsp @@ -142,6 +142,18 @@ union StopOnDisconnectEnableStatus { string, } +@doc("Stop on no connect enable or disable status.") +@added(APIVersions.v2024_10_01_preview) +union StopOnNoConnectEnableStatus { + @doc("Stop on no connect is enabled on the Dev Box.") + Enabled: "Enabled", + + @doc("Stop on no connect is not enabled on the Dev Box.") + Disabled: "Disabled", + + string, +} + @doc("Pool status indicating whether a pool is available to create Dev Boxes.") union PoolHealthStatus { @doc("The pool health status is not known.") @@ -359,6 +371,10 @@ union DevBoxOperationKind { @added(APIVersions.v2024_09_01_preview) RestoreSnapshot: "RestoreSnapshot", + @doc("The operation represents a Dev Box manual snapshot creation.") + @added(APIVersions.v2024_10_01_preview) + CaptureSnapshot: "CaptureSnapshot", + string, } @@ -377,6 +393,18 @@ union DevBoxRepairOutcome { string, } +@doc("The type of snapshot.") +@added(APIVersions.v2024_10_01_preview) +union SnapshotType { + @doc("The snapshot type indicates that this is a manually taken snapshot.") + Manual: "Manual", + + @doc("The snapshot type indicates that this is an automatically taken snapshot.") + Automatic: "Automatic", + + string, +} + @doc("A pool of Dev Boxes.") @resource("pools") @parentResource(Project) @@ -420,6 +448,10 @@ model Pool { @doc("Stop on disconnect configuration settings for Dev Boxes created in this pool.") stopOnDisconnect?: StopOnDisconnectConfiguration; + @doc("Stop on no connect configuration settings for Dev Boxes created in this pool.") + @added(APIVersions.v2024_10_01_preview) + stopOnNoConnect?: StopOnNoConnectConfiguration; + @doc(""" Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes. @@ -500,6 +532,18 @@ model StopOnDisconnectConfiguration { gracePeriodMinutes?: int32; } +@doc("Stop on no connect configuration settings for Dev Boxes created in this pool.") +@added(APIVersions.v2024_10_01_preview) +model StopOnNoConnectConfiguration { + @doc(""" + Enables the feature to stop a started Dev Box when it has not been connected to, once the grace period has lapsed. + """) + status: StopOnNoConnectEnableStatus; + + @doc("The specified time in minutes to wait before stopping a Dev Box if no connection is made. This will only be present if stop on no connect is enabled.") + gracePeriodMinutes?: int32; +} + alias ScheduleListResult = Azure.Core.Page<Schedule>; @doc("A Schedule to execute action.") @@ -631,6 +675,11 @@ model DevBox { @visibility("read") createdTime?: utcDateTime; + @doc("Last time a user connected to this Dev Box, in RFC3339 format.") + @visibility("read") + @added(APIVersions.v2024_10_01_preview) + lastConnectedTime?: utcDateTime; + @doc("Indicates whether the owner of the Dev Box is a local administrator.") @visibility("read", "create") localAdministrator?: LocalAdminStatus; @@ -803,6 +852,13 @@ model DevBoxRestoreSnapshotOperation extends DevBoxOperation { kind: DevBoxOperationKind.RestoreSnapshot; } +@doc("Information about a snapshot creation operation on a Dev Box.") +@added(APIVersions.v2024_10_01_preview) +model DevBoxCaptureSnapshotOperation extends DevBoxOperation { + @doc("The kind of operation that occurred.") + kind: DevBoxOperationKind.CaptureSnapshot; +} + @doc("The Customization Task list result.") model PagedCustomizationTaskDefinition is Azure.Core.Page<CustomizationTaskDefinition>; @@ -981,4 +1037,14 @@ model DevBoxSnapshot { @doc("The datetime that the snapshot was created, in RFC3339 format.") @visibility("read") createdTime: utcDateTime; + + @doc("The datetime when the snapshot expires, will only be shown for a manual snapshot, in RFC3339 format.") + @visibility("read") + @added(APIVersions.v2024_10_01_preview) + expirationTime?: utcDateTime; + + @doc("The type of the snapshot indicates whether it is manual or automatic.") + @visibility("read") + @added(APIVersions.v2024_10_01_preview) + snapshotType: SnapshotType; } diff --git a/specification/devcenter/DevCenter/DevBox/routes.tsp b/specification/devcenter/DevCenter/DevBox/routes.tsp index d43ef877e44c..b203fcedf8b0 100644 --- a/specification/devcenter/DevCenter/DevBox/routes.tsp +++ b/specification/devcenter/DevCenter/DevBox/routes.tsp @@ -439,4 +439,15 @@ interface DevBoxes { }, OperationStatus >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Replacing Status Monitor" + @doc("Captures a manual snapshot of the Dev Box.") + @added(APIVersions.v2024_10_01_preview) + @pollingOperation(OperationStatuses.get) + @action("captureSnapshot") + captureSnapshotDevBox is DevCenterOps.LongRunningResourceAction< + DevBox, + {}, + OperationStatus + >; } diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CaptureSnapshotDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CaptureSnapshotDevBox.json new file mode 100644 index 000000000000..1306f8183682 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CaptureSnapshotDevBox.json @@ -0,0 +1,25 @@ +{ + "title": "Attempts to capture the manual snapshot for the Dev Box.", + "operationId": "DevBoxes_CaptureSnapshotDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CreateCustomizationGroup.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CreateCustomizationGroup.json new file mode 100644 index 000000000000..0ce11d294f54 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CreateCustomizationGroup.json @@ -0,0 +1,57 @@ +{ + "title": "Applies customizations to the Dev Box.", + "operationId": "DevBoxes_CreateCustomizationGroup", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "customizationGroupName": "Provisioning", + "body": { + "tasks": [ + { + "name": "catalogName/choco", + "displayName": "Install VS Code", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + } + }, + { + "name": "catalogName/write-to-file", + "runAs": "User" + } + ] + } + }, + "responses": { + "200": { + "body": { + "name": "Provisioning", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning", + "tasks": [ + { + "id": "a9202018-fb6a-4007-8b52-26d7c6d1c1fb", + "name": "catalogName/choco", + "displayName": "Install VS Code", + "status": "NotStarted", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + }, + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/a9202018-fb6a-4007-8b52-26d7c6d1c1fb" + }, + { + "id": "91835dc0-ef5a-4f58-9e3a-099aea8481f4", + "name": "catalogName/write-to-file", + "runAs": "User", + "status": "NotStarted", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/91835dc0-ef5a-4f58-9e3a-099aea8481f4" + } + ], + "status": "NotStarted" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CreateDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CreateDevBox.json new file mode 100644 index 000000000000..3b2a85f411d0 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CreateDevBox.json @@ -0,0 +1,74 @@ +{ + "title": "Creates or replaces a Dev Box.", + "operationId": "DevBoxes_CreateDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "body": { + "poolName": "LargeDevWorkStationPool" + } + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + }, + "201": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Creating", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayAction.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayAction.json new file mode 100644 index 000000000000..83f344d66d86 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayAction.json @@ -0,0 +1,29 @@ +{ + "title": "Delays the occurrence of an action.", + "operationId": "DevBoxes_DelayAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "actionName": "schedule-default", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "suspendedUntil": "2022-09-30T17:00:00Z", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayActions.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayActions.json new file mode 100644 index 000000000000..89db45645b88 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayActions.json @@ -0,0 +1,51 @@ +{ + "title": "Delays all actions.", + "operationId": "DevBoxes_DelayActions", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "result": "Succeeded", + "action": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "suspendedUntil": "2022-09-30T17:00:00Z", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "result": "Succeeded", + "action": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool", + "sourceType": "Pool", + "suspendedUntil": "2022-09-30T17:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayActionsWithError.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayActionsWithError.json new file mode 100644 index 000000000000..f512eee91740 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayActionsWithError.json @@ -0,0 +1,43 @@ +{ + "title": "Delays all actions with an error.", + "operationId": "DevBoxes_DelayActionsWithError", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "result": "Failed", + "error": { + "code": "DelayOverMaxTime", + "message": "The schedule cannot be delayed more than 8 hours from the original invocation time." + } + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "result": "Succeeded", + "action": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool", + "sourceType": "Pool", + "suspendedUntil": "2022-09-30T17:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DeleteDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DeleteDevBox.json new file mode 100644 index 000000000000..f4a9c9cf9b65 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DeleteDevBox.json @@ -0,0 +1,26 @@ +{ + "title": "Deletes a Dev Box.", + "operationId": "DevBoxes_DeleteDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetAction.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetAction.json new file mode 100644 index 000000000000..2d62c465e19d --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetAction.json @@ -0,0 +1,27 @@ +{ + "title": "Gets an action.", + "operationId": "DevBoxes_GetAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "actionName": "schedule-default" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationGroup.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationGroup.json new file mode 100644 index 000000000000..df202ebc899f --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationGroup.json @@ -0,0 +1,44 @@ +{ + "title": "Gets a customization group.", + "operationId": "DevBoxes_GetCustomizationGroup", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "customizationGroupName": "Provisioning" + }, + "responses": { + "200": { + "body": { + "name": "Provisioning", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning", + "tasks": [ + { + "id": "a9202018-fb6a-4007-8b52-26d7c6d1c1fb", + "name": "catalogName/choco", + "displayName": "Install VS Code", + "status": "Succeeded", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + }, + "startTime": "2021-08-05T18:00:00.000Z", + "endTime": "2021-08-05T18:00:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/a9202018-fb6a-4007-8b52-26d7c6d1c1fb" + }, + { + "id": "91835dc0-ef5a-4f58-9e3a-099aea8481f4", + "name": "catalogName/write-to-file", + "status": "Running", + "startTime": "2021-08-05T18:00:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/91835dc0-ef5a-4f58-9e3a-099aea8481f4" + } + ], + "status": "Running", + "startTime": "2021-08-05T18:00:00.000Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationTaskDefinitions.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationTaskDefinitions.json new file mode 100644 index 000000000000..9922353497d3 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationTaskDefinitions.json @@ -0,0 +1,36 @@ +{ + "title": "Gets a customization task.", + "operationId": "DevBoxes_GetCustomizationTaskDefinitions", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "api-version": "2024-10-01-preview", + "catalogName": "myCatalog", + "taskName": "choco" + }, + "responses": { + "200": { + "body": { + "name": "myCatalog/choco", + "catalogName": "myCatalog", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/customizationtasks/choco", + "description": "Install a package via chocolatey", + "parameters": { + "package": { + "description": "The package to install", + "type": "string", + "required": true + }, + "version": { + "description": "The version of the package", + "type": "string", + "default": "latest" + }, + "retryOnFail": { + "type": "boolean" + } + } + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationTaskLog.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationTaskLog.json new file mode 100644 index 000000000000..a23db3682380 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationTaskLog.json @@ -0,0 +1,18 @@ +{ + "title": "Gets the log for a customization task.", + "operationId": "DevBoxes_GetCustomizationTaskLog", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "4863c6d0-e979-4a36-ac8d-80029debfd80", + "devBoxName": "MyDevBox", + "customizationGroupName": "Provisioning", + "customizationTaskId": "91835dc0-ef5a-4f58-9e3a-099aea8481f4" + }, + "responses": { + "200": { + "body": "WzIwMjMtMDgtMTBUMTA6MTk6NTUuODIwMTAxKzAwOjAwXSBDaG9jb2xhdGV5IHYxLjMuMVxuWzIwMjMtMDgtMTBUMTA6MTk6NTUuOTEzMjk3KzAwOjAwXSAyIHZhbGlkYXRpb25zIHBlcmZvcm1lZC4gMSBzdWNjZXNzKGVzKSwgMSB3YXJuaW5nKHMpLCBhbmQgMCBlcnJvcihzKS4=" + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetDevBoxByUser.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetDevBoxByUser.json new file mode 100644 index 000000000000..4f37e7673039 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetDevBoxByUser.json @@ -0,0 +1,41 @@ +{ + "title": "Gets a Dev Box.", + "operationId": "DevBoxes_GetDevBoxByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastConnectedTime": "2022-04-01T00:13:23.323Z", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetImagingTaskLog.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetImagingTaskLog.json new file mode 100644 index 000000000000..cc7fabcf2337 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetImagingTaskLog.json @@ -0,0 +1,15 @@ +{ + "title": "Gets the log for an imaging build task.", + "operationId": "DevBoxes_GetImagingTaskLog", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "imageBuildLogId": "91835dc0-ef5a-4f58-9e3a-099aea8481f4" + }, + "responses": { + "200": { + "body": "WzIwMjMtMDgtMTBUMTA6MTk6NTUuODIwMTAxKzAwOjAwXSBDaG9jb2xhdGV5IHYxLjMuMVxuWzIwMjMtMDgtMTBUMTA6MTk6NTUuOTEzMjk3KzAwOjAwXSAyIHZhbGlkYXRpb25zIHBlcmZvcm1lZC4gMSBzdWNjZXNzKGVzKSwgMSB3YXJuaW5nKHMpLCBhbmQgMCBlcnJvcihzKS4=" + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetOperation.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetOperation.json new file mode 100644 index 000000000000..a7f76d9d7c13 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetOperation.json @@ -0,0 +1,25 @@ +{ + "title": "Gets an operation on a Dev Box.", + "operationId": "DevBoxes_GetOperation", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Start", + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetPool.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetPool.json new file mode 100644 index 000000000000..06b37d499a33 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetPool.json @@ -0,0 +1,45 @@ +{ + "title": "Gets a pool.", + "operationId": "DevBoxes_GetPool", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "api-version": "2024-10-01-preview", + "poolName": "DevPool" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/LargeDevWorkStationPool", + "name": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + }, + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Healthy", + "displayName": "LargePool" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetRemoteConnection.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetRemoteConnection.json new file mode 100644 index 000000000000..8f8f9dc03d70 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetRemoteConnection.json @@ -0,0 +1,18 @@ +{ + "title": "Gets RDP Connection info.", + "operationId": "DevBoxes_GetRemoteConnection", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "200": { + "body": { + "webUrl": "https://connectionUrl" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetScheduleByPool.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetScheduleByPool.json new file mode 100644 index 000000000000..a0ed28a46bbc --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetScheduleByPool.json @@ -0,0 +1,25 @@ +{ + "title": "Gets a schedule.", + "operationId": "DevBoxes_GetScheduleByPool", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "api-version": "2024-10-01-preview", + "poolName": "DevPool", + "scheduleName": "default" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", + "name": "default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool", + "sourceType": "Pool", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetSnapshot.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetSnapshot.json new file mode 100644 index 000000000000..f62c94303145 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetSnapshot.json @@ -0,0 +1,21 @@ +{ + "title": "Gets a snapshot by snapshot id.", + "operationId": "DevBoxes_GetSnapshot", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6797" + }, + "responses": { + "200": { + "body": { + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6797", + "createdTime": "2022-09-30T15:23:00Z", + "snapshotType": "Automatic" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListActions.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListActions.json new file mode 100644 index 000000000000..c73522362510 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListActions.json @@ -0,0 +1,42 @@ +{ + "title": "Lists actions on a Dev Box.", + "operationId": "DevBoxes_ListActions", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool", + "sourceType": "Pool", + "next": { + "scheduledTime": "2022-09-30T15:23:00Z" + } + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "suspendedUntil": "2022-09-30T17:00:00Z", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListAllDevBoxes.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListAllDevBoxes.json new file mode 100644 index 000000000000..d191b87a886b --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListAllDevBoxes.json @@ -0,0 +1,42 @@ +{ + "title": "Lists Dev Boxes that the caller has access to in the DevCenter.", + "operationId": "DevBoxes_ListAllDevBoxes", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastConnectedTime": "2022-04-01T00:13:23.323Z", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListAllDevBoxesByUser.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListAllDevBoxesByUser.json new file mode 100644 index 000000000000..f76e593664da --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListAllDevBoxesByUser.json @@ -0,0 +1,44 @@ +{ + "title": "Lists Dev Boxes in the project for a particular user.", + "operationId": "DevBoxes_ListAllDevBoxesByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastConnectedTime": "2022-04-01T00:13:23.323Z", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationGroups.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationGroups.json new file mode 100644 index 000000000000..25efb85d3eed --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationGroups.json @@ -0,0 +1,68 @@ +{ + "title": "Lists customization groups on the Dev Box. Listed customization groups exclude task information unless specified via the include parameter.", + "operationId": "DevBoxes_ListCustomizationGroups", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "include": "tasks" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Provisioning", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning", + "tasks": [ + { + "id": "a9202018-fb6a-4007-8b52-26d7c6d1c1fb", + "name": "catalogName/choco", + "displayName": "Install VS Code", + "status": "Succeeded", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + }, + "startTime": "2021-08-05T18:00:00.000Z", + "endTime": "2021-08-05T18:00:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/a9202018-fb6a-4007-8b52-26d7c6d1c1fb" + }, + { + "id": "91835dc0-ef5a-4f58-9e3a-099aea8481f4", + "name": "catalogName/write-to-file", + "status": "Succeeded", + "startTime": "2021-08-05T18:10:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/91835dc0-ef5a-4f58-9e3a-099aea8481f4" + } + ], + "status": "Succeeded", + "startTime": "2021-08-05T18:00:00.000Z", + "endTime": "2021-08-05T18:10:00.000Z" + }, + { + "name": "Personalizations", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Personalizations", + "tasks": [ + { + "id": "d8ec7648-23c9-4e86-8883-6d42ad6c9609", + "name": "catalogName/choco", + "displayName": "Install Git", + "status": "Running", + "parameters": { + "packageName": "git" + }, + "startTime": "2021-08-05T18:10:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Personalizations/logs/d8ec7648-23c9-4e86-8883-6d42ad6c9609" + } + ], + "status": "Running", + "startTime": "2021-08-05T18:10:00.000Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationGroupsWithoutTasks.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationGroupsWithoutTasks.json new file mode 100644 index 000000000000..1f857f91d3d0 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationGroupsWithoutTasks.json @@ -0,0 +1,32 @@ +{ + "title": "Lists customization groups on the Dev Box. Listed customization groups exclude task information unless specified via the include parameter.", + "operationId": "DevBoxes_ListCustomizationGroupsWithoutTasks", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Provisioning", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning", + "status": "Succeeded", + "startTime": "2021-08-05T18:00:00.000Z", + "endTime": "2021-08-05T18:10:00.000Z" + }, + { + "name": "Personalizations", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Personalizations", + "status": "Running", + "startTime": "2021-08-05T18:10:00.000Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationTaskDefinitionsByProject.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationTaskDefinitionsByProject.json new file mode 100644 index 000000000000..6886b08fd453 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationTaskDefinitionsByProject.json @@ -0,0 +1,53 @@ +{ + "title": "Lists all customization tasks available to the project.", + "operationId": "DevBoxes_ListCustomizationTaskDefinitionsByProject", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myCatalog/choco", + "catalogName": "myCatalog", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/customizationtasks/choco", + "description": "Install a package via chocolatey", + "parameters": { + "package": { + "description": "The package to install", + "type": "string", + "required": true + }, + "version": { + "description": "The version of the package", + "type": "string", + "default": "latest" + }, + "retryOnFail": { + "type": "boolean" + } + } + }, + { + "name": "myCatalog/powershell", + "catalogName": "myCatalog", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/customizationtasks/powershell", + "description": "Runs an arbitrary Powershell command", + "parameters": { + "command": { + "type": "string", + "required": true + }, + "runAsAdmin": { + "type": "boolean" + } + } + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListDevBoxesByUser.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListDevBoxesByUser.json new file mode 100644 index 000000000000..ee0a1c013dcd --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListDevBoxesByUser.json @@ -0,0 +1,44 @@ +{ + "title": "Lists Dev Boxes in the project for a particular user.", + "operationId": "DevBoxes_ListDevBoxesByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastConnectedTime": "2022-04-01T00:13:23.323Z", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListOperations.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListOperations.json new file mode 100644 index 000000000000..fa770194c6af --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListOperations.json @@ -0,0 +1,42 @@ +{ + "title": "Lists operations on the Dev Box which have occurred within the past 90 days.", + "operationId": "DevBoxes_ListOperations", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Start", + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/a6eb12ee-daa1-2215-9c44-63618dc2a781", + "operationId": "a6eb12ee-daa1-2215-9c44-63618dc2a781", + "status": "Succeeded", + "kind": "Repair", + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-10T19:31:20.7229492+00:00", + "endTime": "2022-09-10T19:57:41.7229492+00:00", + "result": { + "code": "ConnectivityFixApplied", + "message": "We resolved some connectivity issues with your Dev Box.", + "repairOutcome": "FixApplied" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListPools.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListPools.json new file mode 100644 index 000000000000..065f2392a615 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListPools.json @@ -0,0 +1,79 @@ +{ + "title": "Lists available pools.", + "operationId": "DevBoxes_ListPools", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/LargeDevWorkStationPool", + "name": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + }, + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Healthy", + "displayName": "LargePool" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/SQLDevelopmentMachinePool", + "name": "SQLDevelopmentMachinePool", + "location": "southcentralus", + "osType": "Windows", + "hardwareProfile": { + "vCPUs": 16, + "memoryGB": 128 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "SqlDevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + }, + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Healthy", + "displayName": "SQLPool" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSchedulesByPool.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSchedulesByPool.json new file mode 100644 index 000000000000..3139ab52c06a --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSchedulesByPool.json @@ -0,0 +1,28 @@ +{ + "title": "Lists all schedules within a pool that are configured by your project administrator.", + "operationId": "DevBoxes_ListSchedulesByPool", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "poolName": "DevPool", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", + "name": "default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool", + "sourceType": "Pool", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSchedulesByProject.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSchedulesByProject.json new file mode 100644 index 000000000000..920494b62d99 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSchedulesByProject.json @@ -0,0 +1,27 @@ +{ + "title": "Lists all schedules within a project that are configured by your project administrator.", + "operationId": "DevBoxes_ListSchedulesByProject", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", + "name": "default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool", + "sourceType": "Pool", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSnapshots.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSnapshots.json new file mode 100644 index 000000000000..6cb959b2204e --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSnapshots.json @@ -0,0 +1,30 @@ +{ + "title": "Lists snapshots for this Dev Box.", + "operationId": "DevBoxes_ListSnapshots", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6797", + "createdTime": "2022-09-30T15:23:00Z", + "snapshotType": "Automatic" + }, + { + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6798", + "createdTime": "2022-09-30T15:23:00Z", + "expirationTime": "2024-10-30T15:23:00Z", + "snapshotType": "Manual" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RepairDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RepairDevBox.json new file mode 100644 index 000000000000..ab297ebe0667 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RepairDevBox.json @@ -0,0 +1,25 @@ +{ + "title": "Attempts automated repair steps to resolve common problems on a Dev Box. The Dev Box may restart during this operation.", + "operationId": "DevBoxes_RepairDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestartDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestartDevBox.json new file mode 100644 index 000000000000..acef706175e1 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestartDevBox.json @@ -0,0 +1,25 @@ +{ + "title": "Restarts a Dev Box.", + "operationId": "DevBoxes_RestartDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestoreSnapshotDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestoreSnapshotDevBox.json new file mode 100644 index 000000000000..891948c547a0 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestoreSnapshotDevBox.json @@ -0,0 +1,26 @@ +{ + "title": "Attempts to restore the Dev Box to a selected snapshot.", + "operationId": "DevBoxes_RestoreSnapshotDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6797" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_SkipAction.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_SkipAction.json new file mode 100644 index 000000000000..bc83aa55f3c1 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_SkipAction.json @@ -0,0 +1,15 @@ +{ + "title": "Skips an occurrence of an action.", + "operationId": "DevBoxes_SkipAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "actionName": "schedule-default" + }, + "responses": { + "204": {} + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_StartDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_StartDevBox.json new file mode 100644 index 000000000000..5c34fc1c57c2 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_StartDevBox.json @@ -0,0 +1,25 @@ +{ + "title": "Starts a Dev Box.", + "operationId": "DevBoxes_StartDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_StopDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_StopDevBox.json new file mode 100644 index 000000000000..99dd05cc7c03 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_StopDevBox.json @@ -0,0 +1,26 @@ +{ + "title": "Stops a Dev Box.", + "operationId": "DevBoxes_StopDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "hibernate": "true" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ValidateCustomizationTasksAction.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ValidateCustomizationTasksAction.json new file mode 100644 index 000000000000..7fa247cff7a6 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ValidateCustomizationTasksAction.json @@ -0,0 +1,40 @@ +{ + "title": "Validates a list of customization tasks.", + "operationId": "DevBoxes_ValidateCustomizationTasksAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "body": { + "tasks": [ + { + "name": "catalogName/choco", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + } + }, + { + "name": "catalogName/write-to-disk" + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Succeeded", + "startTime": "2023-02-01T12:43:54.122Z", + "result": { + "validationResult": "Succeeded" + } + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ValidateCustomizationTasksActionWithFailure.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ValidateCustomizationTasksActionWithFailure.json new file mode 100644 index 000000000000..e6de65937cf9 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ValidateCustomizationTasksActionWithFailure.json @@ -0,0 +1,53 @@ +{ + "title": "Validates a list of customization tasks.", + "operationId": "DevBoxes_ValidateCustomizationTasksActionWithFailure", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "body": { + "tasks": [ + { + "name": "catalogName/choco", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + } + }, + { + "name": "catalogName/write-to-file" + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Succeeded", + "startTime": "2023-02-01T12:43:54.122Z", + "result": { + "validationResult": "Failed", + "errors": [ + { + "target": { + "name": "catalogName/write-to-file" + }, + "details": [ + { + "code": "TaskNotFound", + "message": "Could not find the referenced task catalogName/write-to-file." + } + ] + } + ] + } + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_GetProject.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_GetProject.json new file mode 100644 index 000000000000..44331c0613ab --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_GetProject.json @@ -0,0 +1,19 @@ +{ + "title": "Gets a project.", + "operationId": "DevCenter_GetProject", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/DevDiv", + "name": "DevDiv", + "description": "The developer division", + "displayName": "DeveloperDivision" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_GetProjectAbilities.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_GetProjectAbilities.json new file mode 100644 index 000000000000..1dd761dc9891 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_GetProjectAbilities.json @@ -0,0 +1,37 @@ +{ + "title": "Gets the signed-in user's permitted abilities in a project.", + "operationId": "DevCenter_GetProjectAbilities", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "abilitiesAsAdmin": [ + "ReadDevBoxes", + "ReadEnvironments" + ], + "abilitiesAsDeveloper": [ + "CustomizeDevBoxes", + "DeleteDevBoxes", + "DeleteEnvironments", + "ManageDevBoxActions", + "ManageEnvironmentActions", + "ReadDevBoxActions", + "ReadDevBoxes", + "ReadEnvironmentActions", + "ReadEnvironmentOutputs", + "ReadEnvironments", + "ReadRemoteConnections", + "StartDevBoxes", + "StopDevBoxes", + "WriteDevBoxes", + "WriteEnvironments" + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_ListProjects.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_ListProjects.json new file mode 100644 index 000000000000..a7d9e2e31725 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_ListProjects.json @@ -0,0 +1,22 @@ +{ + "title": "Lists all projects in a Dev Center.", + "operationId": "DevCenter_ListProjects", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject", + "name": "DevDiv", + "description": "The developer division", + "displayName": "DeveloperDivision" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_CreateOrReplaceEnvironment.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_CreateOrReplaceEnvironment.json new file mode 100644 index 000000000000..c31a9c1565a5 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_CreateOrReplaceEnvironment.json @@ -0,0 +1,43 @@ +{ + "title": "Creates or updates an environment.", + "operationId": "Environments_CreateOrReplaceEnvironment", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "environmentName": "mydevenv", + "userId": "me", + "body": { + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "expirationDate": "2023-09-10T17:00:00Z" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Creating", + "expirationDate": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_DelayAction.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_DelayAction.json new file mode 100644 index 000000000000..fedd0acb2c35 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_DelayAction.json @@ -0,0 +1,27 @@ +{ + "title": "Delays the occurrence of an action.", + "operationId": "Environments_DelayAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnv", + "actionName": "default", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/default", + "name": "default", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_DeleteEnvironment.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_DeleteEnvironment.json new file mode 100644 index 000000000000..b12474e9fe84 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_DeleteEnvironment.json @@ -0,0 +1,26 @@ +{ + "title": "Deletes an environment and all its associated resources.", + "operationId": "Environments_DeleteEnvironment", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ForceDeleteEnvironment.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ForceDeleteEnvironment.json new file mode 100644 index 000000000000..3305cb49fb0b --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ForceDeleteEnvironment.json @@ -0,0 +1,27 @@ +{ + "title": "Deletes an environment and its resource group without the environment definition.", + "operationId": "Environments_DeleteEnvironment", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv", + "force": "true" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetAction.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetAction.json new file mode 100644 index 000000000000..8c5dcee14079 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetAction.json @@ -0,0 +1,26 @@ +{ + "title": "Retrieve a specific environment action.", + "operationId": "Environments_GetAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "actionName": "default" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/default", + "name": "default", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetCatalog.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetCatalog.json new file mode 100644 index 000000000000..d0296c59168f --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetCatalog.json @@ -0,0 +1,18 @@ +{ + "title": "Gets the specified catalog within the project.", + "operationId": "Environments_GetCatalog", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "catalogName": "foo" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/foo", + "name": "foo" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentByUser.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentByUser.json new file mode 100644 index 000000000000..fc09eaf09dec --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentByUser.json @@ -0,0 +1,30 @@ +{ + "title": "Gets an environment.", + "operationId": "Environments_GetEnvironmentByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg028321", + "expirationDate": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentDefinition.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentDefinition.json new file mode 100644 index 000000000000..6a2a39903855 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentDefinition.json @@ -0,0 +1,58 @@ +{ + "title": "Get an environment definition from a catalog.", + "operationId": "Environments_GetEnvironmentDefinition", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "catalogName": "myCatalog", + "definitionName": "foo" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "name": "foo", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true, + "default": "dotnet", + "allowed": [ + "node", + "dotnet", + "java" + ] + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true, + "default": "Standard_LRS", + "allowed": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS" + ] + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "default": "true", + "readOnly": true, + "required": true + } + ], + "parametersSchema": "{\"type\":\"object\",\"properties\":{\"functionAppRuntime\":{\"$id\":\"functionAppRuntime\",\"value\":\"dotnet\",\"displayName\":\"Function App Runtime\",\"type\":\"string\",\"enum\":[\"node\",\"dotnet\",\"java\"]},\"storageAccountType\":{\"$id\":\"storageAccountType\",\"value\":\"Standard_LRS\",\"displayName\":\"Storage Account Type\",\"type\":\"string\",\"enum\":[\"Standard_LRS\",\"Standard_GRS\",\"Standard_RAGRS\"]},\"httpsOnly\":{\"$id\":\"httpsOnly\",\"value\":true,\"displayName\":\"HTTPS only\",\"type\":\"boolean\"}},\"required\":[\"functionAppRuntime\",\"storageAccountType\"]}", + "templatePath": "azuredeploy.json" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentTypeAbilities.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentTypeAbilities.json new file mode 100644 index 000000000000..15bd60987c65 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentTypeAbilities.json @@ -0,0 +1,28 @@ +{ + "title": "Gets the signed-in user's permitted abilities in an environment type.", + "operationId": "Environments_GetEnvironmentTypeAbilities", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "environmentTypeName": "devtestenv", + "userId": "me", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "abilitiesAsAdmin": [ + "ReadEnvironments" + ], + "abilitiesAsDeveloper": [ + "DeleteEnvironments", + "ManageEnvironmentActions", + "ReadEnvironmentActions", + "ReadEnvironmentOutputs", + "ReadEnvironments", + "WriteEnvironments" + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentTypes.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentTypes.json new file mode 100644 index 000000000000..d41c0d94320e --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentTypes.json @@ -0,0 +1,21 @@ +{ + "title": "Get an environment type configured for a project.", + "operationId": "Environments_GetEnvironmentTypes", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "environmentTypeName": "devtestenv", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/environmentTypes/devtestenv", + "name": "devtestenv", + "status": "Enabled", + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "displayName": "DevTestEnvironment" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetLogsByOperation.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetLogsByOperation.json new file mode 100644 index 000000000000..5fb52d5225a3 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetLogsByOperation.json @@ -0,0 +1,17 @@ +{ + "title": "Gets the logs for an operation on an environment.", + "operationId": "Environments_GetLogsByOperation", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": "{file}" + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetOperation.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetOperation.json new file mode 100644 index 000000000000..6e4d5ac213af --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetOperation.json @@ -0,0 +1,29 @@ +{ + "title": "Gets an environment action result.", + "operationId": "Environments_GetOperation", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/myEnvironment/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Deploy", + "environmentParameters": { + "paramA": "valueA", + "paramB": "valueB" + }, + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetOutputs.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetOutputs.json new file mode 100644 index 000000000000..20f9755f7101 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetOutputs.json @@ -0,0 +1,51 @@ +{ + "title": "Gets Outputs from the environment.", + "operationId": "Environments_GetOutputs", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "responses": { + "200": { + "body": { + "outputs": { + "stringOutput": { + "type": "string", + "value": "Output1 value", + "sensitive": false + }, + "arrayOutput": { + "type": "array", + "value": [ + 1, + 2, + 3 + ], + "sensitive": false + }, + "boolOutput": { + "type": "bool", + "value": true, + "sensitive": false + }, + "intOutput": { + "type": "int", + "value": 1, + "sensitive": false + }, + "objectOutput": { + "type": "object", + "value": { + "name": "name", + "id": "id" + }, + "sensitive": false + } + } + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListActions.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListActions.json new file mode 100644 index 000000000000..fec2e7db31bb --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListActions.json @@ -0,0 +1,39 @@ +{ + "title": "Get all scheduled actions for a user within an environment.", + "operationId": "Environments_ListActions", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/default", + "name": "default", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-10T17:00:00Z" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/expire", + "name": "expire", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-10-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-20T17:00:00Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListCatalogsByProject.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListCatalogsByProject.json new file mode 100644 index 000000000000..d9fbc4eee5d0 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListCatalogsByProject.json @@ -0,0 +1,21 @@ +{ + "title": "Lists all of the catalogs available for a project.", + "operationId": "Environments_ListCatalogsByProject", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/foo", + "name": "foo" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentDefinitionsByCatalog.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentDefinitionsByCatalog.json new file mode 100644 index 000000000000..72928b19772c --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentDefinitionsByCatalog.json @@ -0,0 +1,69 @@ +{ + "title": "Lists all environment definitions available within a catalog.", + "operationId": "Environments_ListEnvironmentDefinitionsByCatalog", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "catalogName": "myCatalog" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "name": "foo", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true, + "default": "dotnet", + "allowed": [ + "node", + "dotnet", + "java" + ] + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true, + "default": "Standard_LRS", + "allowed": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS" + ] + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "default": "true", + "readOnly": true, + "required": true + } + ], + "parametersSchema": "{\"type\":\"object\",\"properties\":{\"functionAppRuntime\":{\"$id\":\"functionAppRuntime\",\"value\":\"dotnet\",\"displayName\":\"Function App Runtime\",\"type\":\"string\",\"enum\":[\"node\",\"dotnet\",\"java\"]},\"storageAccountType\":{\"$id\":\"storageAccountType\",\"value\":\"Standard_LRS\",\"displayName\":\"Storage Account Type\",\"type\":\"string\",\"enum\":[\"Standard_LRS\",\"Standard_GRS\",\"Standard_RAGRS\"]},\"httpsOnly\":{\"$id\":\"httpsOnly\",\"value\":true,\"displayName\":\"HTTPS only\",\"type\":\"boolean\"}},\"required\":[\"functionAppRuntime\",\"storageAccountType\"]}", + "templatePath": "azuredeploy.json" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", + "name": "bar", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "templatePath": "azuredeploy.json" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentDefinitionsByProject.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentDefinitionsByProject.json new file mode 100644 index 000000000000..3055da215535 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentDefinitionsByProject.json @@ -0,0 +1,68 @@ +{ + "title": "Lists all environment definitions available for a project.", + "operationId": "Environments_ListEnvironmentDefinitionsByProject", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "name": "foo", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true, + "default": "dotnet", + "allowed": [ + "node", + "dotnet", + "java" + ] + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true, + "default": "Standard_LRS", + "allowed": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS" + ] + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "default": "true", + "readOnly": true, + "required": true + } + ], + "parametersSchema": "{\"type\":\"object\",\"properties\":{\"functionAppRuntime\":{\"$id\":\"functionAppRuntime\",\"value\":\"dotnet\",\"displayName\":\"Function App Runtime\",\"type\":\"string\",\"enum\":[\"node\",\"dotnet\",\"java\"]},\"storageAccountType\":{\"$id\":\"storageAccountType\",\"value\":\"Standard_LRS\",\"displayName\":\"Storage Account Type\",\"type\":\"string\",\"enum\":[\"Standard_LRS\",\"Standard_GRS\",\"Standard_RAGRS\"]},\"httpsOnly\":{\"$id\":\"httpsOnly\",\"value\":true,\"displayName\":\"HTTPS only\",\"type\":\"boolean\"}},\"required\":[\"functionAppRuntime\",\"storageAccountType\"]}", + "templatePath": "azuredeploy.json" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", + "id": "/projects/myProject/catalogs/myOtherCatalog/environmentDefinitions/bar", + "name": "bar", + "catalogName": "myOtherCatalog", + "description": "This environment definition is just for example purposes.", + "templatePath": "azuredeploy.json" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentTypes.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentTypes.json new file mode 100644 index 000000000000..62e267038a17 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentTypes.json @@ -0,0 +1,24 @@ +{ + "title": "Lists all environment types configured for a project.", + "operationId": "Environments_ListEnvironmentTypes", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/environmentTypes/devtestenv", + "name": "devtestenv", + "status": "Enabled", + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "displayName": "DevTestEnvironment" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironments.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironments.json new file mode 100644 index 000000000000..037ce43b0111 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironments.json @@ -0,0 +1,32 @@ +{ + "title": "Lists all environment definitions available for a project.", + "operationId": "Environments_ListEnvironments", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg028321", + "expirationDate": "2023-09-10T17:00:00Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentsByUser.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentsByUser.json new file mode 100644 index 000000000000..a31423259000 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentsByUser.json @@ -0,0 +1,33 @@ +{ + "title": "Lists the environments for a project and user.", + "operationId": "Environments_ListEnvironmentsByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg028321", + "expirationDate": "2023-09-10T17:00:00Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListOperations.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListOperations.json new file mode 100644 index 000000000000..8386bc5476ab --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListOperations.json @@ -0,0 +1,32 @@ +{ + "title": "Lists operations on the environment which have occurred within the past 90 days.", + "operationId": "Environments_ListOperations", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/myEnvironment/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Deploy", + "environmentParameters": { + "paramA": "valueA", + "paramB": "valueB" + }, + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_PatchEnvironment.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_PatchEnvironment.json new file mode 100644 index 000000000000..c31b552d4813 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_PatchEnvironment.json @@ -0,0 +1,32 @@ +{ + "title": "Partially updates an environment.", + "operationId": "Environments_PatchEnvironment", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "environmentName": "mydevenv", + "userId": "me", + "body": { + "expirationDate": "2023-09-10T17:00:00Z" + } + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "expirationDate": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_SkipAction.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_SkipAction.json new file mode 100644 index 000000000000..d620617d53de --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_SkipAction.json @@ -0,0 +1,21 @@ +{ + "title": "Skips an occurrence of an action.", + "operationId": "Environments_SkipAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "environmentName": "myEnv", + "userId": "me", + "actionName": "default", + "body": { + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + } + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/OperationStatuses_Get.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/OperationStatuses_Get.json new file mode 100644 index 000000000000..c1d48444d062 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/OperationStatuses_Get.json @@ -0,0 +1,19 @@ +{ + "title": "Get the status of an operation.", + "operationId": "OperationStatuses_Get", + "parameters": { + "api-version": "2024-10-01-preview", + "projectName": "myProject", + "operationId": "fa067167-e49d-41bd-8dd8-de719b9de3b3" + }, + "responses": { + "200": { + "body": { + "id": "/projects/myProject/operationStatuses/fa067167-e49d-41bd-8dd8-de719b9de3b3", + "name": "fa067167-e49d-41bd-8dd8-de719b9de3b3", + "status": "Running", + "startTime": "2024-01-24T21:14:58.472Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/main.tsp b/specification/devcenter/DevCenter/main.tsp index ef638853073c..fd5c466076c7 100644 --- a/specification/devcenter/DevCenter/main.tsp +++ b/specification/devcenter/DevCenter/main.tsp @@ -55,4 +55,8 @@ enum APIVersions { @doc("The 2024-09-01-preview service API version") @useDependency(Versions.v1_0_Preview_2) v2024_09_01_preview: "2024-09-01-preview", + + @doc("The 2024-10-01-preview service API version") + @useDependency(Versions.v1_0_Preview_2) + v2024_10_01_preview: "2024-10-01-preview", } diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json new file mode 100644 index 000000000000..78fedb94d760 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json @@ -0,0 +1,7219 @@ +{ + "swagger": "2.0", + "info": { + "title": "DevCenter", + "version": "2024-10-01-preview", + "description": "DevCenter service", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "The DevCenter-specific URI to operate on.", + "required": true, + "type": "string", + "format": "uri", + "x-ms-skip-url-encoding": true + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "OAuth2Auth": [ + "https://devcenter.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "OAuth2Auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://devcenter.azure.com/.default": "" + } + } + }, + "tags": [], + "paths": { + "/devboxes": { + "get": { + "operationId": "DevBoxes_ListAllDevBoxes", + "description": "Lists Dev Boxes that the caller has access to in the DevCenter.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDevBox" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists Dev Boxes that the caller has access to in the DevCenter.": { + "$ref": "./examples/DevBoxes_ListAllDevBoxes.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects": { + "get": { + "operationId": "DevCenter_ListProjects", + "description": "Lists all projects.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedProject" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all projects in a Dev Center.": { + "$ref": "./examples/DevCenter_ListProjects.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}": { + "get": { + "operationId": "DevCenter_GetProject", + "description": "Gets a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets a project.": { + "$ref": "./examples/DevCenter_GetProject.json" + } + } + } + }, + "/projects/{projectName}/catalogs": { + "get": { + "operationId": "Environments_ListCatalogsByProject", + "description": "Lists all of the catalogs available for a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedCatalog" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all of the catalogs available for a project.": { + "$ref": "./examples/Environments_ListCatalogsByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/catalogs/{catalogName}": { + "get": { + "operationId": "Environments_GetCatalog", + "description": "Gets the specified catalog within the project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of the catalog.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets the specified catalog within the project.": { + "$ref": "./examples/Environments_GetCatalog.json" + } + } + } + }, + "/projects/{projectName}/catalogs/{catalogName}/customizationTasks/{taskName}": { + "get": { + "operationId": "DevBoxes_GetCustomizationTaskDefinitions", + "description": "Gets a customization task.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of the catalog.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "taskName", + "in": "path", + "description": "Full name of the task: {catalogName}/{taskName}.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomizationTaskDefinition" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets a customization task.": { + "$ref": "./examples/DevBoxes_GetCustomizationTaskDefinitions.json" + } + } + } + }, + "/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions": { + "get": { + "operationId": "Environments_ListEnvironmentDefinitionsByCatalog", + "description": "Lists all environment definitions available within a catalog.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "The name of the catalog", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEnvironmentDefinition" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all environment definitions available within a catalog.": { + "$ref": "./examples/Environments_ListEnvironmentDefinitionsByCatalog.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions/{definitionName}": { + "get": { + "operationId": "Environments_GetEnvironmentDefinition", + "description": "Get an environment definition from a catalog.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of the catalog.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "definitionName", + "in": "path", + "description": "Name of the environment definition.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentDefinition" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get an environment definition from a catalog.": { + "$ref": "./examples/Environments_GetEnvironmentDefinition.json" + } + } + } + }, + "/projects/{projectName}/customizationTasks": { + "get": { + "operationId": "DevBoxes_ListCustomizationTaskDefinitionsByProject", + "description": "Lists all customization tasks available to the project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedCustomizationTaskDefinition" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all customization tasks available to the project.": { + "$ref": "./examples/DevBoxes_ListCustomizationTaskDefinitionsByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/customizationTasks:validateGroup": { + "post": { + "operationId": "DevBoxes_ValidateCustomizationTasksAction", + "description": "Validates a list of customization tasks.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Customization tasks to validate.", + "required": true, + "schema": { + "$ref": "#/definitions/CustomizationTaskList" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/CustomizationTaskListValidationOperationResult" + }, + "headers": { + "Location": { + "type": "string" + }, + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Validates a list of customization tasks.": { + "$ref": "./examples/DevBoxes_ValidateCustomizationTasksAction.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/environmentDefinitions": { + "get": { + "operationId": "Environments_ListEnvironmentDefinitionsByProject", + "description": "Lists all environment definitions available for a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEnvironmentDefinition" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all environment definitions available for a project.": { + "$ref": "./examples/Environments_ListEnvironmentDefinitionsByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/environmentTypes": { + "get": { + "operationId": "Environments_ListEnvironmentTypes", + "description": "Lists all environment types configured for a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEnvironmentType" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all environment types configured for a project.": { + "$ref": "./examples/Environments_ListEnvironmentTypes.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/environmentTypes/{environmentTypeName}": { + "get": { + "operationId": "Environments_GetEnvironmentTypes", + "description": "Get an environment type configured for a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "environmentTypeName", + "in": "path", + "description": "Name of the environment type.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentType" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get an environment type configured for a project.": { + "$ref": "./examples/Environments_GetEnvironmentTypes.json" + } + } + } + }, + "/projects/{projectName}/environmentTypes/{environmentTypeName}/users/{userId}/abilities": { + "get": { + "operationId": "Environments_GetEnvironmentTypeAbilities", + "description": "Gets the signed-in user's permitted abilities in an environment type.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "name": "environmentTypeName", + "in": "path", + "description": "The name of the environment type", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "name": "top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: 'top=10'.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentTypeAbilities" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets the signed-in user's permitted abilities in an environment type.": { + "$ref": "./examples/Environments_GetEnvironmentTypeAbilities.json" + } + } + } + }, + "/projects/{projectName}/environments": { + "get": { + "operationId": "Environments_ListEnvironments", + "description": "Lists the environments for a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEnvironment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all environment definitions available for a project.": { + "$ref": "./examples/Environments_ListEnvironments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/imageBuildLogs/{imageBuildLogId}": { + "get": { + "operationId": "DevBoxes_GetImagingTaskLog", + "description": "Gets the log for an imaging build task.", + "produces": [ + "text/plain", + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "name": "imageBuildLogId", + "in": "path", + "description": "An imaging build log id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets the log for an imaging build task.": { + "$ref": "./examples/DevBoxes_GetImagingTaskLog.json" + } + } + } + }, + "/projects/{projectName}/operationstatuses/{operationId}": { + "get": { + "operationId": "OperationStatuses_Get", + "description": "Get the status of an operation.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "operationId", + "in": "path", + "description": "The operation id name.", + "required": true, + "type": "string", + "format": "uuid", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get the status of an operation.": { + "$ref": "./examples/OperationStatuses_Get.json" + } + } + } + }, + "/projects/{projectName}/pools": { + "get": { + "operationId": "DevBoxes_ListPools", + "description": "Lists available pools.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedPool" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists available pools.": { + "$ref": "./examples/DevBoxes_ListPools.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/pools/{poolName}": { + "get": { + "operationId": "DevBoxes_GetPool", + "description": "Gets a pool.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "poolName", + "in": "path", + "description": "Pool name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets a pool.": { + "$ref": "./examples/DevBoxes_GetPool.json" + } + } + } + }, + "/projects/{projectName}/pools/{poolName}/schedules": { + "get": { + "operationId": "DevBoxes_ListSchedulesByPool", + "description": "Lists all schedules within a pool that are configured by your project administrator.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "name": "poolName", + "in": "path", + "description": "The name of a pool of Dev Boxes.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedSchedule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all schedules within a pool that are configured by your project administrator.": { + "$ref": "./examples/DevBoxes_ListSchedulesByPool.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/pools/{poolName}/schedules/{scheduleName}": { + "get": { + "operationId": "DevBoxes_GetScheduleByPool", + "description": "Gets a schedule.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "poolName", + "in": "path", + "description": "Pool name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "scheduleName", + "in": "path", + "description": "Display name for the Schedule.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Schedule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets a schedule.": { + "$ref": "./examples/DevBoxes_GetScheduleByPool.json" + } + } + } + }, + "/projects/{projectName}/schedules": { + "get": { + "operationId": "DevBoxes_ListSchedulesByProject", + "description": "Lists all schedules within a project that are configured by your project administrator.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedSchedule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all schedules within a project that are configured by your project administrator.": { + "$ref": "./examples/DevBoxes_ListSchedulesByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/abilities": { + "get": { + "operationId": "DevCenter_GetProjectAbilities", + "description": "Gets the signed-in user's permitted abilities in a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProjectAbilities" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets the signed-in user's permitted abilities in a project.": { + "$ref": "./examples/DevCenter_GetProjectAbilities.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes": { + "get": { + "operationId": "DevBoxes_ListDevBoxesByUser", + "description": "Lists Dev Boxes in the project for a particular user.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDevBox" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists Dev Boxes in the project for a particular user.": { + "$ref": "./examples/DevBoxes_ListDevBoxesByUser.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}": { + "get": { + "operationId": "DevBoxes_GetDevBoxByUser", + "description": "Gets a Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBox" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets a Dev Box.": { + "$ref": "./examples/DevBoxes_GetDevBoxByUser.json" + } + } + }, + "put": { + "operationId": "DevBoxes_CreateDevBox", + "description": "Creates or replaces a Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents the body request of a Dev Box creation. Dev Box Pool name is required. Optionally set the owner of the Dev Box as local administrator", + "required": true, + "schema": { + "$ref": "#/definitions/DevBox" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBox" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/DevBox" + }, + "headers": { + "Location": { + "type": "string", + "format": "uri", + "description": "The location of an instance of DevBox" + }, + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Creates or replaces a Dev Box.": { + "$ref": "./examples/DevBoxes_CreateDevBox.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "DevBoxes_DeleteDevBox", + "description": "Deletes a Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "Location": { + "type": "string" + }, + "Operation-Location": { + "type": "string" + } + } + }, + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Deletes a Dev Box.": { + "$ref": "./examples/DevBoxes_DeleteDevBox.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:start": { + "post": { + "operationId": "DevBoxes_StartDevBox", + "description": "Starts a Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Starts a Dev Box.": { + "$ref": "./examples/DevBoxes_StartDevBox.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:stop": { + "post": { + "operationId": "DevBoxes_StopDevBox", + "description": "Stops a Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "$ref": "#/parameters/HibernateQueryParameter" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Stops a Dev Box.": { + "$ref": "./examples/DevBoxes_StopDevBox.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:restart": { + "post": { + "operationId": "DevBoxes_RestartDevBox", + "description": "Restarts a Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Restarts a Dev Box.": { + "$ref": "./examples/DevBoxes_RestartDevBox.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:repair": { + "post": { + "operationId": "DevBoxes_RepairDevBox", + "description": "Attempts automated repair steps to resolve common problems on a Dev Box. The Dev Box may restart during this operation.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Attempts automated repair steps to resolve common problems on a Dev Box. The Dev Box may restart during this operation.": { + "$ref": "./examples/DevBoxes_RepairDevBox.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:restoreSnapshot": { + "post": { + "operationId": "DevBoxes_RestoreSnapshotDevBox", + "description": "Restores a Dev Box to a specified snapshot.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "$ref": "#/parameters/SnapshotIdQueryParameter" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Attempts to restore the Dev Box to a selected snapshot.": { + "$ref": "./examples/DevBoxes_RestoreSnapshotDevBox.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:captureSnapshot": { + "post": { + "operationId": "DevBoxes_CaptureSnapshotDevBox", + "description": "Captures a manual snapshot of the Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Attempts to capture the manual snapshot for the Dev Box.": { + "$ref": "./examples/DevBoxes_CaptureSnapshotDevBox.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions": { + "get": { + "operationId": "DevBoxes_ListActions", + "description": "Lists actions on a Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDevBoxAction" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists actions on a Dev Box.": { + "$ref": "./examples/DevBoxes_ListActions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions/{actionName}": { + "get": { + "operationId": "DevBoxes_GetAction", + "description": "Gets an action.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "actionName", + "in": "path", + "description": "The name of the action.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxAction" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets an action.": { + "$ref": "./examples/DevBoxes_GetAction.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions/{actionName}:skip": { + "post": { + "operationId": "DevBoxes_SkipAction", + "description": "Skips an occurrence of an action.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "actionName", + "in": "path", + "description": "The name of the action.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Skips an occurrence of an action.": { + "$ref": "./examples/DevBoxes_SkipAction.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions/{actionName}:delay": { + "post": { + "operationId": "DevBoxes_DelayAction", + "description": "Delays the occurrence of an action.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "actionName", + "in": "path", + "description": "The name of the action.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "$ref": "#/parameters/DelayUntilQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxAction" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Delays the occurrence of an action.": { + "$ref": "./examples/DevBoxes_DelayAction.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions:delay": { + "post": { + "operationId": "DevBoxes_DelayActions", + "description": "Delays all actions.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "$ref": "#/parameters/DelayUntilQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDevBoxActionDelayResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Delays all actions.": { + "$ref": "./examples/DevBoxes_DelayActions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/customizationGroups": { + "get": { + "operationId": "DevBoxes_ListCustomizationGroups", + "description": " Lists customization groups on the Dev Box. Listed customization groups exclude \n task information unless specified via the include parameter.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "include", + "in": "query", + "description": "Optional query parameter to specify what properties should be included in the response.", + "required": false, + "type": "string", + "enum": [ + "tasks" + ], + "x-ms-enum": { + "name": "ListCustomizationGroupsIncludeProperty", + "modelAsString": true, + "values": [ + { + "name": "tasks", + "value": "tasks", + "description": "Include list of tasks in the response." + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedCustomizationGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists customization groups on the Dev Box. Listed customization groups exclude task information unless specified via the include parameter.": { + "$ref": "./examples/DevBoxes_ListCustomizationGroups.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/customizationGroups/{customizationGroupName}": { + "get": { + "operationId": "DevBoxes_GetCustomizationGroup", + "description": " Gets a customization group.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "customizationGroupName", + "in": "path", + "description": "Name of the customization group.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomizationGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets a customization group.": { + "$ref": "./examples/DevBoxes_GetCustomizationGroup.json" + } + } + }, + "put": { + "operationId": "DevBoxes_CreateCustomizationGroup", + "description": "Applies customizations to the Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "name": "customizationGroupName", + "in": "path", + "description": "A customization group name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "body", + "in": "body", + "description": "Represents the body request of a Dev Box creation. Dev Box Pool name is required. Optionally set the owner of the Dev Box as local administrator", + "required": true, + "schema": { + "$ref": "#/definitions/CustomizationGroup" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomizationGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Applies customizations to the Dev Box.": { + "$ref": "./examples/DevBoxes_CreateCustomizationGroup.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/customizationGroups/{customizationGroupName}/logs/{customizationTaskId}": { + "get": { + "operationId": "DevBoxes_GetCustomizationTaskLog", + "description": "Gets the log for a customization task.", + "produces": [ + "text/plain", + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "name": "customizationGroupName", + "in": "path", + "description": "A customization group name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "customizationTaskId", + "in": "path", + "description": "A customization task ID.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets the log for a customization task.": { + "$ref": "./examples/DevBoxes_GetCustomizationTaskLog.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/operations": { + "get": { + "operationId": "DevBoxes_ListOperations", + "description": "Lists operations on the Dev Box which have occurred within the past 90 days.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDevBoxOperation" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists operations on the Dev Box which have occurred within the past 90 days.": { + "$ref": "./examples/DevBoxes_ListOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/operations/{operationId}": { + "get": { + "operationId": "DevBoxes_GetOperation", + "description": "Gets an operation on a Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "operationId", + "in": "path", + "description": "Unique identifier for the Dev Box operation.", + "required": true, + "type": "string", + "format": "uuid", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxOperation" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets an operation on a Dev Box.": { + "$ref": "./examples/DevBoxes_GetOperation.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/remoteConnection": { + "get": { + "operationId": "DevBoxes_GetRemoteConnection", + "description": "Gets RDP Connection info.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RemoteConnection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets RDP Connection info.": { + "$ref": "./examples/DevBoxes_GetRemoteConnection.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/snapshots": { + "get": { + "operationId": "DevBoxes_ListSnapshots", + "description": "Lists snapshots for this Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDevBoxSnapshot" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists snapshots for this Dev Box.": { + "$ref": "./examples/DevBoxes_ListSnapshots.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/snapshots/{snapshotId}": { + "get": { + "operationId": "DevBoxes_GetSnapshot", + "description": "Gets a snapshot by snapshot id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "snapshotId", + "in": "path", + "description": "The id of the snapshot. Should be treated as opaque string.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxSnapshot" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets a snapshot by snapshot id.": { + "$ref": "./examples/DevBoxes_GetSnapshot.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments": { + "get": { + "operationId": "Environments_ListEnvironmentsByUser", + "description": "Lists the environments for a project and user.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEnvironment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists the environments for a project and user.": { + "$ref": "./examples/Environments_ListEnvironmentsByUser.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}": { + "get": { + "operationId": "Environments_GetEnvironmentByUser", + "description": "Gets an environment.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "environmentName", + "in": "path", + "description": "Environment name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Environment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets an environment.": { + "$ref": "./examples/Environments_GetEnvironmentByUser.json" + } + } + }, + "put": { + "operationId": "Environments_CreateOrReplaceEnvironment", + "description": "Creates or updates an environment.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents an environment.", + "required": true, + "schema": { + "$ref": "#/definitions/Environment" + } + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/Environment" + }, + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Creates or updates an environment.": { + "$ref": "./examples/Environments_CreateOrReplaceEnvironment.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Environments_PatchEnvironment", + "description": "Partially updates an environment.", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents an environment.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentUpdate" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Environment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Partially updates an environment.": { + "$ref": "./examples/Environments_PatchEnvironment.json" + } + } + }, + "delete": { + "operationId": "Environments_DeleteEnvironment", + "description": "Deletes an environment and all its associated resources", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ForceDeleteEnvironmentQueryParameter" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "Location": { + "type": "string" + }, + "Operation-Location": { + "type": "string" + } + } + }, + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Deletes an environment and all its associated resources.": { + "$ref": "./examples/Environments_DeleteEnvironment.json" + }, + "Deletes an environment and its resource group without the environment definition.": { + "$ref": "./examples/Environments_ForceDeleteEnvironment.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/actions": { + "get": { + "operationId": "Environments_ListActions", + "description": "Get all scheduled actions for a user within an environment.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "environmentName", + "in": "path", + "description": "Environment name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEnvironmentAction" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get all scheduled actions for a user within an environment.": { + "$ref": "./examples/Environments_ListActions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/actions/{actionName}": { + "get": { + "operationId": "Environments_GetAction", + "description": "Retrieve a specific environment action.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "environmentName", + "in": "path", + "description": "Environment name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "actionName", + "in": "path", + "description": "Uniquely identifies the action.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentAction" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Retrieve a specific environment action.": { + "$ref": "./examples/Environments_GetAction.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/actions/{actionName}:skip": { + "post": { + "operationId": "Environments_SkipAction", + "description": "Skips an occurrence of an action.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "environmentName", + "in": "path", + "description": "Environment name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "actionName", + "in": "path", + "description": "Uniquely identifies the action.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Skips an occurrence of an action.": { + "$ref": "./examples/Environments_SkipAction.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/actions/{actionName}:delay": { + "post": { + "operationId": "Environments_DelayAction", + "description": "Delays the occurrence of an action.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "environmentName", + "in": "path", + "description": "Environment name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "actionName", + "in": "path", + "description": "Uniquely identifies the action.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "until", + "in": "query", + "description": "The time to delay the Environment action until, in RFC3339 format.", + "required": true, + "type": "string", + "format": "date-time" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentAction" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Delays the occurrence of an action.": { + "$ref": "./examples/Environments_DelayAction.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/operations": { + "get": { + "operationId": "Environments_ListOperations", + "description": "Lists operations on the environment which have occurred within the past 90 days", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "environmentName", + "in": "path", + "description": "Environment name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEnvironmentOperation" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists operations on the environment which have occurred within the past 90 days.": { + "$ref": "./examples/Environments_ListOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}": { + "get": { + "operationId": "Environments_GetOperation", + "description": "Gets an environment action result.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "environmentName", + "in": "path", + "description": "Environment name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "operationId", + "in": "path", + "description": "Unique identifier for the environment operation.", + "required": true, + "type": "string", + "format": "uuid", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentOperation" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets an environment action result.": { + "$ref": "./examples/Environments_GetOperation.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}/logs": { + "get": { + "operationId": "Environments_GetLogsByOperation", + "description": "Gets the logs for an operation on an environment.", + "produces": [ + "text/plain", + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "operationId", + "in": "path", + "description": "The id of the operation on an environment.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets the logs for an operation on an environment.": { + "$ref": "./examples/Environments_GetLogsByOperation.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/outputs": { + "get": { + "operationId": "Environments_GetOutputs", + "description": "Gets Outputs from the environment.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentOutputs" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets Outputs from the environment.": { + "$ref": "./examples/Environments_GetOutputs.json" + } + } + } + }, + "/users/{userId}/devboxes": { + "get": { + "operationId": "DevBoxes_ListAllDevBoxesByUser", + "description": "Lists Dev Boxes in the Dev Center for a particular user.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDevBox" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists Dev Boxes in the project for a particular user.": { + "$ref": "./examples/DevBoxes_ListAllDevBoxesByUser.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Azure.Core.Foundations.Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "Azure.Core.Foundations.ErrorResponse": { + "type": "object", + "description": "A response containing error details.", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.InnerError": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "Azure.Core.Foundations.OperationState": { + "type": "string", + "description": "Enum describing allowed operation states.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "OperationState", + "modelAsString": true, + "values": [ + { + "name": "NotStarted", + "value": "NotStarted", + "description": "The operation has not started." + }, + { + "name": "Running", + "value": "Running", + "description": "The operation is in progress." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The operation has completed successfully." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The operation has failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "The operation has been canceled by the user." + } + ] + } + }, + "Azure.Core.azureLocation": { + "type": "string", + "description": "Represents an Azure geography region where supported resource providers live." + }, + "Azure.Core.uuid": { + "type": "string", + "format": "uuid", + "description": "Universally Unique Identifier" + }, + "Catalog": { + "type": "object", + "description": "A catalog.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the catalog." + }, + "name": { + "type": "string", + "description": "Name of the catalog.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + } + }, + "required": [ + "uri", + "name" + ] + }, + "CustomizationGroup": { + "type": "object", + "description": "Represents a list of tasks to apply to a Dev Box.", + "properties": { + "tasks": { + "type": "array", + "description": "Tasks to apply. Note by default tasks are excluded from the response when\nlisting customization groups. To include them, use the `include=tasks` query\nparameter.", + "items": { + "$ref": "#/definitions/CustomizationTask" + } + }, + "uri": { + "type": "string", + "description": "The unique URI of the customization group.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Name of the customization group.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/CustomizationGroupStatus", + "description": "Status of the customization group.", + "readOnly": true + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Start time of the customization group, in RFC3339 format.", + "readOnly": true + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "End time of the customization group, in RFC3339 format.", + "readOnly": true + } + }, + "required": [ + "name" + ] + }, + "CustomizationGroupStatus": { + "type": "string", + "description": "Status of a customization group.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed", + "ValidationFailed" + ], + "x-ms-enum": { + "name": "CustomizationGroupStatus", + "modelAsString": true, + "values": [ + { + "name": "NotStarted", + "value": "NotStarted", + "description": "The customization group has not yet started." + }, + { + "name": "Running", + "value": "Running", + "description": "The customization group is currently executing." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "All tasks in the customization group successfully executed." + }, + { + "name": "Failed", + "value": "Failed", + "description": "At least one task in the customization group failed." + }, + { + "name": "ValidationFailed", + "value": "ValidationFailed", + "description": "At least one task in the customization group failed validation." + } + ] + } + }, + "CustomizationTask": { + "type": "object", + "description": "A customization task to run on a Dev Box.", + "properties": { + "name": { + "type": "string", + "description": "Name of the task.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "parameters": { + "type": "object", + "description": "Parameters for the task.", + "additionalProperties": { + "type": "string" + } + }, + "displayName": { + "type": "string", + "description": "Display name to help differentiate multiple instances of the same task." + }, + "timeoutInSeconds": { + "type": "integer", + "format": "int32", + "description": "Timeout, in seconds. Overrides any timeout provided on the task definition." + }, + "runAs": { + "$ref": "#/definitions/CustomizationTaskExecutionAccount", + "description": "What account to run the task as." + }, + "id": { + "type": "string", + "description": "ID of the task instance.", + "readOnly": true + }, + "logUri": { + "type": "string", + "description": "The unique URI for retrieving the task logs.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/CustomizationTaskStatus", + "description": "Status of the task.", + "readOnly": true + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Start time of the task, in RFC3339 format.", + "readOnly": true + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "End time of the task, in RFC3339 format.", + "readOnly": true + } + }, + "required": [ + "name" + ] + }, + "CustomizationTaskDefinition": { + "type": "object", + "description": "Represents a task to be used in customizing a Dev Box.", + "properties": { + "name": { + "type": "string", + "description": "Full name of the task: {catalogName}/{taskName}.", + "readOnly": true + }, + "catalogName": { + "type": "string", + "description": "Name of the catalog that the task belongs to.", + "readOnly": true + }, + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the customization task.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of the task." + }, + "parameters": { + "type": "object", + "description": "Parameters for the task.", + "additionalProperties": { + "$ref": "#/definitions/CustomizationTaskDefinitionParameter" + } + } + }, + "required": [ + "name", + "catalogName" + ] + }, + "CustomizationTaskDefinitionParameter": { + "type": "object", + "description": "Parameters for a customization task.", + "properties": { + "description": { + "type": "string", + "description": "Description of the parameter." + }, + "type": { + "$ref": "#/definitions/CustomizationTaskDefinitionParameterType", + "description": "Type of the parameter." + }, + "required": { + "type": "boolean", + "description": "Whether or not the parameter is required.", + "readOnly": true + }, + "default": { + "type": "string", + "description": "Default value for the parameter." + }, + "allowed": { + "type": "array", + "description": "Allowed values for the parameter.", + "items": { + "type": "string" + } + } + }, + "required": [ + "type" + ] + }, + "CustomizationTaskDefinitionParameterType": { + "type": "string", + "description": "Type of the parameter.", + "enum": [ + "string", + "number", + "boolean" + ], + "x-ms-enum": { + "name": "CustomizationTaskDefinitionParameterType", + "modelAsString": true, + "values": [ + { + "name": "string", + "value": "string", + "description": "The parameter accepts a string value." + }, + { + "name": "number", + "value": "number", + "description": "The parameter accepts a number value." + }, + { + "name": "boolean", + "value": "boolean", + "description": "The parameter accepts a boolean value." + } + ] + } + }, + "CustomizationTaskExecutionAccount": { + "type": "string", + "description": "What account to run the task as.", + "enum": [ + "System", + "User" + ], + "x-ms-enum": { + "name": "CustomizationTaskExecutionAccount", + "modelAsString": true, + "values": [ + { + "name": "System", + "value": "System", + "description": "The SYSTEM account." + }, + { + "name": "User", + "value": "User", + "description": "The account of the signed in user." + } + ] + } + }, + "CustomizationTaskList": { + "type": "object", + "description": "Represents a list of tasks to apply to a Dev Box", + "properties": { + "tasks": { + "type": "array", + "description": "Tasks to apply.", + "items": { + "$ref": "#/definitions/CustomizationTask" + } + } + } + }, + "CustomizationTaskListValidationError": { + "type": "object", + "description": "All of the validation errors for a customization task.", + "properties": { + "target": { + "$ref": "#/definitions/CustomizationTask", + "description": "The customization task that the error is about." + }, + "details": { + "type": "array", + "description": "List of validation errors for the task.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "target", + "details" + ] + }, + "CustomizationTaskListValidationOperationResult": { + "type": "object", + "description": "The operation result of validating a list of customization tasks.", + "properties": { + "id": { + "type": "string", + "description": "Fully qualified ID for the operation status.", + "readOnly": true + }, + "name": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The operation id name.", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Azure.Core.Foundations.OperationState", + "description": "Provisioning state of the resource." + }, + "resourceId": { + "type": "string", + "description": "The id of the resource." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the operation, in RFC3339 format." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the operation, in RFC3339 format." + }, + "percentComplete": { + "type": "number", + "format": "double", + "description": "Percent of the operation that is complete.", + "minimum": 0, + "maximum": 100 + }, + "properties": { + "description": "Custom operation properties, populated only for a successful operation." + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Operation Error message." + }, + "result": { + "$ref": "#/definitions/CustomizationTaskListValidationResult", + "description": "Outcome of validation." + } + }, + "required": [ + "id", + "name", + "status" + ] + }, + "CustomizationTaskListValidationResult": { + "type": "object", + "description": "The result of validating a list of customization tasks.", + "properties": { + "validationResult": { + "$ref": "#/definitions/CustomizationTaskListValidationStatus", + "description": "Outcome of validation." + }, + "errors": { + "type": "array", + "description": "List of validation errors. Absent if no errors.", + "items": { + "$ref": "#/definitions/CustomizationTaskListValidationError" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "validationResult" + ] + }, + "CustomizationTaskListValidationStatus": { + "type": "string", + "description": "Status of validating a list of customization tasks.", + "enum": [ + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "CustomizationTaskListValidationStatus", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Validation succeeded." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Validation failed." + } + ] + } + }, + "CustomizationTaskStatus": { + "type": "string", + "description": "Status of a customization task.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "FailedValidation", + "Skipped", + "TimedOut", + "Failed", + "WaitingForUserInputUac", + "WaitingForUserSession" + ], + "x-ms-enum": { + "name": "CustomizationTaskStatus", + "modelAsString": true, + "values": [ + { + "name": "NotStarted", + "value": "NotStarted", + "description": "The task has not yet started." + }, + { + "name": "Running", + "value": "Running", + "description": "The task is currently executing." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The task successfully executed." + }, + { + "name": "FailedValidation", + "value": "FailedValidation", + "description": "The task reference is not valid." + }, + { + "name": "Skipped", + "value": "Skipped", + "description": "he task was skipped." + }, + { + "name": "TimedOut", + "value": "TimedOut", + "description": "The task timed out." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The task failed to execute." + }, + { + "name": "WaitingForUserInputUac", + "value": "WaitingForUserInputUac", + "description": "The task is awaiting the User Account Control (UAC) prompt to be approved. (See more at: https://learn.microsoft.com/windows/security/application-security/application-control/user-account-control/)" + }, + { + "name": "WaitingForUserSession", + "value": "WaitingForUserSession", + "description": "The task is awaiting the user to connect to the Dev Box to execute." + } + ] + } + }, + "DevBox": { + "type": "object", + "description": "A Dev Box.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the dev box.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Display name for the Dev Box.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "projectName": { + "type": "string", + "description": "Name of the project this Dev Box belongs to.", + "readOnly": true + }, + "poolName": { + "type": "string", + "description": "The name of the Dev Box pool this machine belongs to.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "hibernateSupport": { + "$ref": "#/definitions/HibernateSupport", + "description": "Indicates whether hibernate is enabled/disabled or unknown.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/DevBoxProvisioningState", + "description": "The current provisioning state of the Dev Box.", + "readOnly": true + }, + "actionState": { + "type": "string", + "description": "The current action state of the Dev Box. This is state is based on previous\naction performed by user.", + "readOnly": true + }, + "powerState": { + "$ref": "#/definitions/PowerState", + "description": "The current power state of the Dev Box.", + "readOnly": true + }, + "uniqueId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "A unique identifier for the Dev Box. This is a GUID-formatted string (e.g.\n00000000-0000-0000-0000-000000000000).", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Provisioning or action error details. Populated only for error states.", + "readOnly": true + }, + "location": { + "$ref": "#/definitions/Azure.Core.azureLocation", + "description": "Azure region where this Dev Box is located. This will be the same region as the\nVirtual Network it is attached to.", + "readOnly": true + }, + "osType": { + "$ref": "#/definitions/OsType", + "description": "The operating system type of this Dev Box.", + "readOnly": true + }, + "user": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The AAD object id of the user this Dev Box is assigned to.", + "readOnly": true + }, + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "Information about the Dev Box's hardware resources.", + "readOnly": true + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Storage settings for this Dev Box.", + "readOnly": true + }, + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Information about the image used for this Dev Box.", + "readOnly": true + }, + "createdTime": { + "type": "string", + "format": "date-time", + "description": "Creation time of this Dev Box, in RFC3339 format.", + "readOnly": true + }, + "lastConnectedTime": { + "type": "string", + "format": "date-time", + "description": "Last time a user connected to this Dev Box, in RFC3339 format.", + "readOnly": true + }, + "localAdministrator": { + "$ref": "#/definitions/LocalAdminStatus", + "description": "Indicates whether the owner of the Dev Box is a local administrator.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "uri", + "name", + "poolName" + ] + }, + "DevBoxAction": { + "type": "object", + "description": "An action which will take place on a Dev Box.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI for the Dev Box action." + }, + "name": { + "type": "string", + "description": "The name of the action.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "actionType": { + "$ref": "#/definitions/DevBoxActionType", + "description": "The action that will be taken." + }, + "sourceId": { + "type": "string", + "description": "The id of the resource which triggered this action." + }, + "sourceUri": { + "type": "string", + "format": "uri", + "description": "The URI of the resource which triggered this action." + }, + "sourceType": { + "$ref": "#/definitions/DevBoxActionSourceType", + "description": "The type of the resource which triggered this action." + }, + "suspendedUntil": { + "type": "string", + "format": "date-time", + "description": "The earliest time that the action could occur (UTC), in RFC3339 format." + }, + "next": { + "$ref": "#/definitions/DevBoxNextAction", + "description": "Details about the next run of this action." + } + }, + "required": [ + "uri", + "name", + "actionType", + "sourceId", + "sourceUri", + "sourceType" + ] + }, + "DevBoxActionDelayResult": { + "type": "object", + "description": "The action delay result.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the action." + }, + "name": { + "type": "string", + "description": "The name of the action." + }, + "result": { + "$ref": "#/definitions/DevBoxActionDelayResultStatus", + "description": "The result of the delay operation on this action." + }, + "action": { + "$ref": "#/definitions/DevBoxAction", + "description": "The delayed action." + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Information about the error that occurred. Only populated on error." + } + }, + "required": [ + "uri", + "name", + "result" + ] + }, + "DevBoxActionDelayResultStatus": { + "type": "string", + "description": "The result of the delay operation on this action.", + "enum": [ + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "DevBoxActionDelayResultStatus", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The delay operation succeeded." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The delay operation failed." + } + ] + } + }, + "DevBoxActionSourceType": { + "type": "string", + "description": "The type of the resource which triggered the action.", + "enum": [ + "Pool", + "Schedule" + ], + "x-ms-enum": { + "name": "DevBoxActionSourceType", + "modelAsString": true, + "values": [ + { + "name": "Pool", + "value": "Pool", + "description": "The action was triggered by a Dev Box pool." + }, + { + "name": "Schedule", + "value": "Schedule", + "description": "The action was triggered by a Dev Box schedule." + } + ] + } + }, + "DevBoxActionType": { + "type": "string", + "description": "The type of action which will take place on a Dev Box.", + "enum": [ + "Stop" + ], + "x-ms-enum": { + "name": "DevBoxActionType", + "modelAsString": true, + "values": [ + { + "name": "Stop", + "value": "Stop", + "description": "The action will stop the Dev Box." + } + ] + } + }, + "DevBoxCaptureSnapshotOperation": { + "type": "object", + "description": "Information about a snapshot creation operation on a Dev Box.", + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ], + "x-ms-discriminator-value": "CaptureSnapshot" + }, + "DevBoxNextAction": { + "type": "object", + "description": "Details about the next run of an action.", + "properties": { + "scheduledTime": { + "type": "string", + "format": "date-time", + "description": "The time the action will be triggered (UTC), in RFC3339 format." + } + }, + "required": [ + "scheduledTime" + ] + }, + "DevBoxOperation": { + "type": "object", + "description": "Information about an operation on a Dev Box.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI for the Dev Box operation." + }, + "operationId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "Unique identifier for the Dev Box operation.", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$", + "readOnly": true + }, + "kind": { + "$ref": "#/definitions/DevBoxOperationKind", + "description": "The kind of operation that occurred." + }, + "status": { + "$ref": "#/definitions/Azure.Core.Foundations.OperationState", + "description": "The operation status." + }, + "createdByObjectId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The object ID of the actor which initiated the operation." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "he time the operation started, in RFC3339 format." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The time the operation finished, in RFC3339 format." + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Provisioning or operation error details. Populated only for error states." + } + }, + "discriminator": "kind", + "required": [ + "uri", + "operationId", + "kind", + "status" + ] + }, + "DevBoxOperationKind": { + "type": "string", + "description": "The type of Dev Box operation.", + "enum": [ + "Start", + "Stop", + "Restart", + "Repair", + "RestoreSnapshot", + "CaptureSnapshot" + ], + "x-ms-enum": { + "name": "DevBoxOperationKind", + "modelAsString": true, + "values": [ + { + "name": "Start", + "value": "Start", + "description": "The operation represents a Dev Box start." + }, + { + "name": "Stop", + "value": "Stop", + "description": "The operation represents a Dev Box stop." + }, + { + "name": "Restart", + "value": "Restart", + "description": "The operation represents a Dev Box restart." + }, + { + "name": "Repair", + "value": "Repair", + "description": "The operation represents a Dev Box repair." + }, + { + "name": "RestoreSnapshot", + "value": "RestoreSnapshot", + "description": "The operation represents a Dev Box restore from snapshot." + }, + { + "name": "CaptureSnapshot", + "value": "CaptureSnapshot", + "description": "The operation represents a Dev Box manual snapshot creation." + } + ] + } + }, + "DevBoxProvisioningState": { + "type": "string", + "description": "Indicates the provisioning state of the Dev Box.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Deleting", + "Updating", + "Starting", + "Stopping", + "Provisioning", + "ProvisionedWithWarning", + "InGracePeriod", + "NotProvisioned" + ], + "x-ms-enum": { + "name": "DevBoxProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Dev Box was successfully provisioned." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Dev Box failed to provision." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Dev Box provision was canceled." + }, + { + "name": "Creating", + "value": "Creating", + "description": "Dev Box is being created." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Dev Box is being deleted." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Dev Box is updating." + }, + { + "name": "Starting", + "value": "Starting", + "description": "Dev Box is starting." + }, + { + "name": "Stopping", + "value": "Stopping", + "description": "Dev Box is stopping." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Dev Box is provisioning." + }, + { + "name": "ProvisionedWithWarning", + "value": "ProvisionedWithWarning", + "description": "Dev Box was provisioned with warning." + }, + { + "name": "InGracePeriod", + "value": "InGracePeriod", + "description": "Dev Box is in grace period." + }, + { + "name": "NotProvisioned", + "value": "NotProvisioned", + "description": "Dev Box is not provisioned." + } + ] + } + }, + "DevBoxRepairOperation": { + "type": "object", + "description": "Information about a start operation on a Dev Box.", + "properties": { + "result": { + "$ref": "#/definitions/DevBoxRepairOperationResult", + "description": "The result of the repair operation." + } + }, + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ], + "x-ms-discriminator-value": "Repair" + }, + "DevBoxRepairOperationResult": { + "type": "object", + "description": "Information about the result of a repair operation on a Dev Box.", + "properties": { + "repairOutcome": { + "$ref": "#/definitions/DevBoxRepairOutcome", + "description": "The outcome of the repair operation." + }, + "code": { + "type": "string", + "description": "The result code associated with the repair operation." + }, + "message": { + "type": "string", + "description": "The result message associated with the repair operation." + } + } + }, + "DevBoxRepairOutcome": { + "type": "string", + "description": "The action taken during a repair operation.", + "enum": [ + "FixApplied", + "IssuesDetected", + "NoIssuesDetected" + ], + "x-ms-enum": { + "name": "DevBoxRepairOutcome", + "modelAsString": true, + "values": [ + { + "name": "FixApplied", + "value": "FixApplied", + "description": "A fix for an issue was automatically applied to the Dev Box." + }, + { + "name": "IssuesDetected", + "value": "IssuesDetected", + "description": "One or more issues was detected on the Dev Box, but they could not be fixed automatically." + }, + { + "name": "NoIssuesDetected", + "value": "NoIssuesDetected", + "description": "The service did not identify any issues on the Dev Box." + } + ] + } + }, + "DevBoxRestartOperation": { + "type": "object", + "description": "Information about a restart operation on a Dev Box.", + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ], + "x-ms-discriminator-value": "Restart" + }, + "DevBoxRestoreSnapshotOperation": { + "type": "object", + "description": "Information about a restore from snapshot operation on a Dev Box.", + "properties": { + "snapshotId": { + "type": "string", + "description": "Specifies the snapshot id that was used for the restore operation." + } + }, + "required": [ + "snapshotId" + ], + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ], + "x-ms-discriminator-value": "RestoreSnapshot" + }, + "DevBoxSnapshot": { + "type": "object", + "description": "A DevBox snapshot", + "properties": { + "snapshotId": { + "type": "string", + "description": "The id of the snapshot. Should be treated as opaque string.", + "readOnly": true + }, + "createdTime": { + "type": "string", + "format": "date-time", + "description": "The datetime that the snapshot was created, in RFC3339 format.", + "readOnly": true + }, + "expirationTime": { + "type": "string", + "format": "date-time", + "description": "The datetime when the snapshot expires, will only be shown for a manual snapshot, in RFC3339 format.", + "readOnly": true + }, + "snapshotType": { + "$ref": "#/definitions/SnapshotType", + "description": "The type of the snapshot indicates whether it is manual or automatic.", + "readOnly": true + } + }, + "required": [ + "snapshotId", + "createdTime", + "snapshotType" + ] + }, + "DevBoxStartOperation": { + "type": "object", + "description": "Information about a start operation on a Dev Box.", + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ], + "x-ms-discriminator-value": "Start" + }, + "DevBoxStopOperation": { + "type": "object", + "description": "Information about a stop operation on a Dev Box.", + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ], + "x-ms-discriminator-value": "Stop" + }, + "Environment": { + "type": "object", + "description": "Properties of an environment.", + "properties": { + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "The time the expiration date will be triggered (UTC), after which the\nenvironment and associated resources will be deleted." + }, + "parameters": { + "type": "object", + "description": "Parameters object for the environment.", + "additionalProperties": {} + }, + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the environment.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Environment name.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "environmentType": { + "type": "string", + "description": "Environment type.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "user": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The AAD object id of the owner of this Environment.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/EnvironmentProvisioningState", + "description": "The provisioning state of the environment.", + "readOnly": true + }, + "resourceGroupId": { + "type": "string", + "description": "The identifier of the resource group containing the environment's resources.", + "readOnly": true + }, + "catalogName": { + "type": "string", + "description": "Name of the catalog.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "environmentDefinitionName": { + "type": "string", + "description": "Name of the environment definition.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Provisioning error details. Populated only for error states.", + "readOnly": true + } + }, + "required": [ + "uri", + "name", + "environmentType", + "catalogName", + "environmentDefinitionName" + ] + }, + "EnvironmentAction": { + "type": "object", + "description": "An upcoming Environment Action.", + "properties": { + "name": { + "type": "string", + "description": "Uniquely identifies the action.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "uri": { + "type": "string", + "format": "uri", + "description": "Uri of the action resource.", + "readOnly": true + }, + "actionType": { + "$ref": "#/definitions/EnvironmentActionType", + "description": "The action that will be taken." + }, + "next": { + "$ref": "#/definitions/EnvironmentNextAction", + "description": "Details about the next run of this action." + }, + "lastModifiedBy": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "Object Id of the user who last modified the action.", + "readOnly": true + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "Time the object was last modified, in RFC3339 format." + } + }, + "required": [ + "name", + "uri", + "actionType" + ] + }, + "EnvironmentActionType": { + "type": "string", + "description": "The scheduled action types.", + "enum": [ + "Delete" + ], + "x-ms-enum": { + "name": "EnvironmentActionType", + "modelAsString": true, + "values": [ + { + "name": "Delete", + "value": "Delete", + "description": "The action will delete the environment and associated resources." + } + ] + } + }, + "EnvironmentDefinition": { + "type": "object", + "description": "An environment definition.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the environment definition." + }, + "id": { + "type": "string", + "description": "The ID of the environment definition." + }, + "name": { + "type": "string", + "description": "Name of the environment definition.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "catalogName": { + "type": "string", + "description": "Name of the catalog." + }, + "description": { + "type": "string", + "description": "A short description of the environment definition." + }, + "parameters": { + "type": "array", + "description": "Input parameters passed to an environment.", + "items": { + "$ref": "#/definitions/EnvironmentDefinitionParameter" + } + }, + "parametersSchema": { + "type": "string", + "description": "JSON schema defining the parameters object passed to an environment." + }, + "templatePath": { + "type": "string", + "description": "Path to the Environment Definition entrypoint file." + } + }, + "required": [ + "uri", + "id", + "name", + "catalogName" + ] + }, + "EnvironmentDefinitionParameter": { + "type": "object", + "description": "Properties of an Environment Definition parameter", + "properties": { + "id": { + "type": "string", + "description": "Unique ID of the parameter." + }, + "name": { + "type": "string", + "description": "Display name of the parameter." + }, + "description": { + "type": "string", + "description": "Description of the parameter." + }, + "default": { + "type": "string", + "description": "Default value of the parameter." + }, + "type": { + "$ref": "#/definitions/ParameterType", + "description": "A string of one of the basic JSON types (number, integer, array, object,\nboolean, string)." + }, + "readOnly": { + "type": "boolean", + "description": "Whether or not this parameter is read-only. If true, default should have a\nvalue." + }, + "required": { + "type": "boolean", + "description": "Whether or not this parameter is required." + }, + "allowed": { + "type": "array", + "description": "An array of allowed values.", + "minItems": 1, + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "type", + "required" + ] + }, + "EnvironmentDeleteOperation": { + "type": "object", + "description": "Information about a delete operation on an environment.", + "allOf": [ + { + "$ref": "#/definitions/EnvironmentOperation" + } + ], + "x-ms-discriminator-value": "Delete" + }, + "EnvironmentDeployOperation": { + "type": "object", + "description": "Information about a deploy operation on an environment.", + "allOf": [ + { + "$ref": "#/definitions/EnvironmentOperation" + } + ], + "x-ms-discriminator-value": "Deploy" + }, + "EnvironmentNextAction": { + "type": "object", + "description": "Details about the next run of an action.", + "properties": { + "scheduledTime": { + "type": "string", + "format": "date-time", + "description": "The time the action will be triggered (UTC), in RFC3339 format." + } + } + }, + "EnvironmentOperation": { + "type": "object", + "description": "Information about an operation on an environment.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI for the environment operation." + }, + "operationId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "Unique identifier for the environment operation.", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$", + "readOnly": true + }, + "kind": { + "$ref": "#/definitions/EnvironmentOperationKind", + "description": "The kind of operation that occurred." + }, + "status": { + "$ref": "#/definitions/Azure.Core.Foundations.OperationState", + "description": "The operation status." + }, + "createdByObjectId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The object ID of the actor which initiated the operation." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The time the operation started, in RFC3339 format." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The time the operation finished, in RFC3339 format." + }, + "environmentParameters": { + "type": "object", + "description": "Parameters object for the environment at the time of the operation.", + "additionalProperties": {} + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Provisioning or operation error details. Populated only for error states." + } + }, + "discriminator": "kind", + "required": [ + "uri", + "operationId", + "kind", + "status" + ] + }, + "EnvironmentOperationKind": { + "type": "string", + "description": "The type of environment operation.", + "enum": [ + "Deploy", + "Delete" + ], + "x-ms-enum": { + "name": "EnvironmentOperationKind", + "modelAsString": true, + "values": [ + { + "name": "Deploy", + "value": "Deploy", + "description": "The operation represents a deployment." + }, + { + "name": "Delete", + "value": "Delete", + "description": "The operation represents a delete." + } + ] + } + }, + "EnvironmentOutput": { + "type": "object", + "description": "Output from environment deployment.", + "properties": { + "type": { + "$ref": "#/definitions/EnvironmentOutputType", + "description": "Type of the output value." + }, + "value": { + "description": "The output value." + }, + "sensitive": { + "type": "boolean", + "description": "Indicates if the value is sensitive." + } + } + }, + "EnvironmentOutputType": { + "type": "string", + "description": "Type of the output value.", + "enum": [ + "array", + "boolean", + "number", + "object", + "string" + ], + "x-ms-enum": { + "name": "EnvironmentOutputType", + "modelAsString": true, + "values": [ + { + "name": "array", + "value": "array", + "description": "The output is an array of values." + }, + { + "name": "boolean", + "value": "boolean", + "description": "The output is a boolean value." + }, + { + "name": "number", + "value": "number", + "description": "The output is a number value." + }, + { + "name": "object", + "value": "object", + "description": "The output is an object value." + }, + { + "name": "string", + "value": "string", + "description": "The output is a string value." + } + ] + } + }, + "EnvironmentOutputs": { + "type": "object", + "description": "Outputs from environment deployment.", + "properties": { + "outputs": { + "type": "object", + "description": "The outputs Names and Values.", + "additionalProperties": { + "$ref": "#/definitions/EnvironmentOutput" + } + } + } + }, + "EnvironmentProvisioningState": { + "type": "string", + "description": "The provisioning state of the environment.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Accepted", + "Deleting", + "Updating", + "Preparing", + "Running", + "Syncing", + "MovingResources", + "TransientFailure", + "StorageProvisioningFailed" + ], + "x-ms-enum": { + "name": "EnvironmentProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The environment was successfully provisioned." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The environment failed to provision." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "The environment provisioning was canceled." + }, + { + "name": "Creating", + "value": "Creating", + "description": "The environment is creating." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The environment was accepted." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The environment is deleting." + }, + { + "name": "Updating", + "value": "Updating", + "description": "The environment is updating." + }, + { + "name": "Preparing", + "value": "Preparing", + "description": "The environment is preparing." + }, + { + "name": "Running", + "value": "Running", + "description": "The environment is running." + }, + { + "name": "Syncing", + "value": "Syncing", + "description": "The environment is Syncing." + }, + { + "name": "MovingResources", + "value": "MovingResources", + "description": "The environment is moving resources." + }, + { + "name": "TransientFailure", + "value": "TransientFailure", + "description": "The environment has a transient failure." + }, + { + "name": "StorageProvisioningFailed", + "value": "StorageProvisioningFailed", + "description": "The environment storage provisioning failed." + } + ] + } + }, + "EnvironmentType": { + "type": "object", + "description": "Properties of an environment type.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the environment type." + }, + "name": { + "type": "string", + "description": "Name of the environment type.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "deploymentTargetId": { + "type": "string", + "description": "Id of a subscription or management group that the environment type will be\nmapped to. The environment's resources will be deployed into this subscription\nor management group." + }, + "status": { + "$ref": "#/definitions/EnvironmentTypeEnableStatus", + "description": "Indicates whether this environment type is enabled for use in this project." + }, + "displayName": { + "type": "string", + "description": "Display name of the environment type." + } + }, + "required": [ + "uri", + "name", + "deploymentTargetId", + "status" + ] + }, + "EnvironmentTypeAbilities": { + "type": "object", + "description": "Abilities a user has on an environment type.", + "properties": { + "abilitiesAsAdmin": { + "type": "array", + "description": "The abilities the user has to perform actions on the environment type as an admin.", + "items": { + "$ref": "#/definitions/EnvironmentTypeAbilityAsAdmin" + } + }, + "abilitiesAsDeveloper": { + "type": "array", + "description": "The abilities the user has to perform actions on the environment type as a developer.", + "items": { + "$ref": "#/definitions/EnvironmentTypeAbilityAsDeveloper" + } + } + }, + "required": [ + "abilitiesAsAdmin", + "abilitiesAsDeveloper" + ] + }, + "EnvironmentTypeAbilityAsAdmin": { + "type": "string", + "description": "An ability the user has to perform an action on the environment type as an admin.", + "enum": [ + "DeleteEnvironments", + "ManageEnvironmentActions", + "ReadEnvironmentActions", + "ReadEnvironmentOutputs", + "ReadEnvironments", + "WriteEnvironments" + ], + "x-ms-enum": { + "name": "EnvironmentTypeAbilityAsAdmin", + "modelAsString": true, + "values": [ + { + "name": "DeleteEnvironments", + "value": "DeleteEnvironments", + "description": "User can delete environments." + }, + { + "name": "ManageEnvironmentActions", + "value": "ManageEnvironmentActions", + "description": "User can delay and skip actions on environments." + }, + { + "name": "ReadEnvironmentActions", + "value": "ReadEnvironmentActions", + "description": "User can read actions on environments." + }, + { + "name": "ReadEnvironmentOutputs", + "value": "ReadEnvironmentOutputs", + "description": "User can read outputs on environments." + }, + { + "name": "ReadEnvironments", + "value": "ReadEnvironments", + "description": "User can read environments." + }, + { + "name": "WriteEnvironments", + "value": "WriteEnvironments", + "description": "User can create new environments or replace and update existing ones." + } + ] + } + }, + "EnvironmentTypeAbilityAsDeveloper": { + "type": "string", + "description": "An ability the user has to perform an action on the environment type as a developer.", + "enum": [ + "DeleteEnvironments", + "ManageEnvironmentActions", + "ReadEnvironmentActions", + "ReadEnvironmentOutputs", + "ReadEnvironments", + "WriteEnvironments" + ], + "x-ms-enum": { + "name": "EnvironmentTypeAbilityAsDeveloper", + "modelAsString": true, + "values": [ + { + "name": "DeleteEnvironments", + "value": "DeleteEnvironments", + "description": "User can delete environments." + }, + { + "name": "ManageEnvironmentActions", + "value": "ManageEnvironmentActions", + "description": "User can delay and skip actions on environments." + }, + { + "name": "ReadEnvironmentActions", + "value": "ReadEnvironmentActions", + "description": "User can read actions on environments." + }, + { + "name": "ReadEnvironmentOutputs", + "value": "ReadEnvironmentOutputs", + "description": "User can read outputs on environments." + }, + { + "name": "ReadEnvironments", + "value": "ReadEnvironments", + "description": "User can read environments." + }, + { + "name": "WriteEnvironments", + "value": "WriteEnvironments", + "description": "User can create new environments or replace and update existing ones." + } + ] + } + }, + "EnvironmentTypeEnableStatus": { + "type": "string", + "description": "Indicates whether an environment type is enabled for use in a project.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnvironmentTypeEnableStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The environment type is enabled for use in the project." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The environment type is not enabled for use in the project." + } + ] + } + }, + "EnvironmentUpdate": { + "type": "object", + "description": "Properties of an environment.", + "properties": { + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "The time the expiration date will be triggered (UTC), after which the\nenvironment and associated resources will be deleted." + }, + "parameters": { + "type": "object", + "description": "Parameters object for the environment.", + "additionalProperties": {} + } + } + }, + "HardwareProfile": { + "type": "object", + "description": "Hardware specifications for the Dev Box.", + "properties": { + "skuName": { + "$ref": "#/definitions/SkuName", + "description": "The name of the SKU.", + "readOnly": true + }, + "vCPUs": { + "type": "integer", + "format": "int32", + "description": "The number of vCPUs available for the Dev Box.", + "readOnly": true + }, + "memoryGB": { + "type": "integer", + "format": "int32", + "description": "The amount of memory available for the Dev Box.", + "readOnly": true + } + } + }, + "HibernateSupport": { + "type": "string", + "description": "Indicates whether hibernate is supported and enabled, disabled, or unsupported by the operating system. Unknown hibernate support is represented as null.", + "enum": [ + "Enabled", + "Disabled", + "OsUnsupported" + ], + "x-ms-enum": { + "name": "HibernateSupport", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Hibernate is enabled." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Hibernate is not enabled." + }, + { + "name": "OsUnsupported", + "value": "OsUnsupported", + "description": "Hibernate is not supported by the operating system." + } + ] + } + }, + "ImageReference": { + "type": "object", + "description": "Specifies information about the image used.", + "properties": { + "name": { + "type": "string", + "description": "The name of the image used.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "The version of the image.", + "readOnly": true + }, + "operatingSystem": { + "type": "string", + "description": "The operating system of the image.", + "readOnly": true + }, + "osBuildNumber": { + "type": "string", + "description": "The operating system build number of the image.", + "readOnly": true + }, + "publishedDate": { + "type": "string", + "format": "date-time", + "description": "The datetime that the backing image version was published, in RFC3339 format.", + "readOnly": true + } + } + }, + "LocalAdminStatus": { + "type": "string", + "description": "Indicates whether owners of Dev Boxes in a pool are local administrators on the Dev Boxes.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "LocalAdminStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Owners of Dev Boxes in the pool are local administrators on the Dev Boxes." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Owners of Dev Boxes in the pool are not local administrators on the Dev Boxes." + } + ] + } + }, + "OperationStatus": { + "type": "object", + "description": "The current status of an async operation.", + "properties": { + "id": { + "type": "string", + "description": "Fully qualified ID for the operation status.", + "readOnly": true + }, + "name": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The operation id name.", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Azure.Core.Foundations.OperationState", + "description": "Provisioning state of the resource." + }, + "resourceId": { + "type": "string", + "description": "The id of the resource." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the operation, in RFC3339 format." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the operation, in RFC3339 format." + }, + "percentComplete": { + "type": "number", + "format": "double", + "description": "Percent of the operation that is complete.", + "minimum": 0, + "maximum": 100 + }, + "properties": { + "description": "Custom operation properties, populated only for a successful operation." + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Operation Error message." + } + }, + "required": [ + "id", + "name", + "status" + ] + }, + "OsDisk": { + "type": "object", + "description": "Settings for the operating system disk.", + "properties": { + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "The size of the OS Disk in gigabytes.", + "readOnly": true + } + } + }, + "OsType": { + "type": "string", + "description": "The operating system type.", + "enum": [ + "Windows" + ], + "x-ms-enum": { + "name": "OsType", + "modelAsString": true, + "values": [ + { + "name": "Windows", + "value": "Windows", + "description": "The Windows operating system." + } + ] + } + }, + "PagedCatalog": { + "type": "object", + "description": "Paged collection of Catalog items", + "properties": { + "value": { + "type": "array", + "description": "The Catalog items on this page", + "items": { + "$ref": "#/definitions/Catalog" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedCustomizationGroup": { + "type": "object", + "description": "Paged collection of CustomizationGroup items", + "properties": { + "value": { + "type": "array", + "description": "The CustomizationGroup items on this page", + "items": { + "$ref": "#/definitions/CustomizationGroup" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedCustomizationTaskDefinition": { + "type": "object", + "description": "The Customization Task list result.", + "properties": { + "value": { + "type": "array", + "description": "The CustomizationTaskDefinition items on this page", + "items": { + "$ref": "#/definitions/CustomizationTaskDefinition" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedDevBox": { + "type": "object", + "description": "Paged collection of DevBox items", + "properties": { + "value": { + "type": "array", + "description": "The DevBox items on this page", + "items": { + "$ref": "#/definitions/DevBox" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedDevBoxAction": { + "type": "object", + "description": "Paged collection of DevBoxAction items", + "properties": { + "value": { + "type": "array", + "description": "The DevBoxAction items on this page", + "items": { + "$ref": "#/definitions/DevBoxAction" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedDevBoxActionDelayResult": { + "type": "object", + "description": "Paged collection of DevBoxActionDelayResult items", + "properties": { + "value": { + "type": "array", + "description": "The DevBoxActionDelayResult items on this page", + "items": { + "$ref": "#/definitions/DevBoxActionDelayResult" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedDevBoxOperation": { + "type": "object", + "description": "Paged collection of DevBoxOperation items", + "properties": { + "value": { + "type": "array", + "description": "The DevBoxOperation items on this page", + "items": { + "$ref": "#/definitions/DevBoxOperation" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedDevBoxSnapshot": { + "type": "object", + "description": "Paged collection of DevBoxSnapshot items", + "properties": { + "value": { + "type": "array", + "description": "The DevBoxSnapshot items on this page", + "items": { + "$ref": "#/definitions/DevBoxSnapshot" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedEnvironment": { + "type": "object", + "description": "Paged collection of Environment items", + "properties": { + "value": { + "type": "array", + "description": "The Environment items on this page", + "items": { + "$ref": "#/definitions/Environment" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedEnvironmentAction": { + "type": "object", + "description": "Paged collection of EnvironmentAction items", + "properties": { + "value": { + "type": "array", + "description": "The EnvironmentAction items on this page", + "items": { + "$ref": "#/definitions/EnvironmentAction" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedEnvironmentDefinition": { + "type": "object", + "description": "Paged collection of EnvironmentDefinition items", + "properties": { + "value": { + "type": "array", + "description": "The EnvironmentDefinition items on this page", + "items": { + "$ref": "#/definitions/EnvironmentDefinition" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedEnvironmentOperation": { + "type": "object", + "description": "Paged collection of EnvironmentOperation items", + "properties": { + "value": { + "type": "array", + "description": "The EnvironmentOperation items on this page", + "items": { + "$ref": "#/definitions/EnvironmentOperation" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedEnvironmentType": { + "type": "object", + "description": "Paged collection of EnvironmentType items", + "properties": { + "value": { + "type": "array", + "description": "The EnvironmentType items on this page", + "items": { + "$ref": "#/definitions/EnvironmentType" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedPool": { + "type": "object", + "description": "Paged collection of Pool items", + "properties": { + "value": { + "type": "array", + "description": "The Pool items on this page", + "items": { + "$ref": "#/definitions/Pool" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedProject": { + "type": "object", + "description": "Paged collection of Project items", + "properties": { + "value": { + "type": "array", + "description": "The Project items on this page", + "items": { + "$ref": "#/definitions/Project" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedSchedule": { + "type": "object", + "description": "Paged collection of Schedule items", + "properties": { + "value": { + "type": "array", + "description": "The Schedule items on this page", + "items": { + "$ref": "#/definitions/Schedule" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ParameterType": { + "type": "string", + "description": "The type of data a parameter accepts.", + "enum": [ + "array", + "boolean", + "integer", + "number", + "object", + "string" + ], + "x-ms-enum": { + "name": "ParameterType", + "modelAsString": true, + "values": [ + { + "name": "array", + "value": "array", + "description": "The parameter accepts an array of values." + }, + { + "name": "boolean", + "value": "boolean", + "description": "The parameter accepts a boolean value." + }, + { + "name": "integer", + "value": "integer", + "description": "The parameter accepts an integer value." + }, + { + "name": "number", + "value": "number", + "description": "The parameter accepts a number value." + }, + { + "name": "object", + "value": "object", + "description": "The parameter accepts an object value." + }, + { + "name": "string", + "value": "string", + "description": "The parameter accepts a string value." + } + ] + } + }, + "Pool": { + "type": "object", + "description": "A pool of Dev Boxes.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the pool." + }, + "name": { + "type": "string", + "description": "Pool name.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "location": { + "$ref": "#/definitions/Azure.Core.azureLocation", + "description": "Azure region where Dev Boxes in the pool are located." + }, + "osType": { + "$ref": "#/definitions/OsType", + "description": "The operating system type of Dev Boxes in this pool." + }, + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "Hardware settings for the Dev Boxes created in this pool." + }, + "hibernateSupport": { + "$ref": "#/definitions/HibernateSupport", + "description": "Indicates whether hibernate is enabled/disabled or unknown." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Storage settings for Dev Box created in this pool." + }, + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Image settings for Dev Boxes create in this pool." + }, + "localAdministrator": { + "$ref": "#/definitions/LocalAdminStatus", + "description": "Indicates whether owners of Dev Boxes in this pool are local administrators on\nthe Dev Boxes." + }, + "stopOnDisconnect": { + "$ref": "#/definitions/StopOnDisconnectConfiguration", + "description": "Stop on disconnect configuration settings for Dev Boxes created in this pool." + }, + "stopOnNoConnect": { + "$ref": "#/definitions/StopOnNoConnectConfiguration", + "description": "Stop on no connect configuration settings for Dev Boxes created in this pool." + }, + "healthStatus": { + "$ref": "#/definitions/PoolHealthStatus", + "description": "Overall health status of the Pool. Indicates whether or not the Pool is\navailable to create Dev Boxes." + }, + "displayName": { + "type": "string", + "description": "Display name of the pool." + } + }, + "required": [ + "uri", + "name", + "location", + "healthStatus" + ] + }, + "PoolHealthStatus": { + "type": "string", + "description": "Pool status indicating whether a pool is available to create Dev Boxes.", + "enum": [ + "Unknown", + "Pending", + "Healthy", + "Warning", + "Unhealthy" + ], + "x-ms-enum": { + "name": "PoolHealthStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "The pool health status is not known." + }, + { + "name": "Pending", + "value": "Pending", + "description": "The pool health status waiting for health checks to run." + }, + { + "name": "Healthy", + "value": "Healthy", + "description": "The pool health status is healthy." + }, + { + "name": "Warning", + "value": "Warning", + "description": "The pool health status has one or more warnings." + }, + { + "name": "Unhealthy", + "value": "Unhealthy", + "description": "The pool health status is not healthy." + } + ] + } + }, + "PowerState": { + "type": "string", + "description": "The power states of a Dev Box.", + "enum": [ + "Unknown", + "Running", + "Deallocated", + "PoweredOff", + "Hibernated" + ], + "x-ms-enum": { + "name": "PowerState", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "The Dev Box power state is not known." + }, + { + "name": "Running", + "value": "Running", + "description": "The Dev Box is running." + }, + { + "name": "Deallocated", + "value": "Deallocated", + "description": "The Dev Box is deallocated." + }, + { + "name": "PoweredOff", + "value": "PoweredOff", + "description": "The Dev Box is powered off." + }, + { + "name": "Hibernated", + "value": "Hibernated", + "description": "The Dev Box is hibernated." + } + ] + } + }, + "Project": { + "type": "object", + "description": "Project details.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the project." + }, + "name": { + "type": "string", + "description": "Name of the project.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of the project." + }, + "maxDevBoxesPerUser": { + "type": "integer", + "format": "int32", + "description": "When specified, indicates the maximum number of Dev Boxes a single user can\ncreate across all pools in the project.", + "minimum": 0 + }, + "displayName": { + "type": "string", + "description": "Display name of the pool." + } + }, + "required": [ + "uri", + "name" + ] + }, + "ProjectAbilities": { + "type": "object", + "description": "Abilities a user has on a project.", + "properties": { + "abilitiesAsAdmin": { + "type": "array", + "description": "The abilities the user has to perform actions on the project as an admin.", + "items": { + "$ref": "#/definitions/ProjectAbilityAsAdmin" + } + }, + "abilitiesAsDeveloper": { + "type": "array", + "description": "The abilities the user has to perform actions on the project as a developer.", + "items": { + "$ref": "#/definitions/ProjectAbilityAsDeveloper" + } + } + }, + "required": [ + "abilitiesAsAdmin", + "abilitiesAsDeveloper" + ] + }, + "ProjectAbilityAsAdmin": { + "type": "string", + "description": "An ability the user has to perform an action on the project as an admin.", + "enum": [ + "DeleteDevBoxes", + "DeleteEnvironments", + "ManageEnvironmentActions", + "ReadDevBoxes", + "ReadEnvironmentActions", + "ReadEnvironmentOutputs", + "ReadEnvironments", + "StartDevBoxes", + "StopDevBoxes", + "WriteDevBoxes", + "WriteEnvironments" + ], + "x-ms-enum": { + "name": "ProjectAbilityAsAdmin", + "modelAsString": true, + "values": [ + { + "name": "DeleteDevBoxes", + "value": "DeleteDevBoxes", + "description": "User can delete dev boxes." + }, + { + "name": "DeleteEnvironments", + "value": "DeleteEnvironments", + "description": "User can delete environments." + }, + { + "name": "ManageEnvironmentActions", + "value": "ManageEnvironmentActions", + "description": "User can delay and skip actions on environments." + }, + { + "name": "ReadDevBoxes", + "value": "ReadDevBoxes", + "description": "User can read dev boxes." + }, + { + "name": "ReadEnvironmentActions", + "value": "ReadEnvironmentActions", + "description": "User can read actions on environments." + }, + { + "name": "ReadEnvironmentOutputs", + "value": "ReadEnvironmentOutputs", + "description": "User can read outputs on environments." + }, + { + "name": "ReadEnvironments", + "value": "ReadEnvironments", + "description": "User can read environments." + }, + { + "name": "StartDevBoxes", + "value": "StartDevBoxes", + "description": "User can start dev boxes." + }, + { + "name": "StopDevBoxes", + "value": "StopDevBoxes", + "description": "User can stop dev boxes." + }, + { + "name": "WriteDevBoxes", + "value": "WriteDevBoxes", + "description": "User can create dev boxes." + }, + { + "name": "WriteEnvironments", + "value": "WriteEnvironments", + "description": "User can create new environments or replace and update existing ones." + } + ] + } + }, + "ProjectAbilityAsDeveloper": { + "type": "string", + "description": "An ability the user has to perform an action on the project as a developer.", + "enum": [ + "CustomizeDevBoxes", + "DeleteDevBoxes", + "DeleteEnvironments", + "ManageDevBoxActions", + "ManageEnvironmentActions", + "ReadDevBoxActions", + "ReadDevBoxes", + "ReadEnvironmentActions", + "ReadEnvironmentOutputs", + "ReadEnvironments", + "ReadRemoteConnections", + "StartDevBoxes", + "StopDevBoxes", + "WriteDevBoxes", + "WriteEnvironments" + ], + "x-ms-enum": { + "name": "ProjectAbilityAsDeveloper", + "modelAsString": true, + "values": [ + { + "name": "CustomizeDevBoxes", + "value": "CustomizeDevBoxes", + "description": "User can customize their own dev boxes." + }, + { + "name": "DeleteDevBoxes", + "value": "DeleteDevBoxes", + "description": "User can delete their own dev boxes." + }, + { + "name": "DeleteEnvironments", + "value": "DeleteEnvironments", + "description": "User can delete environments." + }, + { + "name": "ManageDevBoxActions", + "value": "ManageDevBoxActions", + "description": "User can delay and skip actions on their own dev boxes." + }, + { + "name": "ManageEnvironmentActions", + "value": "ManageEnvironmentActions", + "description": "User can delay and skip actions on environments." + }, + { + "name": "ReadDevBoxActions", + "value": "ReadDevBoxActions", + "description": "User can read actions on their own dev boxes." + }, + { + "name": "ReadDevBoxes", + "value": "ReadDevBoxes", + "description": "User can read their own dev boxes." + }, + { + "name": "ReadEnvironmentActions", + "value": "ReadEnvironmentActions", + "description": "User can read actions on environments." + }, + { + "name": "ReadEnvironmentOutputs", + "value": "ReadEnvironmentOutputs", + "description": "User can read outputs on environments." + }, + { + "name": "ReadEnvironments", + "value": "ReadEnvironments", + "description": "User can read environments." + }, + { + "name": "ReadRemoteConnections", + "value": "ReadRemoteConnections", + "description": "User can read remote connections on their own dev boxes." + }, + { + "name": "StartDevBoxes", + "value": "StartDevBoxes", + "description": "User can start their own dev boxes." + }, + { + "name": "StopDevBoxes", + "value": "StopDevBoxes", + "description": "User can stop their own dev boxes." + }, + { + "name": "WriteDevBoxes", + "value": "WriteDevBoxes", + "description": "User can create dev boxes." + }, + { + "name": "WriteEnvironments", + "value": "WriteEnvironments", + "description": "User can create new environments or replace and update existing ones." + } + ] + } + }, + "RemoteConnection": { + "type": "object", + "description": "Provides remote connection information for a Dev Box.", + "properties": { + "webUrl": { + "type": "string", + "format": "uri", + "description": "URL to open a browser based RDP session." + }, + "rdpConnectionUrl": { + "type": "string", + "format": "uri", + "description": "Link to open a Remote Desktop session." + }, + "cloudPcConnectionUrl": { + "type": "string", + "format": "uri", + "description": "Link to open a remote desktop session via a dev box's underlying Cloud PC (This will default to Windows App)." + } + } + }, + "Schedule": { + "type": "object", + "description": "A Schedule to execute action.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the schedule." + }, + "name": { + "type": "string", + "description": "Display name for the Schedule.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "sourceUri": { + "type": "string", + "format": "uri", + "description": "The URI of the resource that this schedule belongs to." + }, + "sourceType": { + "$ref": "#/definitions/ScheduleSourceType", + "description": "The type of the resource that this schedule belongs to." + }, + "type": { + "$ref": "#/definitions/ScheduledType", + "description": "Supported type this scheduled task represents." + }, + "frequency": { + "$ref": "#/definitions/ScheduledFrequency", + "description": "The frequency of this scheduled task." + }, + "time": { + "type": "string", + "description": "The target time to trigger the action. The format is HH:MM." + }, + "timeZone": { + "type": "string", + "description": "The IANA timezone id at which the schedule should execute." + } + }, + "required": [ + "uri", + "name", + "sourceUri", + "sourceType", + "type", + "frequency", + "time", + "timeZone" + ] + }, + "ScheduleSourceType": { + "type": "string", + "description": "The type of the resource that this schedule belongs to.", + "enum": [ + "Pool" + ], + "x-ms-enum": { + "name": "ScheduleSourceType", + "modelAsString": true, + "values": [ + { + "name": "Pool", + "value": "Pool", + "description": "The schedule source is a Dev Box pool." + } + ] + } + }, + "ScheduledFrequency": { + "type": "string", + "description": "The frequency of task execution.", + "enum": [ + "Daily" + ], + "x-ms-enum": { + "name": "ScheduledFrequency", + "modelAsString": true, + "values": [ + { + "name": "Daily", + "value": "Daily", + "description": "The scheduled task will run every day." + } + ] + } + }, + "ScheduledType": { + "type": "string", + "description": "The supported types for a scheduled task.", + "enum": [ + "StopDevBox" + ], + "x-ms-enum": { + "name": "ScheduledType", + "modelAsString": true, + "values": [ + { + "name": "StopDevBox", + "value": "StopDevBox", + "description": "The scheduled task will stop impacted Dev Boxes." + } + ] + } + }, + "SkuName": { + "type": "string", + "description": "Indicates the Dev Box compute.", + "enum": [ + "general_i_8c32gb256ssd_v2", + "general_i_8c32gb512ssd_v2", + "general_i_8c32gb1024ssd_v2", + "general_i_8c32gb2048ssd_v2", + "general_i_16c64gb256ssd_v2", + "general_i_16c64gb512ssd_v2", + "general_i_16c64gb1024ssd_v2", + "general_i_16c64gb2048ssd_v2", + "general_i_32c128gb512ssd_v2", + "general_i_32c128gb1024ssd_v2", + "general_i_32c128gb2048ssd_v2", + "general_a_8c32gb256ssd_v2", + "general_a_8c32gb512ssd_v2", + "general_a_8c32gb1024ssd_v2", + "general_a_8c32gb2048ssd_v2", + "general_a_16c64gb256ssd_v2", + "general_a_16c64gb512ssd_v2", + "general_a_16c64gb1024ssd_v2", + "general_a_16c64gb2048ssd_v2", + "general_a_32c128gb512ssd_v2", + "general_a_32c128gb1024ssd_v2", + "general_a_32c128gb2048ssd_v2" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true, + "values": [ + { + "name": "general_i_8c32gb256ssd_v2", + "value": "general_i_8c32gb256ssd_v2", + "description": "Intel, 8 vCPU, 32 GB RAM, 256 GB Storage." + }, + { + "name": "general_i_8c32gb512ssd_v2", + "value": "general_i_8c32gb512ssd_v2", + "description": "Intel, 8 vCPU, 32 GB RAM, 512 GB Storage." + }, + { + "name": "general_i_8c32gb1024ssd_v2", + "value": "general_i_8c32gb1024ssd_v2", + "description": "Intel, 8 vCPU, 32 GB RAM, 1024 GB Storage." + }, + { + "name": "general_i_8c32gb2048ssd_v2", + "value": "general_i_8c32gb2048ssd_v2", + "description": "Intel, 8 vCPU, 32 GB RAM, 2048 GB Storage." + }, + { + "name": "general_i_16c64gb256ssd_v2", + "value": "general_i_16c64gb256ssd_v2", + "description": "Intel, 16 vCPU, 64 GB RAM, 256 GB Storage." + }, + { + "name": "general_i_16c64gb512ssd_v2", + "value": "general_i_16c64gb512ssd_v2", + "description": "Intel, 16 vCPU, 64 GB RAM, 512 GB Storage." + }, + { + "name": "general_i_16c64gb1024ssd_v2", + "value": "general_i_16c64gb1024ssd_v2", + "description": "Intel, 16 vCPU, 64 GB RAM, 1024 GB Storage." + }, + { + "name": "general_i_16c64gb2048ssd_v2", + "value": "general_i_16c64gb2048ssd_v2", + "description": "Intel, 16 vCPU, 64 GB RAM, 2048 GB Storage." + }, + { + "name": "general_i_32c128gb512ssd_v2", + "value": "general_i_32c128gb512ssd_v2", + "description": "Intel, 32 vCPU, 128 GB RAM, 512 GB Storage." + }, + { + "name": "general_i_32c128gb1024ssd_v2", + "value": "general_i_32c128gb1024ssd_v2", + "description": "Intel, 32 vCPU, 128 GB RAM, 1024 GB Storage." + }, + { + "name": "general_i_32c128gb2048ssd_v2", + "value": "general_i_32c128gb2048ssd_v2", + "description": "Intel, 32 vCPU, 128 GB RAM, 2048 GB Storage." + }, + { + "name": "general_a_8c32gb256ssd_v2", + "value": "general_a_8c32gb256ssd_v2", + "description": "AMD, 8 vCPU, 32 GB RAM, 256 GB Storage." + }, + { + "name": "general_a_8c32gb512ssd_v2", + "value": "general_a_8c32gb512ssd_v2", + "description": "AMD, 8 vCPU, 32 GB RAM, 512 GB Storage." + }, + { + "name": "general_a_8c32gb1024ssd_v2", + "value": "general_a_8c32gb1024ssd_v2", + "description": "AMD, 8 vCPU, 32 GB RAM, 1024 GB Storage." + }, + { + "name": "general_a_8c32gb2048ssd_v2", + "value": "general_a_8c32gb2048ssd_v2", + "description": "AMD, 8 vCPU, 32 GB RAM, 2048 GB Storage." + }, + { + "name": "general_a_16c64gb256ssd_v2", + "value": "general_a_16c64gb256ssd_v2", + "description": "AMD, 16 vCPU, 64 GB RAM, 256 GB Storage." + }, + { + "name": "general_a_16c64gb512ssd_v2", + "value": "general_a_16c64gb512ssd_v2", + "description": "AMD, 16 vCPU, 64 GB RAM, 512 GB Storage." + }, + { + "name": "general_a_16c64gb1024ssd_v2", + "value": "general_a_16c64gb1024ssd_v2", + "description": "AMD, 16 vCPU, 64 GB RAM, 1024 GB Storage." + }, + { + "name": "general_a_16c64gb2048ssd_v2", + "value": "general_a_16c64gb2048ssd_v2", + "description": "AMD, 16 vCPU, 64 GB RAM, 2048 GB Storage." + }, + { + "name": "general_a_32c128gb512ssd_v2", + "value": "general_a_32c128gb512ssd_v2", + "description": "AMD, 32 vCPU, 128 GB RAM, 512 GB Storage." + }, + { + "name": "general_a_32c128gb1024ssd_v2", + "value": "general_a_32c128gb1024ssd_v2", + "description": "AMD, 32 vCPU, 128 GB RAM, 1024 GB Storage." + }, + { + "name": "general_a_32c128gb2048ssd_v2", + "value": "general_a_32c128gb2048ssd_v2", + "description": "AMD, 32 vCPU, 128 GB RAM, 2048 GB Storage." + } + ] + } + }, + "SnapshotType": { + "type": "string", + "description": "The type of snapshot.", + "enum": [ + "Manual", + "Automatic" + ], + "x-ms-enum": { + "name": "SnapshotType", + "modelAsString": true, + "values": [ + { + "name": "Manual", + "value": "Manual", + "description": "The snapshot type indicates that this is a manually taken snapshot." + }, + { + "name": "Automatic", + "value": "Automatic", + "description": "The snapshot type indicates that this is an automatically taken snapshot." + } + ] + } + }, + "StopOnDisconnectConfiguration": { + "type": "object", + "description": "Stop on disconnect configuration settings for Dev Boxes created in this pool.", + "properties": { + "status": { + "$ref": "#/definitions/StopOnDisconnectEnableStatus", + "description": "Indicates whether the feature to stop the devbox on disconnect once the grace\nperiod has lapsed is enabled." + }, + "gracePeriodMinutes": { + "type": "integer", + "format": "int32", + "description": "The specified time in minutes to wait before stopping a Dev Box once disconnect\nis detected." + } + }, + "required": [ + "status" + ] + }, + "StopOnDisconnectEnableStatus": { + "type": "string", + "description": "Indicates whether the feature to stop the devbox on disconnect once the grace period has lapsed is enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "StopOnDisconnectEnableStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Stop on disconnect is enabled on the Dev Box." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Stop on disconnect is not enabled on the Dev Box." + } + ] + } + }, + "StopOnNoConnectConfiguration": { + "type": "object", + "description": "Stop on no connect configuration settings for Dev Boxes created in this pool.", + "properties": { + "status": { + "$ref": "#/definitions/StopOnNoConnectEnableStatus", + "description": "Enables the feature to stop a started Dev Box when it has not been connected to, once the grace period has lapsed." + }, + "gracePeriodMinutes": { + "type": "integer", + "format": "int32", + "description": "The specified time in minutes to wait before stopping a Dev Box if no connection is made. This will only be present if stop on no connect is enabled." + } + }, + "required": [ + "status" + ] + }, + "StopOnNoConnectEnableStatus": { + "type": "string", + "description": "Stop on no connect enable or disable status.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "StopOnNoConnectEnableStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Stop on no connect is enabled on the Dev Box." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Stop on no connect is not enabled on the Dev Box." + } + ] + } + }, + "StorageProfile": { + "type": "object", + "description": "Storage settings for the Dev Box's disks.", + "properties": { + "osDisk": { + "$ref": "#/definitions/OsDisk", + "description": "Settings for the operating system disk." + } + } + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + }, + "DelayUntilQueryParameter": { + "name": "until", + "in": "query", + "description": "The time to delay the Dev Box action or actions until, in RFC3339 format.", + "required": true, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method", + "x-ms-client-name": "delayUntil" + }, + "DevBoxNameParameter": { + "name": "devBoxName", + "in": "path", + "description": "The name of a Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "x-ms-parameter-location": "method" + }, + "EnvironmentNameParameter": { + "name": "environmentName", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "x-ms-parameter-location": "method" + }, + "ForceDeleteEnvironmentQueryParameter": { + "name": "force", + "in": "query", + "description": "The query option to force environment deletion even if the environment definition does not exist. This is a best-effort delete, and anything custom that forces resource creation beyond the associated resource group may not be deleted.", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "HibernateQueryParameter": { + "name": "hibernate", + "in": "query", + "description": "Optional parameter to hibernate the dev box.", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "ProjectNameParameter": { + "name": "projectName", + "in": "path", + "description": "The DevCenter Project upon which to execute operations.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "x-ms-parameter-location": "method" + }, + "SnapshotIdQueryParameter": { + "name": "snapshotId", + "in": "query", + "description": "Required parameter that specifies the snapshot id to use for the restore operation.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "UserIdParameter": { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CaptureSnapshotDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CaptureSnapshotDevBox.json new file mode 100644 index 000000000000..1306f8183682 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CaptureSnapshotDevBox.json @@ -0,0 +1,25 @@ +{ + "title": "Attempts to capture the manual snapshot for the Dev Box.", + "operationId": "DevBoxes_CaptureSnapshotDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CreateCustomizationGroup.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CreateCustomizationGroup.json new file mode 100644 index 000000000000..0ce11d294f54 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CreateCustomizationGroup.json @@ -0,0 +1,57 @@ +{ + "title": "Applies customizations to the Dev Box.", + "operationId": "DevBoxes_CreateCustomizationGroup", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "customizationGroupName": "Provisioning", + "body": { + "tasks": [ + { + "name": "catalogName/choco", + "displayName": "Install VS Code", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + } + }, + { + "name": "catalogName/write-to-file", + "runAs": "User" + } + ] + } + }, + "responses": { + "200": { + "body": { + "name": "Provisioning", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning", + "tasks": [ + { + "id": "a9202018-fb6a-4007-8b52-26d7c6d1c1fb", + "name": "catalogName/choco", + "displayName": "Install VS Code", + "status": "NotStarted", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + }, + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/a9202018-fb6a-4007-8b52-26d7c6d1c1fb" + }, + { + "id": "91835dc0-ef5a-4f58-9e3a-099aea8481f4", + "name": "catalogName/write-to-file", + "runAs": "User", + "status": "NotStarted", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/91835dc0-ef5a-4f58-9e3a-099aea8481f4" + } + ], + "status": "NotStarted" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CreateDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CreateDevBox.json new file mode 100644 index 000000000000..3b2a85f411d0 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CreateDevBox.json @@ -0,0 +1,74 @@ +{ + "title": "Creates or replaces a Dev Box.", + "operationId": "DevBoxes_CreateDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "body": { + "poolName": "LargeDevWorkStationPool" + } + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + }, + "201": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Creating", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DelayAction.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DelayAction.json new file mode 100644 index 000000000000..83f344d66d86 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DelayAction.json @@ -0,0 +1,29 @@ +{ + "title": "Delays the occurrence of an action.", + "operationId": "DevBoxes_DelayAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "actionName": "schedule-default", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "suspendedUntil": "2022-09-30T17:00:00Z", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DelayActions.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DelayActions.json new file mode 100644 index 000000000000..89db45645b88 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DelayActions.json @@ -0,0 +1,51 @@ +{ + "title": "Delays all actions.", + "operationId": "DevBoxes_DelayActions", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "result": "Succeeded", + "action": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "suspendedUntil": "2022-09-30T17:00:00Z", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "result": "Succeeded", + "action": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool", + "sourceType": "Pool", + "suspendedUntil": "2022-09-30T17:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DeleteDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DeleteDevBox.json new file mode 100644 index 000000000000..f4a9c9cf9b65 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DeleteDevBox.json @@ -0,0 +1,26 @@ +{ + "title": "Deletes a Dev Box.", + "operationId": "DevBoxes_DeleteDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetAction.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetAction.json new file mode 100644 index 000000000000..2d62c465e19d --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetAction.json @@ -0,0 +1,27 @@ +{ + "title": "Gets an action.", + "operationId": "DevBoxes_GetAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "actionName": "schedule-default" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationGroup.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationGroup.json new file mode 100644 index 000000000000..df202ebc899f --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationGroup.json @@ -0,0 +1,44 @@ +{ + "title": "Gets a customization group.", + "operationId": "DevBoxes_GetCustomizationGroup", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "customizationGroupName": "Provisioning" + }, + "responses": { + "200": { + "body": { + "name": "Provisioning", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning", + "tasks": [ + { + "id": "a9202018-fb6a-4007-8b52-26d7c6d1c1fb", + "name": "catalogName/choco", + "displayName": "Install VS Code", + "status": "Succeeded", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + }, + "startTime": "2021-08-05T18:00:00.000Z", + "endTime": "2021-08-05T18:00:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/a9202018-fb6a-4007-8b52-26d7c6d1c1fb" + }, + { + "id": "91835dc0-ef5a-4f58-9e3a-099aea8481f4", + "name": "catalogName/write-to-file", + "status": "Running", + "startTime": "2021-08-05T18:00:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/91835dc0-ef5a-4f58-9e3a-099aea8481f4" + } + ], + "status": "Running", + "startTime": "2021-08-05T18:00:00.000Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationTaskDefinitions.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationTaskDefinitions.json new file mode 100644 index 000000000000..9922353497d3 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationTaskDefinitions.json @@ -0,0 +1,36 @@ +{ + "title": "Gets a customization task.", + "operationId": "DevBoxes_GetCustomizationTaskDefinitions", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "api-version": "2024-10-01-preview", + "catalogName": "myCatalog", + "taskName": "choco" + }, + "responses": { + "200": { + "body": { + "name": "myCatalog/choco", + "catalogName": "myCatalog", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/customizationtasks/choco", + "description": "Install a package via chocolatey", + "parameters": { + "package": { + "description": "The package to install", + "type": "string", + "required": true + }, + "version": { + "description": "The version of the package", + "type": "string", + "default": "latest" + }, + "retryOnFail": { + "type": "boolean" + } + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationTaskLog.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationTaskLog.json new file mode 100644 index 000000000000..a23db3682380 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationTaskLog.json @@ -0,0 +1,18 @@ +{ + "title": "Gets the log for a customization task.", + "operationId": "DevBoxes_GetCustomizationTaskLog", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "4863c6d0-e979-4a36-ac8d-80029debfd80", + "devBoxName": "MyDevBox", + "customizationGroupName": "Provisioning", + "customizationTaskId": "91835dc0-ef5a-4f58-9e3a-099aea8481f4" + }, + "responses": { + "200": { + "body": "WzIwMjMtMDgtMTBUMTA6MTk6NTUuODIwMTAxKzAwOjAwXSBDaG9jb2xhdGV5IHYxLjMuMVxuWzIwMjMtMDgtMTBUMTA6MTk6NTUuOTEzMjk3KzAwOjAwXSAyIHZhbGlkYXRpb25zIHBlcmZvcm1lZC4gMSBzdWNjZXNzKGVzKSwgMSB3YXJuaW5nKHMpLCBhbmQgMCBlcnJvcihzKS4=" + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetDevBoxByUser.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetDevBoxByUser.json new file mode 100644 index 000000000000..4f37e7673039 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetDevBoxByUser.json @@ -0,0 +1,41 @@ +{ + "title": "Gets a Dev Box.", + "operationId": "DevBoxes_GetDevBoxByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastConnectedTime": "2022-04-01T00:13:23.323Z", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetImagingTaskLog.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetImagingTaskLog.json new file mode 100644 index 000000000000..cc7fabcf2337 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetImagingTaskLog.json @@ -0,0 +1,15 @@ +{ + "title": "Gets the log for an imaging build task.", + "operationId": "DevBoxes_GetImagingTaskLog", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "imageBuildLogId": "91835dc0-ef5a-4f58-9e3a-099aea8481f4" + }, + "responses": { + "200": { + "body": "WzIwMjMtMDgtMTBUMTA6MTk6NTUuODIwMTAxKzAwOjAwXSBDaG9jb2xhdGV5IHYxLjMuMVxuWzIwMjMtMDgtMTBUMTA6MTk6NTUuOTEzMjk3KzAwOjAwXSAyIHZhbGlkYXRpb25zIHBlcmZvcm1lZC4gMSBzdWNjZXNzKGVzKSwgMSB3YXJuaW5nKHMpLCBhbmQgMCBlcnJvcihzKS4=" + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetOperation.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetOperation.json new file mode 100644 index 000000000000..a7f76d9d7c13 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetOperation.json @@ -0,0 +1,25 @@ +{ + "title": "Gets an operation on a Dev Box.", + "operationId": "DevBoxes_GetOperation", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Start", + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetPool.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetPool.json new file mode 100644 index 000000000000..06b37d499a33 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetPool.json @@ -0,0 +1,45 @@ +{ + "title": "Gets a pool.", + "operationId": "DevBoxes_GetPool", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "api-version": "2024-10-01-preview", + "poolName": "DevPool" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/LargeDevWorkStationPool", + "name": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + }, + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Healthy", + "displayName": "LargePool" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetRemoteConnection.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetRemoteConnection.json new file mode 100644 index 000000000000..8f8f9dc03d70 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetRemoteConnection.json @@ -0,0 +1,18 @@ +{ + "title": "Gets RDP Connection info.", + "operationId": "DevBoxes_GetRemoteConnection", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "200": { + "body": { + "webUrl": "https://connectionUrl" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetScheduleByPool.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetScheduleByPool.json new file mode 100644 index 000000000000..a0ed28a46bbc --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetScheduleByPool.json @@ -0,0 +1,25 @@ +{ + "title": "Gets a schedule.", + "operationId": "DevBoxes_GetScheduleByPool", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "api-version": "2024-10-01-preview", + "poolName": "DevPool", + "scheduleName": "default" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", + "name": "default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool", + "sourceType": "Pool", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetSnapshot.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetSnapshot.json new file mode 100644 index 000000000000..f62c94303145 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetSnapshot.json @@ -0,0 +1,21 @@ +{ + "title": "Gets a snapshot by snapshot id.", + "operationId": "DevBoxes_GetSnapshot", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6797" + }, + "responses": { + "200": { + "body": { + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6797", + "createdTime": "2022-09-30T15:23:00Z", + "snapshotType": "Automatic" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListActions.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListActions.json new file mode 100644 index 000000000000..c73522362510 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListActions.json @@ -0,0 +1,42 @@ +{ + "title": "Lists actions on a Dev Box.", + "operationId": "DevBoxes_ListActions", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool", + "sourceType": "Pool", + "next": { + "scheduledTime": "2022-09-30T15:23:00Z" + } + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "suspendedUntil": "2022-09-30T17:00:00Z", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListAllDevBoxes.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListAllDevBoxes.json new file mode 100644 index 000000000000..d191b87a886b --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListAllDevBoxes.json @@ -0,0 +1,42 @@ +{ + "title": "Lists Dev Boxes that the caller has access to in the DevCenter.", + "operationId": "DevBoxes_ListAllDevBoxes", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastConnectedTime": "2022-04-01T00:13:23.323Z", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListAllDevBoxesByUser.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListAllDevBoxesByUser.json new file mode 100644 index 000000000000..f76e593664da --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListAllDevBoxesByUser.json @@ -0,0 +1,44 @@ +{ + "title": "Lists Dev Boxes in the project for a particular user.", + "operationId": "DevBoxes_ListAllDevBoxesByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastConnectedTime": "2022-04-01T00:13:23.323Z", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListCustomizationGroups.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListCustomizationGroups.json new file mode 100644 index 000000000000..25efb85d3eed --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListCustomizationGroups.json @@ -0,0 +1,68 @@ +{ + "title": "Lists customization groups on the Dev Box. Listed customization groups exclude task information unless specified via the include parameter.", + "operationId": "DevBoxes_ListCustomizationGroups", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "include": "tasks" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Provisioning", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning", + "tasks": [ + { + "id": "a9202018-fb6a-4007-8b52-26d7c6d1c1fb", + "name": "catalogName/choco", + "displayName": "Install VS Code", + "status": "Succeeded", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + }, + "startTime": "2021-08-05T18:00:00.000Z", + "endTime": "2021-08-05T18:00:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/a9202018-fb6a-4007-8b52-26d7c6d1c1fb" + }, + { + "id": "91835dc0-ef5a-4f58-9e3a-099aea8481f4", + "name": "catalogName/write-to-file", + "status": "Succeeded", + "startTime": "2021-08-05T18:10:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/91835dc0-ef5a-4f58-9e3a-099aea8481f4" + } + ], + "status": "Succeeded", + "startTime": "2021-08-05T18:00:00.000Z", + "endTime": "2021-08-05T18:10:00.000Z" + }, + { + "name": "Personalizations", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Personalizations", + "tasks": [ + { + "id": "d8ec7648-23c9-4e86-8883-6d42ad6c9609", + "name": "catalogName/choco", + "displayName": "Install Git", + "status": "Running", + "parameters": { + "packageName": "git" + }, + "startTime": "2021-08-05T18:10:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Personalizations/logs/d8ec7648-23c9-4e86-8883-6d42ad6c9609" + } + ], + "status": "Running", + "startTime": "2021-08-05T18:10:00.000Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListCustomizationTaskDefinitionsByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListCustomizationTaskDefinitionsByProject.json new file mode 100644 index 000000000000..6886b08fd453 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListCustomizationTaskDefinitionsByProject.json @@ -0,0 +1,53 @@ +{ + "title": "Lists all customization tasks available to the project.", + "operationId": "DevBoxes_ListCustomizationTaskDefinitionsByProject", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myCatalog/choco", + "catalogName": "myCatalog", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/customizationtasks/choco", + "description": "Install a package via chocolatey", + "parameters": { + "package": { + "description": "The package to install", + "type": "string", + "required": true + }, + "version": { + "description": "The version of the package", + "type": "string", + "default": "latest" + }, + "retryOnFail": { + "type": "boolean" + } + } + }, + { + "name": "myCatalog/powershell", + "catalogName": "myCatalog", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/customizationtasks/powershell", + "description": "Runs an arbitrary Powershell command", + "parameters": { + "command": { + "type": "string", + "required": true + }, + "runAsAdmin": { + "type": "boolean" + } + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListDevBoxesByUser.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListDevBoxesByUser.json new file mode 100644 index 000000000000..ee0a1c013dcd --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListDevBoxesByUser.json @@ -0,0 +1,44 @@ +{ + "title": "Lists Dev Boxes in the project for a particular user.", + "operationId": "DevBoxes_ListDevBoxesByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastConnectedTime": "2022-04-01T00:13:23.323Z", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListOperations.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListOperations.json new file mode 100644 index 000000000000..fa770194c6af --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListOperations.json @@ -0,0 +1,42 @@ +{ + "title": "Lists operations on the Dev Box which have occurred within the past 90 days.", + "operationId": "DevBoxes_ListOperations", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Start", + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/a6eb12ee-daa1-2215-9c44-63618dc2a781", + "operationId": "a6eb12ee-daa1-2215-9c44-63618dc2a781", + "status": "Succeeded", + "kind": "Repair", + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-10T19:31:20.7229492+00:00", + "endTime": "2022-09-10T19:57:41.7229492+00:00", + "result": { + "code": "ConnectivityFixApplied", + "message": "We resolved some connectivity issues with your Dev Box.", + "repairOutcome": "FixApplied" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListPools.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListPools.json new file mode 100644 index 000000000000..065f2392a615 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListPools.json @@ -0,0 +1,79 @@ +{ + "title": "Lists available pools.", + "operationId": "DevBoxes_ListPools", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/LargeDevWorkStationPool", + "name": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + }, + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Healthy", + "displayName": "LargePool" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/SQLDevelopmentMachinePool", + "name": "SQLDevelopmentMachinePool", + "location": "southcentralus", + "osType": "Windows", + "hardwareProfile": { + "vCPUs": 16, + "memoryGB": 128 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "SqlDevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + }, + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Healthy", + "displayName": "SQLPool" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSchedulesByPool.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSchedulesByPool.json new file mode 100644 index 000000000000..3139ab52c06a --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSchedulesByPool.json @@ -0,0 +1,28 @@ +{ + "title": "Lists all schedules within a pool that are configured by your project administrator.", + "operationId": "DevBoxes_ListSchedulesByPool", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "poolName": "DevPool", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", + "name": "default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool", + "sourceType": "Pool", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSchedulesByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSchedulesByProject.json new file mode 100644 index 000000000000..920494b62d99 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSchedulesByProject.json @@ -0,0 +1,27 @@ +{ + "title": "Lists all schedules within a project that are configured by your project administrator.", + "operationId": "DevBoxes_ListSchedulesByProject", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", + "name": "default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool", + "sourceType": "Pool", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSnapshots.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSnapshots.json new file mode 100644 index 000000000000..6cb959b2204e --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSnapshots.json @@ -0,0 +1,30 @@ +{ + "title": "Lists snapshots for this Dev Box.", + "operationId": "DevBoxes_ListSnapshots", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6797", + "createdTime": "2022-09-30T15:23:00Z", + "snapshotType": "Automatic" + }, + { + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6798", + "createdTime": "2022-09-30T15:23:00Z", + "expirationTime": "2024-10-30T15:23:00Z", + "snapshotType": "Manual" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RepairDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RepairDevBox.json new file mode 100644 index 000000000000..ab297ebe0667 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RepairDevBox.json @@ -0,0 +1,25 @@ +{ + "title": "Attempts automated repair steps to resolve common problems on a Dev Box. The Dev Box may restart during this operation.", + "operationId": "DevBoxes_RepairDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestartDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestartDevBox.json new file mode 100644 index 000000000000..acef706175e1 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestartDevBox.json @@ -0,0 +1,25 @@ +{ + "title": "Restarts a Dev Box.", + "operationId": "DevBoxes_RestartDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestoreSnapshotDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestoreSnapshotDevBox.json new file mode 100644 index 000000000000..891948c547a0 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestoreSnapshotDevBox.json @@ -0,0 +1,26 @@ +{ + "title": "Attempts to restore the Dev Box to a selected snapshot.", + "operationId": "DevBoxes_RestoreSnapshotDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6797" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_SkipAction.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_SkipAction.json new file mode 100644 index 000000000000..bc83aa55f3c1 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_SkipAction.json @@ -0,0 +1,15 @@ +{ + "title": "Skips an occurrence of an action.", + "operationId": "DevBoxes_SkipAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "actionName": "schedule-default" + }, + "responses": { + "204": {} + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_StartDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_StartDevBox.json new file mode 100644 index 000000000000..5c34fc1c57c2 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_StartDevBox.json @@ -0,0 +1,25 @@ +{ + "title": "Starts a Dev Box.", + "operationId": "DevBoxes_StartDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_StopDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_StopDevBox.json new file mode 100644 index 000000000000..99dd05cc7c03 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_StopDevBox.json @@ -0,0 +1,26 @@ +{ + "title": "Stops a Dev Box.", + "operationId": "DevBoxes_StopDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "hibernate": "true" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ValidateCustomizationTasksAction.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ValidateCustomizationTasksAction.json new file mode 100644 index 000000000000..7fa247cff7a6 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ValidateCustomizationTasksAction.json @@ -0,0 +1,40 @@ +{ + "title": "Validates a list of customization tasks.", + "operationId": "DevBoxes_ValidateCustomizationTasksAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "body": { + "tasks": [ + { + "name": "catalogName/choco", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + } + }, + { + "name": "catalogName/write-to-disk" + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Succeeded", + "startTime": "2023-02-01T12:43:54.122Z", + "result": { + "validationResult": "Succeeded" + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_GetProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_GetProject.json new file mode 100644 index 000000000000..44331c0613ab --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_GetProject.json @@ -0,0 +1,19 @@ +{ + "title": "Gets a project.", + "operationId": "DevCenter_GetProject", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/DevDiv", + "name": "DevDiv", + "description": "The developer division", + "displayName": "DeveloperDivision" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_GetProjectAbilities.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_GetProjectAbilities.json new file mode 100644 index 000000000000..1dd761dc9891 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_GetProjectAbilities.json @@ -0,0 +1,37 @@ +{ + "title": "Gets the signed-in user's permitted abilities in a project.", + "operationId": "DevCenter_GetProjectAbilities", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "abilitiesAsAdmin": [ + "ReadDevBoxes", + "ReadEnvironments" + ], + "abilitiesAsDeveloper": [ + "CustomizeDevBoxes", + "DeleteDevBoxes", + "DeleteEnvironments", + "ManageDevBoxActions", + "ManageEnvironmentActions", + "ReadDevBoxActions", + "ReadDevBoxes", + "ReadEnvironmentActions", + "ReadEnvironmentOutputs", + "ReadEnvironments", + "ReadRemoteConnections", + "StartDevBoxes", + "StopDevBoxes", + "WriteDevBoxes", + "WriteEnvironments" + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_ListProjects.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_ListProjects.json new file mode 100644 index 000000000000..a7d9e2e31725 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_ListProjects.json @@ -0,0 +1,22 @@ +{ + "title": "Lists all projects in a Dev Center.", + "operationId": "DevCenter_ListProjects", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject", + "name": "DevDiv", + "description": "The developer division", + "displayName": "DeveloperDivision" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_CreateOrReplaceEnvironment.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_CreateOrReplaceEnvironment.json new file mode 100644 index 000000000000..c31a9c1565a5 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_CreateOrReplaceEnvironment.json @@ -0,0 +1,43 @@ +{ + "title": "Creates or updates an environment.", + "operationId": "Environments_CreateOrReplaceEnvironment", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "environmentName": "mydevenv", + "userId": "me", + "body": { + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "expirationDate": "2023-09-10T17:00:00Z" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Creating", + "expirationDate": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_DelayAction.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_DelayAction.json new file mode 100644 index 000000000000..fedd0acb2c35 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_DelayAction.json @@ -0,0 +1,27 @@ +{ + "title": "Delays the occurrence of an action.", + "operationId": "Environments_DelayAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnv", + "actionName": "default", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/default", + "name": "default", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_DeleteEnvironment.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_DeleteEnvironment.json new file mode 100644 index 000000000000..b12474e9fe84 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_DeleteEnvironment.json @@ -0,0 +1,26 @@ +{ + "title": "Deletes an environment and all its associated resources.", + "operationId": "Environments_DeleteEnvironment", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ForceDeleteEnvironment.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ForceDeleteEnvironment.json new file mode 100644 index 000000000000..3305cb49fb0b --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ForceDeleteEnvironment.json @@ -0,0 +1,27 @@ +{ + "title": "Deletes an environment and its resource group without the environment definition.", + "operationId": "Environments_DeleteEnvironment", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv", + "force": "true" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetAction.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetAction.json new file mode 100644 index 000000000000..8c5dcee14079 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetAction.json @@ -0,0 +1,26 @@ +{ + "title": "Retrieve a specific environment action.", + "operationId": "Environments_GetAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "actionName": "default" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/default", + "name": "default", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetCatalog.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetCatalog.json new file mode 100644 index 000000000000..d0296c59168f --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetCatalog.json @@ -0,0 +1,18 @@ +{ + "title": "Gets the specified catalog within the project.", + "operationId": "Environments_GetCatalog", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "catalogName": "foo" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/foo", + "name": "foo" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentByUser.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentByUser.json new file mode 100644 index 000000000000..fc09eaf09dec --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentByUser.json @@ -0,0 +1,30 @@ +{ + "title": "Gets an environment.", + "operationId": "Environments_GetEnvironmentByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg028321", + "expirationDate": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentDefinition.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentDefinition.json new file mode 100644 index 000000000000..6a2a39903855 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentDefinition.json @@ -0,0 +1,58 @@ +{ + "title": "Get an environment definition from a catalog.", + "operationId": "Environments_GetEnvironmentDefinition", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "catalogName": "myCatalog", + "definitionName": "foo" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "name": "foo", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true, + "default": "dotnet", + "allowed": [ + "node", + "dotnet", + "java" + ] + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true, + "default": "Standard_LRS", + "allowed": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS" + ] + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "default": "true", + "readOnly": true, + "required": true + } + ], + "parametersSchema": "{\"type\":\"object\",\"properties\":{\"functionAppRuntime\":{\"$id\":\"functionAppRuntime\",\"value\":\"dotnet\",\"displayName\":\"Function App Runtime\",\"type\":\"string\",\"enum\":[\"node\",\"dotnet\",\"java\"]},\"storageAccountType\":{\"$id\":\"storageAccountType\",\"value\":\"Standard_LRS\",\"displayName\":\"Storage Account Type\",\"type\":\"string\",\"enum\":[\"Standard_LRS\",\"Standard_GRS\",\"Standard_RAGRS\"]},\"httpsOnly\":{\"$id\":\"httpsOnly\",\"value\":true,\"displayName\":\"HTTPS only\",\"type\":\"boolean\"}},\"required\":[\"functionAppRuntime\",\"storageAccountType\"]}", + "templatePath": "azuredeploy.json" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentTypeAbilities.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentTypeAbilities.json new file mode 100644 index 000000000000..15bd60987c65 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentTypeAbilities.json @@ -0,0 +1,28 @@ +{ + "title": "Gets the signed-in user's permitted abilities in an environment type.", + "operationId": "Environments_GetEnvironmentTypeAbilities", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "environmentTypeName": "devtestenv", + "userId": "me", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "abilitiesAsAdmin": [ + "ReadEnvironments" + ], + "abilitiesAsDeveloper": [ + "DeleteEnvironments", + "ManageEnvironmentActions", + "ReadEnvironmentActions", + "ReadEnvironmentOutputs", + "ReadEnvironments", + "WriteEnvironments" + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentTypes.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentTypes.json new file mode 100644 index 000000000000..d41c0d94320e --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentTypes.json @@ -0,0 +1,21 @@ +{ + "title": "Get an environment type configured for a project.", + "operationId": "Environments_GetEnvironmentTypes", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "environmentTypeName": "devtestenv", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/environmentTypes/devtestenv", + "name": "devtestenv", + "status": "Enabled", + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "displayName": "DevTestEnvironment" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetLogsByOperation.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetLogsByOperation.json new file mode 100644 index 000000000000..5fb52d5225a3 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetLogsByOperation.json @@ -0,0 +1,17 @@ +{ + "title": "Gets the logs for an operation on an environment.", + "operationId": "Environments_GetLogsByOperation", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": "{file}" + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetOperation.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetOperation.json new file mode 100644 index 000000000000..6e4d5ac213af --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetOperation.json @@ -0,0 +1,29 @@ +{ + "title": "Gets an environment action result.", + "operationId": "Environments_GetOperation", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/myEnvironment/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Deploy", + "environmentParameters": { + "paramA": "valueA", + "paramB": "valueB" + }, + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetOutputs.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetOutputs.json new file mode 100644 index 000000000000..20f9755f7101 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetOutputs.json @@ -0,0 +1,51 @@ +{ + "title": "Gets Outputs from the environment.", + "operationId": "Environments_GetOutputs", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "responses": { + "200": { + "body": { + "outputs": { + "stringOutput": { + "type": "string", + "value": "Output1 value", + "sensitive": false + }, + "arrayOutput": { + "type": "array", + "value": [ + 1, + 2, + 3 + ], + "sensitive": false + }, + "boolOutput": { + "type": "bool", + "value": true, + "sensitive": false + }, + "intOutput": { + "type": "int", + "value": 1, + "sensitive": false + }, + "objectOutput": { + "type": "object", + "value": { + "name": "name", + "id": "id" + }, + "sensitive": false + } + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListActions.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListActions.json new file mode 100644 index 000000000000..fec2e7db31bb --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListActions.json @@ -0,0 +1,39 @@ +{ + "title": "Get all scheduled actions for a user within an environment.", + "operationId": "Environments_ListActions", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/default", + "name": "default", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-10T17:00:00Z" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/expire", + "name": "expire", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-10-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-20T17:00:00Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListCatalogsByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListCatalogsByProject.json new file mode 100644 index 000000000000..d9fbc4eee5d0 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListCatalogsByProject.json @@ -0,0 +1,21 @@ +{ + "title": "Lists all of the catalogs available for a project.", + "operationId": "Environments_ListCatalogsByProject", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/foo", + "name": "foo" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentDefinitionsByCatalog.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentDefinitionsByCatalog.json new file mode 100644 index 000000000000..72928b19772c --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentDefinitionsByCatalog.json @@ -0,0 +1,69 @@ +{ + "title": "Lists all environment definitions available within a catalog.", + "operationId": "Environments_ListEnvironmentDefinitionsByCatalog", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "catalogName": "myCatalog" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "name": "foo", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true, + "default": "dotnet", + "allowed": [ + "node", + "dotnet", + "java" + ] + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true, + "default": "Standard_LRS", + "allowed": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS" + ] + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "default": "true", + "readOnly": true, + "required": true + } + ], + "parametersSchema": "{\"type\":\"object\",\"properties\":{\"functionAppRuntime\":{\"$id\":\"functionAppRuntime\",\"value\":\"dotnet\",\"displayName\":\"Function App Runtime\",\"type\":\"string\",\"enum\":[\"node\",\"dotnet\",\"java\"]},\"storageAccountType\":{\"$id\":\"storageAccountType\",\"value\":\"Standard_LRS\",\"displayName\":\"Storage Account Type\",\"type\":\"string\",\"enum\":[\"Standard_LRS\",\"Standard_GRS\",\"Standard_RAGRS\"]},\"httpsOnly\":{\"$id\":\"httpsOnly\",\"value\":true,\"displayName\":\"HTTPS only\",\"type\":\"boolean\"}},\"required\":[\"functionAppRuntime\",\"storageAccountType\"]}", + "templatePath": "azuredeploy.json" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", + "name": "bar", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "templatePath": "azuredeploy.json" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentDefinitionsByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentDefinitionsByProject.json new file mode 100644 index 000000000000..3055da215535 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentDefinitionsByProject.json @@ -0,0 +1,68 @@ +{ + "title": "Lists all environment definitions available for a project.", + "operationId": "Environments_ListEnvironmentDefinitionsByProject", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "name": "foo", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true, + "default": "dotnet", + "allowed": [ + "node", + "dotnet", + "java" + ] + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true, + "default": "Standard_LRS", + "allowed": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS" + ] + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "default": "true", + "readOnly": true, + "required": true + } + ], + "parametersSchema": "{\"type\":\"object\",\"properties\":{\"functionAppRuntime\":{\"$id\":\"functionAppRuntime\",\"value\":\"dotnet\",\"displayName\":\"Function App Runtime\",\"type\":\"string\",\"enum\":[\"node\",\"dotnet\",\"java\"]},\"storageAccountType\":{\"$id\":\"storageAccountType\",\"value\":\"Standard_LRS\",\"displayName\":\"Storage Account Type\",\"type\":\"string\",\"enum\":[\"Standard_LRS\",\"Standard_GRS\",\"Standard_RAGRS\"]},\"httpsOnly\":{\"$id\":\"httpsOnly\",\"value\":true,\"displayName\":\"HTTPS only\",\"type\":\"boolean\"}},\"required\":[\"functionAppRuntime\",\"storageAccountType\"]}", + "templatePath": "azuredeploy.json" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", + "id": "/projects/myProject/catalogs/myOtherCatalog/environmentDefinitions/bar", + "name": "bar", + "catalogName": "myOtherCatalog", + "description": "This environment definition is just for example purposes.", + "templatePath": "azuredeploy.json" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentTypes.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentTypes.json new file mode 100644 index 000000000000..62e267038a17 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentTypes.json @@ -0,0 +1,24 @@ +{ + "title": "Lists all environment types configured for a project.", + "operationId": "Environments_ListEnvironmentTypes", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/environmentTypes/devtestenv", + "name": "devtestenv", + "status": "Enabled", + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "displayName": "DevTestEnvironment" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironments.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironments.json new file mode 100644 index 000000000000..037ce43b0111 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironments.json @@ -0,0 +1,32 @@ +{ + "title": "Lists all environment definitions available for a project.", + "operationId": "Environments_ListEnvironments", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg028321", + "expirationDate": "2023-09-10T17:00:00Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentsByUser.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentsByUser.json new file mode 100644 index 000000000000..a31423259000 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentsByUser.json @@ -0,0 +1,33 @@ +{ + "title": "Lists the environments for a project and user.", + "operationId": "Environments_ListEnvironmentsByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg028321", + "expirationDate": "2023-09-10T17:00:00Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListOperations.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListOperations.json new file mode 100644 index 000000000000..8386bc5476ab --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListOperations.json @@ -0,0 +1,32 @@ +{ + "title": "Lists operations on the environment which have occurred within the past 90 days.", + "operationId": "Environments_ListOperations", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/myEnvironment/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Deploy", + "environmentParameters": { + "paramA": "valueA", + "paramB": "valueB" + }, + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_PatchEnvironment.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_PatchEnvironment.json new file mode 100644 index 000000000000..c31b552d4813 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_PatchEnvironment.json @@ -0,0 +1,32 @@ +{ + "title": "Partially updates an environment.", + "operationId": "Environments_PatchEnvironment", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "environmentName": "mydevenv", + "userId": "me", + "body": { + "expirationDate": "2023-09-10T17:00:00Z" + } + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "expirationDate": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_SkipAction.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_SkipAction.json new file mode 100644 index 000000000000..d620617d53de --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_SkipAction.json @@ -0,0 +1,21 @@ +{ + "title": "Skips an occurrence of an action.", + "operationId": "Environments_SkipAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "environmentName": "myEnv", + "userId": "me", + "actionName": "default", + "body": { + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + } + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/OperationStatuses_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/OperationStatuses_Get.json new file mode 100644 index 000000000000..c1d48444d062 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/OperationStatuses_Get.json @@ -0,0 +1,19 @@ +{ + "title": "Get the status of an operation.", + "operationId": "OperationStatuses_Get", + "parameters": { + "api-version": "2024-10-01-preview", + "projectName": "myProject", + "operationId": "fa067167-e49d-41bd-8dd8-de719b9de3b3" + }, + "responses": { + "200": { + "body": { + "id": "/projects/myProject/operationStatuses/fa067167-e49d-41bd-8dd8-de719b9de3b3", + "name": "fa067167-e49d-41bd-8dd8-de719b9de3b3", + "status": "Running", + "startTime": "2024-01-24T21:14:58.472Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/readme.md b/specification/devcenter/data-plane/readme.md index 4adfb0eb98b6..d1cdb23e358a 100644 --- a/specification/devcenter/data-plane/readme.md +++ b/specification/devcenter/data-plane/readme.md @@ -27,7 +27,22 @@ These are the global settings for the devcenter. ``` yaml openapi-type: data-plane azure-arm: false -tag: package-2024-09-01-preview +tag: package-2024-10-01-preview +``` + +### Tag: package-2024-10-01-preview + +These settings apply only when `--tag=package-2024-10-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-10-01-preview' +input-file: + - Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json + +directive: + - suppress: HostParametersValidation + reason: Requires URL format for endpoint params, which violates R2003 and causes problems with codegen. + - suppress: OperationIdNounVerb + reason: DevBoxes and Environments are operations with multiple models. ``` ### Tag: package-2024-09-01-preview